SOAP Connector Form
Completing the Response tab

Field

Description

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 object, perhaps for an auditing or history purpose.

Field

Description

Enter the external name of the SOAP response header.

Enter a text description.

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.

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.

Field

Description

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. B-21862 B-21649 SR-4259 SR-3548 B-20669 BooleanB-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 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 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.

Enter the external name of the parameter.

Enter a text description.

Specify the destination or type of destination for the value in Process Commander. 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.

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 pencil icon to review the property. B-20446 pencil
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 V5.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. B-21542
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.

Field

Description

Select to specify that the connector is to extract SOAP attachments from the SOAP response message. For more information, see Pega Developer network article PRKB-25026 How to configure a SOAP or dotNET connector to send or receive SOAP with attachments.