LinkedIn
Copied!

Table of Contents

Configuring the request for a Service SOAP rule

Version:

Only available versions of this content are shown in the dropdown

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

  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 data mapping of the incoming SOAP requests.

  4. Click the Request tab.

    1. In the SOAP action HTTP request header field section, change the default SOAPAction HTTP header provided in the WSDL file that is generated for the service by selecting Specify custom SOAP action URI.

    2. In the SOAP action URI field, enter the URI of the custom SOAPAction HTTP header that you want to include in the request.

  5. In the Request headers section, map data from the SOAP envelope header:

    1. In the Data type field, indicate the data type that your service expects in the request header:

      • String
      • XML Literal
    2. In the Name field, enter the external name of the request header.

    3. In the Description field, enter a text description.

    4. In the Map to field, 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.

    5. In the Map to key field, specify 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.

  6. In the Request parameters section, map data from the body of the SOAP request:

    1. In this Data type field, select the data type of the SOAP body parameter.

      • If you selected Document/literal as the binding type in the Style and use section on the Service tab, select XML Literal.
        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.

      For details about data types, see How to complete data mapping for SOAP and dotNet services.
    2. In the Name field, enter the external name of the parameter when the WSDL file is generated:

      This name does not need to match a rule or object in Pega Platform.
    3. Optional:

      To describe the parameter, in the Description field, enter an explanation for the parameter.

    4. In the Map to field, specify the destination or the type of destination for the value in Pega Platform.

      The choices in the list depend on the value that you selected in the Data type field.

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

    5. In the Map to key field, specify the key to locating the property or the rule in the destination that is entered in the Map to field.

      For descriptions of the choices in this field, see 5.e.
  7. Click Save.

Did you find this content helpful?

Have a question? Get answers now.

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