DEFINE queues
Contents
DEFINE QALIAS
Use DEFINE QALIAS to define a new alias queue, and set its parameters.
An alias queue provides a level of indirection to another queue. The queue to which the alias refers must be another local or remote queue, defined at this queue manager. It cannot be another alias queue.
Synonym: DEF QA
DEFINE QALIAS >>-DEFINE QALIAS(q-name)--+--------------------------+----------> >--+---------------------+-------+------------------+-----------> '-| define attrs |-' >--+--------------------+--+-------------------+--------------->< '-| common q attrs |-' '-| alias q attrs |-' Define attrs .-NOREPLACE-. |--+-------------------+--+-----------+-------------------------| '-LIKE(qalias-name)-' '-REPLACE---' Common q attrs .-DEFPRTY(0)-------. .-DEFPSIST(NO)------. |--+------------------+--+-------------------+------------------> '-DEFPRTY(integer)-' '-DEFPSIST(YES)-----' .-DESCR(' ')------. .-PUT(ENABLED)------. >--+-----------------+--+-------------------+-------------------| '-DESCR(string)---' '-PUT(DISABLED)-----' Alias q attrs .-CLUSNL(' ')------. .-CLUSTER(' ')---------. |--+------------------+-------+----------------------+----------> '-CLUSNL(nlname)---' '-CLUSTER(clustername)-' .-DEFBIND(OPEN)------. .-GET(ENABLED)------. >--+--------------------+-------+-------------------+-----------> '-DEFBIND(NOTFIXED)--' '-GET(DISABLED)-----' .-SCOPE(QMGR)----------. .-TARGQ(' ')------. >--+----------------------+--+-----------------+----------------| '-SCOPE(CELL)----------' '-TARGQ(string)---'
DEFINE QLOCAL
Use DEFINE QLOCAL to define a new local queue, and set its parameters.
Synonym: DEF QL
DEFINE QLOCAL >>-DEFINE QLOCAL(q-name)--+--------------------------+----------> .-QSGDISP(QMGR)--------. (5) >--+----------------------+-------+------------------+----------> | (6) | '-| define attrs |-' +-QSGDISP(COPY)--------+ | (6) | +-QSGDISP(GROUP)-------+ | (6) | '-QSGDISP(SHARED)------' >--+--------------------+--+-------------------+--------------->< '-| common q attrs |-' '-| local q attrs |-' Define attrs .-NOREPLACE-. |--+-------------------+--+-----------+-------------------------| '-LIKE(qlocal-name)-' '-REPLACE---' Common q attrs (1) (1) .-DEFPRTY(0)-------. .-DEFPSIST(NO)------. |--+------------------+--+-------------------+------------------> '-DEFPRTY(integer)-' '-DEFPSIST(YES)-----' (1) (1) .-DESCR(' ')------. .-PUT(ENABLED)------. >--+-----------------+--+-------------------+-------------------| '-DESCR(string)---' '-PUT(DISABLED)-----' Local q attrs (1) (1) .-BOQNAME(' ')------. .-BOTHRESH(0)-------. |--+-------------------+--+-------------------+-----------------> '-BOQNAME(string)---' '-BOTHRESH(integer)-' .-CFSTRUCT(' ')------------. (5) >--+--------------------------+---------------------------------> '-CFSTRUCT(structure-name)-' (1) (1) .-CLUSNL(' ')------. (2) .-CLUSTER(' ')---------. (2) >--+------------------+-------+----------------------+----------> '-CLUSNL(nlname)---' '-CLUSTER(clustername)-' (1) (7) .-DEFBIND(OPEN)------. (2) .-DEFSOPT(SHARED)------. >--+--------------------+-------+----------------------+--------> '-DEFBIND(NOTFIXED)--' '-DEFSOPT(EXCL)--------' (1) (1) .-DISTL(NO)------. (8) .-GET(ENABLED)------. >--+----------------+-------+-------------------+---------------> '-DISTL(YES)-----' '-GET(DISABLED)-----' (1) (1) .-NOHARDENBO------. .-INDXTYPE(NONE)-----------. (5) >--+-----------------+--+--------------------------+------------> '-HARDENBO--------' '-INDXTYPE(-+-MSGID----+-)-' +-CORRELID-+ +-GROUPID--+ '-MSGTOKEN-' (1) (9) .-INITQ(' ')------. .-MAXDEPTH(5000)------. >--+-----------------+--+---------------------+-----------------> '-INITQ(string)---' '-MAXDEPTH(integer)---' (1) (1) .-MAXMSGL(4 194 304)------. .-MSGDLVSQ(PRIORITY)------. >--+-------------------------+--+-------------------------+-----> '-MAXMSGL(integer)--------' '-MSGDLVSQ(FIFO)----------' (1) (1) .-PROCESS(' ')------. .-QDEPTHHI(80)------. >--+-------------------+--+-------------------+-----------------> '-PROCESS(string)---' '-QDEPTHHI(integer)-' (1) (1) .-QDEPTHLO(40)------. .-QDPHIEV(DISABLED)------. >--+-------------------+--+------------------------+------------> '-QDEPTHLO(integer)-' '-QDPHIEV(ENABLED)-------' (1) (1) .-QDPLOEV(DISABLED)------. .-QDPMAXEV(ENABLED)------. >--+------------------------+--+------------------------+-------> '-QDPLOEV(ENABLED)-------' '-QDPMAXEV(DISABLED)-----' (1) (1) .-QSVCIEV(NONE)-------. .-QSVCINT(999 999 999)------. >--+---------------------+--+---------------------------+-------> '-QSVCIEV(-+-HIGH-+-)-' '-QSVCINT(integer)----------' '-OK---' (1) (3) (1) .-RETINTVL(999 999 999)------. .-SCOPE(QMGR)----------. >--+----------------------------+--+----------------------+-----> '-RETINTVL(integer)----------' | (4) | '-SCOPE(CELL)----------' (10) (1) .-SHARE-------. .-STGCLASS('DEFAULT')------. (5) >--+-------------+--+--------------------------+----------------> '-NOSHARE-----' '-STGCLASS(string)---------' (1) (1) .-TRIGDATA(' ')------. .-TRIGDPTH(1)-------. >--+--------------------+--+-------------------+----------------> '-TRIGDATA(string)---' '-TRIGDPTH(integer)-' (1) (1) .-NOTRIGGER------. .-TRIGMPRI(0)-------. >--+----------------+--+-------------------+--------------------> '-TRIGGER--------' '-TRIGMPRI(integer)-' (1) (1) .-TRIGTYPE(FIRST)-------. .-USAGE(NORMAL)------. >--+-----------------------+--+--------------------+------------| '-TRIGTYPE(-+-EVERY-+-)-' '-USAGE(XMITQ)-------' +-DEPTH-+ '-NONE--'
Notes:
- This is the default supplied with WebSphere MQ, but your installation might have changed it.
- Valid only on AIX, Compaq OpenVMS, HP-UX, Linux, OS/2 Warp, OS/400, Solaris, Windows, and z/OS.
- Valid only on Compaq OpenVMS, OS/2 Warp, OS/400, UNIX systems, and Windows.
- Valid only on Compaq OpenVMS, OS/2 Warp, UNIX systems, and Windows.
- Used only on z/OS.
- Valid only on full function WebSphere MQ for z/OS when the queue manager is a member of a queue-sharing group.
- This is the default supplied with WebSphere MQ (except on z/OS, where it is EXCL), but your installation might have changed it.
- Valid only on AIX, Compaq OpenVMS, HP-UX, Linux, OS/2 Warp, OS/400, Solaris, and Windows.
- This is the default supplied with WebSphere MQ (except on z/OS, where it is 999 999 999), but your installation might have changed it.
- This is the default supplied with WebSphere MQ (except on z/OS, where it is NOSHARE), but your installation might have changed it.
DEFINE QMODEL
Use DEFINE QMODEL to define a new model queue, and set its parameters.
A model queue is not a real queue, but a collection of attributes that you can use when creating dynamic queues with the MQOPEN API call.
When it has been defined, a model queue (like any other queue) has a complete set of applicable attributes, even if some of these are defaults.
Synonym: DEF QM
DEFINE QMODEL >>-DEFINE QMODEL(q-name)--+--------------------------+----------> .-QSGDISP(QMGR)-------. (1) >--+---------------------+-------+------------------+-----------> | (2) | '-| define attrs |-' +-QSGDISP(COPY)-------+ | (2) | '-QSGDISP(GROUP)------' >--+--------------------+--+-------------------+----------------> '-| common q attrs |-' '-| local q attrs |-' >--+------------------+---------------------------------------->< '-| model q attr |-' Define attrs .-NOREPLACE-. |--+-------------------+--+-----------+-------------------------| '-LIKE(qmodel-name)-' '-REPLACE---' Common q attrs (3) (3) .-DEFPRTY(0)-------. .-DEFPSIST(NO)------. |--+------------------+--+-------------------+------------------> '-DEFPRTY(integer)-' '-DEFPSIST(YES)-----' (3) (3) .-DESCR(' ')------. .-PUT(ENABLED)------. >--+-----------------+--+-------------------+-------------------| '-DESCR(string)---' '-PUT(DISABLED)-----' Local q attrs (3) (3) .-BOQNAME(' ')------. .-BOTHRESH(0)-------. |--+-------------------+--+-------------------+-----------------> '-BOQNAME(string)---' '-BOTHRESH(integer)-' (1) (3) .-CFSTRUCT(' ')-----------------. .-DEFSOPT(EXCL)------. >--+-------------------------------+--+--------------------+----> | (1) | '-DEFSOPT(SHARED)----' '-CFSTRUCT(structure-name)------' (3) (3) .-DISTL(NO)------. (4) .-GET(ENABLED)------. >--+----------------+-------+-------------------+---------------> '-DISTL(YES)-----' '-GET(DISABLED)-----' (3) (3) .-NOHARDENBO------. .-INDXTYPE(NONE)-----------. (1) >--+-----------------+--+--------------------------+------------> '-HARDENBO--------' '-INDXTYPE(-+-MSGID----+-)-' +-CORRELID-+ +-GROUPID--+ '-MSGTOKEN-' (3) (5) .-INITQ(' ')------. .-MAXDEPTH(5000)------. >--+-----------------+--+---------------------+-----------------> '-INITQ(string)---' '-MAXDEPTH(integer)---' (3) (3) .-MAXMSGL(4 194 304)------. .-MSGDLVSQ(PRIORITY)------. >--+-------------------------+--+-------------------------+-----> '-MAXMSGL(integer)--------' '-MSGDLVSQ(FIFO)----------' (3) (3) .-PROCESS(' ')------. .-QDEPTHHI(80)------. >--+-------------------+--+-------------------+-----------------> '-PROCESS(string)---' '-QDEPTHHI(integer)-' (3) (3) .-QDEPTHLO(40)------. .-QDPHIEV(DISABLED)------. >--+-------------------+--+------------------------+------------> '-QDEPTHLO(integer)-' '-QDPHIEV(ENABLED)-------' (3) (3) .-QDPLOEV(DISABLED)------. .-QDPMAXEV(ENABLED)------. >--+------------------------+--+------------------------+-------> '-QDPLOEV(ENABLED)-------' '-QDPMAXEV(DISABLED)-----' (3) (3) .-QSVCIEV(NONE)-------. .-QSVCINT(999 999 999)------. >--+---------------------+--+---------------------------+-------> '-QSVCIEV(-+-HIGH-+-)-' '-QSVCINT(integer)----------' '-OK---' (3) (3) .-RETINTVL(999 999 999)------. .-NOSHARE------. >--+----------------------------+--+--------------+-------------> '-RETINTVL(integer)----------' '-SHARE--------' (3) (3) .-STGCLASS('DEFAULT')------. (1) .-TRIGDATA(' ')------. >--+--------------------------+-------+--------------------+----> '-STGCLASS(string)---------' '-TRIGDATA(string)---' (3) (3) .-TRIGDPTH(1)-------. .-NOTRIGGER------. >--+-------------------+--+----------------+--------------------> '-TRIGDPTH(integer)-' '-TRIGGER--------' (3) (3) .-TRIGMPRI(0)-------. .-TRIGTYPE(FIRST)-------. >--+-------------------+--+-----------------------+-------------> '-TRIGMPRI(integer)-' '-TRIGTYPE(-+-EVERY-+-)-' +-DEPTH-+ '-NONE--' (3) .-USAGE(NORMAL)------. >--+--------------------+---------------------------------------| '-USAGE(XMITQ)-------' Model q attr (3) .-DEFTYPE(TEMPDYN)-------. |--+------------------------+-----------------------------------| +-DEFTYPE(PERMDYN)-------+ | (1) | '-DEFTYPE(SHAREDYN)------'
Notes:
- Used only on z/OS.
- Valid only on full function WebSphere MQ for z/OS when the queue manager is a member of a queue-sharing group.
- This is the default supplied with WebSphere MQ, but your installation might have changed it.
- Valid only on AIX, Compaq OpenVMS, HP-UX, Linux, OS/2 Warp, OS/400, Solaris, and Windows.
- This is the default supplied with WebSphere MQ (except on z/OS, where it is 999 999 999), but your installation might have changed it.
DEFINE QREMOTE
Use DEFINE QREMOTE to define a new local definition of a remote queue, a queue manager alias, or a reply-to queue alias, and to set its parameters.
A remote queue is one that is owned by another queue manager that application processes connected to this queue manager need to access.
Synonym: DEF QR
DEFINE QREMOTE >>-DEFINE QREMOTE(q-name)--+--------------------------+---------> .-QSGDISP(QMGR)-------. (5) >--+---------------------+-------+------------------+-----------> | (6) | '-| define attrs |-' +-QSGDISP(COPY)-------+ | (6) | '-QSGDISP(GROUP)------' >--+--------------------+--+--------------------+-------------->< '-| common q attrs |-' '-| remote q attrs |-' Define attrs .-NOREPLACE-. |--+--------------------+--+-----------+------------------------| '-LIKE(qremote-name)-' '-REPLACE---' Common q attrs (1) (1) .-DEFPRTY(0)-------. .-DEFPSIST(NO)------. |--+------------------+--+-------------------+------------------> '-DEFPRTY(integer)-' '-DEFPSIST(YES)-----' (1) (1) .-DESCR(' ')------. .-PUT(ENABLED)------. >--+-----------------+--+-------------------+-------------------| '-DESCR(string)---' '-PUT(DISABLED)-----' Remote q attrs (1) (1) .-CLUSNL(' ')------. (2) .-CLUSTER(' ')---------. (2) |--+------------------+-------+----------------------+----------> '-CLUSNL(nlname)---' '-CLUSTER(clustername)-' (1) (1) .-DEFBIND(OPEN)------. (2) .-RNAME(' ')------. >--+--------------------+-------+-----------------+-------------> '-DEFBIND(NOTFIXED)--' '-RNAME(string)---' (1) (3) (1) .-RQMNAME(' ')------. .-SCOPE(QMGR)----------. >--+-------------------+--+----------------------+--------------> '-RQMNAME(string)---' | (4) | '-SCOPE(CELL)----------' (1) .-XMITQ(' ')------. >--+-----------------+------------------------------------------| '-XMITQ(string)---'
Notes:
- This is the default supplied with WebSphere MQ, but your installation might have changed it.
- Valid only on AIX, Compaq OpenVMS, HP-UX, Linux, OS/2 Warp, OS/400, Solaris, Windows, and z/OS.
- Valid only on Compaq OpenVMS, OS/2 Warp, OS/400, UNIX systems, and Windows.
- Valid only on Compaq OpenVMS, OS/2 Warp, UNIX systems, and Windows.
- Valid only on z/OS.
- Valid only on full function WebSphere MQ for z/OS when the queue manager is a member of a queue-sharing group.
Parameter descriptions
The parameter descriptions also apply to the ALTER QUEUE commands, with the following exceptions:
- The FORCE parameter applies only to the ALTER QUEUE commands.
- The LIKE parameter applies only to the DEFINE QUEUE commands.
- The REPLACE and NOREPLACE parameter applies only to the DEFINE QUEUE commands.
- The variations in the CMDSCOPE and QSGDISP parameters between the ALTER QUEUE and DEFINE QUEUE commands are described.
(q-name)
- Local name of the queue, except the remote queue where it is the local definition of the remote queue. Required.
The name must not be the same as any other queue name (of whatever queue type) currently defined on this queue manager (unless REPLACE or ALTER is specified). See Rules for naming WebSphere MQ objects.
BOQNAME(string)
- Backout requeue name.
This parameter is supported only on local and model queues.
Apart from maintaining a value for this parameter, the queue manager takes no action based on its value.
BOTHRESH(integer)
- The backout threshold.
This parameter is supported only on local and model queues.
Apart from maintaining a value for this parameter, the queue manager takes no action based on its value.
Specify a value in the range zero through 999 999 999.
CFSTRUCT(structure-name)
- Specifies the name of the Coupling Facility structure where you want messages stored when you use shared queues.
This parameter is supported only on z/OS for local and model queues.
The name:
- Cannot have more than 12 characters
- Must start with an uppercase letter (A through Z)
- Can include only the characters A through Z and 0 through 9
The name of the queue-sharing group to which the queue manager is connected is prefixed to the name you supply. The name of the queue-sharing group is always four characters, padded with @ symbols if necessary. For example, if you use a queue-sharing group named NY03 and you supply the name PRODUCT7, the resultant Coupling Facility structure name is NY03PRODUCT7. Note that the administrative structure for the queue-sharing group (in this case NY03CSQ_ADMIN) cannot be used for storing messages.
For ALTER QLOCAL, ALTER QMODEL, DEFINE QLOCAL with REPLACE, and DEFINE QMODEL with REPLACE the following rules apply:
- On a local queue with QSGDISP(SHARED), CFSTRUCT cannot change.
To change either the CFSTRUCT or QSGDISP value delete and redefine the queue. To preserve any of the messages on the queue off-load the messages before you delete the queue and reload the messages after you have redefined the queue, or move the messages to another queue.
- On a model queue with DEFTYPE(SHAREDYN), CFSTRUCT cannot be blank.
- On a local queue with a QSGDISP other than SHARED, or a model queue with a DEFTYPE other than SHAREDYN, the value of CFSTRUCT does not matter.
For DEFINE QLOCAL with NOREPLACE and DEFINE QMODEL with NOREPLACE, the Coupling Facility structure:
- On a local queue with QSGDISP(SHARED) or a model queue with a DEFTYPE(SHAREDYN), CFSTRUCT cannot be blank.
- On a local queue with a QSGDISP other than SHARED, or a model queue with a DEFTYPE other than SHAREDYN, the value of CFSTRUCT does not matter.
Note:
- Before you can use the queue, the structure must be defined in the Coupling Facility Resource Management (CFRM) policy data set.
CLUSNL(nlname)
- The name of the namelist that specifies a list of clusters to which the queue belongs.
This parameter is supported only on alias, local, and remote queues.
Changes to this parameter do not affect instances of the queue that are already open.
Only one of the resultant values of CLUSTER or CLUSNL can be nonblank; you cannot specify a value for both.
On local queues, this parameter cannot be set for transmission, SYSTEM.CHANNEL.xx, SYSTEM.CLUSTER.xx, or SYSTEM.COMMAND.xx queues, and on z/OS only, for SYSTEM.QSG.xx queues.
This parameter is valid only on AIX, Compaq OpenVMS, HP-UX, Linux, OS/2 Warp, Solaris, Windows, and z/OS.
Note:
- This parameter must be blank within the reduced function form of WebSphere MQ for z/OS supplied with WebSphere Application Server.
CLUSTER(clustername)
- The name of the cluster to which the queue belongs.
This parameter is supported only on alias, local, and remote queues.
The maximum length is 48 characters conforming to the rules for naming WebSphere MQ objects. Changes to this parameter do not affect instances of the queue that are already open.
Only one of the resultant values of CLUSNL or CLUSTER can be nonblank; you cannot specify a value for both.
On local queues, this parameter cannot be set for transmission, SYSTEM.CHANNEL.xx, SYSTEM.CLUSTER.xx, or SYSTEM.COMMAND.xx queues, and on z/OS only, for SYSTEM.QSG.xx queues.
This parameter is valid only on AIX, Compaq OpenVMS, HP-UX, Linux, OS/2 Warp, OS/400, Solaris, Windows, and z/OS.
Note:
- This parameter must be blank within the reduced function form of WebSphere MQ for z/OS supplied with WebSphere Application Server.
CMDSCOPE
- This parameter applies to z/OS only and specifies how the command is executed when the queue manager is a member of a queue-sharing group.
CMDSCOPE must be blank, or the local queue manager, if QSGDISP is set to GROUP or SHARED.
' '
- The command is executed on the queue manager on which it was entered. This is the default value.
qmgr-name
- The command is executed on the queue manager you specify, providing the queue manager is active within the queue-sharing group.
You can specify a queue manager name, other than the queue manager on which the command was entered, only if you are using a queue-sharing group environment and if the command server is enabled.
*
- The command is executed on the local queue manager and is also passed to every active queue manager in the queue-sharing group. The effect of this is the same as entering the command on every queue manager in the queue-sharing group.
DEFBIND
- Specifies the binding to be used when the application specifies MQOO_BIND_AS_Q_DEF on the MQOPEN call, and the queue is a cluster queue.
OPEN
- The queue handle is bound to a specific instance of the cluster queue when the queue is opened.
NOTFIXED
- The queue handle is not bound to any particular instance of the cluster queue. This allows the queue manager to select a specific queue instance when the message is put using MQPUT, and to change that selection subsequently should the need arise.
The MQPUT1 call always behaves as if NOTFIXED had been specified.
This parameter is valid only on AIX, Compaq OpenVMS, HP-UX, Linux, OS/2 Warp, OS/400, Solaris, Windows, and z/OS.
DEFPRTY(integer)
- The default priority of messages put on the queue. The value must be in the range zero, (the lowest priority) through to the MAXPRTY queue manager parameter. (MAXPRTY is 9.)
DEFPSIST
- Specifies the message persistence to be used when applications specify the MQPER_PERSISTENCE_AS_Q_DEF option.
NO
- Messages on this queue are lost across a restart of the queue manager. This is the default supplied with WebSphere MQ, but your installation might have changed it.
YES
- Messages on this queue survive a restart of the queue manager.
On z/OS, N and Y are accepted as synonyms of NO and YES.
DEFSOPT
- The default share option for applications opening this queue for input:
EXCL
- The open request is for exclusive input from the queue
SHARED
- The open request is for shared input from the queue
DEFTYPE
- Queue definition type.
This parameter is supported only on model queues.
PERMDYN
- A permanent dynamic queue is created when an application issues an MQOPEN MQI call with the name of this model queue specified in the object descriptor (MQOD).
On z/OS, the dynamic queue has a disposition of QMGR.
SHAREDYN
- This option is available on z/OS only.
A permanent dynamic queue is created when an application issues an MQOPEN API call with the name of this model queue specified in the object descriptor (MQOD).
The dynamic queue has a disposition of SHARED.
TEMPDYN
- A temporary dynamic queue is created when an application issues an MQOPEN API call with the name of this model queue specified in the object descriptor (MQOD).
On z/OS, the dynamic queue has a disposition of QMGR.
Do not specify this value for a model queue definition with a DEFPSIST parameter of YES.
If you specify this option, do not specify INDXTYPE(MSGTOKEN).
DESCR(string)
- Plain-text comment. It provides descriptive information about the object when an operator issues the DISPLAY QUEUE command.
It should contain only displayable characters. The maximum length is 64 characters. In a DBCS installation, it can contain DBCS characters (subject to a maximum length of 64 bytes).
Note:
- If characters are used that are not in the coded character set identifier (CCSID) for this queue manager, they might be translated incorrectly if the information is sent to another queue manager.
DISTL
- Whether distribution lists are supported by the partner queue manager.
YES
- Distribution lists are supported by the partner queue manager.
NO
- Distribution lists are not supported by the partner queue manager.
Note:
- You should not normally change this parameter, because it is set by the MCA. However you can set this parameter when defining a transmission queue if the distribution list capability of the destination queue manager is known.
This parameter is valid only on AIX, Compaq OpenVMS, HP-UX, Linux, OS/2 Warp, OS/400, Solaris, and Windows.
FORCE
- This parameter applies only to the ALTER command on alias, local and remote queues.
Specify this parameter to force completion of the command in the following circumstances.
For an alias queue, if both of the following are true:
- The TARGQ parameter is specified
- An application has this alias queue open
For a local queue, if both of the following are true:
- The NOSHARE parameter is specified
- One or more applications have the queue open for input
FORCE is also needed if both of the following are true:
- The USAGE parameter is changed
- Either one or more messages are on the queue, or one or more applications have the queue open
Do not change the USAGE parameter while there are messages on the queue; the format of messages changes when they are put on a transmission queue.
For a remote queue if both of the following are true:
- The XMITQ parameter is changed
- One or more applications has this queue open as a remote queue
FORCE is also needed if both of the following are true:
- Any of the RNAME, RQMNAME, or XMITQ parameters are changed
- One or more applications has a queue open that resolved through this definition as a queue manager alias
Note:
- FORCE is not required if this definition is in use as a reply-to queue alias only.
If FORCE is not specified in the circumstances described, the command is unsuccessful.
GET
- Whether applications are to be permitted to get messages from this queue:
ENABLED
- Messages can be retrieved from the queue (by suitably authorized applications). This is the default supplied with WebSphere MQ, but your installation might have changed it.
DISABLED
- Applications cannot retrieve messages from the queue.
This parameter can also be changed using the MQSET API call.
HARDENBO and NOHARDENBO
- Whether hardening should be used to ensure that the count of the number of times that a message has been backed out is accurate.
This parameter is supported only on local and model queues.
HARDENBO
- The count is hardened.
NOHARDENBO
- The count is not hardened. This is the default supplied with WebSphere MQ, but your installation might have changed it.
Note:
- On MQSeries for Compaq NonStop Kernel, this parameter is ignored. The backout count of a message is always hardened for persistent messages, and never hardened for non-persistent messages.
INDXTYPE
- The type of index maintained by the queue manager to expedite MQGET operations on the queue:
This parameter is supported only on local and model queues.
NONE
- No index is maintained. Use this when messages are usually retrieved sequentially or use both the message identifier and the correlation identifier as a selection criterion on the MQGET call.
MSGID
- An index of message identifiers is maintained. Use this when messages are usually retrieved using the message identifier as a selection criterion on the MQGET call with the correlation identifier set to NULL.
CORRELID
- An index of correlation identifiers is maintained. Use this when messages are usually retrieved using the correlation identifier as a selection criterion on the MQGET call with the message identifier set to NULL.
GROUPID
- An index of group identifiers is maintained. Use this when messages need to be retrieved using message grouping selection criteria.
Notes:
MSGTOKEN
- An index of message tokens is maintained. Use this when the queue is a WLM-managed queue that you are using with the Workload Manager functions of z/OS.
Note:
- You cannot set INDXTYPE to MSGTOKEN if:
- The queue is a model queue with a definition type of SHAREDYN
- The queue is a temporary dynamic queue
- The queue is a transmission queue
- You specify QSGDISP(SHARED)
If you are altering or replacing an existing local queue, you can change the INDXTYPE parameter only in the cases indicated in the following table:
Queue type NON-SHARED SHARED Queue state Uncommitted activity No uncommitted activity, messages present No uncommitted activity, and empty Open or messages present Not open, and empty Change INDXTYPE from: To: NONE MSGID No Yes Yes No Yes NONE CORRELID No Yes Yes No Yes NONE MSGTOKEN No No Yes - - NONE GROUPID No No Yes No Yes MSGID NONE No Yes Yes No Yes MSGID CORRELID No Yes Yes No Yes MSGID MSGTOKEN No No Yes - - MSGID GROUPID No No Yes No Yes CORRELID NONE No Yes Yes No Yes CORRELID MSGID No Yes Yes No Yes CORRELID MSGTOKEN No No Yes - - CORRELID GROUPID No No Yes No Yes MSGTOKEN NONE No Yes Yes - - MSGTOKEN MSGID No Yes Yes - - MSGTOKEN CORRELID No Yes Yes - - MSGTOKEN GROUPID No No Yes - - GROUPID NONE No No Yes No Yes GROUPID MSGID No No Yes No Yes GROUPID CORRELID No No Yes No Yes GROUPID MSGTOKEN No No Yes - - This parameter is supported only on z/OS. On other platforms, retrieval optimization might be provided, but it is not controlled by a queue parameter.
INITQ(string)
- The local name of a local queue (known as the initiation queue) on this queue manager, to which trigger messages relating to this queue are written. See Rules for naming WebSphere MQ objects.
This parameter is supported only on local and model queues.
LIKE(qtype-name)
- The name of a queue, whose parameters will be used to model this definition.
This parameter applies only to the appropriate DEFINE Queue command.
If this field is not filled in, and you do not complete the parameter fields related to the command, the values are taken from one of the following, depending upon the queue type:
SYSTEM.DEFAULT.ALIAS.QUEUE Alias queue SYSTEM.DEFAULT.LOCAL.QUEUE Local queue SYSTEM.DEFAULT.MODEL.QUEUE Model queue SYSTEM.DEFAULT.REMOTE.QUEUE Remote queue
This is equivalent to defining the following object:
LIKE(SYSTEM.DEFAULT.ALIAS.QUEUE)for an alias queue, and similarly for other queue types.
These default queue definitions can be altered by the installation to the default values required.
On WebSphere MQ for z/OS, the queue manager searches page set zero for an object with the name you specify. If the object is not found, the queue manager then searches the shared repository. The disposition of the LIKE object is not copied to the object you are defining.
Notes:
- QSGDISP (GROUP) objects are not searched.
- LIKE is ignored if QSGDISP(COPY) is specified.
MAXDEPTH(integer)
- The maximum number of messages allowed on the queue.
This parameter is supported only on local and model queues.
On AIX, Compaq OpenVMS, HP-UX, Linux, OS/400, Solaris, Windows, and z/OS, specify a value in the range zero through 999 999 999.
On any other WebSphere MQ platform, specify a value in the range zero through 640 000.
Other factors can still cause the queue to be treated as full, for example, if there is no further DASD space available.
If this value is reduced, any messages that are already on the queue that exceed the new maximum remain intact.
MAXMSGL(integer)
- The maximum length (in bytes) of messages on this queue.
This parameter is supported only on local and model queues.
On AIX, Compaq OpenVMS, HP-UX, Linux, OS/2 Warp, OS/400, Solaris, and Windows, specify a value in the range zero through to the maximum message length for the queue manager. See the MAXMSGL parameter of the ALTER QMGR command for more information.
On z/OS, specify a value in the range zero through 100 MB. However, if you also specify QSGDISP(SHARED), or DEFTYPE(SHAREDYN), the MAXMSGL must be in the range zero through 64 512 bytes.
On other platforms, specify a value in the range zero through 4 194 304 bytes (4 MB).
For a transmission queue, this value includes the space required for headers. It is recommended that the value should be at least 4000 bytes larger than the maximum expected length of user data in any message that could be put on a transmission queue.
If this value is reduced, any messages that are already on the queue whose length exceeds the new maximum are not affected.
Applications can use this parameter to determine the size of buffer they need to retrieve messages from the queue. Therefore, the value should only be reduced if it is known that this will not cause an application to operate incorrectly.
MSGDLVSQ
- Message delivery sequence.
This parameter is supported only on local and model queues.
PRIORITY
- Messages are delivered (in response to MQGET API calls) in first-in-first-out (FIFO) order within priority. This is the default supplied with WebSphere MQ, but your installation might have changed it.
FIFO
- Messages are delivered (in response to MQGET API calls) in FIFO order. Priority is ignored for messages on this queue.
If the message delivery sequence is changed from PRIORITY to FIFO while there are messages on the queue, the order of the messages already on the queue is not changed. Messages added to the queue subsequently take the default priority of the queue, and so might be processed before some of the existing messages.
If the message delivery sequence is changed from FIFO to PRIORITY, the messages put on the queue while the queue was set to FIFO take the default priority.
Note:
- If INDXTYPE(GROUPID) is specified with MSGDLVSQ(PRIORITY), the priority in which groups are retrieved is based on the priority of the first message within each group. The priorities zero and one are used by the queue manager to optimize the retrieval of messages in logical order, thus the first message in each group should not use these priorities. If it does, the message is stored as if it was priority two.
PROCESS(string)
- The local name of the WebSphere MQ process.
This parameter is supported only on local and model queues.
Name of a process instance that identifies the application started by the queue manager when a trigger event occurs. See Rules for naming WebSphere MQ objects.
The process does not have to be defined when the local queue is defined, but it must be available for a trigger event to occur.
If the queue is a transmission queue, the process gives the name of the channel to be started. This parameter is optional for transmission queues on AIX, Compaq OpenVMS, HP-UX, Linux, OS/2 Warp, OS/400, Solaris, Windows, and z/OS; if you do not specify it, the channel name is taken from the value specified for the TRIGDATA parameter.
PUT
- Whether messages can be put on the queue.
ENABLED
- Messages can be added to the queue (by suitably authorized applications). This is the default supplied with WebSphere MQ, but your installation might have changed it.
DISABLED
- Messages cannot be added to the queue.
This parameter can also be changed using the MQSET API call.
QDEPTHHI(integer)
- The threshold against which the queue depth is compared to generate a Queue Depth High event.
This parameter is supported only on local and model queues. For more information about the effect that shared queues on z/OS have on this event, see the WebSphere MQ Event Monitoring book.
This event indicates that an application has put a message on a queue, and this has caused the number of messages on the queue to become greater than or equal to the queue depth high threshold. See the QDPHIEV parameter.
The value is expressed as a percentage of the maximum queue depth (MAXDEPTH parameter), and must be greater than or equal to zero, and less than or equal to 100.
QDEPTHLO(integer)
- The threshold against which the queue depth is compared to generate a Queue Depth Low event.
This parameter is supported only on local and model queues. For more information about the effect that shared queues on z/OS have on this event, see the WebSphere MQ Event Monitoring book.
This event indicates that an application has retrieved a message from a queue, and this has caused the number of messages on the queue to become less than or equal to the queue depth low threshold. See the QDPLOEV parameter.
The value is expressed as a percentage of the maximum queue depth (MAXDEPTH parameter), and must be in the range zero through 100.
QDPHIEV
- Controls whether Queue Depth High events are generated.
This parameter is supported only on local and model queues.
A Queue Depth High event indicates that an application has put a message on a queue, and this has caused the number of messages on the queue to become greater than or equal to the queue depth high threshold (see the QDEPTHHI parameter).
Note:
- The value of this parameter can change implicitly. For more information on this, and the effect that shared queues on z/OS have on this event, see the description of the Queue Depth High event in the WebSphere MQ Event Monitoring book.
ENABLED
- Queue Depth High events are generated
DISABLED
- Queue Depth High events are not generated
QDPLOEV
- Controls whether Queue Depth Low events are generated.
This parameter is supported only on local and model queues.
A Queue Depth Low event indicates that an application has retrieved a message from a queue, and this has caused the number of messages on the queue to become less than or equal to the queue depth low threshold (see the QDEPTHLO parameter).
Note:
- The value of this parameter can change implicitly. For more information on this, and the effect that shared queues on z/OS have on this event, see the description of the Queue Depth Low event in the WebSphere MQ Event Monitoring book.
ENABLED
- Queue Depth Low events are generated
DISABLED
- Queue Depth Low events are not generated
QDPMAXEV
- Controls whether Queue Full events are generated.
This parameter is supported only on local and model queues.
A Queue Full event indicates that a put to a queue has been rejected because the queue is full, that is, the queue depth has already reached its maximum value.
Note:
- The value of this parameter can change implicitly. For more information on this, and the effect that shared queues on z/OS have on this event, see the description of the Queue Full event in the WebSphere MQ Event Monitoring book.
ENABLED
- Queue Full events are generated
DISABLED
- Queue Full events are not generated
QSGDISP
- This parameter applies to z/OS only.
Specifies the disposition of the object within the group.
QSGDISP ALTER DEFINE COPY The object definition resides on the page set of the queue manager that executes the command. The object was defined using a command that had the parameters QSGDISP(COPY). Any object residing in the shared repository, or any object defined using a command that had the parameters QSGDISP(QMGR), is not affected by this command. The object is defined on the page set of the queue manager that executes the command using the QSGDISP(GROUP) object of the same name as the 'LIKE' object. For local queues, messages are stored on the page sets of each queue manager and are available only through that queue manager.
GROUP The object definition resides in the shared repository. The object was defined using a command that had the parameters QSGDISP(GROUP). Any object residing on the page set of the queue manager that executes the command (except a local copy of the object), or any object defined using a command that had the parameters QSGDISP(SHARED), is not affected by this command.
If the command is successful, the following command is generated and sent to all active queue managers in the queue-sharing group to refresh local copies on page set zero:DEFINE QUEUE(q-name) REPLACE QSGDISP(COPY)The object definition resides in the shared repository. This is allowed only if there is a shared queue manager environment.
If the definition is successful, the following command is generated and sent to all active queue managers to make or refresh local copies on page set zero:DEFINE QUEUE(q-name) REPLACE QSGDISP(COPY)PRIVATE The object resides on the page set of the queue manager that executes the command, and was defined with QSGDISP(QMGR) or QSGDISP(COPY).
Any object residing in the shared repository is unaffected.Not permitted. QMGR The object definition resides on the page set of the queue manager that executes the command. The object was defined using a command that had the parameters QSGDISP(QMGR). Any object residing in the shared repository, or any local copy of such an object, is not affected by this command.
This is the default value.The object is defined on the page set of the queue manager that executes the command. This is the default value.
For local queues, messages are stored on the page sets of each queue manager and are available only through that queue manager.SHARED This value applies only to local queues.
The object definition resides in the shared repository. The object was defined using a command that had the parameters QSGDISP(SHARED). Any object residing on the page set of the queue manager that executes the command, or any object defined using a command that had the parameters QSGDISP(GROUP), is not affected by this command.
If the queue is clustered, a command is generated and sent to all active queue managers in the queue-sharing group to notify them of this clustered, shared queue.This option applies only to local queues.
The object is defined in the shared repository. Messages are stored in the Coupling Facility and are available to any queue manager in the queue-sharing group. You can specify SHARED only if:
- CFSTRUCT is nonblank
- INDXTYPE is not MSGTOKEN
- The queue is not one of the following:
- SYSTEM.CHANNEL.INITQ
- SYSTEM.CHANNEL.SEQNO
- SYSTEM.CHANNEL.COMMAND
- SYSTEM.COMMAND.INPUT
If the queue is clustered, a command is generated and sent to all active queue managers in the queue-sharing group to notify them of this clustered, shared queue.
QSVCIEV
- Controls whether Service Interval High or Service Interval OK events are generated.
This parameter is supported only on local and model queues and has no effect if it is specified on a shared queue.
A Service Interval High event is generated when a check indicates that no messages have been retrieved from the queue for at least the time indicated by the QSVCINT parameter.
A Service Interval OK event is generated when a check indicates that messages have been retrieved from the queue within the time indicated by the QSVCINT parameter.
Note:
- The value of this parameter can change implicitly. For more information, see the description of the Service Interval High and Service Interval OK events in the WebSphere MQ Event Monitoring book.
HIGH
- Service Interval High events are generated
OK
- Service Interval OK events are generated
NONE
- No service interval events are generated
QSVCINT(integer)
- The service interval used for comPARISon to generate Service Interval High and Service Interval OK events.
This parameter is supported only on local and model queues and has no effect if it is specified on a shared queue.
See the QSVCIEV parameter.
The value is in units of milliseconds, and must bein the range zero through 999 999 999.
REPLACE and NOREPLACE
- This option controls whether any existing definition (and on WebSphere MQ for z/OS of the same disposition) is to be replaced with this one. Any object with a different disposition is not changed. The default is NOREPLACE.
REPLACE
- If the object does exist, the effect is similar to issuing the ALTER command without the FORCE option and with all the other parameters specified. In particular, note that any messages that are on the existing queue are retained.
(The difference between the ALTER command without the FORCE option, and the DEFINE command with the REPLACE option, is that ALTER does not change unspecified parameters, but DEFINE with REPLACE sets all the parameters. When you use REPLACE, unspecified parameters are taken either from the object named on the LIKE option, or from the default definition, and the parameters of the object being replaced, if one exists, are ignored.)
The command fails if both of the following are true:
- The command sets parameters that would require the use of the FORCE option if you were using the ALTER command
- The object is open
The ALTER command with the FORCE option succeeds in this situation.
If SCOPE(CELL) is specified on Compaq OpenVMS, UNIX systems, OS/2 Warp, or Windows, and there is already a queue with the same name in the cell directory, the command fails, whether or not REPLACE is specified.
NOREPLACE
- The definition should not replace any existing definition of the object.
RETINTVL(integer)
- The number of hours from the queue creation date and time (the date and time at which the queue was defined), after which the queue is no longer needed. The value must be in the range zero through 999 999 999.
This parameter is supported only on local and model queues.
The CRDATE and CRTIME can be displayed using the DISPLAY QUEUE command.
This information is available for use by an operator or a housekeeping application to delete queues that are no longer required.
Note:
- The queue manager does not delete queues based on this value, nor does it prevent queues from being deleted if their retention interval has not expired. It is the user's responsibility to take any required action.
RNAME(string)
- Name of remote queue. This is the local name of the queue as defined on the queue manager specified by RQMNAME.
This parameter is supported only on remote queues.
- If this definition is used for a local definition of a remote queue, RNAME must not be blank when the open occurs.
- If this definition is used for a queue manager alias definition, RNAME must be blank when the open occurs.
- If this definition is used for a reply-to alias, this name is the name of the queue that is to be the reply-to queue.
The name is not checked to ensure that it contains only those characters normally allowed for queue names (see Rules for naming WebSphere MQ objects).
RQMNAME(string)
- The name of the remote queue manager on which the queue RNAME is defined.
This parameter is supported only on remote queues.
- If an application opens the local definition of a remote queue, RQMNAME must not be blank or the name of the local queue manager. When the open occurs, if XMITQ is blank there must be a local queue of this name, which is to be used as the transmission queue.
- If this definition is used for a queue manager alias, RQMNAME is the name of the queue manager that is being aliased. It can be the name of the local queue manager. Otherwise, if XMITQ is blank, when the open occurs there must be a local queue of this name, which is to be used as the transmission queue.
- If this definition is used for a reply-to alias, this name is the name of the queue manager that is to be the reply-to queue manager.
The name is not checked to ensure that it contains only those characters normally allowed for WebSphere MQ object names (see Rules for naming WebSphere MQ objects).
SCOPE
- Specifies the scope of the queue definition.
This parameter is supported only on alias, local, and remote queues.
QMGR
- The queue definition has queue manager scope. This means that the definition of the queue does not extend beyond the queue manager that owns it. To open the queue for output from some other queue manager, either the name of the owning queue manager must be specified, or the other queue manager must have a local definition of the queue.
CELL
- The queue definition has cell scope. This means that the queue is known to all the queue managers in the cell, and can be opened for output merely by specifying the name of the queue; the name of the queue manager that owns the queue need not be specified.
If there is already a queue with the same name in the cell directory, the command fails. The REPLACE option has no effect on this.
This value is valid only if a name service supporting a cell directory (for example, the supplied DCE name service) has been configured.
This parameter is valid only on Compaq OpenVMS, OS/2 Warp, UNIX systems, and Windows.
SHARE and NOSHARE
- Whether multiple applications can get messages from this queue.
This parameter is supported only on local and model queues.
SHARE
- More than one application instance can get messages from the queue
NOSHARE
- A single application instance only can get messages from the queue
STGCLASS(string)
- The name of the storage class.
This parameter is supported only on local and model queues.
This is an installation-defined name.
This parameter is valid on z/OS only. For more information, see the WebSphere MQ for z/OS Concepts and Planning Guide.
The first character of the name must be uppercase A through Z, and subsequent characters either uppercase A through Z or numeric 0 through 9.
Note:
- You can change this parameter only if the queue is empty and closed.
On platforms other than z/OS, this parameter is ignored.
If you specify QSGDISP(SHARED) or DEFTYPE(SHAREDYN), this parameter is ignored.
TARGQ(string)
- The local name of the base queue being aliased. (See Rules for naming WebSphere MQ objects.) The maximum length is 48 characters.
This parameter is supported only on alias queues.
This must be one of the following (although this is not checked until the alias queue is opened by an application):
- A local queue (not a model queue)
- A local definition of a remote queue
This queue need not be defined until an application process opens the alias queue.
TRIGDATA(string)
- The data that is inserted in the trigger message. The maximum length of the string is 64 bytes.
This parameter is supported only on local and model queues.
For a transmission queue on AIX, Compaq OpenVMS, HP-UX, Linux, OS/2 Warp, OS/400, Solaris, Windows, or z/OS, you can use this parameter to specify the name of the channel to be started.
This parameter can also be changed using the MQSET API call.
TRIGDPTH(integer)
- The number of messages that have to be on the queue before a trigger message is written, if TRIGTYPE is DEPTH. The value must be in the range 1 through 999 999 999.
This parameter is supported only on local and model queues.
This parameter can also be changed using the MQSET API call.
TRIGGER and NOTRIGGER
- Whether trigger messages are written to the initiation queue (named by the INITQ parameter) to trigger the application (named by the PROCESS parameter):
TRIGGER
- Triggering is active, and trigger messages are written to the initiation queue.
NOTRIGGER
- Triggering is not active, and trigger messages are not written to the initiation queue.
This parameter is supported only on local and model queues.
This is the default supplied with WebSphere MQ, but your installation might have changed it.
This parameter can also be changed using the MQSET API call.
TRIGMPRI(integer)
- The message priority number that triggers this queue. The value must be in the range zero through to the MAXPRTY queue manager parameter (see DISPLAY QMGR for details).
This parameter can also be changed using the MQSET API call.
TRIGTYPE
- Whether and under what conditions a trigger message is written to the initiation queue (named by the INITQ parameter).
This parameter is supported only on local and model queues.
FIRST
- Whenever the first message of priority equal to or greater than that specified by the TRIGMPRI parameter of the queue arrives on the queue.
EVERY
- Every time a message arrives on the queue with priority equal to or greater than that specified by the TRIGMPRI parameter of the queue.
DEPTH
- When the number of messages with priority equal to or greater than that specified by TRIGMPRI is equal to the number indicated by the TRIGDPTH parameter.
NONE
- No trigger messages are written.
This parameter can also be changed using the MQSET API call.
USAGE
- Queue usage.
This parameter is supported only on local and model queues.
NORMAL
- The queue is not a transmission queue.
XMITQ
- The queue is a transmission queue, which is used to hold messages that are destined for a remote queue manager. When an application puts a message to a remote queue, the message is stored on the appropriate transmission queue whilst awaiting transmission to the remote queue manager.
If you specify this option, do not specify values for CLUSTER and CLUSNL and do not specify INDXTYPE(MSGTOKEN) or INDXTYPE(GROUPID).
XMITQ(string)
- The name of the transmission queue to be used for forwarding messages to the remote queue, for either a remote queue or for a queue manager alias definition.
This parameter is supported only on remote queues.
If XMITQ is blank, a queue with the same name as RQMNAME is used as the transmission queue.
This parameter is ignored if the definition is being used as a queue manager alias and RQMNAME is the name of the local queue manager.
It is also ignored if the definition is used as a reply-to queue alias definition.
Usage notes
- For alias queues:
- DEFINE QALIAS(otherqname) TARGQ(aliasqueue) CLUSTER(c) has the effect of advertising queue aliasqueue by the name otherqname.
- DEFINE QALIAS(otherqname) TARGQ(aliasqueue) has the effect of allowing a queue advertised by the name otherqname to be used on this queue manager by the name aliasqueue.
- For remote queues:
- DEFINE QREMOTE(rqueue) RNAME(otherq) RQMNAME(otherqm) CLUSTER(cl) has the effect of advertising this queue manager as a store and forward gateway to which messages for queue rqueue can be sent. It has no effect as a reply-to queue alias, except on the local queue manager.
DEFINE QREMOTE(otherqm) RNAME() RQMNAME(anotherqm) XMITQ(xq) CLUSTER has the effect of advertising this queue manager as a store and forward gateway to which messages for anotherqm can be sent.
- RQMNAME can itself be the name of a cluster queue manager within the cluster, thus (as with QALIAS definitions) you can map the advertised queue manager name to another name locally.
- It is possible for the values of RQMNAME and QREMOTE to be the same if RQMNAME is itself a cluster queue manager. If this definition is also advertised using a CLUSTER attribute, do not choose the local queue manager in the cluster workload exit because a cyclic definition will result.
- Remote queues do not have to be defined locally. The advantage of doing so is that applications can refer to the queue by a simple, locally-defined name, rather than by one that is qualified by the ID of the queue manager on which the queue resides. This means that applications do not need to be aware of the real location of the queue.
- A remote queue definition can also be used as a mechanism for holding a queue manager alias definition, or a reply-to queue alias definition. The name of the definition in these cases is:
- The queue manager name being used as the alias for another queue manager name (queue manager alias), or
- The queue name being used as the alias for the reply-to queue (reply-to queue alias).
WebSphere is a trademark of the IBM Corporation in the United States, other countries, or both.
IBM is a trademark of the IBM Corporation in the United States, other countries, or both.