Newer version of documentation BMC provides a newer version of the documentation for this version of the product. As a result, BMC no longer accepts comments in this space.BMC recommends upgrading to the latest version of the product. To see documentation for that version, see bao8301.

Specifying queues

Use the BBPARM member AAOMQLxx parameters TYPE, QMGR, and QUEUE to specify MQ queues that will become eligible for automation.

A fourth optional parameter, OPEN, indicates how the queue should be processed. All parameters must be typed on one line (abbreviations are available); the syntax is

TYPE(INCL|EXCL) QMGR(queue-manager-name) QUEUE(queue-name) OPEN(S,I)

The following table describes the AAOMQLxx parameters.

Parameter

Description


TYPE( INCL|EXCL)

Specifies whether BMC AMI Ops Automation for MQ should include or exclude this queue in the set of queues that are eligible for automation. This parameter is abbreviated with T. Possible values are:

  • INCL specifies that BMC AMI Ops Automation for MQ should make this queue eligible for possible automation. Abbreviated with I, this setting is the default.
  • EXCL specifies that BMC AMI Ops Automation for MQ should not make this queue eligible for automation. This parameter is abbreviated with E.

QMGR(queue-manager-name)

Specifies the four-character ID for a local z/OS queue manager that BMC AMI Ops Automation for MQ will monitor. Abbreviated with M, this parameter supports asterisk (*) and plus (+) wildcard characters.

This parameter is required and there is no default value. You must specify a queue manager name or a partial queue manager name with wildcard characters (a plus (+) represents one character, and an asterisk (*) represents one or more characters).

QUEUE(queue-name)

Specifies the 48-character name of the queue that BMC AMI Ops Automation for MQ makes eligible for automation. Abbreviated with U, this parameter supports asterisk (*) and plus (+) wildcard characters.

This parameter is required and there is no default value. You must specify a queue name or a partial queue name with wildcard characters (a plus (+) represents one character, and an asterisk (*) represents one or more characters).

OPEN(option1,option 2)

Gives you control over how the queue is opened and what action to take against the messages in the opened queue. This parameter is abbreviated with O.

Possible values for option1 are:

  • EXCLUSIVE, which is the open queue with MQOO_INPUT_EXCLUSIVE option. This option means that other applications will be unable to open the queue while BMC AMI Ops Automationhas it open. It also means that if another application has the queue opened, BMC AMI OpsA will be unable to open it. This parameter is abbreviated with E.

  • SHARED, which is the pen queue with MQOO_INPUT_SHARED option. This option is abbreviated with S. This subparameter is the default for option 1.

Possible values for option2 are:

  • PROCESSOLD routes all existing messages found on the queue at open time through the Rule Processor so that they are automated. This option is useful for processing messages that were put on the queue while BMC AMI OpsAwas unable to open the queue. This parameter is abbreviated with P.

  • IGNOREOLD ignores (does not process) any messages found on the queue at open time. Abbreviated with I. This subparameter is the default for option 2.
Example

This example indicates that the queue is to be opened with the QOO_INPUT_EXCLUSIVE option, and all existing messages found on the queue at open time should be rerouted through the Rule Processor for automation: OPEN(EXCLUSIVE,PROCESSOLD) or O(E,P)

Example

This example indicates that the queue is to be opened with the MQOO_INPUT_SHARED option, and all existing messages found on the queue at open time should be ignored: OPEN(SHARED,IGNOREOLD) or O(S,I)

You can specify multiple sets of these parameters. Continuations are not supported.

Example of specifying queues in AAOMQLxx

BMC recommends that you use the following figure as a model for your specifications.

Example of coding in AAOMQLxx member

*----------------------------------------------------------------------
* PARAMETER(DEFAULT)    VALUES ---------- DESCRIPTION -----------------
*
* TYPE(INCL)                   TYPE ABBREVIATED WITH 'T'.
*                        INCL  INCLUDE THIS QUEUE FOR RULES (INCL) OR
*                              ABBREVIATE WITH 'I'.
*                              EXAMPLE: T(I)
*                        EXCL  EXCLUDE (EXCL) THIS QUEUE FOR RULES.
*                              ABBREVIATE WITH 'E'.
*                              EXAMPLE: T(E)
*
* QMGR                         QMGR ABBREVIATED WITH 'M'.
*                              NAME OF IBM MQ QUEUE MANAGER. NO
*                              DEFAULT, THIS PARAMETER MUST BE CODED.
*                              EXAMPLE: M(CSQ1)
*
* QUEUE                        QUEUE ABBREVIATED WITH 'U'.
*                              NAME OF IBM MQ QUEUE. NO DEFAULT,
*                              THIS PARAMETER MUST BE CODED.
*                              EXAMPLE: U(SYSTEM.ADMIN.QMGR.EVENT)
*
* OPEN(S,I)                    OPEN ABBREVIATED WITH 'O'.
*                   EXCLUSIVE  QUEUE OPENED WITH MQOO_INPUT_EXCLUSIVE
*                              OPTION.  ABBREVIATE WITH 'E'.
*
*                      SHARED  QUEUE OPENED WITH MQOO_INPUT_SHARED
*                              OPTION.  ABBREVIATE WITH 'S'.  THIS IS
*                              A DEFAULT OPTION.
*
*                  PROCESSOLD  ROUTE ALL EXISTING MESSAGES FOUND ON
*                              THE QUEUE AT OPEN TIME THROUGH THE RULE
*                              PROCESSOR TO ALLOW AUTOMATION TO BE
*                              PERFORMED ON THEM.  ABBREVIATE WITH 'P'.
*
*                   IGNOREOLD  IGNORE (DO NOT PROCESS) ANY EXISTING
*                              MESSAGES FOUND ON THE QUEUE AT OPEN TIME.
*                              ABBREVIATE WITH 'I'.  THIS IS A DEFAULT
*                              OPTION.
*
*                              EXAMPLE 1: OPEN(EXCLUSIVE,PROCESSOLD) OR
*                              O(E,P) INDICATES THE QUEUE IS TO BE
*                              OPENED WITH THE MQOO_INPUT_EXCLUSIVE
*                              OPTION AND ALL EXISTING MESSAGES FOUND ON
*                              THE QUEUE AT OPEN TIME SHOULD BE ROUTED
*                              THROUGH THE RULE PROCESSOR FOR
*                              AUTOMATION.
*
*                              EXAMPLE 2: OPEN(SHARED,IGNOREOLD) OR
*                              O(S,I) INDICATES THE QUEUE IS TO BE
*                              OPENED WITH THE MQOO_INPUT_SHARED OPTION
*                              AND ALL EXISTING MESSAGES FOUND ON THE
*                              QUEUE AT OPEN TIME SHOULD BE IGNORED.
*
*----------------------------------------------------------------------
* IBM MQ SYSTEM EVENT QUEUES
*----------------------------------------------------------------------
TYPE(INCL) QMGR(*) QUEUE(SYSTEM.ADMIN.*.EVENT)
*
*----------------------------------------------------------------------
* IBM MQ SYSTEM EVENT'S FROM distributed QUEUE MANAGERS
*----------------------------------------------------------------------
TYPE(INCL) QMGR(*) QUEUE(SYSTEM.DISTRIB.EVENTS)
*
*----------------------------------------------------------------------
* REMAINDER OF QUEUES *DO NOT OPEN*
*----------------------------------------------------------------------
TYPE(EXCL) QMGR(*) QUEUE(*)

Note

In the list, you must separately list the queues eligible for automation from the queues that will be excluded from automation.

For each IBM MQ queue manager, BMC AMI OpsA matches the list of existing queues to the contents of the active AAOMQLxx member. It sequentially scans the AAOMQLxx member and evaluates the QMGR(queue manager name) and QUEUE(queue name) specifications until a match is found.

When a match is found BMC AMI OpsA will either include or exclude the queue based on the TYPE(INCL|EXCL) setting. If two (or more) statements overlap or conflict, the first definition encountered will be used.

Any queue not included in the AAOMQLxx member will not be eligible for automation. If you code a Rule for an excluded queue, the Rule will never fire.

The AAOMQLxx is processed:

  • At BBI-SS PAS startup
  • When the BBI commands .RESET MQ or .RESET QM are issued

For more information about BBI commands for BMC AMI Ops Automation for MQ, see BMC-AMI-Ops-Automation-for-MQ-BBI-commands.

Note

While BMC AMI OpsA has a queue opened, no other application can open exclusively or delete that queue.

Related topic

Parameters-for-BBPARM-member-AAOMQLxx

 

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