WebSphere MQ (Legacy) output connector

This connector delivers output via IBM WebSphere MQ message queues. Before you can use this connector, you must add -webspheremq as a custom argument. You do this in the Configure Platform Export dialog box in Design Center.

Connector settings
Setting	Description
Queue manager	The queue manager to connect to.
Queue name	The name of the queue to use.
Message persistence	• AS_Q_DEF – use the message persistency specified for the message queue. • Yes – write the message to disk. The message will be recoverable in case of system failure. • No – process the message in memory. This will improve performance at the expense of security.
Max. message size	The maximum message size StreamServer can handle without message segmentation. Default is 4Mb.
Allow queue manager segmentation	Enables the Queue Manager to segment the message. This may be necessary if the message is routed between different platforms, and the message exceeds the maximum message size on a platform.
Allow application segmentation	• Yes – if the message exceeds the maximum message size, it is divided into several smaller messages. • No – if the message exceeds the maximum message size, no data is sent to the message queue. An error message is written to the log.
Message format	• String – enable the Queue Manager to convert the message data to the character format used on the platform that receives the message. • None – disable the message data conversion. If a code page is specified, the data will be converted to this code page regardless of the Message Format setting.
Channel name	The name of the client connection channel. The name must be the same as the name of the server connection channel defined on the WebSphere MQ server.
Channel protocol	The protocol to use for WebSphere MQ communication. You can select one of the following: • TCP/IP • NETBIOS • SPX • LU62
Channel server name	Host name or IP address of the server running the queue manager.

Runtime specific connector settings
Setting	Description
Message type	• Request – Used if an answer to the message is expected. You must also specify ReplyToQ and ReplyToQMgr. See Custom connector settings below. • Reply – Used if the message is a reply to a request message. • Datagram – Used if no answer to the message is expected. • Report – Used if you want the receiving application or the Queue Manager to report the message status to StreamServer. You must also specify Report Option. See Custom connector settings below.
Message ID	A message ID. Enables sending and receiving applications to correlate messages. Maximum length is 24 characters.
Correlation ID	A correlation ID. Specify a correlation ID for example if you are sending a reply message, and want the receiver to know which message you reply to. Use the Message Id from the request as your correlation ID. The maximum length is determined by the environment variable MQ_CORREL_ID_LENGTH. The recommended value is 24.

Custom connector settings

You can use the QueueOption keyword with the appropriate parameter to configure special runtime parameters. See Using custom commands and keywords in the Design Center documentation for information on how to add custom commands and keywords.

Parameter	Description
Report Option	Refer to the WebSphere MQ documentation for information about available Report Options. Must be long integer format (hexadecimal or decimal). For example: QueueOption "Report Option" "0x101C0000"
ReplyToQ	The name of queue to reply to if a request message is sent or if any report options are set. For example: QueueOption "ReplyToQ" "pdfQ"
ReplyToQMgr	The name of the queue manager where the reply-to queue is hosted. For example: QueueOption "ReplyToQMgr" "QM_Strs"

Additional information

Specifying a client connection channel using environment variable

You can use the environment variable MQSERVER to specify a default client connection channel to a specific queue manager. This will be the default client connection channel for all WebSphere MQ input and output connectors. If you specify MQSERVER and also specify valid Channel settings for a physical layer in the GUI (Channel name, Channel protocol, and Channel server name), this physical layer will use the client connection channel specified by the GUI settings (valid GUI settings override MQSERVER definition).

Use the following syntax to specify a client connection channel:

On Windows: SET MQSERVER=<ChannelName>/<TransportType>/<ConnectionName> On UNIX: export MQSERVER=<ChannelName>/<TransportType>/<ConnectionName>

ChannelName	The name of the client connection channel. The name must be the same as the name of the server connection channel defined on the WebSphere MQ server. The ChannelName must not include forward slash (/).
TransportType	The protocol to use for WebSphere MQ communication. You can use one of the following: • TCP • NETBIOS • SPX • LU62
ConnectionName	Host name or IP address of the server running the queue manager.

Example 52

Specifying client channels on Windows.

SET MQSERVER=CHAN1/TCP/MCID66499

SET MQSERVER=CHAN2/TCP/9.20.4.56(1456)

SET MQSERVER=CHAN3/NETBIOS/BOX643

 

Example 53

Specifying client channels on UNIX.

export MQSERVER=CHAN1/TCP/'MCID66499'

export MQSERVER=CHAN2/TCP/'9.20.4.56'

export MQSERVER=CHAN3/LU62/BOX99