MQ/204 options for commands and statements - Revision history

JAL: reduce table width

2017-11-08T02:31:22Z

reduce table width

ELowell: /* MQ/204 options */

2015-12-17T16:58:42Z

MQ/204 options

← Older revision		Revision as of 16:58, 17 December 2015
Line 962:		Line 962:
	</table>		</table>
	</div>		</div>

			==See also==
			{{Template: MQ/204 topic list}}

	[[Category:MQ/204]]		[[Category:MQ/204]]

ELowell at 20:39, 11 November 2015

2015-11-11T20:39:56Z

← Older revision		Revision as of 20:39, 11 November 2015
Line 822:		Line 822:
	</ul>		</ul>
	<p>Alternatively, you can specify a numeric value, either as a literal or a %<var class="term">variable</var>. </p>		<p>Alternatively, you can specify a numeric value, either as a literal or a %<var class="term">variable</var>. </p>
	<p>See the recommended [[MQ/204 overview#WebSphere MQ documentation\|WebSphere MQ documentation]], which describes the acceptable numeric values.</p>		<p>See the recommended [[MQ/204 overview#IBM WebSphere MQ documentation\|WebSphere MQ documentation]], which describes the acceptable numeric values.</p>
	<p>No default report options are passed.</p>		<p>No default report options are passed.</p>
	</td>		</td>

ELowell at 20:39, 11 November 2015

2015-11-11T20:39:18Z

← Older revision		Revision as of 20:39, 11 November 2015
Line 822:		Line 822:
	</ul>		</ul>
	<p>Alternatively, you can specify a numeric value, either as a literal or a %<var class="term">variable</var>. </p>		<p>Alternatively, you can specify a numeric value, either as a literal or a %<var class="term">variable</var>. </p>
	<p>See [[~~Working with~~ MQ/204#WebSphere MQ documentation\|WebSphere MQ documentation]] ~~for the recommended WebSphere MQ documentation~~, which describes the acceptable numeric values.</p>		<p>See the recommended [[MQ/204 overview#WebSphere MQ documentation\|WebSphere MQ documentation]], which describes the acceptable numeric values.</p>
	<p>No default report options are passed.</p>		<p>No default report options are passed.</p>
	</td>		</td>

ELowell at 20:36, 11 November 2015

2015-11-11T20:36:30Z

← Older revision		Revision as of 20:36, 11 November 2015
Line 438:		Line 438:
	<p>Corresponds to WebSphere MQ MQGMO_MARK_SKIP_BACKOUT.</p>		<p>Corresponds to WebSphere MQ MQGMO_MARK_SKIP_BACKOUT.</p>
	<p>		<p>
	This option can be useful to prevent get, error, back out loops. See [[MQ/204 ~~messages~~#Removing messages that cause errors\|Removing messages that cause errors]].</p>		This option can be useful to prevent get, error, back out loops. See [[MQ/204 programming#Removing messages that cause errors\|Removing messages that cause errors]].</p>
	</td>		</td>
	<td>MQGET</td>		<td>MQGET</td>
Line 597:		Line 597:
	<td>Used in error-handling code to remove messages that did not convert from within the SOUL application and are now stuck on the queue.		<td>Used in error-handling code to remove messages that did not convert from within the SOUL application and are now stuck on the queue.
	<p>		<p>
	See [[MQ/204 ~~messages~~#Removing messages that do not convert\|Removing messages that do not convert]].</p>		See [[MQ/204 programming#Removing messages that do not convert\|Removing messages that do not convert]].</p>
	</td>		</td>
	<td>MQGET</td>		<td>MQGET</td>

ELowell at 20:32, 11 November 2015

2015-11-11T20:32:30Z

← Older revision		Revision as of 20:32, 11 November 2015
Line 438:		Line 438:
	<p>Corresponds to WebSphere MQ MQGMO_MARK_SKIP_BACKOUT.</p>		<p>Corresponds to WebSphere MQ MQGMO_MARK_SKIP_BACKOUT.</p>
	<p>		<p>
	This option can be useful to prevent get, error, back out loops. See [[~~Working with~~ MQ/204#~~Messages~~ that cause errors\|~~Messages~~ that cause errors]].</p>		This option can be useful to prevent get, error, back out loops. See [[MQ/204 messages#Removing messages that cause errors\|Removing messages that cause errors]].</p>
	</td>		</td>
	<td>MQGET</td>		<td>MQGET</td>
Line 597:		Line 597:
	<td>Used in error-handling code to remove messages that did not convert from within the SOUL application and are now stuck on the queue.		<td>Used in error-handling code to remove messages that did not convert from within the SOUL application and are now stuck on the queue.
	<p>		<p>
	See [[~~Working with~~ MQ/204#Removing messages that do not convert\|Removing messages that do not convert]].</p>		See [[MQ/204 messages#Removing messages that do not convert\|Removing messages that do not convert]].</p>
	</td>		</td>
	<td>MQGET</td>		<td>MQGET</td>

ELowell: /* Overview */

2015-11-11T20:29:39Z

Overview

← Older revision		Revision as of 20:29, 11 November 2015
Line 1:		Line 1:
	==Overview==		==Overview==
	The definition and activity of MQ/204 queue managers, queues, and messages can be defined and changed using options. For review of how options are changed and passed by MQ/204 statements and commands, see [[~~Working with~~ MQ/204#Rules of inheritance\|Rules of inheritance]].		The definition and activity of MQ/204 queue managers, queues, and messages can be defined and changed using options. For review of how options are changed and passed by MQ/204 statements and commands, see [[MQ/204 queue management#Rules of inheritance\|Rules of inheritance]].

	==MQ/204 options==		==MQ/204 options==

ELowell: Created page with "==Overview== The definition and activity of MQ/204 queue managers, queues, and messages can be defined and changed using options. For review of how options are changed and pas..."

2015-11-11T16:10:46Z

Created page with "==Overview== The definition and activity of MQ/204 queue managers, queues, and messages can be defined and changed using options. For review of how options are changed and pas..."

New page

==Overview==
The definition and activity of MQ/204 queue managers, queues, and messages can be defined and changed using options. For review of how options are changed and passed by MQ/204 statements and commands, see [[Working with MQ/204#Rules of inheritance|Rules of inheritance]].

==MQ/204 options==
The options in the following table apply to the commands and statements listed.

Note: You cannot use <var class="term">option</var>=%<var class="term">variable</var> in a DEFINE QUEUE command.

<div style="font-size: 80%">
<table>
<caption>Options for MQ/204 commands and statements</caption>
<tr class="head">
<th>Option</th>
<th>Purpose</th>
<th>Discussion</th>
<th>Can be set on...</th>
</tr>
<tr>
<td>ACCEPT_TRUNCATED_MSG</td>
<td>If a message was truncated because the target was too small, removes it from the queue; or, if browsing, advances the browse cursor.</td>
<td>Corresponds to the WebSphere MQ option MQGMO_ACCEPT_TRUNCATED_MSG.
</td>
<td>DEFINE QUEUE 
MODIFY QUEUE 
MQGET 
OPEN QUEUE
</td></tr>
<tr>
<td>NO_ACCEPT_TRUNCATED_MSG(default)</td>
<td>Truncated message is not removed from the queue; the browse cursor is not advanced.</td>
<td>This option is the alternate to ACCEPT_TRUNCATED_MSG option.</td>
<td>DEFINE QUEUE 
MODIFY QUEUE 
MQGET 
OPEN QUEUE
</td>
</tr>
<tr>
<td>ACCOUNTINGTOKEN='<var class="term">value</var>' 
or =%<var class="term">variable</var>
</td>
<td>Sets the value of the Accounting Token portion of the identity context.</td>
<td>String from 1 to 32 characters long.</td>
<td>MQPUT 
MQPUT1
</td>
</tr>
<tr>
<td>ALL_MSGS_AVAILABLE</td>
<td>Use on an MQGET call to retrieve only messages that belong to complete groups, as well as messages that do not belong to a group.</td>
<td> </td>
<td>DEFINE QUEUE 
MODIFY QUEUE 
MQGET 
OPEN QUEUE</td>
</tr>
<tr>
<td>NOT_ALL_MSGS_AVAILABLE (default)</td>
<td>Use on an MQGET call to retrieve any message in the queue, including partial groups.</td>
<td> </td>
<td>DEFINE QUEUE 
MODIFY QUEUE 
MQGET 
OPEN QUEUE</td>
</tr>
<tr>
<td>ALLOW_PASS_ALL_CONTEXT</td>
<td>Passes origin context information on all subsequent MQPUT calls.</td>
<td>Corresponds to WebSphere MQ MQOO_PASS_ALL_CONTEXT.
Can be specified only if the OUTPUT option is also specified.
</td>
<td>OPEN QUEUE</td>
</tr>
<tr>
<td>ALLOW_PASS_IDENTITY_CONTEXT</td>
<td>Passes identity context information on all subsequent MQPUT calls.</td>
<td>Corresponds to WebSphere MQ MQOO_PASS_IDENTITY_CONTEXT.
Can be specified only if the OUTPUT option is also specified.
</td>
<td>OPEN QUEUE</td>
</tr>
<tr>
<td>ALLOW_SET_ALL_CONTEXT</td>
<td>Sets origin context information on all subsequent MQPUT calls.</td>
<td>Corresponds to WebSphere MQ MQOO_SET_IDENTITY_CONTEXT.
Can be specified only if the OUTPUT option is also specified.
</td>
<td>OPEN QUEUE</td>
</tr>
<tr>
<td>ALLOW_SET_IDENTITY_CONTEXT</td>
<td>Sets identify context information on all subsequent MQPUT calls.</td>
<td>Corresponds to WebSphere MQ MQOO_SET_IDENTITY_CONTEXT.
Can be specified only when the OUTPUT option is also specified.
</td>
<td>OPEN QUEUE</td>
</tr>
<tr>
<td>APPLIDENTITYDATA='<var class="term">value</var>' or =%<var class="term">variable</var></td>
<td>Sets the value of the ApplIdentityData portion of the identity context.</td>
<td>String from 1 to 32 characters long.
Defaults to blanks.</td>
<td>MQPUT 
MQPUT1
</td>
</tr>
<tr>
<td>APPLORIGINDATA='<var class="term">value</var>' or =%<var class="term">variable</var></td>
<td>Sets the value of the ApplOriginData portion of the origin context.</td>
<td>String from 1 to 4 characters long.
Defaults to blanks.
</td>
<td>MQPUT 
MQPUT1
</td>
</tr>
<tr>
<td>BROWSE</td>
<td>Examines messages without removing them from the queue.</td>
<td>Corresponds to WebSphere MQ MQOO_BROWSE.
Compatible with all other access options.
</td>
<td>OPEN QUEUE</td></tr>
<tr>
<td>BROWSE_FIRST </td>
<td>First message is retrieved, but not deleted from the queue:
<ul>
<li>If either MSGID or CORRELID is specified, the first matching message on the queue is browsed. </li>
<li>If neither MSGID nor CORRELID is specified, then the first message on the queue is browsed.</li>
</ul>
</td>
<td>Corresponds to WebSphere MQ MQGMO_BROWSE_FIRST; is mutually exclusive with BROWSE_NEXT.
You can specify this option only if the queue was opened in browse mode.
</td>
<td>MQGET</td>
</tr>
<tr>
<td>BROWSE_MSG_UNDER_CURSOR</td>
<td>Reread the same message again.</td>
<td>You would typically do this to unlock a locked message or vice versa.
See the LOCK and UNLOCK options later in this table.
</td>
<td>MQGET</td>
</tr>
<tr>
<td>BROWSE_NEXT</td>
<td>Next message, relative to the current browse position, is retrieved, but not deleted from the queue:
<ul>
<li>
If either MSGID nor CORRELID is specified, the next matching message on the queue is browsed. </li>
<li>
If neither MSGID or CORRELID is specified, then the next message on the queue is browsed. </li>
</ul>
</td>
<td>Corresponds to WebSphere MQ MQGMO_BROWSE_NEXT; is mutually exclusive with BROWSE_FIRST.
You can specify this option only if the queue was opened in browse mode.
</td>
<td>MQGET</td>
</tr>
<tr>
<td>BUFLEN=<var class="term">n</var> or =%<var class="term">variable</var></td>
<td>Specifies the maximum number of bytes to get or put.</td>
<td>Resized according to size of BUFFER (formerly and still accepted MQ_BUFFER) area.</td>
<td>MQGET 
MQPUT 
MQPUT1</td>
</tr>
<tr>
<td>CONTEXT=<var class="term">name</var> or =%<var class="term">variable</var></td>
<td>Passes name of a queue entity from which context information should be passed.</td>
<td>Context can be passed only from a queue that is opened for input with the SAVE_ALL_CONTEXT option.</td>
<td>
DEFINE QUEUE 
MODIFY QUEUE 
MQPUT 
MQPUT1 
OPEN QUEUE
</td>
</tr>
<tr>
<td>CONVERT (default)</td>
<td>Converts messages from one system to another for the convenience of the recipient; from EBCDIC to ASCII, for example.</td>
<td>Corresponds to WebSphere MQ MQGMO_CONVERT.</td>
<td>MQGET</td>
</tr>
<tr>
<td>CORRELID='<var class="term">msgid</var> '
 or =%<var class="term">variable</var></td>
<td>Value to place in the correlation ID field of the message. On a reply message, the ID of the request being replied to (MQMD.MsgId) is often set in this field. However, the correlation ID might be set on any message type.</td>
<td>String from 1 to 24 characters long containing a correlation ID to use as matching criterion.
Default is blanks.
Corresponds to WebSphere MQ MQMD.CorrelId. 
You can specify the value as a %<var class="term">variable</var>.
</td>
<td>MQGET 
MQPUT 
MQPUT1</td>
</tr>
<tr>
<td>DEFAULT_CONTEXT</td>
<td>Message is put with the default context information.</td>
<td>Corresponds to WebSphere MQ option MQPMO_DEFAULT_CONTEXT.
Mutually exclusive with:
<ul>
<li>NO_CONTEXT</li>
<li>PASS_ALL_CONTEXT</li>
<li>PASS_IDENTITY_CONTEXT</li>
<li>SET_ALL_CONTEXT</li>
<li>SET_IDENTITY_CONTEXT</li>
</ul>
</td>
<td>MQPUT
MQPUT1
</td>
</tr>
<tr>
<td>DELETE</td>
<td>Deletes a permanent local dynamic queue when there are no more messages on the queue and no uncommitted MQGET or MQPUT requests outstanding.</td>
<td>Corresponds to WebSphere MQ option MQCO_DELETE.</td>
<td>CLOSE QUEUE</td>
</tr>
<tr>
<td>DELETE_PURGE</td>
<td>Deletes a temporary local dynamic queue and purges all outstanding messages and requests.</td>
<td>Corresponds to WebSphere MQ option MQCO_DELETE_PURGE.</td>
<td>CLOSE QUEUE</td>
</tr>
<tr>
<td>DESCRIPTOR=<var class="term">image</var> (optional)</td>
<td>
Image in which to place the message descriptor (MQMD structure). (See [[MQ/204 and SOUL statements#MQPUT statement|MQPUT statement]].)</td>
<td>A given application might not need the message descriptor. If the size of this image is less than the size of an MQMD, then the MQMD is truncated.</td>
<td>MQGET 
MQPUT 
MQPUT1
</td>
</tr>
<tr>
<td>DYNAMICQNAME=<var class="term">name</var>
 or =%<var class="term">variable</var></td>
<td>Specifies the name of a preallocated WebSphere MQ model queue.</td>
<td>Must be set with the MODEL option.</td>
<td>MQOPEN</td>
</tr>
<tr>
<td>EXPIRY=<var class="term">n</var>
 or =UNLIMITED or =%<var class="term">variable</var></td>
<td>Expiration period of the message in tenths of a second.</td>
<td>Corresponds to MQMD.Expiry field. The default is UNLIMITED (no expiration).</td>
<td>DEFINE QUEUE 
MODIFY QUEUE 
MQPUT 
MQPUT1 
OPEN QUEUE</td>
</tr>
<tr>
<td>FAIL_IF_QUIESCING</td>
<td>Operation fails if the queue manager is inactive.</td>
<td>Corresponds to the WebSphere MQ MQGMO_FAIL_IF_QUIESCING option.</td>
<td>DEFINE QUEUE 
MODIFY QUEUE 
MQGET 
MQPUT 
MQPUT1 
OPEN QUEUE</td>
</tr>
<tr>
<td>NO_FAIL_IF_QUIESCING (default)</td>
<td>
Operation waits if the queue manager is inactive.</td>
<td>This option is the alternate to FAIL_IF_QUIESCING option.</td>
<td>DEFINE QUEUE 
MODIFY QUEUE 
MQGET 
MQPUT 
MQPUT1 
OPEN QUEUE</td>
</tr>
<tr>
<td>FEEDBACK=NONE (default) 
or =<var class="term">n</var> 
or =%<var class="term">variable</var>
</td>
<td>
Feedback (or reason code) that accompanies a REPORT message.</td>
<td>
This value is used only on a REPORT. Valid values are:
<ul>
<li>
NONE</li>
<li>
Integers between MQFB_APPL_FIRST (65536) and MQFB_APPL_LAST (999999999)</li>
<li>
%<var class="term">variable</var></li>
</ul>

Corresponds to WebSphere MQ MQMD.Feedback.
</td>
<td>
MQPUT 
MQPUT1
</td>
</tr>
<tr>
<td>FORMAT=<var class="term">format</var> 
or =%<var class="term">variable</var>
</td>
<td>
Name of the conversion exit set.</td>
<td>String of 1 to 8 characters.

Conversion exit is invoked when the received message uses a different character set or number format than those specified in the message descriptor. 

Corresponds to WebSphere MQ MQMD.Format field. 

There is no default conversion exit set.
</td>
<td>DEFINE QUEUE 
MODIFY QUEUE 
MQPUT 
MQPUT1 
OPEN QUEUE
</td>
</tr>
<tr>
<td>GROUPID</td>
<td>The GROUPID is a 24-byte field that you specify when writing messages that belong to a group. You must specify GROUPID as a null string (or spaces) on the first message of any group.</td>
<td>For MQGET, MQPUT, and MQPUT1 calls, the group identifier of the message is returned in the MQMD, not in the GROUPID field, which is always an input field only.

On an MQGET call, this is an input field when MATCH_GROUP_ID is specified.
</td>
<td>MQGET 
MQPUT 
MQPUT1</td>
</tr>
<tr>
<td>
GSTATUS 
= [ ' ' | 'G' | 'L']</td>
<td>The one-byte GSTATUS field determines whether the message is part of a group. The possible values are:
<ul>
<li>'G' (all messages in a group except the last or only one)</li>
<li>'L' (the last or only logical message in a group)</li>
<li>Space or null (the message is not in a group) </li>
</ul>
</td>
<td>On MQGET operations, this is an output %<var class="term">variable</var>. If you are writing messages that belong to a group but are not in logical order, set this to 'L' for the message that has the highest sequence number.

The default, for MQPUT and MQPUT1 operations, is null--the message does not form part of a group.
</td>
<td>MQGET 
MQPUT 
MQPUT1
</td>
</tr>
<tr>
<td>INPUT_AS_Q_DEF 
(default for local queues)
</td>
<td>Gets messages with shared or exclusive access based on the default selected when the queue was created.
</td>
<td>Corresponds to WebSphere MQ MQOO_INPUT_ AS_Q_DEF.

Mutually exclusive with:
<ul>
<li>INPUT_EXCLUSIVE</li>
<li>INPUT_SHARED</li>
<li>BROWSE</li>
</ul>
</td>
<td>OPEN QUEUE</td>
</tr>
<tr>
<td>INPUT_EXCLUSIVE </td>
<td>Gets messages and deletes them from the queue, with exclusive access to the queue.</td>
<td>Corresponds to WebSphere MQ MQOO_INPUT_EXCLUSIVE.
Mutually exclusive with: 
<ul>
<li>BROWSE</li>
<li>INPUT_AS_Q_DEF</li>
<li>INPUT_EXCLUSIVE</li>
</ul>
</td>
<td>OPEN QUEUE</td>
</tr>
<tr>
<td>INPUT_SHARED </td>
<td>Gets messages and deletes them from the queue, with shared access to the queue.</td>
<td>Corresponds to WebSphere MQ MQOO_INPUT_SHARED.
Mutually exclusive with:
<ul>
<li>BROWSE</li>
<li>INPUT_AS_Q_DEF</li>
<li>INPUT_EXCLUSIVE</li>
</ul>
</td>
<td>OPEN QUEUE</td>
</tr>
<tr>
<td>LOCK</td>
<td>LOCK lets you browse a queue and lock the current message so that other threads do not see it.</td>
<td>The default is not to lock messages while browsing them.</td>
<td>MQGET</td>
</tr>
<tr>
<td>UNLOCK</td>
<td>UNLOCK lets you remove a lock from a previously-locked message.</td>
<td>When you specify UNLOCK, the message itself is not returned, it is just unlocked.</td>
<td>MQGET</td>
</tr>
<tr>
<td>LOGICAL_ORDER</td>
<td>Write one group at a time and write messages in sequential order, starting at 1.</td>
<td>This is the simpler way of writing a group of messages. However, it is not the default.</td>
<td>DEFINE QUEUE 
MODIFY QUEUE 
MQGET 
MQPUT 
OPEN QUEUE
</td>
</tr>
<tr>
<td>NOT_LOGICAL_ORDER (default)</td>
<td>This option gives you more control over the writing of groups, but requires that you specify SEQUENCE and GROUPID for each message.
</td>
<td>You can also use this setting for messages that are not a group.</td>
<td>DEFINE QUEUE 
MODIFY QUEUE 
MQGET 
MQPUT 
MQPUT1 
OPEN QUEUE</td>
</tr>
<tr>
<td>MARK_SKIP_BACKOUT</td>
<td>Messages taken from the queue under syncpoint control are not placed back on the queue if the user or the Online issues an MQBACK.</td>
<td>Messages are placed back on the queue, if the MQBACK is issued by the WebSphere MQ system software.
Corresponds to WebSphere MQ MQGMO_MARK_SKIP_BACKOUT.

This option can be useful to prevent get, error, back out loops. See [[Working with MQ/204#Messages that cause errors|Messages that cause errors]].
</td>
<td>MQGET</td>
</tr>
<tr>
<td>MATCH_CORREL_ID (default)</td>
<td>Retrieve messages that match the specified CORRELID.</td>
<td>If CORRELID is not specified, this option is ignored.</td>
<td>MQGET</td>
</tr>
<tr>
<td>NOT_MATCH_CORREL_ID </td>
<td>Retrieve any message in the queue, if CORRELID is specified.</td>
<td> </td>
<td>MQGET</td>
</tr>
<tr>
<td>MATCH_MSG_GROUP_ID
</td>
<td>Retrieve messages that match the specified GROUPID.</td>
<td>The queue must be indexed by GROUPID.</td>
<td>MQGET</td>
</tr>
<tr>
<td>MATCH_MSG_ID (default)</td>
<td>Retrieve messages that match the specified MSGID.</td>
<td>If MSGID is not specified, this option is ignored.</td>
<td>MQGET</td>
</tr>
<tr>
<td>NOT_MATCH_MSG_ID
</td>
<td>Retrieve any message in the queue, if MSGID is specified.</td>
<td> </td>
<td>MQGET</td>
</tr>
<tr>
<td>MATCH_MSG_SEQ_NUMBER</td>
<td>Retrieve the message that matches SEQUENCE for the current group. If there is no current group, the only valid value of SEQUENCE is 1.</td>
<td>The queue must be indexed by GROUPID.</td>
<td>MQGET</td>
</tr>
<tr>
<td>MATCH_MSG_TOKEN</td>
<td>Use this to retrieve messages that match the specified MSGTOKEN</td>
<td>The queue must be indexed by MSGTOKEN.</td>
<td>MQGET</td>
</tr>
<tr>
<td>MODEL=<var class="term">name</var> 
or =%<var class="term">variable</var></td>
<td>Specifies the internal, Model 204 name of the local dynamic queue.</td>
<td>Must be set in the same statement with the DYNAMICQNAME option.</td>
<td>MQOPEN</td>
</tr>
<tr>
<td>

MSG_UNDER_CURSOR 
</td>
<td>Removes the message under the current browse position from the queue (a real MQGET).</td>
<td>Corresponds to WebSphere MQ MQGMO_MSG_UNDER_CURSOR.

Specify only if the queue is in both browse and input modes: cannot be specified with BROWSE_FIRST or BROWSE_NEXT. 
</td>
<td>MQGET</td>
</tr>
<tr>
<td>MSGID='<var class="term">msgid</var> ' 
or =%<var class="term">variable</var></td>
<td>Message identifier to use as matching criterion.</td>
<td>Value is either a %<var class="term">variable</var> or a string from 1-24 characters that:
<ul>
<li>
You enter</li>
</ul>
or
<ul>
<li>
Queue manager automatically generates</li>
</ul>

Corresponds to WebSphere MQ MQMD.MsgId.
</td>
<td>MQGET 
MQPUT 
MQPUT1 </td>
</tr>
<tr>
<td>MSGLEN=%<var class="term">variable</var></td>
<td>Specifies an output variable in which to return the actual message length.
</td>
<td>Returned message length is less in the event of truncation.</td>
<td>MQGET</td>
</tr>
<tr>
<td>MSGTOKEN</td>
<td>You can select messages by 16-byte message token (MSGTOKEN) by specifying this field as an input field on MQGET statements with MATCH_MSG_TOKEN.</td>
<td>This is also an output field, retrieving the message token that was assigned by the queue manager. (On the MQGET call, it can also be an input field, if MATCH_MSG_TOKEN is specified.</td>
<td>MQGET 
MQPUT 
MQPUT1</td>
</tr>
<tr>
<td>MSGTYPE=DATAGRAM (default) 
or =REPLY 
or =REPORT 
or =REQUEST 
or =%<var class="term">variable</var> 
or = <var class="term">application-defined numeric value</var></td>
<td>Specifies the type of message; 
sets the MQMD.MsgType.</td>
<td>Types specified by keyword are:
<ul>
<li>
DATAGRAM, a simple message that needs no reply; corresponds to WebSphere MQ MQMT_DATAGRAM constant.</li>
<li>
REPLY, a response to REQUEST; corresponds to WebSphere MQ MQMT_REPLY constant. </li>
<li>
REPORT, a message that signifies an error condition or exception that is often requested in the report field of another message; corresponds to WebSphere MQ MQMT_REPORT constant.</li>
<li>
REQUEST, a message that requires a reply; corresponds to WebSphere MQ MQMT_REQUEST constant.</li>
</ul>
</td>
<td>DEFINE QUEUE 
MODIFY QUEUE 
MQPUT 
MQPUT1 
OPEN QUEUE</td>
</tr>
<tr>
<td>NEW_CORREL_ID</td>
<td>This option on the MQPUT statement tells the queue manager to generate a new correlation ID for the message.</td>
<td>The CORRELID option should not be specified with this option, because the queue manager generates a unique correlation identifier, rather than taking it from the CORRELID option.</td>
<td>MQPUT 
MQPUT1</td>
</tr>
<tr>
<td>NO_CONTEXT</td>
<td>Message is placed in the queue without any context information.</td>
<td>Corresponds to WebSphere MQ option MQPMO_NO_CONTEXT.

Mutually exclusive with:
<ul>
<li>DEFAULT_CONTEXT</li>
<li>PASS_ALL_CONTEXT</li>
<li>PASS_IDENTITY_CONTEXT</li>
<li>SET_ALL_CONTEXT</li>
<li>SET_IDENTITY_CONTEXT</li>
</ul>
</td>
<td>MQPUT 
MQPUT1</td>
</tr>
<tr>
<td>NO_CONVERT</td>
<td>Specifies turning off MQGMO_CONVERT.</td>
<td>Used in error-handling code to remove messages that did not convert from within the SOUL application and are now stuck on the queue.

See [[Working with MQ/204#Removing messages that do not convert|Removing messages that do not convert]].
</td>
<td>MQGET</td>
</tr>
<tr>
<td>OUTPUT (default for remote queues)</td>
<td>Puts messages.</td>
<td>Corresponds to WebSphere MQ option MQOO_OUTPUT.</td>
<td>OPEN QUEUE</td>
</tr>
<tr>
<td>PASS_ALL_CONTEXT</td>
<td>
All context information is passed through from an input queue.</td>
<td>Corresponds to the WebSphere MQ option MQPMO_PASS_ALL_CONTEXT.

Mutually exclusive with:
<ul>
<li>DEFAULT_CONTEXT</li>
<li>NO_CONTEXT</li>
<li>PASS_IDENTITY_CONTEXT</li>
<li>SET_ALL_CONTEXT</li>
<li>SET_IDENTITY_CONTEXT</li>
</ul>
</td>
<td>MQPUT 
MQPUT1</td>
</tr>
<tr>
<td>PASS_IDENTITY_CONTEXT</td>
<td>Identity context information is passed through from an input queue.</td>
<td>Corresponds to the WebSphere MQ option MQPMO_PASS_IDENTITY_CONTEXT.

Mutually exclusive with:
<ul>
<li>DEFAULT_CONTEXT</li>
<li>NO_CONTEXT</li>
<li>PASS_ALL_CONTEXT</li>
<li>SET_ALL_CONTEXT</li>
<li>SET_IDENTITY_CONTEXT</li>
</ul>
</td>
<td>MQPUT 
MQPUT1
</td>
</tr>
<tr>
<td>PASS_USER_CONTEXT</td>
<td>Passes user context from the queue identified in the CONTEXT parameter.
</td>
<td>UserIdentifier field value from the last MQGET is passed along with the ALTERNATE_USER_AUTHORITY option. The queue is opened according to the authority granted.</td>
<td>MQPUT1 
OPEN QUEUE</td>
</tr>
<tr>
<td>PERSISTENT</td>
<td>Persistent message that survives a restart of the queue manager.</td>
<td>Corresponds to the WebSphere MQ option MQPER_PERSISTENT of the field MQMD.Persistence.

This option is an alternate to NOT_PERSISTENT and PERSISTENCE_AS_Q_DEF.
</td>
<td>
DEFINE QUEUE 
MODIFY QUEUE 
MQPUT 
MQPUT1 
OPEN QUEUE
</td>
</tr>
<tr>
<td>NOT_PERSISTENT</td>
<td>Message that does not survive restart of the queue manager.</td>
<td>Corresponds to the WebSphere MQ option MQPER_NOT_PERSISTENT of the field MQMD.Persistence.

This option is an alternate to PERSISTENT and PERSISTENCE_AS_Q_DEF.
</td>
<td>DEFINE QUEUE 
MODIFY QUEUE 
MQPUT 
MQPUT1 
OPEN QUEUE
</td>
</tr>
<tr>
<td>PERSISTENCE_AS_Q_DEF (default)</td>
<td>Persistence of the message defaults to the persistence selected when the queue was defined.</td>
<td>Corresponds to the WebSphere MQ option PERSISTENCE_AS_Q_DEF of the field MQMD.Persistence.

This option is tan alternate to PERSISTENT and NOT_PERSISTENT.
</td>
<td>DEFINE QUEUE
MODIFY QUEUE 
MQPUT 
MQPUT1 
OPEN QUEUE </td>
</tr>
<tr>
<td>PRIORITY=<var class="term">n</var> 
or PRIORITY_AS_Q_DEF (default) 
or =%<var class="term">variable</var>
</td>
<td>Priority of the message in the range from 0 to 9; zero is the lowest priority.</td>
<td>Default is priority for the queue object as defined within WebSphere MQ.

Corresponds to MQMD.Priority field in a WebSphere MQ control block. 
</td>
<td>DEFINE QUEUE 
MODIFY QUEUE 
MQPUT 
MQPUT1 
OPEN QUEUE</td>
</tr>
<tr>
<td>PUTAPPLNAME='<var class="term">value</var>' 
or =%<var class="term">variable</var></td>
<td>
Sets the value of the PutApplName portion of the origin context.</td>
<td>
String from 1 to 28 characters long.</td>
<td>MQPUT 
MQPUT1</td>
</tr>
<tr>
<td>PUTAPPLTYPE=<var class="term">keyword</var> 
or =<var class="term">number</var> 
or =%<var class="term">variable</var></td>
<td>Identifies the type of application that put the message.</td>
<td>If the value is a %<var class="term">variable</var> or a number, it must be within the range -1 to 999,999,999 inclusive.

Otherwise, the value is one of the following keywords:
<ul>
<li>AIX</li>
<li>CICS</li>
<li>CICS_VSE</li>
<li>DEFAULT</li>
<li>DOS</li>
<li>GUARDIAN</li>
<li>IMS</li>
<li>IMS_BRIDGE</li>
<li>z/OS</li>
<li>NO_CONTEXT</li>
<li>OS2</li>
<li>OS400</li>
<li>QMGR</li>
<li>UNIX</li>
<li>UNKNOWN</li>
<li>VMS</li>
<li>VOS</li>
<li>WINDOWS</li>
<li>WINDOWS_NT</li>
<li>XCF</li>
</ul>
</td>
<td>MQPUT 
MQPUT1</td>
</tr>
<tr>
<td>PUTDATE=<var class="term">value</var> 
or =%<var class="term">variable</var></td>
<td>Sets the value of the PutDate portion of the origin context.
</td>
<td>String from 1 to 8 characters long.</td>
<td>MQPUT 
MQPUT1</td>
</tr>
<tr>
<td>PUTTIME=<var class="term">value</var> 
or =%<var class="term">variable</var></td>
<td>Sets the value of the PutTime portion of the origin context.
</td>
<td>String from 1 to 8 characters long.</td>
<td>MQPUT 
MQPUT1</td>
</tr>
<tr>
<td>REPLY_QMGR=<var class="term">name</var> 
or =%<var class="term">variable</var></td>
<td>Name of queue manager for remote queue to place the reply in.</td>
<td>Used only on MSGTYPE=REQUEST

No default.

Sets the value of MQMD.ReplyToMGR.

String of up to 48 characters.
</td>
<td>DEFINE QUEUE 
MODIFY QUEUE 
MQPUT 
MQPUT1 
OPEN QUEUE 
</td>
</tr>
<tr>
<td>REPLY_QUEUE=<var class="term">name</var> 
or =%<var class="term">variable</var></td>
<td>Name of the queue to place the reply in.</td>
<td>Used only on a MSGTYPE=REQUEST.
Default is the name of the queue that contained the request. 
Sets the values of MQMD.ReplyToQ.
Sets the value of MQMD.ReplyToMGR if no REPLY_QMGR option is indicated. 
String of up to 48 characters. 
</td>
<td>DEFINE QUEUE 
MODIFY QUEUE 
MQPUT 
MQPUT1 
OPEN QUEUE</td>
</tr>
<tr>
<td>REPORT=<var class="term">option</var>+<var class="term">option</var>... 
or =<var class="term">n</var> 
or =%<var class="term">variable</var> (numeric values only)</td>
<td>Report options, which specify:
<ul>
<li>What conditions you want reported</li>
<li>How to construct the report message</li>
</ul>
</td>
<td>Options are keywords that you combine with plus signs. The available option keywords are the MQRO_ options.
<ul>
<li>Keywords cannot be specified in a %<var class="term">variable</var>.</li>
<li>Keywords are specified without the MQRO_ prefix. </li>
</ul>
Alternatively, you can specify a numeric value, either as a literal or a %<var class="term">variable</var>. 
See [[Working with MQ/204#WebSphere MQ documentation|WebSphere MQ documentation]] for the recommended WebSphere MQ documentation, which describes the acceptable numeric values.
No default report options are passed.
</td>
<td>DEFINE QUEUE 
MODIFY QUEUE 
MQPUT 
MQPUT1 
OPEN QUEUE</td>
</tr>
<tr>
<td>SAVE_ALL_CONTEXT</td>
<td>Saves context information when messages are retrieved with MQGET.</td>
<td>Corresponds to WebSphere MQ MQOO_SAVE_ALL_CONTEXT.
Can be specified only if one of the INPUT_* options is also specified.
</td>
<td>OPEN QUEUE</td>
</tr>

<tr>
<td>SEQUENCE=%<var class="term">variable</var></td>
<td>For messages that are part of a group and NOT_LOGICAL_ORDER is specified (or is the default), this number specifies the logical position of the message within the group, which need not be the physical sequence in which the messages are written. The logical first message is message sequence 1.

On MQGET operations, this is an input variable used only with the MATCH_MSG_SEQ_NUMBER option.

On MQPUT and MQPUT1 operations, this is an input variable that specifies the logical position within the group of the message being written.
</td>
<td>This is a fixed %<var class="term">variable</var>. To retrieve the logical sequence of a message in an MQGET operation, use the DESCRIPTOR option and get the sequence number from the returned MQMD image.

When using SEQUENCE with the MATCH_MSG_SEQ_NUMBER option, you can only match a SEQUENCE greater than 1 within the current group. You cannot, for example, do a repeated BROWSE_NEXT with SEQUENCE 2 to jump from one group to another.
</td>
<td>MQGET 
MQPUT 
MQPUT1</td>
</tr>
<tr>
<td>SET_ALL_CONTEXT</td>
<td>Origin context information is set with values from the APPLORIGINDATA, PUTAPPLNAME, PUTAPPLTYPE, PUTDATE, and PUTTIME options.</td>
<td>Corresponds to the WebSphere MQ option MQPMO_SET_ALL_CONTEXT.

Mutually exclusive with:
<ul>
<li>DEFAULT_CONTEXT</li>
<li>NO_CONTEXT</li>
<li>PASS_ALL_CONTEXT</li>
<li>PASS_IDENTITY_CONTEXT</li>
<li>SET_IDENTITY_CONTEXT</li>
</ul>
</td>
<td>MQPUT 
MQPUT1</td>
</tr>
<tr>
<td>SET_IDENTITY_CONTEXT</td>
<td>Identity context information is set with values from the ACCOUNTINGTOKEN, APPLIDENTITYDATA, and USERIDENTIFIER fields.</td>
<td>Corresponds to the WebSphere MQ option MQPMO_SET_IDENTITY_CONTEXT.
Mutually exclusive with:
<ul>
<li>DEFAULT_CONTEXT</li>
<li>NO_CONTEXT</li>
<li>PASS_ALL_CONTEXT</li>
<li>PASS_IDENTITY_CONTEXT</li>
<li>SET_ALL_CONTEXT</li>
</ul>
</td>
<td>MQPUT 
MQPUT1</td>
</tr>
<tr>
<td>SYNCPOINT (default)</td>
<td>Get and put operations are under transaction control.</td>
<td>Operates on updates for MQCMIT and MQBACK.</td>
<td>DEFINE QUEUE 
MODIFY QUEUE 
MQGET 
MQPUT 
MQPUT1 
OPEN QUEUE</td>
</tr>
<tr>
<td>NO_SYNCPOINT</td>
<td>Get and put operations are not under transaction control.</td>
<td>Does not operate on updates for MQCMIT and MQBACK.</td>
<td>DEFINE QUEUE 
MODIFY QUEUE 
MQGET 
MQPUT< 
MQPUT1 
OPEN QUEUE</td>
</tr>
<tr>
<td>SYNCPOINT_IF_PERSISTENT</td>
<td>This option on the MQGET statement works like SYNCPOINT, but is effective only for persistent messages.</td>
<td> </td>
<td>MQGET</td>
</tr>
<tr>
<td>USERIDENTIFIER='<var class="term">value</var>' 
or =%<var class="term">variable</var></td>
<td>Sets the value of the User identifier portion of the identity context.</td>
<td>String from 1 to 12 characters long.</td>
<td>MQPUT 
MQPUT1</td>
</tr>
<tr>
<td>WAIT</td>
<td>Wait, if a message is unavailable.</td>
<td>You can displace a wait.
This option is the alternate to NO_WAIT option.
The maximum waiting time is specified with WAIT_TIME. 
</td>
<td>DEFINE QUEUE 
MODIFY QUEUE 
MQGET 
OPEN QUEUE</td>
</tr>
<tr>
<td>NO_WAIT (default)</td>
<td>Do not wait, if a message is unavailable.</td>
<td>Corresponds to the WebSphere MQ option MQGMO_NO_WAIT.</td>
<td>DEFINE QUEUE 
MODIFY QUEUE 
MQGET 
OPEN QUEUE</td>
</tr>
<tr>
<td>WAIT_TIME=<var class="term">n</var> 
or =UNLIMITED 
or =%<var class="term">variable</var></td>
<td>Maximum time to wait, in milliseconds, if the WAIT option is specified.
</td>
<td>Default is 0 milliseconds.
To wait forever, specify a value of UNLIMITED, which corresponds to WebSphere MQ MQWI_UNLIMITED.
</td>
<td>DEFINE QUEUE 
MODIFY QUEUE 
MQGET 
OPEN QUEUE</td>
</tr>
</table>
</div>

[[Category:MQ/204]]