EVENT variables

The following table lists the event variables - Rules and Rule-Invoked EXECs:

Table 1. EVENT variables - Rules and Rule-invoked EXECs

Variable name

Notes

IMFQ_EVENT_TYPE

Specifies event type, not a IBM MQ field

IMFQ_EVENT_QMGRNAME

Specifies the name of a queue manager that generated event, whether local or remote

IMFQ_EVENT_QNAME

Specifies the name of a queue from object descriptor

IMFQ_EVENT_BASEQNAME

Specifies the name of a queue manager (to which the alias resolves)

IMFQ_EVENT_APPLNAME

Specifies the name of application

IMFQ_EVENT_OBJECTQMGRNAME

Specifies the name of the object queue manager

IMFQ_EVENT_CHANNELNAME

Specifies the name of channel

IMFQ_EVENT_CONNECTIONNAME

Specifies the connection name

For TCP/IP, this is the internet address only if the channel has successfully established a connection. Otherwise, it is the contents of the ConnectionName field in the channel definition.

IMFQ_EVENT_CLIENTUSERIDENTIFIER

Client-side user identifier of the partner attempting to establish connection.

IMFQ_EVENT_MAXINSTANCES

Maximum channel instances.

IMFQ_EVENT_MAXCLIENTINSTANCES

Maximum channel instances per client.

IMFQ_EVENT_XMITQNAME

Specifies the transmission queue name

IMFQ_EVENT_FORMAT

Specifies the name of format

IMFQ_EVENT_QTYPE

Specifies the type of queue

IMFQ_EVENT_APPLTYPE

Specifies the type of queue to which the alias resolves (A for alias, M for model)

IMFQ_EVENT_REASONQUALIFIER

Specifies one of the following values:

  • MQRQ_CHANNEL_STOPPED_OK

  • MQRQ_CHANNEL_STOPPED_ERROR

  • MQRQ_CHANNEL_STOPPED_RETRY

  • MQRQ_CHANNEL_STOPPED_DISABLED

  • MQRQ_SSL_HANDSHAKE_ERROR

  • MQRQ_SSL_CIPHER_SPEC_ERROR

  • MQRQ_SSL_PEER_NAME_ERROR

  • MQRQ_SSL_CLIENT_AUTH_ERROR

IMFQ_EVENT_ERRORIDENTIFIER

See the section regarding the channel_stopped event, field Error identifier, in the IBM manual MQ Event Monitoring or the IBM Knowledge Center for a description of this data.

IMFQ_EVENT_PROCESSNAME

Specifies the name of the process

IMFQ_EVENT_USERIDENTIFIER

Specifies the name of the user identifier

IMFQ_EVENT_AUXERRORDATAINT1

Specifies the first integer of auxiliary error data for channel errors

IMFQ_EVENT_AUXERRORDATAINT2

Specifies the second integer of auxiliary error data for channel errors

IMFQ_EVENT_AUXERRORDATASTR1

Specifies the first string of auxiliary error data for channel errors

IMFQ_EVENT_AUXERRORDATASTR2

Specifies the second string of auxiliary error data for channel errors

IMFQ_EVENT_AUXERRORDATASTR3

Specifies the third string of auxiliary error data for channel errors

IMFQ_EVENT_TIMESINCERESET

Specifies the time (in seconds) since the statistics were last reset; for this event, this value is greater than the service interval

IMFQ_EVENT_HIGHQDEPTH

Specifies the maximum number of messages on the queue since the statistics were last reset

IMFQ_EVENT_MSGENQCOUNT

Specifies the number of messages enqueued since statistics were last reset

IMFQ_EVENT_MSGDEQCOUNT

Specifies the number of messages dequeued since statistics were last reset

IMFQ_EVENT_BRIDGENAME

Specifies the name of bridge

IMFQ_EVENT_BRIDGETYPE

Specifies the current value is 1 (OTMA)

IMFQ_EVENT_OPTIONS

Specifies the open options

IMFQ_EVENT_COMMAND

Specifies the name of command event

IMFQ_EVENT_CURDEPTH

Specifies the current depth of the event queue

IMFQ_EVENT_EVENTUSERID

Specifies the user ID that issued the command or call that generated the event (CONFIG events)

IMFQ_EVENT_EVENTORIGIN

Specifies the origin of the action causing the event (CONFIG events):

  • MQEVO_CONSOLE

  • MQEVO_INIT

  • MQEVO_MSG

  • MQEVO_MQSET

  • MQEVO_INTERNAL

  • MQEVO_OTHER

IMFQ_EVENT_EVENTQMGR

Specifies the queue manager where the command or call was entered (CONFIG events)

IMFQ_EVENT_EVENTACCOUNTINGTOK

For commands received as a message (MQEVO_MSG), Specifies the accounting token (AccountingToken) from the MD of the command message (CONFIG events)

IMFQ_EVENT_EVENTAPPLIDENTITY

For commands received as a message (MQEVO_MSG), Specifies the application identity data (ApplIdentityData) from the MD of the command message (CONFIG events)

IMFQ_EVENT_EVENTAPPLTYPE

For commands received as a message (MQEVO_MSG), Specifies the type of application (PutApplType) from the MD of the command message (CONFIG events)

See IMFMQI_MD_PUTAPPLTYPE for a list of possible values.

IMFQ_EVENT_EVENTAPPLNAME

For commands received as a message (MQEVO_MSG), Specifies the name of the application (PutApplName) from the MD of the command message (CONFIG events)

IMFQ_EVENT_EVENTAPPLORIGIN

For commands received as a message (MQEVO_MSG), Specifies the application origin data (ApplOriginData) from the MD of the command message (CONFIG events)

IMFQ_EVENT_OBJECTTYPE

Specifies the object type:

  • MQOT_CHANNEL

  • MQOT_NAMELIST

  • MQOT_PROCESS

  • MQOT_Q

  • MQOT_STORAGE_CLASS

  • MQOT_Q_MGR

  • MQOT_AUTH_INFO

  • MQOT_CF_STRUC

IMFQ_EVENT_OBJECTNAME

Specifies the object name, according to object type:

  • MQACH_CHANNEL_NAME

  • MQCA_NAMELIST_NAME

  • MQCA_PROCESS_NAME

  • MQCA_Q_NAME

  • MQCA_STORAGE_CLASS

  • MQCA_Q_MGR_NAME

  • MQCA_AUTH_INFO_NAME

  • MQCA_CF_STRUC_NAME

IMFQ_EVENT_DISPOSITION

Specifies the object disposition:

  • MQQSGD_Q_MGR

  • MQQSGD_SHARED

  • MQQSGD_GROUP

  • MQQSGD_COPY

IMFQ_EVENT_SSLHANDSHAKESTAGE

Specifies the name of the SSL function call reporting the error, or on Windows, a description of the error is given in some cases

IMFQ_EVENT_SSLRETURNCODE

Specifies the numeric return code from a failing SSL call

IMFQ_EVENT_SSLPEERNAME

Specifies the Distinguished Name in the certificate sent from the remote system

Variables for queue manager objects

IMFQ_EVENT_ACTIVITYRECORDING

Specifies whether activity recording is enabled or disabled:

  • MQRECORDING_MSG

  • MQRECORDING_Q

  • MQRECORDING_DISABLED

IMFQ_EVENT_CHANNELEVENT

Determines whether channel events are generated:

  • MQEVR_ENABLED

  • MQEVR_EXCEPTION

  • MQEVR_DISABLED

IMFQ_EVENT_BRIDGEEVENT

Determines whether IMS bridge events are generated:

  • MQEVR_ENABLED

  • MQEVR_DISABLED

IMFQ_EVENT_SSLEVENT

Determines whether SSL events are generated:

  • MQEVR_ENABLED

  • MQEVR_DISABLED

IMFQ_EVENT_CONFIGURATIONEVENT

Determines whether configuration events are generated:

  • MQEVR_ENABLED

  • MQEVR_DISABLED

IMFQ_EVENT_COMMANDEVENT

Determines whether command events are generated:

  • MQEVR_ENABLED

  • MQEVR_DISABLED

  • MQEVR_NO_DISPLAY

IMFQ_EVENT_CLWLMRUCHANNELS

Specifies the number of active outbound cluster channels

IMFQ_EVENT_MAXACTIVECHANNELS

Specifies the maximum number of channels that can be active at the same time

IMFQ_EVENT_CHINITADAPTERS

Specifies the number of channel initiator adapter subtasks to use for processing IBM MQ calls

IMFQ_EVENT_CHINITDISPATCHERS

Specifies the number of dispatchers to use for the channel initiator

IMFQ_EVENT_ADOPTNEWMCACHECK

Specifies the procedure to determine if an existing receiver MCA is to be adopted when an inbound channel is detected of the same name:

  • MQADOPT_CHECK_Q_MGR_NAME

  • MQADOPT_CHECK_NET_ADDR

  • MQADOPT_CHECK_ALL

  • MQADOPT_CHECK_NONE

IMFQ_EVENT_ADOPTNEWMCATYPE

Specifies whether orphaned receiver MCAs are to be restarted when an inbound channel matching the ADOPTNEWMCACHECK procedure is detected:

  • MQADOPT_TYPE_NO

  • MQADOPT_TYPE_ALL

IMFQ_EVENT_CHANNELMONITORING

Specifies the level of monitoring data collection for the channel:

  • MQMON_OFF

  • MQMON_LOW

  • MQMON_MEDIUM

  • MQMON_HIGH

  • MQMON_NONE

IMFQ_EVENT_CLWLUSEQ

Defines the behavior of an MQPUT when the target has both a local instance and at least one remote cluster instance:

  • MQCLWL_USEQ_ANY

  • MQCLWL_USEQ_LOCAL

IMFQ_EVENT_DNSGROUP

Defines the name of the group that the TCP listener that manages inbound transmissions for the queue sharing group must join when using Workload Manager for Dynamic Domain Name Services

IMFQ_EVENT_DNSWLM

Specifies whether the TCP listener that manages inbound transmissions for the queue sharing group will register with the Workload Manager for Dynamic Domain Name Services:

  • MQDNSWLM_YES

  • MQDNSWLM_NO

IMFQ_EVENT_IPADDRESSVERSION

Specifies the IP Version to be used:

  • MQIPADDR_IPV4

  • MQIPADDR_IPV6

IMFQ_EVENT_LISTENERTIMER

Specifies the time interval, in seconds, between attempts to restart a listener following an APPC or TCP/IP failure

IMFQ_EVENT_LUGROUPNAME

Specifies the generic LU name that the LU 6.2 listener that handles inbound transmissions for the queue sharing group is to use

IMFQ_EVENT_LUNAME

Specifies the LU name that the LU 6.2 listener that handles outbound transmissions is to use

IMFQ_EVENT_LU62ARMSUFFIX

Specifies the suffix of the SYS1.PARMLIB member APPCPMxx, that nominates the LUADD for this channel initiator

IMFQ_EVENT_MAXCHANNELS

Specifies the maximum number of current channels, including clients connected to server connection channels

IMFQ_EVENT_TCPCHANNELS

Specifies the maximum number of current channels that use the TCP/IP transmission protocol, including clients connected to server connection channels.

IMFQ_EVENT_LU62CHANNELS

Specifies the maximum number of current channels that use the LU62 transmission protocol, including clients connected to server connection channels

IMFQ_EVENT_OUTBOUNDPORTMAX

Specifiesthe outbound port range maximum

IMFQ_EVENT_OUTBOUNDPORTMIN

Specifies the outbound port range minimum

IMFQ_EVENT_RECEIVETIMEOUT

In conjunction with ReceiveTimeoutType, Specifies how long a TCP/IP channel will wait to receive data, including heartbeats, from its partner before returning to the inactive state

IMFQ_EVENT_RECEIVETIMEOUTTYPE

In conjunction with ReceiveTimeout, Specifies how long a TCP/IP channel will wait to receive data, including heartbeats, from its partner before returning to the inactive state:

  • MQRCVTIME_MULTIPLY

  • MQRCVTIME_ADD

  • MQRCVTIME_EQUAL

IMFQ_EVENT_RECEIVETIMEOUTMIN

Specifies the minimum time, in seconds, that a TCP/IP channel will wait to receive data, including heartbeats, from its partner before returning to the inactive state

IMFQ_EVENT_SHAREDQUEUEQUEUEMA

Specifies how messages are put on a shared queue which specified another queue manager from a queue sharing group as the object queue manager:

  • MQSQQM_USE

  • MQSQQM_IGNORE

IMFQ_EVENT_SSLKEYRESETCOUNT

Specifies the SSL key reset count

IMFQ_EVENT_TCPKEEPALIVE

Specifies whether to use the TCP KEEPALIVE facility to check whether the MCA at the opposite end of a channel is available:

  • MQTCPKEEP_YES

  • MQTCPKEEP_NO

IMFQ_EVENT_TCPNAME

Specifies the TCP name

IMFQ_EVENT_TCPSTACKTYPE

Specifies the TCP stack type:

  • MQTCPSTACK_SINGLE

  • MQTCPSTACK_MULTIPLE

IMFQ_EVENT_TRACEROUTERECORDIN

Specifies whether trace-route messaging is enabled or disabled:

  • MQRECORDING_MSG

  • MQRECORDING_Q

  • MQRECORDING_DISABLED

IMFQ_EVENT_CHINITTRACEAUTOSTA

Specifies whether the channel initiator trace should start automatically:

  • MQTRAXSTR_NO

  • MQTRAXSTR_YES

IMFQ_EVENT_CHINITTRACETABLESI

Specifies the size of the channel initiator's trace data space, in MB

IMFQ_EVENT_QUEUEACCOUNTING

Specifies whether accounting information is collected for queues:

  • MQMON_NONE

  • MQMON_ON

  • MQMON_OFF

IMFQ_EVENT_QUEUEMONITORING

Specifies the level of real-time monitoring data collection for queues:

  • MQMON_NONE

  • MQMON_OFF

  • MQMON_LOW

  • MQMON_MEDIUM

  • MQMON_HIGH

IMFQ_EVENT_CLUSTERSENDERMONIT

Specifies the level of real-time monitoring data collection for auto-defined cluster sender channels:

  • MQMON_OFF

  • MQMON_Q_MGR

  • MQMON_LOW

  • MQMON_MEDIUM

  • MQMON_HIGH

Variables for channel objects

IMFQ_EVENT_CLWLCHANNELRANK

Specifies the cluster workload channel rank

IMFQ_EVENT_CLWLCHANNELPRIORIT

Specifies the cluster workload channel priority

IMFQ_EVENT_CLWLCHANNELWEIGHT

Specifies the cluster workload channel weight

IMFQ_EVENT_CHANNELMONITORING

Specifies the level of monitoring data collection for the channel:

  • MQMON_OFF

  • MQMON_LOW

  • MQMON_MEDIUM

  • MQMON_HIGH

  • MQMON_QMGR

IMFQ_EVENT_HEADERCOMPRESSION

Specifies the header data compression techniques supported by the channel: MQCOMPRESS_NONE MQCOMPRESS_SYSTEM

IMFQ_EVENT_MESSAGECOMPRESSION

Specifies the message data compression techniques supported by the channel:

  • MQCOMPRESS_NONE

  • MQCOMPRESS_RLE

  • MQCOMPRESS_ZLIBFAST

  • MQCOMPRESS_ZLIBHIGH

  • MQCOMPRESS_ANY

IMFQ_EVENT_MSGRETRYCOUNT

Specifies the message retry count

IMFQ_EVENT_MSGRETRYEXIT

Specifies the message retry exit name

IMFQ_EVENT_MSGRETRYINTERVAL

Specifies the message retry interval

IMFQ_EVENT_MSGRETRYUSERDATA

Specifies the message retry exit user data

Variables for queue objects

IMFQ_EVENT_CLWLQUEUERANK

Specifies the queue rank

IMFQ_EVENT_CLWLQUEUEPRIORITY

Specifies the queue priority

IMFQ_EVENT_CLWLUSEQ

Defines the behavior of an MQPUT when the target has both a local instance and at least one remote cluster instance:

  • MQCLWL_USEQ_ANY

  • MQCLWL_USEQ_LOCAL

  • MQCLWL_USEQ_AS_Q_MGR

IMFQ_EVENT_QUEUEACCOUNTING

Specifies whether accounting information is collected:

  • MQMON_ON

  • MQMON_OFF

  • MQMON_QMGR

Variables for StorageClass objects

IMFQ_EVENT_PASSTICKETAPPLICAT

Specifies the name of the application used to authenticate IMS bridge passtickets

This version of the documentation is no longer supported. However, the documentation is available for your convenience. You will not be able to leave comments.

Comments