MQeOutput node

Attention: The use of message flows that contain MQeInput and MQeOutput nodes in WebSphere Message Broker Version 6.0 is deprecated. The behavior that is described here is intended only for when you are deploying from Version 6.0 to a previous version, and to provide a route for migration. Redesign your flows to remove the MQe nodes and replace them with MQ nodes that are configured to your own specifications and coordinated with your MQe Gateway configuration. For more details see Migrating a message flow that contains WebSphere MQ Everyplace nodes.

This topic contains the following sections:

Purpose

Use the MQeOutput node to send messages to clients that connect to the broker using the WebSphere MQ Mobile Transport protocol.

The MQeOutput node forwards messages to WebSphere MQ Everyplace queue managers. If you specify a non-local destination queue manager, ensure that there is either a route to the queue manager, or store-and-forward queue servicing for the queue manager if it exists.

You cannot use the MQeOutput node to change the transactional characteristics of the message flow. The transactional characteristics set by the message flow's input node determine the transactional behavior of the flow.

You cannot use MQeOutput nodes in message flows that you deploy to z/OS systems.

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 to propagate which the message.

If you do not want your message flow to send messages to a WebSphere MQ Everyplace queue, you can choose another supported output node.

The MQeOutput node is represented in the workbench by the following icon:

MQeOutput node icon

Using this node in a message flow

For an example of how this node can be used, consider a farmer who checks his fields to see how well they are irrigated. He is carrying a PDA device with WebSphere MQ Everyplace installed. He sees that his fields are not being irrigated, so he uses his PDA and a Global Satellite Navigation link to check the water flow valve, and finds that it is faulty. This information is available because the remote SCADA device responsible for controlling the valve has published a diagnostic message, which was retrieved by the broker and forwarded to an MQeOutput node and on to the WebSphere MQ Everyplace client on his PDA.

WebSphere MQ Everyplace documentation

You can find further information about WebSphere MQ Everyplace, and the properties of the node, in the WebSphere MQ Everyplace documentation on the WebSphere MQ Web page.

Configuring the MQeOutput node

When you have put an instance of the MQeOutput 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 MQeOutput node as follows:

  1. Enter the Queue Manager Name and Queue Name that specify the destination for the output message if you select Queue Name in Destination Mode (described below). If you select another option for Destination Mode, you do not have to set these properties.
  2. Select Advanced in the properties dialog navigator and select the Destination Mode from the drop-down list. This identifies the queues to which to deliver the output message.
    • Queue Name. The message is sent to the queue named in the Queue Name property. The properties Queue Manager Name and Queue Name (on the Basic tab) are mandatory if you select this option. This is the default.
    • Reply To Queue. The message is sent to the queue named in the ReplyToQ field in the MQMD.
    • Destination List. The message is sent to the list of queues named in the LocalEnvironment (also known as DestinationList) associated with the message.
  3. Select Request in the properties dialog navigator and set properties to define the characteristics of each output message generated.
    1. Select the Request check box to indicate that each output message is marked in the MQMD as a request message (MQMD_REQUEST), and the message identifier field cleared (set to MQMI_NONE) to ensure that WebSphere MQ generates a new identifier. Clear the check box to indicate that each output message is not marked as a request message. You cannot select this check box if you have selected a Destination Mode of Reply To Queue.
    2. Enter a WebSphere MQ Everyplace queue manager name in Reply-to queue manager. This is inserted into the MQMD of each output message as the reply-to queue manager. This new value overrides the current value in the MQMD.
    3. Enter a WebSphere MQ Everyplace queue name in Reply-to queue. This is inserted into the MQMD of each output message as the reply-to queue. This new value overrides the current value in the MQMD.
  4. Select Description in the properties dialog navigator to enter a short description, a long description, or both.
  5. Click Apply to make the changes to the MQeOutput node without closing the properties dialog. Click OK to apply the changes and close the properties dialog.

    Click Cancel to close the dialog and discard all the changes that you have made to the properties.

Connecting the terminals

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 do, 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:

  • Queue name
  • Queue manager name
  • Message reply identifier (this is set to the same value as message ID)
  • Message ID (from the MQMD)
  • Correlation ID (from the MQMD)

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 these terminals.

Terminals and properties

The MQeOutput 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 MQeOutput 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 Everyplace queue manager to which the output queue, specified in Queue Name, is defined.
Queue Name No Yes   The name of the WebSphere MQ Everyplace output queue to which this node puts messages.

The MQeOutput node Advanced property is described in the following table.

Property M C Default Description
Destination Mode Yes No Destination List The queues to which the output message is sent. Valid values are Queue Name, Reply To Queue, and Destination List.

The MQeOutput node Request properties are described in the following table.

Property M C Default Description
Request Yes No Cleared Whether each output message is to be generated as a request message. If you select the check box, the action is performed.
Reply-to queue manager No Yes   The name of the queue manager to which the output queue, specified in Reply-to queue, is defined.
Reply-to queue No Yes   The name of the reply-to queue to which to put a reply to this request.

The MQeOutput 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.