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, you can define the queue as a WebSphere MQ clustered queue or shared queue. When using 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 defined on any queue manager accessible by the broker's queue manager, or to the destinations identified in the LocalEnvironment (also known as the DestinationList) associated with the message.
You can 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, you must 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, you can choose another supported output node.
The MQOutput node is represented in the workbench by the following icon:
Look at the following samples to see how you can use this node:
For an example of how you can 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. Right-click the node in the editor view and click Properties. The node's basic properties are displayed.
All mandatory properties for which you must enter a value (those that do not have a default value defined) are marked with an asterisk on the properties dialog.
Configure the MQOutput node as follows:
Clear the check box if you do not want to generate a new ID. Note that a new message ID is still generated if you select the Request check box in the Request panel of the properties dialog.
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.
Note that a new message identifier is generated even if the New Message ID check box is not selected in the Advanced panel of the properties dialog navigator.
For more details refer to Validating messages and Validation properties for messages in the MRM domain.
Click Cancel to close the dialog and discard all the changes that you have made to the 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 if you want to process the message further, process errors, or send the message to an additional destination.
If you connect one of these output terminals to another node in the message flow, the LocalEnvironment associated with the message is enhanced with the following information for each destination to which the message has been put by this node:
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 out terminals.
When you define an MQOutput node, the option that you select for the Transaction Mode property defines whether the message is written under syncpoint:
Another property of the MQOutput node, Persistence Mode, defines whether the output message is marked as persistent when it is put to the output queue:
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 on the properties dialog 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 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, 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 | Queue Name | The queues to which the output message is sent. Valid values are Destination List, Reply To Queue, and Queue Name. |
Transaction Mode | Yes | No | Automatic | Whether the message is put transactionally. Valid values are Automatic, Yes, and No. |
Persistence Mode | Yes | No | Automatic | Whether the message is put persistently. Valid values are Automatic, Yes, No, and As Defined for Queue. |
New Message ID | Yes | No | Cleared | Whether WebSphere MQ generates a new message identifier to replace the contents of the MsgId field in the MQMD. If you select the check box, this action is performed. |
New Correlation ID | Yes | No | Cleared | Whether WebSphere MQ generates a new correlation identifier to replace the contents of the CorrelId field in the MQMD. If you select the check box, this action is performed. |
Segmentation Allowed | Yes | No | Cleared | If appropriate, WebSphere MQ breaks the message into segments in the queue manager. If you select the check box, this action is performed. |
Message Context | Yes | No | Pass All | How to handle origin context. Valid values are Pass All, Pass Identity, Set All, Set Identity, and Default. |
Alternate User Authority | Yes | No | Cleared | Whether alternate authority is used when the output message is put. If you select the check box, this action is performed. |
The MQOutput node Request properties are described in the following table.
Property | M | C | Default | Description |
---|---|---|---|---|
Request | Yes | No | Cleared | Whether to generate each output message as a request message. If you select the check box, this action is performed. |
Reply-to Queue Manager | No | Yes | The name of the WebSphere MQ queue manager to which the output queue, 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.
Refer to Validation properties for messages in the MRM domain for a full description of these properties.
Property | M | C | Default | Description |
---|---|---|---|---|
Validate | Yes | Yes | Inherit | Whether validation takes place. Valid values are None, Content and Value, Content, and Inherit. |
Failure Action | Yes | No | Exception | 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 | This property cannot be edited. The default action, indicated by the check box being selected, is that basic value constraint checks are included in Content and Value validation. |
Fix | Yes | No | None | This property cannot be edited. |
The MQOutput node Description properties are described in the following table.
Property | M | C | Default | Description |
---|---|---|---|---|
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. |
Notices |
Trademarks |
Downloads |
Library |
Support |
Feedback
![]() ![]() |
ac04570_ |