MQMONITOR attributes

Attributes

AUTOSTART({YES|NO})

Specifies whether to start the MQ monitor automatically.

YES

The MQ monitor is started 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).

NO

The MQ monitor is not started automatically.

DESCRIPTION(text)

In this field, you can provide a description of the resource that you are defining. The description text can be up to 58 characters in length. No restrictions apply to the characters that you can use. However, if you use parentheses, ensure that each left parenthesis has a matching right one. If you use the CREATE command, for each single apostrophe in the text code, use two apostrophes.

GROUP(groupname)

Every resource definition must have a GROUP name. The resource definition becomes a member of the group and is installed in the CICS system when the group is installed.

Acceptable characters:

A-Z 0-9 $ @ #

Any lowercase characters that you enter are converted to uppercase.

The GROUP name can be up to 8 characters in length.

MQMONITOR(name)

Specifies the 8-character name of this resource definition.

Acceptable characters:

A-Z 0-9 $ @ #

Unless you are using the CREATE command, any lowercase characters that you enter are converted to uppercase.

MONDATA(text)

You can specify data to be passed to the transaction monitoring the MQ queue. For example, you can use this field to pass parameters to the MQ bridge monitor transaction CKBR. The attribute can contain up to 200 mixed-case characters.

Note:

When displayed and retrieved by the monitoring task, the MONDATA data is prepended with the following 18 bytes:

• Byte 1: < (left chevron)
• Bytes 2 - 9: MQMONITOR resource name
• Bytes 10 - 17: USERID
• Byte 18: > (right chevron)

Bytes 19 - 218 contains MONDATA as entered by the user.

Therefore, user-written programs must allow for a maximum length of 218 bytes to retrieve MONDATA, and use the MQMONITOR name as specified in bytes 2 - 9 from the retrieved MONDATA for setting the MONSTATUS attribute of the MQ monitor, thereby indicating its current status. 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. For more information, see the security considerations described in MQMONITOR resources.

Any user-defined character strings &applid. or &APPLID. will be replaced by the APPLID of the local region when the MQMONITOR is installed. This will facilitate generic use of this resource.

MONUSERID(userid)

Specifies the user ID to be associated with the transaction monitoring the MQ queue. This attribute is only effective when security checking is active (that is, the SEC system initialization parameter is set to YES). If security checking is disabled (that is, SEC is set to NO), the user ID to be associated with the MQ monitor transaction is the user ID of the transaction that set the state of the MQMONITOR resource to started.

Note: If security checking is active, CICS verifies 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).

QNAME(name)

Specifies the name of the MQ queue to be monitored.

When you specify the QNAME attribute, you can use a symbolic parameter, &APPLID., as a prefix in the value to identify the APPLID of a CICS region; for example, &APPLID..EXAMPLE.QUEUE.NAME. When you install the resource in a CICS region, &APPLID. is replaced with the APPLID of the local region.

If QNAME is omitted, the value is set to &APPLID..INITIATION.QUEUE by default when the resource is installed.

STATUS({ENABLED|DISABLED})

Specifies the initial status of the MQMONITOR resource when it is installed.

DISABLED

The MQMONITOR resource is not available for use.

ENABLED

The MQMONITOR resource is available for use.

TRANSACTION(name)

Specifies the 4-character ID of the CICS transaction that is used by the task monitoring the MQ queue.

If TRANSACTION is omitted, the value is set to CKTI by default.

USERID(id)

Specifies the user ID to be used by default for starting the transaction associated with the application if no suitable user ID is available from any other source.

If USERID is omitted, the CICS default user ID will be used.