This topic contains sections marked as revised for this release
This topic describes the MQOutput node.
This topic contains the following sections:
Use the MQOutput node to send messages to clients that connect to the broker using the WebSphere MQ Enterprise Transport and that use the MQI and AMI application programming interfaces.
The MQOutput node delivers an output message from a message flow to a WebSphere MQ queue. The node uses MQPUT to put the message to the destination queue or queues that you specify.
If appropriate, define the queue as a WebSphere MQ clustered queue or shared queue. When you use a WebSphere MQ clustered queue, leave the queue manager name empty.
You can configure the MQOutput node to put a message to a specific WebSphere MQ queue that is defined on any queue manager that is accessible by the broker's queue manager, or to the destinations identified in the LocalEnvironment (also known as the DestinationList) that is associated with the message.
Set other properties to control the way in which messages are sent, by causing appropriate MQPUT options to be set; for example, you can request that a message is processed under transaction control. You can also specify that WebSphere MQ can, if appropriate, break the message into segments in the queue manager.
If you create a message flow to use as a subflow, you cannot use a standard output node; use an instance of the Output node to create an Out terminal for the subflow through which to propagate the message.
If you do not want your message flow to send messages to a WebSphere MQ queue, choose another supported output node.
The MQOutput node checks for the presence of an MQMD header in the message tree. If no MQMD is present, the MQOutput node creates an MQMD header in the message tree, and populates it with MQMD default properties. If an MQMD header is found, the MQOutput node checks that it is an MQ type header; if it is not, the Message Context property is set to Default. Any other transport headers in the message tree (such as the JMS transport) are serialized on output of the message, and are treated as part of the message payload.
The MQOutput node is contained in the WebSphere MQ drawer of the palette, and is represented in the workbench by the following icon:
Look at the following samples to see how to use this node:
You can view samples only when you use the information center that is integrated with the Message Brokers Toolkit.
For an example of how to use this node, assume that you have written a publishing application that publishes stock updates on a regular basis. The application sends the messages to the broker on an MQInput node, and the message flow makes the publications available to multiple subscribers through a Publication node. You configure a Compute node to create a new output message whenever one particular stock is changed, and wire this to an MQOutput node to record each price change for this stock.
When you have put an instance of the MQOutput node into a message flow, you can configure it; see Configuring a message flow node. The properties of the node are displayed in the Properties view.
All mandatory properties for which you must enter a value (those that do not have a default value defined) are marked with an asterisk.
To configure the MQOutput node:
Clear the check box if you do not want to generate a new ID. A new message ID is still generated if you select Request on the Request tab.
More information about the options to which this property maps is available in the WebSphere MQ Application Programming Reference.
More information about the options to which this property maps is available in the WebSphere MQ Application Programming Reference.
More information about the options to which this property maps is available in the WebSphere MQ Application Programming Reference.
More information about the options to which these properties map is available in the WebSphere MQ Application Programming Reference.
A new message identifier is generated even if the New Message ID check box is not selected on the Advanced tab.
For more details, refer to Validating messages and Validation properties.
Connect the In terminal to the node from which outbound messages bound are routed.
Connect the Out or Failure terminal of this node to another node in this message flow to process the message further, process errors, or send the message to an additional destination.
These values are written in WrittenDestination within the LocalEnvironment tree structure.
If you do not connect either terminal, the LocalEnvironment tree is unchanged.
If you use aggregation in your message flows, you must use the output terminals.
The MQOutput node terminals are described in the following table.
Terminal | Description |
---|---|
In | The input terminal that accepts a message for processing by the node. |
Failure | The output terminal to which the message is routed if a failure is detected when the message is put to the output queue. |
Out | The output terminal to which the message is routed if it has been successfully put to the output queue, and if further processing is required within this message flow. |
The following tables describe the node properties. The column headed M indicates whether the property is mandatory (marked with an asterisk if you must enter a value when no default is defined); the column headed C indicates whether the property is configurable (you can change the value when you add the message flow to the bar file to deploy it).
The MQOutput node Description properties are described in the following table.
Property | M | C | Default | Description |
---|---|---|---|---|
Node name | No | No | The node type, e.g. Input | The name of the node. |
Short Description | No | No | A brief description of the node. | |
Long Description | No | No | Text that describes the purpose of the node in the message flow. |
The MQOutput node Basic properties are described in the following table.
Property | M | C | Default | Description |
---|---|---|---|---|
Queue Manager Name | No | Yes | The name of the WebSphere MQ queue manager to which the output queue, which is specified in Queue Name, is defined. | |
Queue Name | No | Yes | The name of the WebSphere MQ output queue to which this node puts messages (using MQPUT). |
The MQOutput node Advanced properties are described in the following table.
Property | M | C | Default | Description |
---|---|---|---|---|
Destination Mode | Yes | No | The queues to which the output message is sent. Valid values are Destination List, Reply To Queue, and Queue Name. | |
Transaction Mode | Yes | No | Queue Name | This property controls whether the message is put transactionally. Valid values are Automatic, Yes, and No. |
Persistence Mode | Yes | No | Automatic | This property controls whether the message is put persistently. Valid values are Automatic, Yes, No, and As Defined for Queue. |
New Message ID | Yes | No | Cleared | If you select this check box, WebSphere MQ generates a new message identifier to replace the contents of the MsgId field in the MQMD. |
New Correlation ID | Yes | No | Cleared | If you select this check box, WebSphere MQ generates a new correlation identifier to replace the contents of the CorrelId field in the MQMD. |
Segmentation Allowed | Yes | No | Cleared | If you select this check box, when appropriate, WebSphere MQ breaks the message into segments in the queue manager. |
Message Context | Yes | No | Pass All | This property controls how origin context is handled. Valid values are Pass All, Pass Identity, Set All, Set Identity, and Default. |
Alternate User Authority | Yes | No | Cleared | If you select this check box, alternate authority is used when the output message is put. |
The MQOutput node Request properties are described in the following table.
Property | M | C | Default | Description |
---|---|---|---|---|
Request | Yes | No | Cleared | If you select the check box, each output message is generated as a request message. |
Reply-to Queue Manager | No | Yes | The name of the WebSphere MQ queue manager to which the output queue, which is specified in Reply-to Queue, is defined. | |
Reply-to Queue | No | Yes | The name of the WebSphere MQ queue to which to put a reply to this request. |
The Validation properties of the MQOutput node are described in the following table.
For a full description of these properties, see Validation properties.
Property | M | C | Default | Description |
---|---|---|---|---|
Validate | Yes | Yes | Inherit | This property controls whether validation takes place. Valid values are None, Content and Value, Content, and Inherit. |
Failure Action | Yes | No | Exception | This property controls what happens if validation fails. You can set this property only if you set Validate to Content or Content and Value. Valid values are User Trace, Local Error Log, Exception, and Exception List. |
Include All Value Constraints | Yes | No | Selected | You cannot edit this property. If you select the check box, basic value constraint checks are included in Content and Value validation. |
Fix | Yes | No | None | You cannot edit this property. |