IBM Integration Bus, Version 9.0.0.8 Operating Systems: AIX, HP-Itanium, Linux, Solaris, Windows, z/OS

See information about the latest product version

Using LocalEnvironment variables with JMSOutput and JMSReply nodes

The LocalEnvironment data elements related to the processing of JMS Messages in the JMSOutput and JMSReply nodes.

LocalEnvironment.WrittenDestination.JMS.DestinationData fields

The DestinationData element is a data structure created by the JMSOutput and JMSReply nodes for each message that is sent to a JMS Queue or published to a JMS Topic when:

The Out terminal of the node is connected to another node in the message flow
An output message callback routine has been enabled for the message flow. See cciOutputMessageCallback.

The fields in the DestinationData structure are described in the following table, and can be used by a receiving application, or an output message callback routine, to link request messages with reply messages:

Element name	Element Data Type	Description
destinationName	CHARACTER	The name of the JMS Queue to which the node sends an outgoing message or the JMS Topic to which the node publishes. This value can specified in these formats: a JNDI administered object (predefined in the JNDI bindings specified in the Location JNDI bindings node property). In which case the format of the value is `jndi://<JNDI Object name>` a character string that represents the JMS Destination name in an internal format that recognized by that particular JMS provider. For example, when using WebSphere® MQ as the JMS provider a JMS Queue Destination would be represented by the character string `queue://<queue manager>/<queue name>`
initialContext	CHARACTER	The Java™ Class name of the Initial Context Factory for the JMS provider that the JMSOutput or JMSReply node connects to.
JMSMessageID	CHARACTER	A JMS message ID is the value assigned by a JMS Provider when a message is sent to a JMS Queue or published to a JMS Topic. This value is retrieved from the JMS Message object after the message is sent or published.
JMSCorrelationID	CHARACTER	The JMS Message header property called JMSCorrelationID can be used to hold a value referencing some external information to be used for linking request with reply messages. When creating the DestinationData element in the LocalEnvironment this correlation ID value is obtained from the JMSCorrelationID message tree field in the folder OutputRoot.JMSTransport.Transport_Folders. Header_Values.

LocalEnvironment.Destination.JMSDestinationList fields

Transformation nodes can write data elements called DestinationData[n] in the LocalEnvironment folder called Destination.JMSDestinationList. The DestinationData elements are written with an array subscript format where the subscript is an integer that identifies an individual element in the destination list.

A JMSOutput node searches for DestinationData[n] entries in the LocalEnvironment if it has been configured to send to a destination list. The node sends an output message to each entry found in the destination list. The following table describes the format of a DestinationData element.

Element name	Element Data Type	Description
DestinationData	CHARACTER	The name of the JMS Queue to which the node sends an outgoing message or the JMS Topic to which the node publishes. This value can specified in the following formats: A JNDI administered object (predefined in the JNDI bindings specified in the Location JNDI bindings node property). In this case, the format of the value is `jndi://<JNDI Object name>` A character string that represents the JMS Destination name in an internal format that is recognized by that particular JMS provider. For example, when using WebSphere MQ as the JMS provider, a JMS Queue Destination is represented by the character string `queue://<queue manager>/<queue name>` A complex element with DestinationName and DestinationType child elements that specify the name and type of the JMS Destination.
DestinationData.DestinationName	CHARACTER	A character string that represents the name of the JMS destination in an external format that is recognized by the JMS provider. If this field is specified, you must set the DestinationType field.
DestinationData.DestinationType	CHARACTER	The type of the JMS destination referred to in the DestinationName element. If the DestinationType field is set, you must set the DestinationName field. Set the DestinationType field to `Queue` or `Topic`.

ac25870_.htm |

Last updated Friday, 21 July 2017