Connect dotNet form – Completing the Response tab

Configure the data mapping for the reply from the external Web service on the Response tab. 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 reply to properties.

Important: Connect dotNet rules are no longer being actively developed, and are being considered for deprecation in upcoming releases. Using Connect dotNet rules does not follow Pega development best practices. Use Connect SOAP rules instead. For more information, see About Connect SOAP rules.

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 own complex types, the data type for a response parameter is set to 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 an XML parse 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 Pega Community 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 XML ParseRule is the only option. Information from a SOAP response header must be mapped to a Parse XML rule.
Map to key Enter the Namespace and Element names (second and third key parts) to 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.

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, also 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. 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 Parse Rule — The incoming data is a stream of XML to be parsed using the actions defined in a Parse XML rule.
  • Delimited Parse Rule — The incoming data is in a delimited format to be processed by a Parse Delimited rule.
  • Structured Parse Rule — The incoming data is in a flat file that has a fixed format with fields of fixed length to be processed by a Parse Structured rule.

If more choices appear, they 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:
  • If you map to Clipboard, enter the name of the property name to map the data to.
  • 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 XML parse rule. Separate the Namespace value from the Element Name value with a space; use the syntax "NamespaceName ElementName". The system uses the Applies to class of this connector rule as the first key part of the parse rule.

    Optionally, if the Parser Type of the rule is set to DOM, you can enter the Namespace Name only. In that case, the system determines the Element Name key at runtime from the root element of the incoming XML document.

    However, if validation is enabled in the parse rule, you must provide both key parts of the rule to have the incoming XML be validated. Additionally, if the Parser Type of the rule is set to SAX, provide both key parts to the rule.

  • If you map to Delimited Parse Rule, enter the Namespace and Record type names (second and third key parts) of the appropriate delimited parse rule. The system uses the Applies To class of this connector rule as the first key part of the parse rule.
  • If you map to Structured Parse Rule, enter the Activity Name (second key part) of the appropriate structured parse rule. The system uses the Applies To class of this connector rule as the first key part of the parse rule.
  • If you map to 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.