Complete the optional Response tab to specify the data read at
runtime from the incoming response message. Define how Pega Platform maps the
data from fields in the message header or parameter values in the message body to the clipboard.
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.
If you configured an alias
queue for Connect MQ rules in earlier versions of Pega Platform, after
a upgrade to Pega Platform 8.6, Connect MQ rules do not work. To
resolve this issue, create the following dynamic system settings and set the corresponding
Select a MQ message header field from the selection list:
Char Set — Character set identifier of message data.
Correl ID — Correlation ID
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
Format — Eight-byte format
Msg Type — Message type
Persistence — Message persistence
Priority — Message priority
User ID — User identifier
Enter a text description.
Select Clipboard to indicate that the system maps the
data value from the scalar property specified in the Map to
key to the clipboard.
Map to key
Enter the property name to which the data is mapped.
If the response is a Datagram (Msg Type is 8), no response data is received. Leave this
Select the external data type of the response parameter:
String, Integer, Bytes,
All Chars, All Bytes, Double,
To read the entire message buffer as 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 read the length from the message buffer.
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.
Optional. Enter a number of bytes. At runtime, the system advances the cursor
within the message buffer to this index position before it reads the data.
Optional. Used only for text (
) and binary
) data types. Enter a fixed length for the data being
If the data type is String, this is the character-length of
the text value.
If the data type is Bytes, this is the length of the
If you do not specify a data length for a text or binary value, the system reads
an integer representing the true string length from the data buffer immediately
before it reads the value.
Enter a text description of this data mapping.
Select how the system processes response 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 to key .
XML ParseRule — Indicates that the incoming data value
from the sending application is an XML document to be parsed using the data
mappings specified in a Parse XML rule.
HTML PostData — Indicates that the incoming data value
from the sending application is a stream of data posted from an HTML form that
contains property key/value pairs.
If more choices appear, they each identify a custom function rule in a
MapTo library. Review the function rule to determine what it
Map to key
Identify a destination for the Map to operation:
If you map to Clipboard, enter the property to which
data is mapped.
If you map to XML ParseRule, 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. That is, use the syntax "NamespaceName ElementName". The
system uses the Applies to class of this connector rule as the first key part of
the parse rule.
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 run time 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 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.
If you map to 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.