Variables supplied by MainView AutoOPERATOR for all IBM MQ messages
Table 1 describes the most commonly used variables that are available to a Rule or when an EXEC is scheduled from a IBM MQ Rule or a combination of both. For other structures not listed here, for example DLH (Dead Letter Header) and others, please refer to Diagnosing MainView AutoOPERATOR for MQ errors. Variables created from structures begin with 'IMFQ_', followed by the IBM MQ structure, followed by the field name within the IBM MQ structure, with each node delimited by an underscore.
For definitions of field names and constants used in this table, which is derived from IBM MQ structure field names, see the IBM manual MQ Application Programming Reference.
Note
These variables follow the IBM conventions where possible. Therefore, the variables lists in this table may not be complete because IBM may have added new constants since the printing of this manual. For a more complete list, see the IBM manual IBM MQ Application Programming Reference.
Table 1. Variables that are supplied by MainView AutoOPERATOR for all IBM MQ messages
Variable name | Description |
|---|---|
IMFOQMGR | Subsystem ID of queue manager |
IMFQCPF | z/OS console command prefix for this MQ queue manager |
IMFQRMT | Origin of message (Y: message is from a remote queue, N: message is not from a remote queue) |
IMFQ_STRUCTURES | Contains a blank-delimited list of the IBM MQ structures contained in the message For example, in the case of a Dead Letter message, the contents would contain at least: MD DLH |
IMFQ_OFFSETS | Contains blank-delimited list of offsets to structures and application data from the front of the message buffer For example: if the message buffer contains a Dead Letter Header (DLH) and application data, the variable value may look like this: ‘NONE 0 172’ indicating NONE for MD (since it is not in the message buffer), 0 for the DLH (first structure in the buffer) and 172 for application data (follows the DLH). |
IMFQ_QAO_CATCH_UP_MSG | Indicates whether the current message is a potential catch-up message (present on the queue when MainView AutoOPERATOR opened it) Possible values are:
|
IMFQ_MD_STRUCID | Contains the value MQMD_STRUC_ID |
IMFQ_MD_VERSION | Contains either MQMD_VERSION_1 or MQMD_VERSION_2 |
IMFQ_MD_REPORT | Contains one or more of the following delimited by blanks:
See note at the beginning of this table. |
IMFQ_MD_MSGTYPE | Contains one of the following values:
See note at the beginning of this table. |
IMFQ_MD_EXPIRY | Contains a decimal value in the range 1 to 999999999, or MQEI_UNLIMITED |
IMFQ_MD_FEEDBACK | Contains one of the following values for report messages:
In addition, this field can contain any reason code from the following sources:
The content of this field can be a feedback code or a reason code. You can determine whether it is a feedback code or reason code by its value. For example, feedback codes start with MQFB_xxxx and reason codes start with MQRC_xxxx. See note at the beginning of this table. |
IMFQ_MD_ENCODING | Contains either MQENC_NATIVE or any decimal value up to 999999999 |
IMFQ_MD_CODEDCHARSETID | Contains:
See IBM manual MQ Application Programming Reference for details on how the CodedCharSetId field is used as input. |
IMFQ_MD_FORMAT | Contains one of the following values:
See note at the beginning of this table. |
IMFQ_MD_PRIORITY | Contains a decimal value in the range 0 to 999999999 |
IMFQ_MD_PERSISTENCE | Contains one of the following values:
|
IMFQ_MD_MSGID | Contains up to a 32-byte Msgid. Processed exactly as received No conversion of hexadecimal data is done. |
IMFQ_MD_CORRELID | Contains up to a 32-byte CorrelId Processed exactly as received. No conversion of hexadecimal data is done. |
IMFQ_MD_BACKOUTCOUNT | Contains a decimal value in the range 0 to 255 |
IMFQ_MD_REPLYTOQ | Contains up to a 48-character name of the ReplyToQ |
IMFQ_MD_REPLYTOQMGR | Contains up to a 48-character name of the ReplyToQMgr |
IMFQ_MD_USERIDENTIFIER | Contains up to a 12-character UserIdentifier |
IMFQ_MD_ACCOUNTINGTOKEN | Contains either MQACT_NONE or up to a 32-byte AccountingToken Processed exactly as received. No conversion of hexadecimal data is done. |
IMFQ_MD_APPLIDENTITYDATA | Contains up to a 32-character value for ApplIdentityData |
IMFQ_MD_PUTAPPLTYPE | Contains a user-defined type or one or more of the following standard types:
|
IMFQ_MD_PUTAPPLNAME | Contains up to a 28-character value for PutApplName |
IMFQ_MD_PUTDATE | Contains an 8-character date stamp |
IMFQ_MD_PUTTIME | Contains an 8-character time stamp |
IMFQ_MD_APPLORIGINDATA | Contains a 4-character value for ApplOriginData |
IMFQ_MD_GROUPID | If an MQMD_VERSION_2 MD is present, this variable may contain a 24-byte GroupId Processed exactly as received. No conversion of hexadecimal data is done. |
IMFQ_MD_MSGSEQNUMBER | If an MQMD_VERSION_2 MD is present, this variable may contain a decimal value in the range 1 to 999999999 |
IMFQ_MD_OFFSET | If an MQMD_VERSION_2 MD is present, this variable may contain a decimal value in the range 0 to 999999999 |
IMFQ_MD_MSGFLAGS | If an MQMD_VERSION_2 MD is present, this variable may contain one or more of the following character strings delimited by blanks:
See note at the beginning of this table. |
IMFQ_MD_ORIGINALLENGTH | Contains a decimal value in the range 1 to 999999999, or MQOL_UNDEFINED See note at the beginning of this table. |
IMFQ_QATTR_BACKOUTREQUEUEQNAME | Contains up to a 48-character value |
IMFQ_QATTR_BACKOUTTHRESHOLD | Contains a decimal number in the range 0 to 999999999 |
IMFQ_QATTR_CLUSTERCHANNELNAME | Generic name of the cluster sender channels that use this queue as a transmission queue. |
IMFQ_QATTR_CREATIONDATE | Contains a 12-character date |
IMFQ_QATTR_CREATIONTIME | Contains an 8-character time |
IMFQ_QATTR_QDESC | Contains up to a 48-character value |
| IMFQ_QATTR_QNAME | Contains up to a 48-character queue name |
IMFQ_QATTR_CURRENTQDEPTH | Contains a decimal number for the current queue depth |
IMFQ_QATTR_DEFPRIORITY | Contains a decimal number in the range 0 to the MaxPriority of the queue manager |
IMFQ_QATTR_DEFPERSISTENCE | Contains one of the following values:
|
IMFQ_QATTR_DEFINPUTOPENOPTION | Contains one of the following:
|
IMFQ_QATTR_DEFINITIONTYPE | Contains one of the following values:
|
IMFQ_QATTR_INHIBITGET | Contains one of the following values:
|
IMFQ_QATTR_HARDENGETBACKOUT | Contains one of the following values:
|
IMFQ_QATTR_INITIATIONQNAME | Contains up to a 48-character value |
IMFQ_QATTR_OPENINPUTCOUNT | Contains a decimal value |
IMFQ_QATTR_MAXQDEPTH | Contains a decimal number in the range 0 to 999999999 |
IMFQ_QATTR_MAXMSGLENGTH | Contains a decimal number in the range 0 to 104857600 |
IMFQ_QATTR_MSGDELIVERYSEQUENCE | Contains one of the following values:
|
IMFQ_QATTR_OPENOUTPUTCOUNT | Contains a decimal value |
IMFQ_QATTR_PROCESSNAME | Contains up to a 48-character value |
IMFQ_QATTR_INHIBITPUT | Contains one of the following values:
|
IMFQ_QATTR_RETENTIONINTERVAL | Contains a decimal number in the range 0 to 999999999 |
IMFQ_QATTR_SHAREABILITY | Contains one of the following values:
|
IMFQ_QATTR_STORAGECLASS | Contains up to a 8-character value |
IMFQ_QATTR_TRIGGERDATA | Contains up to a 64-character value |
IMFQ_QATTR_TRIGGERDEPTH | Contains a decimal value |
IMFQ_QATTR_TRIGGERControl | Contains one of the following values:
|
IMFQ_QATTR_TRIGGERMSGPRIORITY | Contains a decimal value in the range of 0 to the maximum priority |
IMFQ_QATTR_TRIGGERTYPE | Contains one of the following values:
|
IMFQ_QATTR_USAGE | Contains one of the following values:
|
IMFQ_QATTR_QSERVICEINTERVAL | Contains a decimal number that represents the queue service interval value for the queue Variable not valid for queue managers earlier than release 6.0.0. |
IMFQ_QATTR_INDEXTYPE | Contains one of the following index types:
Variable not valid for queue managers earlier than release 6.0.0. |
IMFQ_QATTR_QDEPTHHIGHEVENT | Determines whether Q_Depth_High events are generated:
Variable not valid for queue managers earlier than release 6.0.0. |
IMFQ_QATTR_QDEPTHLOWEVENT | Determines whether Q_Depth_Low events are generated:
Variable not valid for queue managers earlier than release 6.0.0. |
IMFQ_QATTR_QUEUEMONITORING | Contains the level of monitoring data collection for the queue:
Variable not valid for queue managers earlier than release 6.0.0. |
IMFQ_QATTR_CLWLQUEUERANK | Cluster workload queue rank A decimal value, between 0 and 9. Variable not valid for queue managers earlier than release 6.0.0. |
IMFQ_QATTR_CLWLQUEUEPRIORITY | Cluster workload queue priority A decimal value, between 0 and 9. Variable not valid for queue managers earlier than release 6.0.0. |
IMFQ_QATTR_CLWLUSEQ | Defines the behavior of an MQPUT when the target queue has both a local instance and a remote cluster instance one of the following values:
Variable not valid for queue managers earlier than release 6.0.0. |
IMFQ_QATTR_QUEUEACCOUNTING | Specifies whether accounting information is collected:
Variable not valid for queue managers earlier than release 6.0.0. |
Comments
Log in or register to comment.