createWMQQueue command

Use the createWMQQueue command to create a queue type destination for the WebSphere® MQ messaging provider at a specific scope.

To run the command, use the AdminTask object of the wsadmin scripting client.

[IBM i]The wsadmin scripting client is run from Qshell. For more information, see the topic about configuring Qshell to run product scripts.

This command is valid only when it is used with WebSphere Application Server Version 7 and later application servers. Do not use it with earlier versions.

For a list of the available IBM® MQ messaging provider administrative commands, plus a brief description of each command, enter the following command at the wsadmin prompt:

print AdminTask.help('WMQAdminCommands')

For overview help on a given command, enter the following command at the wsadmin prompt:

print AdminTask.help('command_name')

After using the command, save your changes to the master configuration. For example, use the following command:

AdminConfig.save()

Purpose

Use the createWMQQueue command to create a WebSphere MQ messaging provider queue type destination at a specific scope.

You cannot create a WebSphere MQ messaging provider queue type destination under either of the following conditions:
  • A WebSphere MQ messaging provider queue type destination already exists with the same name, at the same scope.
  • The JNDI name clashes with another entry in WebSphere Application Server JNDI.

Target object

The scope of the WebSphere MQ messaging provider at which the WebSphere MQ messaging provider queue type destination is to be created.

Required parameters

-name
The administrative name assigned to this WebSphere MQ messaging provider queue type destination.
-jndiName
The name used to bind this object into WebSphere Application Server JNDI.
-queueName
The name of the WebSphere MQ queue to use to store messages for the WebSphere MQ messaging provider queue type destination definition.

Optional parameters

-description
An administrative description assigned to the queue type destination.
-qmgr
The queue manager that hosts the WebSphere MQ queue.
-persistence
This parameter determines the level of persistence used to store messages sent to this destination.
Enter one of the following case-sensitive values:
  • APP
  • QDEF
  • PERS
  • NON
  • HIGH

The default value is APP.

-priority
The priority level to assign to messages sent to this destination.
Enter one of the following values:
  • APP
    Note: (APP is case-sensitive.)
  • QDEF
    Note: (QDEF is case-sensitive.)
  • <A positive integer in the range 0 to 9 (inclusive)>

The default value is APP.

-expiry
The length of time after which messages sent to this destination expire and are dealt with according to their disposition options.
Enter one of the following values:
  • APP
    Note: (APP is case-sensitive.)
  • UNLIM
    Note: (UNLIM is case-sensitive.)
  • <Any positive integer>

The default value is APP.

-ccsid
The coded character set identifier (CCSID).

The value of this parameter must be a positive integer or blank. See the IBM MQ messaging provider queue and topic advanced properties settings for more details.

The default value is 1208.

Leaving this field empty indicates that the default value must be used.

-useNativeEncoding
This parameter specifies whether to use native encoding or not. It can take a value true or false.

If it is set to true, the values of the -integerEncoding, -decimalEncoding and -floatingPointEncoding attributes are ignored.

If it is set to false, the encoding is specified by the -integerEncoding, -decimalEncoding and -floatingPointEncoding attributes.

-integerEncoding
The integer encoding setting for this queue.

Enter one of the following case-sensitive values: Normal or Reversed.

The default value is Normal.

-decimalEncoding
The decimal encoding setting for this queue.

Enter one of the following case-sensitive values: Normal or Reversed.

The default value is Normal.

-floatingPointEncoding
The floating point encoding setting for this queue.

Enter one of the following case-sensitive values: IEEENormal, IEEEReversed, z/OS

The default value is IEEENormal.

-useRFH2
This parameter determines whether an RFH version 2 header is appended to messages sent to this destination, also know as targetClient..

Enter one of the following case-sensitive values: true or false (equivalent to JMS or MQ targetClient, respectively)..

The default value is true (JMS targetClient).

-sendAsync
This parameter determines whether messages can be sent to this destination without queue manager acknowledging that they have arrived.

Enter one of the following case-sensitive values: YES, NO or QDEF.

The default value is QDEF.

-readAhead
This parameter determines whether messages for non-persistent consumers can be read ahead and cached.

Enter one of the following case-sensitive values: YES, NO or QDEF.

The default value is QDEF.

-readAheadClose
This parameter specifies the read ahead close method for the message consumer.

Enter one of the following case-sensitive values: DELIVERALL, or DELIVERCURRENT.

The default value is DELIVERALL.

-customProperties
This parameter specifies custom properties to be passed to the WebSphere MQ messaging provider queue type destination implementation. Typically, custom properties are used to set attributes of the queue type destination that are not directly supported through the WebSphere administration interfaces.
Each custom property is specified using name and value table step parameters. Since these are table steps, the order of the two parameters is fixed, so you must always specify the name first and the value second:
  • In Jython: [name value]
  • In Jacl: {name value}
Note: In the following examples, code blocks beginning with wsadmin> show code that is entered by the user. Lines that do not begin with wsadmin> show code that has been returned by the console.

The following example creates a WebSphere MQ messaging provider queue type destination.

  • Using Jython:
    wsadmin>AdminTask.createWMQQueue("9994GKCNode01(cells/9994GKCNode01Cell/
    nodes/9994GKCNode01|node.xml#Node_1)", ["-name queue1 -jndiName jms/queues/Q1
     -queueName APP1.QUEUE1"]) 
    
    queue1(cells/9994GKCNode01Cell/nodes/9994GKCNode01|resources.xml#
    MQQueue_1098737234986) 
  • Using Jacl:
    wsadmin>$AdminTask createWMQQueue 
    9994GKCNode01(cells/9994GKCNode01Cell/nodes/9994GKCNode01|node.xml#Node_1)
    {-name queue1 -jndiName jms/queues/Q1 -queueName APP1.QUEUE1} 
    
    queue1(cells/9994GKCNode01Cell/nodes/9994GKCNode01|resources.xml#
    MQQueue_1098737234986)