MQReply node

The MQReply node is a specialized form of the MQOutput node that puts the output message to the WebSphere® MQ queue that is identified by the ReplyToQ field of the input message header. If appropriate, you can define the queue as a WebSphere MQ clustered queue or shared queue.

The MQReply node uses the options that are set in the Report field in the MQMD. By default (if no options are set), the MQReply node generates a new MsgId field in the reply message, and copies the message ID from the input message to the CorrelId field in the reply message. If the receiving application expects other values in these fields, ensure that the application that puts the message to the message flow input queue sets the required report options, or that you set the appropriate options in the MQMD during message processing in the message flow; for example, use a Compute node to set the Report options in the message.

More information about the Report field is available in the Application Programming Reference section of the WebSphere MQ Version 7 product documentation online.

The MQReply node is contained in the WebSphere MQ drawer of the palette, and is represented in the IBM® Integration Toolkit by the following icon:

You can view information about samples only when you use the product documentation that is integrated with the IBM Integration Toolkit or the online product documentation. You can run samples only when you use the product documentation that is integrated with the IBM Integration Toolkit.

You can use this node when you receive an order from a customer. When the order message is processed, a response is sent to the customer acknowledging receipt of the order and providing a possible date for delivery.

Working with data in the WrittenDestination folder

WrittenDestination = (
   MQ  = (
      DestinationData = (
         queueName        = 'OUT'
         queueManagerName = 'MYQUEUEMANAGER'
         replyIdentifier = X'4d...2e'
         msgId           = X'3c...2c'
         correlId        = X'2a...00'
         GroupId         = X'3a...00'
      )
   )
)

When you have put an instance of the MQReply 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.

Configure the MQReply node as follows:

1. Optional: On the Description tab, enter a short description, a long description, or both. You can also rename the node on this tab.
2. On the Advanced tab:
   1. Select Segmentation Allowed if you want WebSphere MQ to break the message into segments in the queue manager, when appropriate. You must also set MQMF_SEGMENTATION_ALLOWED in the MsgFlags field in the MQMD for segmentation to occur.

      More information about the options to which this property maps is available in the Application Programming Reference section of the WebSphere MQ Version 7 product documentation online.

   2. Choose the persistence mode that you want for the output message.
      • If you select Automatic (the default), the persistence is as specified in the incoming message.
      • If you select Yes, the message is put persistently.
      • If you select No, the message is put non-persistently.
      • If you select As Defined for Queue, the message persistence is set as defined in the WebSphere MQ queue.
   3. Choose the transaction mode that you want for the output message.
      • If you select Automatic (the default), the message transactionality is derived from how it was specified at the MQInput node.
      • If you select Yes, the message is put transactionally.
      • If you select No, the message is put non-transactionally.
3. On the Validation tab, set the validation properties; see Validation properties. If a message is propagated to the Failure terminal of the node, it is not validated.

   For more details, see Validating messages.

The reply message is put (using MQPUT) to the queue named in the input message MQMD as the ReplyTo queue. You cannot change this destination.

The MQReply node terminals are described in the following table.

The following tables describe the node properties. The column headed M indicates whether the property is mandatory; 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 for deployment).

The MQReply node Description properties are described in the following table.

The MQReply node Advanced properties are described in the following table.

The Validation properties of the MQReply node are described in the following table.

For a full description of these properties, see Validation properties.

The MQReply node also has the following properties that you cannot access or modify through the IBM Integration Toolkit interface. However, these values are used by the broker when the message is processed in the message flow.