Skip to main content


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

Configuring the request for a SOAP connector

Updated on April 6, 2022

Use the Request tab of a SOAP connector to configure the data mapping for the outgoing SOAP message.

The data types of the outgoing parameters can be any of the primitive data types that are specified in the W3C XML Schema standard. If you used the Create SOAP Integration wizard to generate the connector rules, and the WSDL file that you identified defines its own complex types, the data type for a parameter is XML Literal. XML Literal indicates that the outgoing parameter contains text that is formatted as XML.

  1. In the navigation pane of Dev Studio, click Records.
  2. Expand the Integration-Connectors category, and then click Connect SOAP.
  3. In the list of Connect SOAP instances, select the instance for which you want to configure the request.
  4. Click the Request tab.
  5. In the Request headers section, specify the data needed for the SOAP envelope header.
    Use this section to map values for SOAP headers. The value of a SOAP header must be well-formed, namespace-qualified XML, typically generated by an XML Stream rule.
    1. In the Name field, enter the external name of the SOAP request header.
    2. In the Description field, enter a text description for the header.
    3. In the Map from field, choose one of the following options:
      • If the Applies To class of the XML rule that provides the value for this header is the same as the Applies To class of the connector rule, select XML Stream.
      • To manually enter the XML content to be included in the header, select Constant.
      • If the Applies To class of the XML rule is different from that of the connector rule, select Clipboard.
    4. In the Map from key field, configure one the following options:
      • If you map from XML Stream, enter the Stream Name (the second key part) of the XML Stream rule. The system uses the first key part (the Applies To class) to find the XML rule.
      • If you map from Constant, enter the well-formed XML to be included in the request header.
      • If you map from Clipboard, select the property that holds the XML text. You can use a linked property reference to identify the property containing the value.
  6. In the Request parameters section, specify the data for the body of the SOAP message.
    1. In the Data type field, select the data type of the external value that you are mapping.
      For details about SOAP data types, see .
      • If the SOAP operation style is document-literal or RPC literal, select the XML Literal data type.
      • If the SOAP operation style is RPC encoded, select any other primitive data type.
    2. In the Name field, enter the external name of the request parameter.
    3. In the Description field, enter a text description for this parameter.
    4. In the Map from field, specify the source or the type of source of the value in Pega Platform. The choices in the selection list depend on the data type specified in the Data type field:
      • Clipboard – The source is a property or page on the clipboard.
      • Constant – The source is a fixed value that does not change.
      • XML Stream – The source is a stream of XML data formatted by an XML Stream rule.

      If you see more choices, each identifies a custom function rule in a MapFrom library. Review the function rule to determine what it does.

    5. In the Map from key field, specify the key to locating the property or rule in the source specified in the Map from field:
      • If you map from the Clipboard, enter a reference to a single value or page property. Click the Open icon to review the property.
      • If you map from Constant, enter a literal text string. To include blank spaces in your text string, surround the string with double quotes. The value you specify should conform to the format of the data type that you select for the parameter.
      • If you map from XML Stream, enter either the Stream Name, (second key part), of the appropriate XML Stream rule, or a page name and Stream Name using the syntax PageName.StreamName.

        The page must be on the clipboard for rule resolution to find the rule. If you specify the stream name only, the system uses the Applies To key part of this connector rule as the first key part of the XML rule. In all cases, the XML stream rule you use must have MapFrom as the value of the XML type key part.

      • If you map from a Rule-Utility-Function from a MapFrom library, either select the property that holds the value to be processed by the function or leave this field blank, as appropriate for the function.
  7. Click Save.
What to do next: Complete the Response tab. For more information, see Configuring the response for a SOAP connector.
  • Previous topic Configuring the connection for a Connect SOAP rule
  • Next topic Configuring the response for a SOAP connector

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