Skip to main content


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

Configuring the response for a Service SOAP rule

Updated on November 23, 2022

Configure the data mapping for the reply message on the Response tab of the Service SOAP rule.

  1. In the navigation pane of Dev Studio, click Records.
  2. Expand the Integration-Services category, and then click Service SOAP.
  3. In the list of Service SOAP instances, select the instance for which you want to configure the Response tab.
  4. Click the Response tab.
  5. In the Response headers section, map data to the outgoing SOAP envelope header:
    1. In the Data type field, select one of the following to indicate the data type that your service sends in the response:
      • String
      • XML Literal
    2. In the Name field, enter the external name of the response header.
    3. In the Description field, enter a text description.
    4. In the Map from field, specify the source of the SOAP header value.
      • 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.
    5. In 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.
  6. In the Response parameters section, map the data for the body of the SOAP message:
    1. In the Data type field, select the data type of the SOAP body parameter.
      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.
    2. In the Name field, enter the external name of the response parameter.
    3. In the Description field, enter a text description.
    4. In the Map from field, specify the source or the type of source of the value in Pega Platform.
      The choices in the list depend on the value you selected in the Data type field.

      For descriptions of the choices in this field, see 5.d.

    5. In the Map from key field, specify the key to locating the property or rule in the source entered in the Map from field.
      For descriptions of the choices in this field, see 5.e.
  7. Click Save.

Have a question? Get answers now.

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

Did you find this content helpful?

Want to help us improve this content?

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