Show all
Use the Request tab to configure the data
mapping for the outgoing SOAP message. Use the Request
Headers section to specify the data needed (if necessary) for
the SOAP envelope header. Use the Request Parameters
section to specify the data for body of the SOAP message.
The data types of the outgoing parameters can be any of the primitive
data types specified in the W3C XML Schema standard. If you used the
Connector and Metadata accelerator to generate the connector rules and
the WSDL file you identified defines its own complex types, the
Data Type for a parameter is XML Page
,
which indicates that the outgoing parameter is an XML object.
Request
Headers
Use this section to map values for SOAP headers. The data type of a
SOAP header is an element (an instance of the W3C DOM object
org.w3c.dom.Element
). The value of a SOAP header must be
well-formed, namespace-qualified XML, typically generated by an XML
Stream rule. SR-6745 If your application requires SOAP
headers that conform to a WS-Security format rather than using HTTP
Basic authentication, you can define that header content here.
SR-6983
- If the Applies To class of the XML Stream rule
is the same as the Applies To class of the
connector rule, you can create a data mapping that specifies the
XML Stream rule in this section.
- If the Applies To class of the XML Stream rule
is different from that of the connector rule, call the XML rule
from the connector activity and then create a data mapping for the
property that holds the stream in this section.
See also
Pega Developer network article PRKB-24061 How to map
a SOAP Header in the request message of a SOAP connector.
Field
|
Description
|
Name
|
Enter the external name of
the SOAP request header. SR-1568 B-17442
|
Description
|
Enter a text description.
|
Map
From
|
Do one of the following:
- If the Applies To class of the XML
rule that provides the value for this header is the same
as the Applies To class of the connector
rule, select
XML Stream .
- If the Applies To class of the XML
rule is different from that of the connector rule, click
in the field and enter
Clipboard .
|
Map From
Key
|
Do one of the following:
- If you selected
XML Stream in the
Map From field, enter the Stream
Name (the second key part) of the XML Stream
rule. The system uses the first key part (the
Applies To class) to find the XML
rule.
- If you specified
Clipboard in the
Map From field, select the property that
holds the XML text.
|
Request
Parameters
Field
|
Description
|
Data
Type
|
Select the XML schema data type of the
external value you are mapping. Select any primitive data
type in the W3C XML Schema standard. See How to complete
mapping details for SOAP and dotNet connectors for
details about data types. B-21862 B-21649 SR-4259 B-22632
B-22574 SR-5558
The XML Page data type indicates that the
parameter is an XML object with a schema described by the
model rule specified on the Advanced tab and that this connector rule was
generated by the Connector and Metadata accelerator.
B-20541 You cannot use the XML Page
data type for a connector rule that you created without using
the Connector and Metadata accelerator.
Select the XML Literal data type if the
parameter is an XML object and you want to map the actual
(literal) XML from an XML stream rule or a single-value text
property. In this case, you must also specify Axis2 on the
Advanced tab. For more information, see More about SOAP Connectors.
If the SOAP operation style is
document-literal and you are creating this rule
manually, you can either specify simple argument-property
mapping entries for the values in the message or use the XML
Literal data type.
|
Name
|
Enter the external name of the request parameter.
|
Description
|
Enter a text description for this row.
|
Map
From
|
Specify the source or
the type of source of the value in Process Commander. The
choices that appear in the selection list depend on the data
type specified in the Data Type field:
Clipboard — The source is a
property or page on the clipboard.
Constant — The source is a fixed
value that does not change.
XML Stream — The source is a stream
of XML data formatted by an XML Stream rule.
HTML Stream — The source is a
stream of HTML data formatted by an HTML rule.
If more choices appear, they each identify a custom
function rule in a MapFrom library. Review the
function rule to determine what it does.
|
Map From
Key
|
Specify the key to locating the property or rule in the
source specified in the Map From field:
Map From
|
Instructions
|
Clipboard
|
Enter a reference to a single value or page
property. If the Connector and Metadata accelerator
set the Data Type to XML
Page , the Map From Key holds
the page name of a page defined on the XML Page tab. Click the pencil icon
to review
the property. B-20446 pencil
|
Constant
|
Enter a literal text string. To include blank
spaces in your text string, surround the string with
double quotes.
|
XML Stream
|
Enter either the Stream Name
— second key part — of the appropriate
XML Stream rule or a page name and Stream
Name using the syntax
PageName.StreamName.
The page must be on the clipboard for rule
resolution to find the rule. If you specify the
stream name only, the system uses the
Applies To key part of this
connector rule as the first key part of the XML
rule.
|
HTML Stream
|
Enter either the Stream Name
— second key part — of the appropriate
HTML rule or a page name and stream name using the
syntax PageName.StreamName.
The page must be on the clipboard for rule
resolution to find the rule. If you specify the
stream name only, the system uses the
Applies To key part of this
connector rule as the first key part of the XML
rule.
|
a Rule-Utility-Function from a
MapFrom library |
Either select the property that holds the value
to be processed by the function or leave this field
blank, as appropriate for the function.
|
|
Binary
Attachments
Field
|
Description
|
Send attachments
with request
|
Select to specify that the connector is to send
attachments with the outgoing SOAP message. For more
information, see the Pega
Developer Network article PRKB-25026 How to configure a
SOAP or dotNET connector to send or receive SOAP with
attachments. 5.4
|
About SOAP Connector
rules