Connect MQ form – Completing the Request tab

Use the Request tab to specify the data that is sent as part of the outgoing request message. Pega Platform maps the data from the clipboard to fields of the message header and to parameter values in the message body.

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

Request Headers

Field Description
Field Optional. Select an MQ message header field from the selection list. Select:
  • Accounting Token — converted to a Java byte array, from the internal Base64-encoded Java String value
  • App ID — Application data relating to identity
  • Char Set — Character set identifier of message data. (To specify the UTF-8 character set, set this CCSID value to 1208. The default is 819, for ISO-8859-1)
  • Correl ID — Correlation ID, converted to a Java byte array, from the internal Base64-encoded Java String value
  • Encoding — Numeric encoding of message data
  • Expiry — The period of time, measured in milliseconds, during which a message is eligible to be successfully retrieved before it is discarded
  • Feedback
  • Format — Eight-byte format
  • Msg ID — Message Identifier (converted to a Java byte array, from the internal Base-64 Java String value)
  • Msg Type — Message type
  • Persistence — Message persistence
  • Priority — Message priority
  • User ID — User identifier
  • Group ID — Message group identifier
  • Message Sequence Number — Number in a sequence of a message in a group
  • Message Flags — Flags controlling the segmentation and status of a message
Description Enter a text description.
Map from Select how the system creates request header values:
  • Clipboard — The system maps the data value to the scalar property specified by the Map from key field.
  • Constant — The system sends a fixed value.

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

Map from key
  • If you map from Clipboard, enter a property reference that is the source of the data.
  • If you map from Constant, enter a literal text string in double quotation marks. You can include spaces in the text string.

Request Data

Indicate how Pega Platform is to assemble property values and literal values to form the request. Order in this array is significant.

Note: To reorder the rows of this array, hold the mouse pointer over a number. Click and drag to another row. To duplicate or move a row, hold the mouse pointer over a number. Or, right-click to access a menu with Cut, Copy, and Insert options.
Field Description
Data type Select the external data type of the parameter value: String, Integer, Bytes, All Chars, All Bytes, Double, or Boolean.

If you choose String, complete the Length field.

To fill the entire message buffer with one variable-length text or binary data, specify All Chars or All Bytes in the first row of this array, and leave the Length field blank. Leave other rows blank. In this case, the system does not write the length into the message buffer.

Note: As a best practice, use All Chars or All Bytes. Do not use String because it prepends an integer of the length of the string to the data.
Offset Optional. Enter a number of bytes. At runtime, the system moves the cursor within the message buffer to this index position before it writes the data.
Length Optional. Complete this field only for String and Bytes data values. Enter a fixed length for the data being written. If the Data Type is String, this is the character-length of the text value being written. If the data type is Bytes, this is the length of the byte-array being written.

At runtime, the system examines the length of the data value. If the data value is longer than the specified length, its value is truncated. If the data value is shorter, the value is padded with white space (for String values), or zeros (for Bytes values).

If you don't specify a data length, the system writes an integer representing the true string length into the data buffer immediately before it writes the data value.
Description Enter a text description of this row.
Map from Select how the system creates request parameter values. The choice you make for this field depends on what you select for Data Type :
  • Clipboard — The system maps the data value to the property specified by the Map from key field.
  • Parse Structured — The system applies a Parse Structured rule. This option is available for Bytes and All Bytes in the Data type field.
  • Constant — The system sends a fixed value.
  • XML Stream — The system composes a stream of XML text, formatted by an XML Stream rule.
  • HTML Stream — The system composes a stream of HTML text, formatted by an HTML rule.

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

Map from key Enter additional details that complete the Map From mapping:
  • If you map from Clipboard, enter a property reference that is the source of the data.
  • If you map from Constant, enter a literal text string in double quotation marks. You can include spaces in the text string.
  • If you map from XML Stream, enter a Stream Name key part of the XML Stream rule that is to generate the data. The system uses the Applies To class of this Connect MQ rule as the Applies To class of the XML Stream rule.
  • If you map from HTML Stream, enter the Stream Name of the HTML rule that is to generate the data stream. The system uses the Applies To class of this Connect MQ rule as the Applies To class of the HTML rule.
  • 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.