Configuring the response for a SOAP connector
Use the Response tab to configure the data mapping for the reply from the external Web service.
The data types of the outgoing parameters can be any of the primitive data types that are specified in the W3C XML Schema standard. If you used the Create SOAP Integration wizard to generate the connector rules, and the WSDL file you identified defines its own complex types, the data type for a parameter is XML Literal. XML Literal indicates that the outgoing parameter contains text that is formatted as XML.
In the navigation pane of Dev Studio, click Records.
Expand the Integration-Connectors category, and then click Connect SOAP.
In the list of Connect SOAP instances, select the instance for which you want to configure the response.
Click the Response tab.
In the SOAP envelope content section, in the Target property field, specify the name of a Single Value text property to hold the entire contents of the SOAP response.Use this field when you need to store the original SOAP message with the work item, for example, for an auditing or history purpose.
In the Response headers section, map the data needed from the incoming SOAP envelope header.
Use this section to map values for SOAP headers in the response.
The SOAP envelope in the response must contain a namespace. For more information, see the Pega Community article, How to map a SOAP header in the request message of a SOAP connector
In the Name field, enter the external name of the SOAP response header.
In the Description field, enter a text description for the response header.
In the Map to field, choose one of the following options:
- If the Applies To class of the XML parse rule to process this data is the same as that of the connector rule, select XML Parse Rule.
- If the Applies To class of the XML parse rule is different from that of the connector rule, click in the field and enter Clipboard.
In the Map to key field, enter the Namespace and Element names (second and third key parts) of the appropriate Parse XML rule, separated by a period.The system uses the Applies To key part of this SOAP connector rule as the first key part of the Parse XML rule.
- If you map to XML Parse Rule, enter the Namespace and Element names (second and third key parts) of the rule separated by a space. The first key part (the Applies To class) is assumed to be that of the connector rule.
- If you map to the Clipboard, select the property to hold the incoming XML.
To ensure that messages that contain a must understand flag that are set to true do not cause an error, select Disable must understand.
In the Response parameters section, specify how to map the data from the body of the reply message to Pega Platform properties.
In the Data type field, select the data type of the parameter value.For details about data types, see Data mapping for SOAP and dotNet connectors.
- If the SOAP operation style is document-literal or RPC literal, select the XML Literal data type.
- If the SOAP operation style is RPC encoded, select any other primitive data type.
In the Name field, enter the external name of the parameter.
In the Description field, enter a text description for this parameter.
In the Map to field, specify the destination or type of destination for the value in Pega Platform.The choices that appear in the selection list depend on the data type specified in the Data type field.
- Clipboard – The destination is a property on the clipboard.
- XML Parse Rule – The incoming data is a stream of XML to be parsed by a Parse XML rule.
If you see more choices, each identifies a custom function rule in a
MapTolibrary. Review the function rule to determine what it does.
In the Map to key field, specify the key to locating the property or rule in the destination specified in the Map to field:
- If you map to the Clipboard, enter the name of the property to which to map the data. Click the Open icon to review the property.
- If you map to XML Parse Rule, enter the Namespace name
(second key part) and the Element Name name (third key part) of the appropriate
Parse XML rule. Separate the Namespace from the Element Name with a space by using
the syntax "
NamespaceName ElementName". The system uses the Applies to class of this connector rule as the first key part of the parse rule.
ArticleConnect SOAP rules
ArticleCreating a Connect SOAP rule
ArticleViewing rule history