Product usage recording with IBM MQ for z/OS products

z/OS® can measure how much processing time is spent in doing work on behalf of the various processes that make up the IBM® MQ product. This is known as product usage recording.

Product usage recording works as follows:

When the IBM MQ for z/OS product is started, it identifies itself to z/OS and requests that the System Management Facilities (SMF) mechanism within z/OS is to automatically measure how much processor time it uses.
When enabled, the z/OS usage measurement facility collects usage figures for each hour of the day, and generates usage records that are added to a report file on disk.
At the end of one full month, these usage records are collected by a program, which generates a report of product usage for the month. This report is used to determine the charge for the IBM MQ for z/OS product.

For more information about product usage recording and the Sub-Capacity Reporting Tool (SCRT), see Preparing to use the Sub-Capacity Reporting Tool. For information about the MULCCAPT parameter see, Using CSQ6SYSP.

As IBM MQ for z/OS is available under several different product IDs (PIDs) you need to ensure that it registers itself to z/OS with the PIDs that you are entitled to, which will ensure that you are charged correctly.

This needs to be done for each of the different parts of the IBM MQ for z/OS product that you might be running:

Queue manager and channel initiator
Advanced message security (AMS)
Managed file transfer (MFT)
mqweb server

This topic describes how you do this.

IBM MQ for z/OS product IDs

Product	Product ID
IBM MQ for z/OS	5655-MQ9
IBM MQ for z/OS Value Unit Edition (VUE)	5655-VU9
IBM MQ Advanced for z/OS	5655-AV9
IBM MQ Advanced for z/OS VUE	5655-AV1

Note: From IBM MQ for z/OS 9.1.3, the older IBM MQ Advanced Message Security for z/OS and IBM MQ Managed File Transfer for z/OS products are no longer available separately and are instead features of IBM MQ Advanced for z/OS and IBM MQ Advanced for z/OS VUE.

Associating the queue manager and channel initiator with a PID

The queue manager and channel initiator address spaces are associated with a specific PID using the QMGRPROD attribute. The following table shows how the value of the QMGRPROD attribute maps to a product and PID:

QMGRPROD value	Product	Product ID
MQ	IBM MQ for z/OS	5655-MQ9
VUE	IBM MQ for z/OS VUE	5655-VU9
ADVANCEDVUE	IBM MQ Advanced for z/OS VUE	5655-AV1

The product and PID used by the queue manager address space are output at start up in the CSQY036I message. Note that the channel initiator does not output an equivalent message, but it uses the same PID.

Prior to IBM MQ for z/OS 9.1.3, VUE mode for both IBM MQ for z/OS VUE and IBM MQ Advanced for z/OS VUE could optionally be enabled using an enablement module. From IBM MQ for z/OS 9.1.3 that enablement module is no longer shipped, and you must use the QMGRPROD attribute.

There are three distinct methods of setting the QMGRPROD attribute:

In the CSQ6USGP macro, which is part of the IBM MQ system parameter module. This is the approach you should use for setting QMGRPROD permanently.
As a parameter on the START QMGR command. This needs to be set for each use of the command.
As a parameter on the JCL used to start the queue manager address space. See starting and stopping a queue manager on z/OS for more information.

The second and third approaches can be useful the first few times that QMGRPROD is used, or for test systems, and will override the values set by CSQ6USGP.

Associating AMS with a PID

The AMS address space is associated with a specific product using the AMSPROD attribute. The table below shows how the value of the AMSPROD attribute maps to a particular product:

AMSPROD value	Product	Product ID
AMS	IBM MQ Advanced Message Security for z/OS	5655-AM9
ADVANCED	IBM MQ Advanced for z/OS	5655-AV9
ADVANCEDVUE	IBM MQ Advanced for z/OS VUE	5655-AV1

[MQ 9.2.0 Jul 2020] Prior to IBM MQ for z/OS 9.1.3, an enablement module was required for the AMS address space to start up. From IBM MQ for z/OS 9.1.3 that enablement module is no longer shipped. Instead, if your enterprise wants to use Advanced Message Security, you must ensure that AMSPROD is set to one of AMS, ADVANCED, or ADVANCEDVUE depending on what product you are entitled to. If SPLCAP(YES) is set in CSQ6SYSP, indicating that the queue manager is to be enabled for AMS, but AMSPROD is not set, then from IBM MQ for z/OS 9.1.3, the queue manager will not start and message CSQY024I will be output.

The product and PID used by the AMS address space are output at start up in the CSQ0619I message.

There are three distinct methods of setting the AMSPROD attribute:

In the CSQ6USGP macro, which is part of the IBM MQ system parameter module. This is the approach you should use for setting AMSPROD permanently.
As a parameter on the START QMGR command. This needs to be set for each use of the command.
As a parameter on the JCL used to start the queue manager address space. See starting and stopping a queue manager on z/OS for more information.

The second and third approaches can be useful the first few times that AMSPROD is used, or for test systems, and will override the values set by CSQ6USGP.

Associating Managed File Transfer with a PID

MFT processes are associated with a specific PID using the fteSetProductId command.

Associating the mqweb server with a PID

From IBM MQ for z/OS 9.2.0 the mqweb server, that hosts the IBM MQ Console and REST API, is associated with the PID provided when it is created using the crtmqweb command.

Once an mqweb server has been created you can change its PID using the setmqweb pid command.

mqweb servers that were created prior to version 9.2.0 will, by default, use the IBM MQ for z/OS PID. You can use the setmqweb pid command to change the PID that they run under if necessary.

You should not use the older manual approach for setting the mqweb server PID, which involved copying properties files.

The PID used by the mqweb server is output at start up in the messages.log using the CWWKB0108I message.

For IBM MQ for z/OS, this looks like:

CWWKB0108I: IBM CORP product MQM MVS/ESA version V9 R2.0 successfully registered with z/OS.

For IBM MQ for z/OS VUE, this looks like:

CWWKB0108I: IBM CORP product MQ z/OS VUE version NOTUSAGE successfully registered with z/OS.

For IBM MQ for z/OS Advanced VUE, this looks like:

CWWKB0108I: IBM CORP product MQ z/OS Adv VUE version NOTUSAGE successfully registered with z/OS.

Default PIDs

In most cases, if a specific PID is not selected, a default PID is used for:

The queue manager and channel initiator, which is IBM MQ for z/OS
mqweb servers created prior to version 9.2.0, which is IBM MQ for z/OS
The AMS address space, which is IBM MQ Advanced Message Security for z/OS
MFT processes, which is IBM MQ Managed File Transfer for z/OS

Sample scenarios

You have IBM MQ for z/OS: QMGRPROD does not need to be changed, the default PID of 5665-MQ9 is used.
You have installed a new IBM MQ Advanced for z/OS Value Unit Edition queue manager, and want to enable AMS: In CSQ6USGP, set QMGRPROD=ADVANCEDVUE and AMSPROD=ADVANCEDVUE; the 5655-AV1 PID is used.