Use the JMSOutput node to send messages to JMS destinations.
This topic contains the following sections:
The JMSOutput node acts as a JMS message producer, and can publish all six message types that are defined in the Java™ Message Service Specification, version 1.1. Messages are published by using method calls, which are described in the JMS specification.
The JMSOutput node is contained in the JMS 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.
Message flows that handle messages that are received from connections to JMS providers must always start with a JMSInput node. If you include the JMSOutput node in a message flow, you do not need to include a JMSInput node; but if you do not include a JMSInput node, you must include the MQJMSTransform node to transform the message to the format that is expected by the JMSOutput node.
If you are propagating JMS messages and creating a message flow to use as a subflow, use an instance of the JMSOutput node as the last node to create an out terminal for the subflow.
SET OutputRoot.JMSTransport.Transport_Folders.Message_MetaData.PayloadType=Payload value
For more information about the JMS message tree and payload values, see Representation of messages in the JMS Transport.
CREATE PROCEDURE CreateJMSDestinationList() BEGIN
SET OutputLocalEnvironment.Destination.JMSDestinationList.DestinationData[1] = 'jndi://TestDestQueue1';
SET OutputLocalEnvironment.Destination.JMSDestinationList.DestinationData[2] = 'jndi://TestDestQueue2';
SET OutputLocalEnvironment.Destination.JMSDestinationList.DestinationData[3] = 'jndi://TestDestQueue3';
END;
Configurable services are defined for a number of JMS providers. You can choose one of the predefined services, or you can create a new service for a new provider, or for one of the existing providers. The predefined services are listed in Configurable services properties.
Use the mqsireportproperties command to view the provider properties, and the mqsichangeproperties command to set or modify the properties.
The sender of a message might want the recipient to reply to the message. In this case, the JMSOutput message can treat the outgoing message as a reply, and route it according to the value that is obtained from the JMSReplyTo property from the request message. You can modify the value of the JMSReplyTo property in the MbMessage; for example, using a Compute node or a JavaCompute node. This action allows dynamic routing of messages from the JMSOutput node. The node sends the message to the JMS destination name that is set in the JMSReplyTo field of the MbMessage Tree.
queue://QM_mn2/myJMSQueue4
In
this case, the value is the JMS-provider specific representation of
a JMS destination for the WebSphere MQ JMS
provider.jndi://jmsQ4
where jmsQ4 is
the name of the JNDI-administered object.Performance might be affected when you use this method because of the need to look up the administered object in JNDI.
To allow the JMSOutput node to set the JMSReplyTo property dynamically in the outgoing message, leave the Reply To Destination field blank on the Basic tab, and set the JMSReplyTo value in the MbMessage using a Compute node or a JavaCompute node.
The node resolves the name of the JNDI-administered object that is supplied in either Publication Topic or Destination Queue, and sends the message to that JMS destination.
The cciOutputMessageCallback function can be registered as a callback and invoked whenever a message is sent by a JMSOutput node. See cciOutputMessageCallback.
If the user exit state is active, the cciOutputMessageCallback function is invoked for every output message that is sent successfully from a JMSOutput node where the callback is registered.
If the node provides WrittenDestination information in the LocalEnvironment tree, the callback is invoked after this information is created. See Using LocalEnvironment variables with JMSOutput and JMSReply nodes.
Connect a Compute node to the Out terminal of a JMSOutput node and interrogate the WrittenDestination List. For more information, see Viewing the logical message tree in trace output.
WrittenDestination = (
JMS = (
DestinationData = (
destinationName = 'queue://jmsQueue1'
initialContext = 'com.sun.jndi.fscontext.RefFSContextFactory'
JMSMessageID = ID:414d512054657374514d2020202020206ab98b4520017a02'
JMSCorrelationID = 'ABCDEFGHIJKLMNOPQRSTUVW'
)
)
)
When you include a JMSOutput node in a message flow, the value that you set for Transaction Mode defines whether messages are sent under syncpoint.
install_dir/bin/ JMSSwitch.dll
XAOpenString=Initial Context,location JNDI,Optional_parms
ThreadOfControl=THREAD
JMSSwitch
XAOpenString=Initial Context,location JNDI,Optional_parms
ThreadOfControl=THREAD
XAResourceManager:
Name=Jms_Provider_Name
SwitchFile=/install_dir/bin/JMSSwitch.so
XAOpenString=Initial Context,location JNDI,Optional_parms
ThreadOfControl=THREAD
Where: The optional parameters are comma-separated and are positional. Therefore, any parameters that are missing must be represented by a comma.
install_dir/classes/xarecovery.jar
install_dir/bin
For more information, see the System Administration Guide section of the WebSphere MQ Version 7 product documentation online.
Syncpoint control for the JMS provider is managed with RRS syncpoint coordination of the queue manager of the broker. You do not need to modify the .ini file.
If the JMSOutput node uses BEA WebLogic as the JMS provider, and the nodes need to participate in coordinated message flow, see Making the JMS provider client available to the JMS nodes.
Connect the In terminal of the JMSOutput node to the node from which outbound messages are routed.
Connect the Out terminal of the JMSOutput node to another node in the message flow to process the message further, to process errors, or to send the message to an additional destination.
When you have put an instance of the JMSOutput 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 that do not have a default value defined are marked with an asterisk.
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 an error occurs. Even if the Validation property is set, messages that are propagated to this terminal are not validated. |
Out | The output terminal to which the message is routed if it has been successfully put to the output destination (topic or queue). |
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).
Property | M | C | Default | Description |
---|---|---|---|---|
Node name | No | No | The node type, JMSOutput | 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. |
Property | M | C | Default | Description | mqsiapplybaroverride command property |
---|---|---|---|---|---|
Destination Queue | No | Yes | The name of the queue to which the node publishes outgoing messages. If the JMSOutput node is to be used to send point-to-point messages, enter the Destination queue name for the JMS queue name that is listed in the bindings file. | destinationQueueName | |
Publication Topic | No | Yes | The name of the topic to which the node publishes
messages.
|
topic | |
Reply to destination | No | Yes | The name of the JMS destination to which the
receiving application must send a reply message. For a reply message
to be returned to this JMS destination, the JMS destination name must
be known to the domain of the JMS provider that is used by the receiving
client. You can enter a JMS destination, which can be either a subscription
queue or a destination topic. The default value is blank, in which case the JMS output message can be regarded as a datagram. If the field is blank, the JMSOutput node does not expect a reply from the receiving JMS client. |
replyToDestination | |
Send to destination list in local environment | No | Yes | Cleared | When you have built a list of JMS destinations in the local environment, select this check box to use the destination list. If you do not select this check box, the node uses the configured JMS destination. If you select this check box but you have not built a list of JMS destination in the local environment, the node uses the configured JMS destination. | useDistList |
Property | M | C | Default | Description | mqsiapplybaroverride command property |
---|---|---|---|---|---|
JMS provider name | Yes | No | WebSphere MQ | Select a JMS vendor name from the list, or enter a name of your choice. When you select a name from the list, the Initial Context Factory property is updated automatically with the relevant Java class. If you enter your own JMS provider name, you must also enter a value for the Initial Context Factory. The name must match the name of a configurable service defined for the broker to which you deploy the message flow. Alternatively, you can specify the JMSProviders configurable service. | |
Initial Context Factory | No | Yes | com.sun.jndi.fscontext. RefFSContextFactory | This property is the starting point for a JNDI
namespace. A JMS application uses the initial context to obtain and
look up the connection factory and queue or topic objects for the
JMS provider. If you select a JMS provider name from the list in JMS provider name, the Initial Context Factory property is updated automatically with the relevant Java class. If you enter your own JMS provider name, you must also enter a value for the Initial Context Factory. The default value is com.sun.jndi.fscontext.RefFSContextFactory, which defines the file-based initial context factory for the WebSphere MQ JMS provider. If the node is set to use your own JMS provider, and the corresponding Configurable services property of the mqsichangeproperties definition has the InitialContextFactory attribute set, this overrides the setting on the node. |
initialContextFactory |
Location JNDI Bindings | No | Yes | The system path or the LDAP location for the
bindings file. The bindings file contains definitions for the JNDI-administered
objects that are used by the JMSOutput node. When you
enter a value for Location JNDI Bindings, ensure that it complies
with the following instructions:
For information about constructing the JNDI-administered objects bindings file, see the documentation that is supplied with the JMS provider. If the node is set to use your own JMS provider, and the corresponding Configurable services property of the mqsichangeproperties definition has the jndiBindingsLocation attribute set, this overrides the setting on the node. |
locationJndiBindings | |
Connection Factory Name | No | Yes | The name of the connection factory that is used by the JMSOutput node to create a connection to the JMS provider. This name must already exist in the bindings file. The Connection factory can be a JMS QueueConnectionFactory or a JMS TopicConnectionFactory, but it must match the message model that is used by the node. Alternatively, you can specify the generic JMS ConnectionFactory, which can be used for both JMS queue or JMS topic destinations. | connectionFactoryName |
Property | M | C | Default | Description |
---|---|---|---|---|
New Correlation ID | No | Yes | If the JMSOutput node is required to generate a new Correlation ID for the message, select New Correlation ID. If you leave the check box cleared, the Correlation ID of the output message is taken from the JMSCorrelationID field in the JMSTransport_Header_Values section of the message tree. | |
Transaction Mode | Yes | No | No | This property controls whether the message
is received under a JMS transaction. Valid values are Yes and No.
|
Delivery Mode | No | Yes | Non Persistent | This property controls the persistence
mode that a JMS provider uses for a message. Valid values are:
|
Message Expiration (ms) | No | Yes | 0 | This property controls the length of time, in
milliseconds, for which the JMS provider keeps the output JMS message.
The default value, 0,
is used to indicate that the message must not expire. Select Inherit from header or enter
an integer that represents a number of milliseconds. If you select Inherit from header, the property
inherits the value of the JMSExpiry field in the JMS message, which
is found at the following location:
|
Message Priority | No | Yes | 4 | This property assigns relative importance to
the message and it can be used for message selection by a receiving
JMS client application or a JMSOutput node. Select a value between 0 (lowest priority) and 9 (highest priority) or select Inherit from header. The default value is 4, which indicates medium priority.
Priorities in the range 0 to 4 relate to typical delivery.
Priorities in the range 5 to 9 relate to graduations of expedited
delivery. If you select Inherit
from header, the property inherits the value of the JMSPriority
field in the JMS message, which is found at the following location:
|
Message Type | No | Yes | Determine output message type from the JMS Message Tree | Select a value from the list to configure the
type of JMS message that is produced by the JMSOutput node. If you do not
set a value for this property, the node assumes the output type from
the metadata PayLoadType field in the JMS message tree, as indicated
by the default value, Determine
output message type from the JMS Message Tree. Valid values
are:
|
Property | M | C | Default | Description | mqsiapplybaroverride command property |
---|---|---|---|---|---|
Validate | No | Yes | Inherit | This property controls whether validation takes place. Valid values are None, Content, Content And Value, and Inherit. | validateMaster |
Failure Action | No | 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. |
Property | M | C | Default | Description |
---|---|---|---|---|
Events | No | No | None | Events that you have defined for the node are
displayed on this tab. By default, no monitoring events are defined
on any node in a message flow. Use Add, Edit,
and Delete to create, change or delete monitoring
events for the node; see Configuring monitoring event sources using monitoring properties for details. You can enable and disable events that are shown here by selecting or clearing the Enabled check box. |