SET MQMONITOR

Enable or disable an MQMONITOR resource definition. Start or stop the MQ monitor. Set automatic restart of the MQ monitor.

SET MQMONITOR

Conditions: IOERR, INVREQ, NOTAUTH, NOTFND, TRANSIDERR, USERIDERR

This command is threadsafe.

For more information about the use of CVDAs, see CICS-value data areas (CVDAs).

Description

Use the SET MQMONITOR command to enable or disable an MQMONITOR resource definition (ENABLESTATUS attribute), start or stop the MQ monitor (MONSTATUS attribute), or set automatic restart of the MQ monitor (AUTOSTART attribute).

This command does not set any other MQMONITOR attributes. To change these attributes, you must change the resource definition and then reinstall the resource.

If you want to change the QNAME attribute of a reserved MQMONITOR resource definition DFHMQINI, you must change the INITQNAME attribute of the MQCONN resource definition for which DFHMQINI is installed and then reinstall the MQCONN resource definition.

A request to set the state of an MQMONITOR to started causes CICS® to issue an EXEC CICS START request that specifies the value from TRANSACTION as the TRANID, the value from USERID as the USERID, and, in case of a non-CKTI transaction, the data contained in MONDATA prepended with 18 bytes as the FROM data (see Figure 1). If the EXEC CICS START command fails, see message DFHMQ0390E for diagnostic details.

Figure 1. FROM data of EXEC CICS START CICS issued upon a request to set the state of an MQMONITOR that is not associated with CKTI to started. The FROM data contains the data in MONDATA prepended with 18 bytes.


Byte 1: < (left chevron)
Bytes 2 - 9: MQMONITOR resource name
Bytes 10 - 17: USERID
Byte 18: > (right chevron)
Bytes 19 - 218: MONDATA as entered by the user

For user-written transactions, the started transaction must retrieve the MONDATA contained in the FROM data and use the MQMONITOR resource name specified in bytes 2 - 9 for issuing the EXEC CICS SET MQMONITOR commands to set the state of the monitoring transaction (MONSTATUS attribute). Also note that when security checking is active, CICS performs security checks on the user ID associated with the transaction that attempts to set the MQ monitor state to started. Therefore, ensure that the user ID associated with the transaction that attempts to set the MQ monitor state to started is a surrogate of the user ID defined in MONUSERID and is authorized to start transactions associated with the MONUSERID. In the case of setting the MQ monitor state through a CICSPlex® SM API interface such as the CICS Explorer®, the user ID to be associated with the MQ monitor transaction is either the region user ID or the PLTPIUSR user ID (if specified). For more information, see the security considerations described in MQMONITOR resources.

Options

AUTOSTART(cvda)

Specifies whether the MQ monitor starts automatically. The CVDA values are as follows:

AUTOSTART

The MQ monitor starts automatically in either of the following situations:

When the connection to the IBM® MQ queue is established.
If the z/OS Workload Manager (WLM) health service is active (see WLMHEALTH), every increment in the z/OS WLM HEALTH value of the CICS region from zero to 100%. For more information, see Effect of z/OS Workload Manager Health service on MQMONITORs and Alert monitor (CKAM).

NOAUTOSTART

The MQ monitor does not start automatically.

ENABLESTATUS(cvda)

Specifies whether the MQMONITOR resource definition is available for use. The CVDA values are as follows:

ENABLED: The MQMONITOR resource definition is to be enabled and made available for use.
DISABLED: The MQMONITOR resource definition is to be disabled.

MONSTATUS(cvda)

Starts or stops the MQ monitor. The CVDA values are as follows:

STARTED: The MQ monitor is to be started.
STOPPED: The MQ monitor is to be stopped.

MQMONITOR(data-value)

Specifies the 8-character name of the MQMONITOR resource to be set.