Skip to main content


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

Service SAP form - Completing the Request tab

Updated on April 6, 2022

Configure the data mapping of the incoming SOAP request from the external SAP application to the Pega Platform on the Request tab.

Important: Service SAP rules are no longer being actively developed, and are being considered for deprecation in upcoming releases. Using Service SAP rules does not follow Pega development best practices. Use Service SOAP rules instead. For more information, see Service SOAP rules.
  • Complete the Request headers section to map data from the SOAP envelope header.
  • Complete the Request parameters section to map data from the body of the SOAP request.

Soap action HTTP request header field

Use this section to enter a custom SOAP action HTTP request header field that allows a server, such as a firewall, to identify the intent of the request, and appropriately filter it. The header field value is a URI that indicates the intent, and it overrides the value that is generated by Pega Platform.

FieldDescription
Specify custom SOAP action URISelect this check box if you want to include a custom SOAP action URI in the request and change the default SOAPAction HTTP header provided in the WSDL file that is generated for the service.
SOAP action URIIf you selected the Specify customSOAP action URI check box, enter the URI of the custom SOAPAction that you want to include in the request. If you leave this value blank, the server presumes that the intent of the SOAP message is provided by the HTTP Request-URI.

Request headers

FieldDescription
Data typeIndicate the data type that your service expects in the request header. Select either string or XML Literal.
NameEnter the external name of the request header.
DescriptionEnter a text description.
Map to

Select the destination for the SOAP header value:

  • To map the SOAP header value to a property on the clipboard, select Clipboard.

    If you selected XML Literal as the data type, the property value contains text that is formatted as XML.

  • To map the SOAP header value to a Parse XML rule, select XML ParseRule.

    This option is recommended if you selected XML Literal as the data type.

Map to keySpecify the key of the property or the rule to which to map the SOAP header value:
  • If the Map to value is Clipboard, enter a reference to the text property to which you want to map the data.
  • If the Map to value is 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 value from the Element Name with a single space character. The system uses the page class of this service rule as the first key part of the parse rule.

Request parameters

FieldDescription
Data type Select the data type of the parameter from the subset of XML schema data types supported by SOAP services. See How to complete data mapping for SOAP and dotNet services for details about data types.
  • If you selected Document/literal as the binding type in the Style and use section on the Service tab, select XML Literal.
    Note: You must configure a single parameter of type XML Literal.
  • If you selected RPC/literal as the binding type in the Style and use section on the Service tab, select XML Literal or one of the other XML schema data types in the list.
  • If you selected RPC/encoded as the binding type in the Style and use section on the Service tab, select one of the other XML schema data types in the list. Do not select XML Literal.
NameEnter the external name of the parameter when the WSDL file is generated. (This need not match a rule or object in the Pega Platform.)
DescriptionOptional. Enter a text description of the parameter.
Map toSpecify the destination or the type of destination for the value in the Pega Platform. The choices in the list depend on value you selected in the Data type field. For descriptions of the Map to options, see the definition of the Map to field in the Request headers section.
Map to keySpecify the key to locating the property or the rule in the destination specified in the Map to field. For descriptions of the Map to key options, see the definition of the Map to key field in the Request headers section.

Tags

Pega Platform 8.6 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