SOAP Connector Form – Completing the Response tab
Use the Response tab to configure the data mapping for the reply from the external Web service. Use the Response Headers section to map the data needed (if any) from the incoming SOAP envelope header. Use the Response Parameters section to specify how to map the data from the body of the reply message to Pega Platform properties.
The data types of the incoming parameters can be any of the primitive data types specified in the W3C XML Schema standard. If you used the Connector and Metadata wizard to generate the connector rules and the WSDL file you identified defines its complex types, the Data Type for a response parameter is XML Page. This indicates that the incoming response parameter is an XML object.
Soap Envelope Content
Field
|
Description
|
| Target Property
|
Optional. Specify the name of a Single Value text property to hold the entire contents of the SOAP response. You use this field when you need to store the original SOAP message with the work item, perhaps for an auditing or history purpose.
|
Response Headers
Use this section to map values for SOAP headers in the response. The data type of a SOAP header is an element (an instance of the W3C DOM object org.w3c.dom.Element) and the contents must be processed by a Parse XML rule.
- If the Applies To class of the Parse XML rule is the same as that of the connector rule, you can create a data mapping that names the parse rule in this section.
- If the Applies To class of the Parse XML rule is different from that of the connector rule, map the value to a single value text property in this section, and then configure the connector activity to call the Parse XML rule.
The SOAP envelope in the response must contain a namespace. See also PDN article How to map a SOAP Header in the request message of a SOAP connector.
Field
|
Description
|
| Name
|
Enter the external name of the SOAP response header.
|
| Description
|
Enter a text description.
|
| Map To
|
Do one of the following:
- 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.
|
| Map To Key
|
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.
Do one of the following
- If you selected
XML Parse Rule in the Map To field, 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 specified
Clipboard in the Map To field, select the property to hold the incoming XML.
|
Response Parameters
Field
|
Description
|
| Data Type
|
Select the XML schema data type of the parameter value. 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.
The XML Page data type indicates that the parameter is an XML object with a schema described by the data transform specified on the Advanced tab that this connector rule was generated by the Connector and Metadata wizard. You cannot use the XML Page data type for a connector rule that you created without using the Connector and Metadata wizard.
Select the XML Literal data type if the parameter is an XML object and you want to map the actual (literal) XML to a Parse XML rule or a single-value text property. In this case, specify Axis2 on the Advanced tab. For more information, see More about SOAP Connectors.
|
| Name
|
Enter the external name of the parameter.
|
| Description
|
Enter a text description.
|
| Map To
|
Specify the destination or type of destination for the value in Pega Platform. The choices that appear in the selection list are dependent on the data type specified in the Data Type field:
Clipboard — The destination is a property on the clipboard.XML ParseRule — The incoming data is a stream of XML to be parsed by a Parse XML rule.Delimited ParseRule — The incoming data is in a delimited format to be processed by a delimited parse rule.Structured Parserule — The incoming data is in a flat file that has a fixed format with fixed length field, to be processed by a structured parse rule.
If more choices appear, they each identify a custom function rule in a MapTo library. Review the function rule to determine what it does.
|
| Map To Key
|
Specify the key to locating the property or rule in the destination specified in Map To field:
Map To
|
Instructions
|
Clipboard
|
Enter the name of the property name to map the data to. Click the Open icon to review the property.
|
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. That is, use the syntax "NamespaceName ElementName" and not "NamespaceName.ElementName." The system uses the Applies to class of this connector rule as the first key part of the parse rule.
To maintain backward compatibility for connector rules created in releases before PRPC Version 5.2, you can specify a data mapping with only a Namespace value. In that case, the system at runtime determines the Element Name key from the root element of the incoming XML document. However, this mapping works only if the Parser Type of the Parse XML rule is set to DOM and validation is not enabled. As a best practice, specify both the Namespace Name and the Element Name of the rule.
|
Delimited ParseRule
|
Enter the Namespace and Record Type names (second and third keys) of the appropriate delimited parse rule. The Applies To class of this connector rule is the first key to the parse rule.
|
Structured ParseRule
|
If the Map To value is, enter the Activity name (second key) of the appropriate structured parse rule. The Applies To class of this connector rule is the first key to the parse rule.
|
a Rule-Utility-Function from a MapTo library |
Either select a property to hold the results of the function or leave this field blank, as appropriate for the function.
|
|
Open topic with navigation