Skip to main content

Service SAP form - Completing the Response tab

Suggest edit
Updated on April 6, 2022

Configure the data mapping for the reply message on the Response tab. Use the Response headers section to map data for the SOAP envelope header. Use the Response parameters section to map data for the body of the SOAP message.

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.

By default, the response message uses UTF-8 character set encoding. However, if the request message HTTP header contains a Content-Type value, the response message uses the same encoding as the request message. Alternatively, you can override this behavior and establish a single character encoding (for all SOAP responses from the system) in a servlet initialization parameter named CharacterEncoding for the PRSOAPServlet. The system uses the value of that parameter in the Content-Type of all responses.

Response headers

FieldDescription
Data typeSelect one of the following to indicate the data type that your service sends in the response. Select either string or XML Literal.
NameEnter the external name of the response header.
DescriptionEnter a text description.
Map from If the data type of a response header is XML Literal set the Map from value to XML Stream. If the data type is string, select one of the other Map from options. See the definition of the Map from field in the Response parameters section.
  • To map the SOAP header value from a property on the clipboard, select Clipboard. If you selected XML Literal as the data type, the property value must contain text that is formatted as well-formed XML.
  • To provide the literal value that is to be sent as the value of the SOAP header, select Constant. If you selected XML Literal as the data type, the property value must contain text that is formatted as well-formed XML.
  • To map the SOAP header value from an XML Stream rule, select XML Stream. This is the recommended option if you selected XML Literal as the data type.
Map from keyIn the Map from key field, specify the key of the property or rule from which to map the SOAP header value.
  • If the Map from value is Clipboard, enter a reference to the text property to use as the source of the data being mapped.
  • If the Map from value is Constant, enter the literal value of the SOAP header.
  • If the Map from value is XML Stream, enter the Stream Name (second key part) of the appropriate XML Stream rule. The system assumes that the XML Type key (second key part) of the XML Stream rule is the constant value MapFrom. The system uses the page class of this service rule as the first key part of the stream rule.

Response 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 .NET services 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 an XML parse rule or a single-value text property.

  • 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 response parameter.
DescriptionEnter a text description.
Map from Specify the source or the type of source of the value in Pega Platform. The choices that appear in the drop-down list are dependent on the data type specified in the Data type field.

For descriptions of the choices in this field, see the Map from entry in the Response headers section.

Map from keySpecify the key to locating the property or rule in the source specified in the Map from field.

For descriptions of the choices in this field, see the Map from key entry in the Response headers section.

Did you find this content helpful? YesNo

Have a question? Get answers now.

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

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