This topic contains sections marked as revised for this release
This topic describes the JMSOutput node.
Use the JMSOutput node to send messages to JMS destinations. 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 workbench by the following icon:
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 in order to create an out terminal for the subflow.
You can use the -c parameter on the mqsichangeproperties command to change the property settings for an object name that already exists in the broker persistent store. For a JMS provider, this object name is a JMS Provider name. Use the mqsideleteconfigurableservice command to delete a JMS provider resource that was created by the mqsicreateconfigurableservice command.
You can use the -c parameter on the mqsireportproperties command to report on the properties of any JMS provider resource (both default and user-defined).
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 across the JMS Transport.
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/myJMSQueue4In this case, the value is the JMS-provider specific representation of a JMS Destination for the WebSphere MQ JMS provider.
jndi:\\jmsQ4where jmsQ4 is the name of the JNDI-administered object.
Performance might be slightly impacted 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.
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.
Configure the JMSOutput node as follows:
To identify the name of the Initial Context Factory for the JMS provider, refer to the JMS provider documentation.
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, refer to the documentation that is supplied with the JMS provider.
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.
For more details, see Validating messages and Validation properties.
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 include a JMSOutput node in a message flow, the value that you set for Transaction Mode defines whether messages are sent under syncpoint.
The JMS provider can supply additional .jar files that are required for transactional support. Refer to the JMS provider documentation. For example, on distributed systems, the WebSphere MQ JMS provider supplies an extra .jar file, com.ibm,mqetclient.jar, which must be added to the broker shared-classes directory. Refer to Making the JMS provider client available to the JMS nodes in this topic.
install_dir/bin/ JMSSwitch.dll XAOpenString=Initial Context,location JNDI,Optional_parms ThreadOfControl=THREAD
install_dir/bin/ JMSSwitch.dll 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=THREADWhere:
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
Refer to the WebSphere MQ System Administration Guide for more information.
To use the same queue manager for both the broker and the JMS provider, ensure that your installation is at the minimum required level: Version 5.3 CSD12 or Version 6.0 Fix Pack 1 WebSphere® MQ Version 6.0 Fix Pack 1 or above is required for XA to use the same queue manager for both the broker and the provider.
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.
WebSphere MQ supports message groups; you can specify that a message belongs to a group and that processing of the message and all other messages in the group must be handled as one transaction. Therefore, if the processing on one message in the group fails, all messages in the group are backed out. The message processing is committed when the last message in the group has been processed successfully and only if processing of all other messages in the group has been successful.
If you choose either or both of these options, the message flow processes the messages on a single thread of execution, and a message is processed to completion before the next message is retrieved from the queue. In all other cases, it is possible that multiple threads within a single message flow are processing multiple messages, and there is no guarantee that the final message in a group, the message that prompts the commit or roll back action, is processed to completion after all other messages in the group.
Ensure you do not have another message flow that is retrieving messages from the same input queue. If you do, there is no guarantee about the order in which the messages within a group are processed.
The terminals of the JMSOutput node 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 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 is successfully retrieved from the WebSphere MQ queue. |
Catch | The output terminal to which the message is routed if an exception is thrown downstream and caught by this node. |
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).
The Description properties of the JMSOutput node are described in the following table.
Property | M | C | Default | Description |
---|---|---|---|---|
Node name | No | No | The node type | 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. |
The JMS Connection properties of the JMSOutput node are described in the following table.
Property | M | C | Default | Description |
---|---|---|---|---|
Initial Context Factory | Yes | Yes | com.sun.jndi.fscontext.RefFSContextFactory | This property is the starting point for a JNDI name
space. A JMS application uses the initial context to obtain and look up the
connection factory and queue or topic objects for the JMS provider. The default value is that value used when WebSphere MQ Java is used as the JMS provider. |
Location JNDI Bindings | No | Yes | The system path or the LDAP location for the bindings file. | |
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. |
The Basic properties of the JMSOutput node are described in the following table.
Property | M | C | Default | Description |
---|---|---|---|---|
Send reply to the JMS header "JMSReplyTo" destination | No | Yes | Cleared | If this check box is selected, the JMS provider is supplied with the JMSReplyTo value from the JMSTransport_Header_values section of the message tree. |
Destination Queue | No | Yes | The name of the queue to which the node publishes outgoing messages. | |
Publication Topic | No | Yes | The name of the topic from which the node receives published messages. | |
Reply to destination | No | Yes | The name of the JMS destination to which the receiving application should 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. |
The Advanced properties of the JMSOutput node are described in the following table.
Property | M | C | Default | Description |
---|---|---|---|---|
New Correlation ID | No | Yes | This property is selected if a New Correlation ID is required. | |
Transaction Mode | Yes | No | None | This property controls whether the incoming message is received under syncpoint. Valid values are None, Local, and Global. |
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 for which the JMS provider keeps the output JMS message. Values are in milliseconds and the default value, 0, is used to indicate that the message should not expire. |
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. |
The Validation properties of the JMSOutput node are described in the following table.
For more information about Validation properties refer to the related links.Property | M | C | Default | Description |
---|---|---|---|---|
Validate | Yes | Yes | None | This property controls whether validation takes place. Valid values are None, Content, and Content And Value. |
Failure Action | Yes | 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. |
Include All Value Constraints | Yes | No | Selected | You cannot edit this property. If the check box is selected (the default), basic value constraint checks are included in Content and Value validation. |
Fix | Yes | No | None | You cannot edit this property. |