The URI for the IBM MQ transport

When communication between the service requester and service provider uses WebSphere® MQ, the URI of the target is in a form that identifies the target as a queue and includes information to specify how the request and response should be handled by IBM MQ.

Syntax

Read syntax diagramSkip visual syntax diagram
>>-jms:/queue?-------------------------------------------------->

   .-&-----------------------------------------------.   
   V                                                 |   
>----+-destination=queuename-+-------------------+-+-+---------><
     |                       '-@queuemanagername-' |     
     +-persistence=message_persistence-------------+     
     +-priority=message_priority-------------------+     
     +-replyDestination=reply_queue----------------+     
     +-SOAPJMS_targetService=string----------------+     
     +-timeout=timeout-----------------------------+     
     +-timeToLive=expiry_time----------------------+     
     '-targetService=string------------------------'     

Options

CICS uses the following options; other web service providers might use further options that are not described here. The entire URI is passed to the service provider, but CICS® ignores any options that it does not support and that are coded in the URI. CICS is not sensitive to the case of the option names. However, some other implementations that support this style of URI are case-sensitive.

destination=queuename [@queuemanagername]
  • queuename is the name of the input queue in the target queue manager
  • queuemanagername is the name of the target queue manager
persistence=message_persistence
Specify one of the following options:
0
Persistence is defined by the default queue persistence.
1
Messages are not persistent.
2
Messages are persistent.

If the option is not specified or is specified incorrectly, the default queue persistence is used.

priority=message_priority
Specifies the message priority. CICS supports integer values in the range 0 - 9 for message priorities, where 9 is assigned to the highest priority messages and 0 is assigned to the lowest priority messages. Alternatively, specify -1 to use the default priority that is defined for the target queue.
replyDestination=reply_queue
Specifies the queue to be used for the response message. If this option is not specified, CICS uses a dynamic queue for the response message. You must define the reply queue in a QLOCAL object before using this option.
Start of changeSOAPJMS_targetService=stringEnd of change
Start of changeIdentifies the target service. If CICS is the service provider, the target service should be of the form '/string', as CICS uses this as the path when attempting to match with URIMAP. If this option is not specified, the value that is specified in TRIGDATA on the input queue at the service provider is used.End of change
timeout=timeout
The timeout in milliseconds for which the service requester waits for a response. If a value of zero is specified, or if this option is omitted, the request will not time out.
timeToLive=expiry-time
Specifies the expiry time for the request in milliseconds. If the option is not specified or is specified incorrectly, the request will not expire.
targetService=string
Identifies the target service. If CICS is the service provider, then the target service should be of the form '/string', as CICS uses this as the path when attempting to match with URIMAP. If this option is not specified, the value that is specified in TRIGDATA on the input queue at the service provider is used.

Example

This example shows a URI for the IBM MQ transport:

jms:/queue?destination=queue01@cics007&timeToLive=10&replyDestination=rqueue05&targetService=/myservice

For information about "connectionFactory" and "initialContextFactory", see the IBM MQ product documentation.



dfhws_mq_uri.html | Timestamp icon Last updated: Sunday, 4 June 2017