Some of the content described in this article is available in meshIQ Manage versions 12.1 and greater.
For a quick overview of what's new or changed, visit the meshIQ Highlights page for a version-by-version breakdown.
Jump to Section:
Version 12.x and Later
Version 11.3 and Earlier
Version 12.x and Later
This topic covers field descriptions for the following message properties:
Message properties are organized by header types such as MD (Message Descriptor), MDE (Message Descriptor Extension), DLH (Dead Letter Header), XQH (Transmission Queue), RFH2 (Rules and Formatting Header version 2), JMS (Java Message Service) and PMO (Put Message Options). The MD1 header is identical to MD, except it does not include Group-related fields.
Each header, when selected, displays its associated property sections such as General, Identity, Reports, and Groups, depending on the header type.
| Edit Message Dialog | ||
|---|---|---|
| Control | Description | States and Conditions |
| Message size (bytes) | Displays size of message without headers. | Always enabled. |
| Remove original | If checked, removes all original message headers when submitted. | |
| Preserve context | If checked, preserves message context. | |
| Contains Headers | Selects which header(s) will be available in the message. | |
| MD button | Displays Message Descriptor Properties window where user can view/edit MD header of message. | Enabled only if MD1 checkbox is not selected. |
| MD1 button | Displays Message Descriptor Properties window where user can view/edit MD1 header of message. | Enabled only if MD1 checkbox is selected. |
| MDE button | Displays Message Descriptor Extension window where user can edit MDE header of message. | Enabled only if MDE checkbox is selected. |
| DLH button | Displays Dead Letter Queue Header window where user can view/edit DLH header of message. | Enabled only if DLH checkbox is selected. |
| XQH button | Displays Transmission Queue Header window where user can view/edit XQH header of message. | Enabled only if XQH checkbox is selected. |
| RFH2 header | Edit raw RFH2 header data. | Enabled only if RFH2 checkbox is selected. |
| JMS header | Edit raw JMS header data. | Enabled only if JMS checkbox is selected. |
| PMO | Displays the Put Options window, where users can configure put message options. | Enabled only if PMO checkbox is selected. |
| File attachment | Input file name to attach to this message. | Always enabled. |
| Data | Displays message data that you can view or edit. | Select the desired format for message entry: Text, Hex, Xml, or Json. |
MD (Message Descriptor) Header
General tab
| Message Descriptor Properties – General tab | ||
| Control | Description | States and Conditions |
| Version | Select MD version from the list. | Always enabled. |
| Message Handling Settings | ||
| Message Type | Select message type from the list. | Always enabled. |
| Application Message Type | Input application message type. | Editable only if APPLICATION message type is selected from the Message Type drop-down menu. |
| Feedback | Select message feedback code from the list. | Always enabled. |
| Application Feedback Code | Input application feedback code. | Editable only if APPLICATION feedback code is selected from the Feedback drop-down menu. |
| Reply To Queue | Input name of a message queue to which the reply or report message should be sent. | Always enabled. |
| Reply To Queue Manager | Input name of the queue manager to which the reply or report message should be sent. | |
| Message Lifecycle Settings | ||
| Expiry |
Input message expiry. For messages that have a positive expiry interval, the countdown toward expiration begins as soon as the message is created. |
Always enabled. |
| Priority | Input message priority. | |
| Put Date | Provides date when message was put. | |
| Put Time | Provides time when message was put. | |
| Backout Count | Provides backout counter. | Read only. |
| Message Persistence Settings: Allows the user to set the message as Not Persistent, Persistent, or As Queue, determining how the message should be stored. | ||
| Message Metadata | ||
| Message Format |
Select message format from the list. If either the RFH2 or the JMS option is selected, then the MQHRF2 list item is automatically selected in the Message format list on the Message Descriptor Properties tab. If either option is later unselected, the Message format is reset to its previous value. |
Always enabled. |
| Encoding | Input message data encoding. | |
| CCSID | Input message coded character set identifier. | |
| Message Origin Settings | ||
| Put Application Type | Input put application type. | Always enabled. |
| Put Application Origin Data | Input application origin data. | |
| Put Application Name | Input put application name. | |
Identity tab
| Message Descriptor Properties – Identity tab | |
| Control | Description |
| Message Identifiers | |
| Message Identifier | Edit message identifier. |
| Correlation Identifier | Edit message correlation identifier. |
| Message Identity Context | |
| User Identifier | Enter user identifier. |
| Application Identity Data | Enter application identity data. |
| Accounting Token | Edit message accounting token. |
Reports tab
| Message Descriptor Properties – Reports tab | |
| Control | Description |
| Exception Handling | |
| Exception | Select an exception report message type from the list. |
| Expiration Handling | |
| Expiration | Select an expiration report message type from the list. |
| Delivery Acknowledgment | |
| Confirm On Arrival | Select confirm on arrival report message type from the list. |
| Confirm On Delivery | Select confirm on delivery report message type from the list. |
| Message ID | Specify how the Message ID of the report or reply message should be set. Options: - Generate New: Generates a new Message ID. - Pass Old: Retains the original Message ID. |
| Correlation ID | Specify how the Correlation ID of the report or reply message should be set. Options: - Copy Message ID: Sets the Correlation ID equal to the Message ID. - Pass Old: Retains the original Correlation ID. |
| Disposition Options | Specify the disposition action when a message cannot be delivered to its destination queue. Options: - DLQ: Send to Dead Letter Queue. - Discard: Discard the message. |
Groups tab
| Message Descriptor Properties – Groups tab | |
| Control | Description |
| Message Mapping | |
| Group Identifier | Edit group identifier. |
| Message Sequence Number | Input sequence number of the logical message within the group. |
| Message Flags | Input message flags. |
| Data Offset | Input offset of data in physical message from the start of the logical message. |
| Original Length | Input length of original message. |
MDE (Message Descriptor Extension) Header
| Message Descriptor Extension Properties | |
|---|---|
| Control | Description |
| Message Mapping | |
| Group Identifier | Edit group identifier. |
| Message Sequence Number | Input sequence number of logical message within group. |
| Message Flags | Input flags that specify attributes of the message. |
| Data Offset | Input offset of data in physical message from the start of the logical message. |
| Original Length | Input length of original message. |
DLH (Dead Letter Header)
| Dead Letter Queue Header | |
| Control | Description |
| Reason Options | |
| Reason | Input reason code. |
| Destination Options | |
| Destination Queue | Input name of destination queue. |
| Destination Queue manager | Input name of destination queue manager. |
| Message Metadata Options | |
| Message Format | Select message format from the list. |
| Encoding | Specify message data encoding. |
| CCSID | Specify message coded character set identifier. |
| Message Put Options | |
| Application Type | Input put application type. |
| Application Name | Input put application name. |
| Put Date | Provides date when message was put. |
| Put Time | Provides time when message was put. |
XQH (Transmission Queue) Header
Destination tab
| Transmission Queue Header – Destination tab | ||
|---|---|---|
| Control | Description | States and Conditions |
| Queue Name | The name of the remote queue. |
Always enabled.
|
| Queue Manager Name | The name of the remote queue manager. | |
Embedded MD- General tab
| Transmission Queue Header – Embedded MD- General tab | ||
|---|---|---|
| Control | Description | States and Conditions |
| MD Version | Select the MD version from the list. | Always enabled. |
| Message Handling Settings | ||
| Message Type | Select message type from the list. | Always enabled. |
| Application Message Type | Input application message type. | Editable only if APPLICATION message type is selected in Message Type combo box. |
| Feedback | Select message feedback code from the list. | Always enabled. |
| Application Feedback Code | Input application feedback code. | Editable only if APPLICATION feedback code is selected in Feedback combo box. |
| Reply To Queue | Input name of a message queue to which the reply or report message should be sent. |
Always enabled. |
| Reply To Queue Manager | Input name of the queue manager to which the reply or report message should be sent. | |
| Message Lifecycle Settings | ||
| Expiry (1/10sec) |
Input message expiry. For messages that have a positive expiry interval, the countdown toward expiration begins as soon as the message is created. |
Always enabled. |
| Priority | Input message priority. | |
| Put Date | Input date when message was put. | |
| Put Time | Input time when message was put. | |
| Backout Count | Provides backout counter. | Read only. |
| Message Persistence Settings: Allows the user to set the message as Not Persistent, Persistent, or As Queue, determining how the message should be stored. | ||
| Message Metadata | ||
| Message Format | Select message format from the list. | Always enabled. |
| Encoding | Input message data encoding. | |
| CCSID | Input message coded character set identifier. | |
| Message Origin Settings | ||
| Put Application Type | Input put application type. | Always enabled. |
| Application Origin Data | Input application origin data. | |
| Put Application Name | Input put application name. | |
Embedded MD- Identity tab
| Transmission Queue Header – Embedded MD- Identity tab | |
| Control | Description |
| Message Identifiers | |
| Message Identifier | Edit message identifier. |
| Correlation Identifier | Edit message correlation identifier. |
| Message Identity Context | |
| User Identifier | Enter user identifier. |
| Application Identity Data | Enter application identity data. |
| Accounting Token | Edit message accounting token. |
Embedded MD – Reports tab
| Transmission Queue Header - Embedded MD- Reports tab | |
| Control | Description |
| Exception Handling | |
| Exception | Select an exception report message type from the list. |
| Expiration Handling | |
| Expiration | Select an expiration report message type from the list. |
| Delivery Acknowledgement | |
| Confirm On Arrival | Select confirm-on-arrival report message type from the list. |
| Confirm On Delivery | Select confirm-on-delivery report message type from the list. |
| Message ID |
Specify how the Message ID of the report message (or the reply message) is to be set. - Generate New: Generates a new Message ID. |
| Correlation ID |
Specify how the Correlation ID of the report message (or the reply message) is to be set. - Copy Message ID: Sets the Correlation ID equal to the Message ID. |
| Disposition Options |
Specify message disposition type when a message cannot be delivered to its destination queue. - DLQ: Send to Dead Letter Queue. |
PMO (Put Message Options)
| Message Put Options | |
|---|---|
| Control | Description |
| Message Transaction Options | |
| Syncpoint | Operate within the normal unit-of-work protocols. |
| No Syncpoint | Operate outside the normal unit-of-work protocols. |
| Identifier Options | |
| New Message ID | Used to identify a new message identifier. |
| New Correlation ID | Used to identify a new correlation identifier. |
| Message Context Options | |
| No Context | Context field in MQMD are set to blanks, nulls, and zeros. |
| Default Context | Message will have default context associated with it. |
| Pass Identity Context | Passes identity context information from the original message to a new message. |
| Pass All Context | Passes identity and origin context information from the original message to a new message. |
| Set Identity Context | Sets identity context information from the original message to a new message. |
| Set All Context | Sets identity and origin context information from the original message to a new message. |
| Additional Put Options | |
| Alternate User Authority | User identifier to validate authority to messages on the queue. |
| Fail if Quiescing | Forces MQPUT or MQPUT1 call to fail if queue manager in quiescing state. |
| Logical Order | Puts groups and segment information in logical order rather than physical order. |
________________________________________________________________________________________________________________
Version 11.3 and Earlier
This topic covers field descriptions for the following message properties tabs:
- Vertical tabs on the left side of the dialog: General, MD (Message Descriptor) properties), MDE (Message Descriptor Extension) properties, DLH (Dead Letter Header) properties, XQH (Transmission Queue) properties, and PMO (Put Message Options). (The MD1 vertical tab is identical to the MD tab, but without a Group tab.)
- Horizontal tabs on the Message Descriptor Properties dialog: General (see MD properties), Identity, Origin, Reports, and Group.
Vertical Tabs
The vertical tabs allow you to add and edit message headers.
General tab
| Edit Message – General tab | ||
|---|---|---|
| Control | Description | States and Conditions |
| Message size (bytes) | Displays size of message without headers. | Always enabled. |
| Remove original | If checked, removes all original message headers when submitted. | |
| Preserve context | If checked, preserves message context. | |
| Contains headers | Selects which header(s) will be available in the message. | |
| MD button | Displays Message Descriptor Properties window where user can view/edit MD header of message. | Enabled only if MD1 checkbox is not selected. |
| MD1 button | Displays Message Descriptor Properties window where user can view/edit MD1 header of message. | Enabled only if MD1 checkbox is selected. |
| MDE button | Displays Message Descriptor Extension window where user can edit MDE header of message. | Enabled only if MDE checkbox is selected. |
| DLH button | Displays Dead Letter Queue Header window where user can view/edit DLH header of message. | Enabled only if DLH checkbox is selected. |
| XQH button | Displays Transmission Queue Header window where user can view/edit XQH header of message. | Enabled only if XQH checkbox is selected. |
| File attachment | Input file name to attach to this message. | Always enabled. |
| Message Criteria | Select from the Criteria list to apply Message Criteria. By default, the Message Criteria from User Settings or Global Settings is selected. You can also select other Message Criteria records. | |
| RFH2 headers | Edit raw RFH2 or JMS header data. | Enabled only if RFH2 checkbox is selected. (Also allows you to edit messages that were created using the JMS checkbox.) |
| Data button | Displays Message Data window where user can view/edit message data. | Always enabled. |
MD (Message Descriptor) Header-General tab
| Message Descriptor Properties – General | ||
| Control | Description | States and Conditions |
| Version | Select MD version from the list. | Always enabled. |
| Application message type | Input application message type. | Editable only if APPLICATION message type is selected from the Message Type drop-down menu. |
| Message type | Select message type from the list. | Always enabled. |
| Application feedback code | Input application feedback code. | Editable only if APPLICATION feedback code is selected from the Feedback drop-down menu. |
| Message format |
Select message format from the list. If either the RFH2 or the JMS option is selected on the General tab, then the MQHRF2 list item is automatically selected in the Message format list on the Message Descriptor Properties tab. If either option is later unselected, the Message format is reset to its previous value. |
Always enabled. |
| Encoding | Provides message data encoding. | Read only. |
| Feedback | Select message feedback code from the list. | Always enabled. |
| CCSID | Provides message coded character set identifier. | Read only. |
| Expiry |
Input message expiry. For messages that have a positive expiry interval, the countdown toward expiration begins as soon as the message is created. |
Always enabled. |
| Priority | Input message priority. | |
| Backout count | Provides backout counter. | Read only. |
| Persistent | Set message persistence. | Always enabled. |
| Put date | Provides date when message was put. | Always enabled. |
| Put time | Provides time when message was put. | |
| Reply to queue | Input name of a message queue to which the reply or report message should be sent. | |
| Reply to QM | Input name of the queue manager to which the reply or report message should be sent. | |
MD (Message Descriptor) Header Horizontal tabs
General tab
See MD (Message Descriptor) Header.
Identity tab
| Message Descriptor Properties – Identity | ||
| Control | Description | States and Conditions |
| Message identifier | Edit message identifier. | Always enabled. |
| Correlation identifier | Edit message correlation identifier. | |
| User identifier | Enter user identifier. | |
| Application identity data | Enter application identity data. | |
| Accounting token | Edit message accounting token. | |
Origin tab
| Message Descriptor Properties – Origin | ||
| Control | Description | States and Conditions |
| Put application type | Input put application type. | Always enabled. |
| Application origin data | Input application origin data. | |
| Application name | Input put application name. | |
Reports tab
| Message Descriptor Properties – Reports | ||
| Control | Description | States and Conditions |
| Exception | Select an exception report message type from the list. | Always enabled. |
| Expiration | Select an expiration report message type from the list. | |
| Confirm on arrival | Select confirm on arrival report message type from the list. | |
| Confirm on delivery | Select confirm on delivery report message type from the list. | |
| Message ID | Specify how the Message ID of the report message (or the reply message) is to be set. | |
| Correlation ID | Specify how the Correlation ID of the report message (or the reply message) is to be set. | |
| Disposition options | Specify message disposition type when a message cannot be delivered to its destination queue. | |
Group tab
| Message Descriptor Properties – Group | ||
| Control | Description | States and Conditions |
| Group identifier | Edit group identifier. | Always enabled. |
| Message sequence number | Input sequence number of the logical message within the group. | |
| Message flags | Input message flags. | |
| Data offset | Input offset of data in physical message from the start of the logical message. | |
| Original length | Input length of original message. | |
MDE (Message Descriptor Extension) Header
| Message Descriptor Extension Properties | |
|---|---|
| Control | Description |
| Version | Select version from the list. |
| Structure length | Specify structure length. |
| Encoding | Specify message data encoding. |
| Coded charset id | Specify message coded character set identifier. |
| Format | Select message format from the list. |
| Flags | Specify a value for flags. |
| Group id | Edit group identifier. |
| Message sequence number | Input sequence number of logical message within group. |
| Offset | Input offset of data in physical message from the start of the logical message. |
| Message flags | Input flags that specify attributes of the message. |
| Original length | Input length of original message. |
DLH (Dead Letter Header)
| Dead Letter Queue Header | |
| Control | Description |
| Version | Select version from the list. |
| Reason | Input reason code. |
| Dest q name | Input name of destination queue. |
| Dest q manager name | Input name of destination queue manager. |
| Encoding | Specify message data encoding. |
| Coded chartset id | Specify message coded character set identifier. |
| Format | Select message format from the list. |
| Put appl type | Input put application type. |
| Put appl name | Input put application name. |
| Put date | Provides date when message was put. |
| Put time | Provides time when message was put. |
XQH (Transmission Queue) Header – General
| Transmission Queue Header – General | ||
|---|---|---|
| Control | Description | States and Conditions |
| Remote q name | The name of the remote queue. | Always enabled. |
| Remote q manager name | The name of the remote queue manager. | |
| MD Version | Select the MD version from the list. | |
| Application message type | Input application message type. | Editable only if APPLICATION message type is selected in Message Type combo box. |
| Message type | Select message type from the list. | Always enabled. |
| Application feedback code | Input application feedback code. | Editable only if APPLICATION feedback code is selected in Feedback combo box. |
| Message format | Select message format from the list. | Always enabled. |
| Encoding | Provides message data encoding. | Read only. |
| Feedback | Select message feedback code from the list. | Always enabled. |
| CCSID | Provides message coded character set identifier. | Read only. |
| Expiry (1/10sec) |
Input message expiry. For messages that have a positive expiry interval, the countdown toward expiration begins as soon as the message is created. |
Always enabled. |
| Priority | Input message priority. | Always enabled. |
| Backout count | Provides backout counter. | Read only. |
| Persistent | Select message persistence. |
Always enabled.
|
| Put date | Input date when message was put. | |
| Put time | Input time when message was put. | |
| Reply to queue | Input name of a message queue to which the reply or report message should be sent. | |
| Reply to QM | Input name of the queue manager to which the reply or report message should be sent. | |
XQH (Transmission Queue) Header – Identity
| Transmission Queue Header – Identity | ||
| Control | Description | States and Conditions |
| Message identifier | Edit message identifier. | Always enabled. |
| Correlation identifier | Edit message correlation identifier. | |
| User identifier | Enter user identifier. | |
| Application identity data | Enter application identity data. | |
| Accounting token | Edit message accounting token. | |
XQH (Transmission Queue) Header – Origin
| Transmission Queue Header – Origin | ||
| Control | Description | States and Conditions |
| Put application type | Input put application type. | Always enabled. |
| Application origin data | Input application origin data. | |
| Put application name | Input put application name. | |
XQH (Transmission Queue) Header – Report
Additional options for XQH messages are available to configure.
| Transmission Queue Header - Report | ||
| Control | Description | States and Conditions |
| Exception | Select an exception report message type from the list. | Always enabled. |
| Expiration | Select an expiration report message type from the list. | |
| Confirm on arrival | Select confirm-on-arrival report message type from the list. | |
| Confirm on delivery | Select confirm-on-delivery report message type from the list. | |
| Message ID | Specify how the Message ID of the report message (or the reply message) is to be set. | |
| Correlation ID | Specify how the Correlation ID of the report message (or the reply message) is to be set. | |
| Disposition options | Specify message disposition type when a message cannot be delivered to its destination queue. | |
PMO (Put Message Options)
| Message Put Options | ||
|---|---|---|
| Control | Description | States and Conditions |
| No Put Options | Specifies that no options are used. | Disabled if another entry is selected. |
| Syncpoint | Operate within the normal unit-of-work protocols. | Enabled only when No Put Options is NOT selected. |
| No Syncpoint | Operate outside the normal unit-of-work protocols. | |
| New Message ID | Used to identify a new message identifier. | |
| New Correlation ID | Used to identify a new correlation identifier. | |
| No Context | Context field in MQMD are set to blanks, nulls, and zeros. | |
| Default Context | Message will have default context associated with it. | |
| Pass Identity Context | Passes identity context information from the original message to a new message. | |
| Pass All Context | Passes identity and origin context information from the original message to a new message. | |
| Set Identity Context | Sets identity context information from the original message to a new message. | |
| Set All Context | Sets identity and origin context information from the original message to a new message. | Enabled only when No Put Options is NOT selected. |
| AlternateUserAuthority | User identifier to validate authority to messages on the queue. | |
| Fail if Quiescing | Forces MQPUT or MQPUT1 call to fail if queue manager in quiescing state. | |
| Logical Order | Puts groups and segment information in logical order rather than physical order. | |