Service SOAP form — Completing the Request tab
Configure the data mapping of the incoming SOAP request from the external client application to Pega Platform on the Request tab:
- Complete the Soap action HTTP request header field section to specify a custom SOAPAction URI for the request.
- 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 SOAPAction 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.
|Specify customSOAP action URI||Select this check box if you want to include a custom SOAPAction URI in the request.|
|SOAP action URI||If you have 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.|
When executing a SOAP service, if the SOAPAction header field is empty or does not match the pattern that is specified in the service WSDL document, the first two keys of the Service SOAP rule (service package name and service class name) are derived from the path information of the SOAP endpoint URL. The third key (service method name) is derived from the element name of the first child element of the SOAP body element.
- Use the Save As form of the Service SOAP rule to ensure that the service rule method name and the name of the root element of the XML stream rule used in the SOAP body are the same.
Append the service method key to the path information of the SOAP endpoint URL. The
format of the endpoint URL will look like this:
|Name||Enter the external name of the request header.|
|Description||Enter a text description.|
If the data type of a request header is
|Map To Key||For descriptions of the Map To Key options, see the definition of the Map To Key field in the Request Parameters section.|
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
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 from an XML stream rule or a single-value text property.
|Name||Enter the external name of the parameter, to be when the WSDL file is generated. (This need not match a rule or object in Pega Platform.)|
|Description||Optional. Enter a text description of the parameter.|
Specify the destination or the type of destination for the value in
Pega Platform. The choices in the list depend on value you selected in
the Data Type field:
If more choices appear, they identify a custom function rule in a
|Map To Key||
Specify the key to locating the property or the rule in the destination
specified in the Map To field:
ArticleService SOAP rules