Service MQ form - Completing the Request tab

Use the Request tab to specify the data read from the incoming request message. Data is mapped to the clipboard from fields of the message header or parameter values in the message body.

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

Header

Field Description
Header Fields  
Field Name Select which MQ Message Header field (from the MDMQ structure) you want to capture. Select:
  • Accounting Token — A Java byte array, converted to a Base64-encoded Java String value internally
  • App ID Data
  • Appl Origin Data
  • Backout Count
  • 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 (a Java byte array, converted to a Base64-encoded Java String value internally)
  • 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 Type — Message type
  • Msg ID — Message ID (a Java byte array, converted to a Base64-encoded Java String value internally)
  • 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
  • Persistence
  • Priority
  • Put Appl Type
  • Put Appl Name
  • Put Date-Time
  • Reply to Q
  • Reply to QMgr
  • Report
  • User ID
  • Version
Description Enter a text description of this field.
Map To Select a mapping type. Select Clipboard to map this value to a Single Value property on the clipboard.

See the description of the Map To field below for other choices.
Map To Key Enter the target property name to which the data is mapped. Use the param keyword to place the data on the parameter page of the activity.

Message Data

Field Description
Message Data  
Data Type Enter the external data type of the request parameter: String, Integer, Bytes, All Chars, All Bytes, Double, or Boolean.

If you choose String, complete the Length field.

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.

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 an offset number to determine where the system positions the internal cursor before reading the data to the buffer.
Length Used only for text ( String ) and binary (Bytes ) data types. Enter a fixed length for the data being read:
  • If the data type is String, this is the character-length of the text value being read.
  • If the data type is Bytes, this is the length of the byte-array being read.

The system truncates data values longer than the specified length. It pads data values shorter than the specified length with white space (for text values), or zeros (for binary values).

If you do not specify a data length for a text or binary value, the system expects and reads an integer representing the actual length from the data buffer immediately before the data value is read.
Description Enter a text description.
Map To Select how the system creates the request parameter values:
  • Clipboard — The system maps the data value from the scalar property specified by the Map From Key. This is the default value.
  • Parse Structured — The system applies a Parse Structured rule. This option is available for Bytes and All Bytes in the Data Types field.
  • Requestor ID — The system reconnects an existing requestor using the requestor ID value returned in the response message buffer of a previous service request.
  • Username — The system authenticates the information using the provided user name value.
  • Password — The system authenticates the information using the provided password value.
  • Parse XMLRule — To indicate that the incoming data value is a stream of XML that can be parsed using the data mappings specified in a Parse XML rule.
  • HTML PostData — To indicate that the incoming data value is a stream of data posted from an HTML form that contains property key/value pairs in POST format.

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 Provide a target to complete the value you selected for the Map To field:
  • If the Map To value is Clipboard, enter the property name into which the data is to be mapped.
  • For Requestor ID, Username, HTML PostData, or Password, leave this field blank.
  • 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 ElementName with a space. That is, use 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.
  • Note: 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 determines the Element Name key at runtime 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 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 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.