Service HTTP form - Completing the Request tab

Complete the Request tab to map the data from the incoming request to properties on the clipboard. If the incoming data includes query strings (name/value pairs appended to the URL), they are mapped to the parameter page of the service activity.

Important: Service HTTP rules are no longer being actively developed. To avoid upgrade issues when these rules are deprecated, use Service REST rules instead. For more information about Service REST rules, see Service REST rules.

Header Fields

Use the fields in this section to map data from the HTTP header of the message. If the request contains an HTTP authentication header or a cookie header that contains a PegaRULES cookie to maintain state between service requests, you do not need to map these values. The Pega Platform processes values for username, password, and PegaRULES cookies automatically.

The data type of all header fields is String.

Field	Description
Name	Enter the external name of the header field.
Description	Enter a short description of the header field.
Map To	Specify the destination or the type of destination for the value in PRPC: `Clipboard` — Map to the page name or property on the clipboard specified by the Map To Key field. If additional choices appear, they identify a custom function rule ( Rule-Utility-Function rule type) in a `MapTo` library. Review the function rule to determine what it does.
Map To Key	Specify the key to locating the property or the rule in the destination specified in the Map To field: If the Map To value is `Clipboard`, enter the property name to which the data be mapped at runtime. If the Map To value is a Rule-Utility-Function from a `MapTo` library, either select a property to hold the results of the function or leave this field blank, as appropriate for the function.

Message Data

Use the fields in this section to map data from the body of the message (if any). The data type of the message is String.

Field Description

Description Enter a short description of the incoming string.

Field	Description
Description	Enter a short description of the incoming string.
Map To	Specify the destination or the type of destination for the value in PRPC: `Clipboard` — Map to the page name or property on the clipboard specified by the Map To Key field. `XML ParseRule` — The incoming data is a stream of XML that must be parsed using the actions defined in a parse XML rule. `Delimited ParseRule` — The incoming data is in a delimited format that must be processed by a delimited parse rule (an instance of Rule-Parse-Delimited ). `Structured Parserule` — The incoming data has a fixed format with fixed length fields and must be processed by a structured parse rule. `HTML PostData` — The incoming data value from the sending application is a stream of data from an HTML form that contains property key/value pairs. If additional choices appear, they identify a custom function rule in a `MapTo` library. Review the function rule to determine what it does.
Map To Key	Specify the key to locating the property or the rule in the destination specified in the Map To field: If the Map To value is `Clipboard`, enter the property name to which the data is mapped at runtime. If the Map To value is `XML Parse Rule`, enter the Namespace name (second key part) and the Element Name name — third key part — of the appropriate Parse XML rule. Separate the Namespace from the Element Name with a space using the syntax "NamespaceName ElementName" and not "NamespaceName.ElementName." The system uses the page class of this service rule as the first key part of the parse rule. To maintain backward compatibility for service rules created in releases before PRPC Version 5.2, you can specify a data mapping with only a Namespace value. In that case, the system at runtime determines the Element Name key from the root element of the incoming XML document. However, this mapping works only if the Parser Type of the Parse XML rule is set to `DOM` and validation is not enabled. As a best practice, specify both the Namespace Name and the Element Name of the rule. If the Map To value is `Delimited ParseRule`, enter the Namespace and Record Type names (second and third key parts) of the appropriate delimited parse rule. The system uses the Applies To class of this service rule as the first key part of the parse rule. If the Map To value is `Structured ParseRule`, enter the Record Type (third key part) of a structured parse rule. The system uses the Applies To class of this service rule as the first key to the parse rule. If the Map To value is a Rule-Utility-Function from a `MapTo` library, select or enter the property that holds the results of the custom function at runtime. If the Map To value is `HTML PostData`, leave this field blank. The name/value pairs in the string will be mapped to the parameter page of the service activity rather than the primary page.

Map To

Specify the destination or the type of destination for the value in PRPC:

Clipboard — Map to the page name or property on the clipboard specified by the Map To Key field.
XML ParseRule — The incoming data is a stream of XML that must be parsed using the actions defined in a parse XML rule.
Delimited ParseRule — The incoming data is in a delimited format that must be processed by a delimited parse rule (an instance of Rule-Parse-Delimited ).
Structured Parserule — The incoming data has a fixed format with fixed length fields and must be processed by a structured parse rule.
HTML PostData — The incoming data value from the sending application is a stream of data from an HTML form that contains property key/value pairs.

If additional choices appear, they identify a custom function rule in a MapTo library. Review the function rule to determine what it does.

Map To Key

Specify the key to locating the property or the rule in the destination specified in the Map To field:

If the Map To value is Clipboard, enter the property name to which the data is mapped at runtime.
If the Map To value is XML Parse Rule, enter the Namespace name (second key part) and the Element Name name — third key part — of the appropriate Parse XML rule. Separate the Namespace from the Element Name with a space using the syntax "NamespaceName ElementName" and not "NamespaceName.ElementName." The system uses the page class of this service rule as the first key part of the parse rule.
To maintain backward compatibility for service rules created in releases before PRPC Version 5.2, you can specify a data mapping with only a Namespace value. In that case, the system at runtime determines the Element Name key from the root element of the incoming XML document. However, this mapping works only if the Parser Type of the Parse XML rule is set to DOM and validation is not enabled. As a best practice, specify both the Namespace Name and the Element Name of the rule.
If the Map To value is Delimited ParseRule, enter the Namespace and Record Type names (second and third key parts) of the appropriate delimited parse rule. The system uses the Applies To class of this service rule as the first key part of the parse rule.
If the Map To value is Structured ParseRule, enter the Record Type (third key part) of a structured parse rule. The system uses the Applies To class of this service rule as the first key to the parse rule.
If the Map To value is a Rule-Utility-Function from a MapTo library, select or enter the property that holds the results of the custom function at runtime.
If the Map To value is HTML PostData, leave this field blank. The name/value pairs in the string will be mapped to the parameter page of the service activity rather than the primary page.