Variables supplied by BMC AMI Ops Automation for IBM MQ messages

The following table lists the most commonly used variables supplied by BMC AMI Ops Automation that are available to Rules and EXECs scheduled from a Rule, for all IBM MQ messages

For other structures not listed here, for example DLH (Dead Letter Header) and others, see Diagnosing-BMC-AMI-Ops-Automation-for-MQ-errors.

Related topic

SHARED-variables-for-IBM-MQ-events

Variables supplied by BMC AMI Ops Automation 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.

BMC AMI Ops Automation does not supply IMFMQI_QATTR variables for EXECs. If you want to get queue attributes from a non Rule-invoked EXEC, use the IMFEXEC CMD TYPE(MQS) command to do a display and look at the results to get those attributes.

For definitions of field names and constants used in this table, which are derived from IBM MQ structure field names, see the IBM publication MQ Application Programming Reference.

Important

These variables follow the IBM conventions where possible. Therefore, the variables listed in this table might not be complete because IBM might have added new constants. For a more complete list, see the IBM publication IBM MQ Application Programming Reference.

Variable name

Description

IMFOQMGR

Subsystem ID of queue manager

IMFQCPF

z/OS console command prefix for this MQ queue manager

IMFQEPFL 

Contains the numeric value of the percentage full of the event queue

This variable is valid only for event queues.

IMFQRMT

Origin of message (Y: message is from a remote queue, N: message is not from a remote queue)

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_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_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_APPLORIGINDATA

Contains a 4-character value for ApplOriginData

IMFQ_MD_BACKOUTCOUNT

Contains a decimal value in the range 0 to 255

IMFQ_MD_CODEDCHARSETID

Contains:

  • MQCCSI_Q_MGR
  • MQCCSI_EMBEDDED
  • Or any decimal value up to 999999999.

See IBM publication MQ Application Programming Reference for details on how the CodedCharSetId field is used as input.

IMFQ_MD_CORRELID

Contains up to a 32-byte CorrelId

Processed exactly as received. No conversion of hexadecimal data is done.

IMFQ_MD_ENCODING

Contains either MQENC_NATIVE or any decimal value up to 999999999

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:

  • MQFB_NONE
  • MQFB_COA
  • MQFB_COD
  • MQFB_EXPIRATION
  • MQFB_PAN
  • MQFB_NAN
  • MQFB_QUIT

In addition, this field can contain any reason code from the following sources:

  • IMS-bridge feedback codes
  • CICS-bridge feedback codes
  • IBM MQ reason codes

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_FORMAT

Contains one of the following values:

  • MQFMT_NONE
  • MQFMT_ADMIN
  • MQFMT_CHANNEL_COMPLETED
  • MQFMT_CICS
  • MQFMT_COMMAND_1
  • MQFMT_COMMAND_2
  • MQFMT_DEAD_LETTER_HEADER
  • MQFMT_EVENT
  • MQFMT_IMS
  • MQFMT_IMS_VAR_STRING
  • MQFMT_MD_EXTENSION
  • MQFMT_PCF
  • MQFMT_REF_MSG_HEADER
  • MQFMT_STRING
  • MQFMT_TRIGGER
  • MQFMT_WORK_INFO_HEADER
  • MQFMT_XMIT_Q_HEADER
  • MQFMT_RF_HEADER

See note at the beginning of this table.

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_MSGFLAGS

If an MQMD_VERSION_2 MD is present, this variable may contain one or more of the following character strings delimited by blanks:

  • MQMF_SEGMENTATION_INHIBITED
  • MQMF_SEGMENTATION_ALLOWED
  • MQMF_MSG_IN_GROUP
  • MQMF_LAST_MSG_IN_GROUP
  • MQMF_SEGMENT
  • MQMF_LAST_SEGMENT
  • MQMF_NONE

See note at the beginning of this table.

IMFQ_MD_MSGID

Contains up to a 32-byte Msgid. 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_MSGTYPE

Contains one of the following values:

  • MQMT_DATAGRAM
  • MQMT_REQUEST
  • MQMT_REPLY
  • MQMT_REPORT

See note at the beginning of this table.

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_ORIGINALLENGTH

Contains a decimal value in the range 1 to 999999999, or MQOL_UNDEFINED

See note at the beginning of this table.

IMFQ_MD_PERSISTENCE

Contains one of the following values:

  • MQPER_PERSISTENT
  • MQPER_NOT_PERSISTENT

IMFQ_MD_PRIORITY

Contains a decimal value in the range 0 to 999999999

IMFQ_MD_PUTAPPLNAME

Contains up to a 28-character value for PutApplName

IMFQ_MD_PUTAPPLTYPE

Contains a user-defined type or one or more of the following standard types:

  • MQAT_AIX
  • MQAT_BROKER
  • MQAT_CICS
  • MQAT_CICS_BRIDGE
  • MQAT_CICS_VSE
  • MQAT_DEFAULT
  • MQAT_DOS
  • MQAT_DQM
  • MQAT_GUARDIAN
  • MQAT_IMS
  • MQAT_IMS_BRIDGE
  • MQAT_JAVA
  • MQAT_NO_CONTEXT
  • MQAT_NOTES_AGENT
  • MQAT_NSK
  • MQAT_OS2
  • MQAT_OS390
  • MQAT_OS400
  • MQAT_QMGR
  • MQAT_UNIX
  • MQAT_VMS
  • MQAT_VOS
  • MQAT_WINDOWS
  • MQAT_WINDOWS_NT
  • MQAT_XCF
  • MQAT_UNKNOWN

See note at the beginning of this table.

IMFQ_MD_PUTDATE

Contains an 8-character date stamp

IMFQ_MD_PUTTIME

Contains an 8-character time stamp

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_REPORT

Contains one or more of the following delimited by blanks:

  • MQRO_EXCEPTION
  • MQRO_EXCEPTION_WITH_DATA
  • MQRO_EXCEPTION_WITH_FULL_DATA
  • MQRO_EXPIRATION
  • MQRO_EXPIRATION_WITH_DATA
  • MQRO_EXPIRATION_WITH_FULL_DATA
  • MQRO_COA
  • MQRO_COA_WITH_DATA
  • MQRO_COA_WITH_FULL_DATA
  • MQRO_COD
  • MQRO_COD_WITH_DATA
  • MQRO_COD_WITH_FULL_DATA
  • MQRO_PAN
  • MQRO_NAN
  • MQRO_NEW_MSG_ID
  • MQRO_PASS_MSG_ID
  • MQRO_COPY_MSG_ID_TO_CORREL_ID
  • MQRO_PASS_CORREL_ID
  • MQRO_DEAD_LETTER_Q
  • MQRO_DISCARD_MSG
  • MQRO_NONE

See note at the beginning of this table.

IMFQ_MD_STRUCID

Contains the value MQMD_STRUC_ID

IMFQ_MD_USERIDENTIFIER

Contains up to a 12-character UserIdentifier

IMFQ_MD_VERSION

Contains either MQMD_VERSION_1 or MQMD_VERSION_2

IMFQ_QAO_CATCH_UP_MSG

Indicates whether the current message is a potential catch-up message (present on the queue when BMC AMI OpsA opened it)

Possible values are:

  • Y (Yes): the message already existed on the queue
  • N (No): the message has newly arrived since the queue was opened

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_CAPEXPRY

Contains one of the following:

  • A value between 1 and 999,999,999
  • MQEI_UNLIMITED

Valid for version 9.4 (or later) of IBM MQ. 

IMFQ_QATTR_CLUSTERCHANNELNAME

Generic name of the cluster sender channels that use this queue as a transmission queue.

IMFQ_QATTR_CLWLQUEUEPRIORITY

Cluster workload queue priority

A decimal value, between 0 and 9.

IMFQ_QATTR_CLWLQUEUERANK

Cluster workload queue rank

A decimal value, between 0 and 9.

IMFQ_QATTR_CREATIONDATE

Contains a 12-character date

IMFQ_QATTR_CREATIONTIME

Contains an 8-character time

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_DEFINITIONTYPE

Contains one of the following values:

  • MQQDT_PREDEFINED
  • MQQDT_PERMANENT_DYNAMIC
  • MQQDT_TEMPORARY_DYNAMIC
  • MQQDT_SHARED_DYNAMIC

IMFQ_QATTR_DEFINPUTOPENOPTION

Contains one of the following:

  • MQOO_INPUT_EXCLUSIVE
  • MQOO_INPUT_SHARED

IMFQ_QATTR_DEFPERSISTENCE

Contains one of the following values:

  • MQPER_PERSISTENT
  • MQPER_NOT_PERSISTENT

IMFQ_QATTR_CLWLUSEQ

Defines the behavior of an MQPUT when the target queue has both a local instance and a remote cluster instance

The variable can contain one of the following values:

  • MQCLWL_USEQ_ANY
  • MQCLWL_USEQ_LOCAL
  • MQCLWL_USEQ_AS_Q_MGR

IMFQ_QATTR_QDESC

Contains up to a 48-character value

IMFQ_QATTR_QNAME                  

Contains up to 48-character queue name

IMFQ_QATTR_HARDENGETBACKOUT

Contains one of the following values:

  • MQQA_BACKOUT_HARDENED
  • MQQA_BACKOUT_NOT_HARDENED

IMFQ_QATTR_INDEXTYPE

Contains one of the following index types:

  • MQIT_NONE
  • MQIT_MSG_ID
  • MQIT_CORREL_ID
  • MQIT_MSG_TOKEN
  • MQIT_GROUP_ID

IMFQ_QATTR_INHIBITGET

Contains one of the following values:

  • MQQA_GET_ALLOWED
  • MQQA_GET_INHIBITED

IMFQ_QATTR_INHIBITPUT

Contains one of the following values:

  • MQQA_PUT_INHIBITED
  • MQQA_PUT_ALLOWED

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:

  • MQMDS_FIFO
  • MQMDS_PRIORITY

IMFQ_QATTR_OPENOUTPUTCOUNT

Contains a decimal value

IMFQ_QATTR_PROCESSNAME

Contains up to a 48-character value

IMFQ_QATTR_QDEPTHHIGHEVENT

Determines whether Q_Depth_High events are generated:

  • MQEVR_ENABLED
  • MQEVR_DISABLED

IMFQ_QATTR_QDEPTHLOWEVENT

Determines whether Q_Depth_Low events are generated:

  • MQEVR_ENABLED
  • MQEVR_DISABLED

IMFQ_QATTR_QSERVICEINTERVAL

Contains a decimal number that represents the queue service interval value for the queue

IMFQ_QATTR_QUEUEACCOUNTING

Specifies whether accounting information is collected:

  • MQMON_ON
  • MQMON_OFF
  • MQMON_QMGR

IMFQ_QATTR_QUEUEMONITORING

Contains the level of monitoring data collection for the queue:

  • MQMON_OFF
  • MQMON_LOW
  • MQMON_MEDIUM
  • MQMON_HIGH
  • MQMON_QMGR

IMFQ_QATTR_RETENTIONINTERVAL

Contains a decimal number in the range 0 to 999999999

IMFQ_QATTR_SHAREABILITY

Contains one of the following values:

  • MQQA_SHAREABLE
  • MQQA_NOT_SHAREABLE

IMFQ_QATTR_STORAGECLASS

Contains up to a 8-character value

IMFQ_QATTR_STREAMQ                

Contains up to a 48-character queue name. 

Valid for version 9.4 (or later) of IBM MQ. 

IMFQ_QATTR_STRMQOS

Contains one of the following:

  • MQST_BEST_EFFORT
  • MQST_MUST_DUP

Valid for version 9.4 (or later) of IBM MQ. 

IMFQ_QATTR_TRIGGERControl

Contains one of the following values:

  • MQTC_OFF
  • MQTC_ON

IMFQ_QATTR_TRIGGERDATA

Contains up to a 64-character value

IMFQ_QATTR_TRIGGERDEPTH

Contains a decimal value

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:

  • MQTT_NONE
  • MQTT_FIRST
  • MQTT_EVERY
  • MQTT_DEPTH

IMFQ_QATTR_USAGE

Contains one of the following values:

  • MQUS_NORMAL
  • MQUS_TRANSMISSION

 

Tip: For faster searching, add an asterisk to the end of your partial query. Example: cert*