Skip to main content


         This documentation site is for previous versions. Visit our new documentation site for current releases.      
 

SAP Connector form - Completing the Response tab

Updated on April 6, 2022

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.

Note: This tab is displayed for the SOAP connector type only.
Important: Connect SAP rules are no longer being actively developed, and are being considered for deprecation in upcoming releases. Using Connect SAP rules does not follow Pega development best practices. Use Connect SOAP rules instead. For more information, see 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 Create SAP Integration wizard to generate the connector rules and the WSDL file that you identified defines its complex types, the Data Type for a response parameter is XML Literal. This indicates that the incoming response parameter is an XML object.

Soap envelope content

FieldDescription
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.

FieldDescription
NameEnter the external name of the SOAP response header.
DescriptionEnter a text description.
Map toDo 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 keyEnter 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 SAP connector rule as the first key part of the Parse XML rule.

Do one of the following:

  • 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 Clipboard, select the property to hold the incoming XML.

Response parameters

FieldDescription
Data type Select the 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.

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.

NameEnter the external name of the parameter.
DescriptionEnter 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 Parse Rule — The incoming data is a stream of XML to be parsed by a Parse XML 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:
  • If you map to Clipboard, enter the name of the property name to map the data to. Click the Open icon to review the property.
  • If you map to XML ParseRule, 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". 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.
  • Previous topic SAP Connector form - Completing the Request tab
  • Next topic SAP Connector form - Completing the Faults tab

Related articles

Connect SAP rulesConnect SAP rules - Completing the Create, Save As, or Specialization form

Tags

Pega Platform 8.7 Data Integration

Have a question? Get answers now.

Visit the Support Center to ask questions, engage in discussions, share ideas, and help others.

Visit the Support Center

Did you find this content helpful?

Yes
No

Want to help us improve this content?
Suggest an edit

We'd prefer it if you saw us at our best.

Pega.com is not optimized for Internet Explorer. For the optimal experience, please use:

Close Deprecation Notice
Contact us