Connect HTTP form – Completing the Response tab

Use the Response tab to map the data from the response.

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 from the HTTP header of the message. 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 to Specify the destination or the type of destination for the value in Pega Platform:
  • 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 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 you map to Clipboard, enter the property name to which the data is mapped at run time.
  • If you map to a function rule, 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 the response data from the message.

Field Description
Description The data type of the message data is String. Enter a short description of the incoming string.
Map to Specify the destination or the type of destination for the value in Pega Platform:
  • 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 (an instance of the Rule-Parse-XML rule type).
  • 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 (an instance of the Rule-Parse-Structured rule type).

If more 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 you map to Clipboard, enter the property name to which the data is to be mapped.
  • If you map to XML ParseRule, enter the Namespace name (second key part) and the Element 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". The system uses the Applies to class of this connector rule as the first key part of the parse rule.
    Note: To maintain backward compatibility for connector 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 you map to 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 you map to 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 part of the parse rule.
  • If you map to a Rule-Utility-Function 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.