Connect HTTP form – Completing the Request tab

Use the Request tab to map data for the request message.

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

Header fields

Use the fields in this section to map data for HTTP header fields. The data type of a header field is String.

Field Description
Name Enter the external name of the header field.
Description Enter a short description of the header field.
Map from Specify the source or the type of source of the value:
  • Clipboard — Map from the page name or property on the clipboard specified by the Map from key field.
  • Constant — The data is a fixed value that does not change.

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

Map from key Specify the key to locating the property or rule in the source specified in the Map from field.
  • If you map from Clipboard, enter the property name from which the data is mapped at run time. You can also use a linked property reference to identify the property containing the value.
  • If you map from Constant, enter the value of the constant surrounded by double quotation marks.
  • 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 at run time or leave this field blank, as appropriate for the function.

Query string parameters

When the HTTP method specified on the Service tab is GET, use the fields in this section to specify name/value pairs to append as a query string to the URL of the target system.

Field Description
Name Enter the name to use for the parameter. The data type of a query string parameter is String.
Description Enter a short description of the parameter.
Map from Specify the source or the type of source of the value in Pega Platform. For descriptions of the Map from options, see the definition of the Map from field in the Header fields section.
Map from key Specify the key to locating the property or rule in the source specified in the Map from field. For descriptions of the Map from key options, see the definition of the Map from key field in the Header fields section.

Message data

When the HTTP method field on the Service tab is set to POST, use the fields in this section to specify the data to include in the POST message.

Field Description
Description The data type of the message data is String. Enter a short description of the string in the response.
Map from Specify the source or the type of source of the value:
  • Clipboard — The source is a property or a page on the clipboard.
  • Constant — The source is a fixed value.
  • XML Stream — The source is a stream of XML data formatted by an XML Stream rule.
  • HTML Stream — The source is a stream of HTML data formatted by an HTML rule.

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

Map from key Specify the key to locating the property or rule in the source specified in the Map from field:
  • If you map from Clipboard, enter the reference to the property from which the data is mapped at run time. You can also use a linked property reference to identify the property containing the value.
  • If you map from Constant, enter a literal text string. To include blank spaces in your text string, surround the string with double quotation marks.
  • If you map from XML Stream, enter either the Stream name (second key) 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 when the connector rule runs for rule resolution to find the rule. If you specify the stream name only, the system uses the Applies to class of this connector rule as the first key part of the XML Stream rule.
  • If you map from HTML Stream, enter either the Stream name (second key) of the appropriate HTML rule or a page name and stream name using the syntaxPageName.StreamName. The page must be on the clipboard when the service rule runs for rule resolution to find the rule. If you specify the stream name only, the system uses the Applies to class of this connector rule as the first key part of the HTML rule.
  • If you map from a Rule-Utility-Function from a MapFrom library, enter or select the property that holds the value to pass to the custom function at run time.