MQGet node

The MQGet node icon

This page contains information on:

MQGet node terminals
Configuring the MQGet node
Node properties

The MQGet node retrieves a message from an MQSeries queue and adds the message into the message flow.

The MQGet node has one input terminal called in and three output terminals, out, no message and failure. When a message is received in the input terminal, the node attempts to get a message from the queue defined in the attributes of the node. If no message is available, the original incoming messages is propagated without change through the no message terminal. If a message is retrieved from the queue, the message is added as a single new field into the outgoing message. The name of the field and its location in the message tree is supplied as a configuration attribute of the node. If an error is encountered, the incoming message is sent without change through the fail terminal and a message logged to the MQSI V2 message log.

Node terminals

The MQGet node provides the following terminals:

in

The input terminal that accepts a message for processing by the node.

out

The output terminal to which the message is propagated if a message is added to the flow.

no message

The output terminal to which the message is propagated if there is no available message on the MQSeries queue.

failure The output terminal to which the message is propagated if an error is encountered while attempting to get a new message from the queue.

Configuring the MQGet node

The MQGet node retrieves a message from an MQSeries queue. In order to achieve this, the name of the queue and how to get the message must be specified. In addition, when the message is retrieved from the queue, the location in the message tree must be specified into which the message will be retrieved.

The MQGet node allows a message to be retrieved and that message interpreted as either a String or a Byte Array (BLOB). This is also a parameter.

MQGet node properties

Property	Default	Description
Input Queue Name		Name of the MQSeries queue from which the message will be retrieved
Message Tree Location		The path in the message flow into which the retrieved message will be stored. This path is supplied in ESQL notation and must begin with "Root.". For example, to save the retrieved message as a field called 'Data' in an XML message, specify: Root.XML.A.Data
Data Type	BLOB	The element data type that will be used to hold the message in the resulting message tree. This may be either BLOB or String.
Select by MsgId	false	Should the message be retrieved from the queue by MsgId or simply the first available? If by MsgId, then the 'Root.MQMD.MsgId' field will be used to select the new message.
Select by CorrelId	false	Should the message be retrieved from the queue by matching CorreldId or simply the first available? If by CorrelId, then the 'Root.MQMD.CorrelId' field will be used to select the new message.
Transaction Mode	Automatic	Transaction Mode – This option allows the message to be obtained as part of the logical unit of work of the message flow. The possible values of this attribute are: Automatic – If the message obtained from the queue is a persistent message, then it will be included in the logical unit of work. If the message is non-persistent, it will not be included. Yes – The message will be obtained from the queue as part of the logical unit of work. No – The message will not be obtained from the queue as part of the logical unit of work.

in	The input terminal that accepts a message for processing by the node.
out	The output terminal to which the message is propagated if a message is added to the flow.
no message	The output terminal to which the message is propagated if there is no available message on the MQSeries queue.
failure	The output terminal to which the message is propagated if an error is encountered while attempting to get a new message from the queue.