Copyright © Cloud Software Group, Inc. All Rights Reserved

Reply To JMS Message

Activity

The Reply To JMS Message activity sends a reply to a previously received JMS queue or topic message. Activities that can receive JMS messages are listed on the Configuration tab. The activity that you select determines which message the reply message is in response to.

Configuration

The Configuration tab has the following fields.

Field	Global Var?	Description
Name	No	The name to appear as the label for the activity in the process definition.
Description	No	Short description of the activity.
Reply To	No	A drop-down list of activities that can receive JMS queue or topic messages. The activity you select determines the message this activity replies to. The reply-to queue or topic name from the message in the selected activity is used to send the reply message.
Message Type	No	The type of the message. This can be one of the following: • Simple — A message with no body portion. • Bytes — A stream of bytes. • Map — A set of name/value pairs. The names are strings, and the values are simple data types (Java primitives), an array of bytes (use the Binary datatype to map this data), or a string. Each item can be accessed sequentially or by its name. • Object — A serializable Java object. • Object Ref — An object reference to a Java object. • Stream — A stream of Java primitives, strings, or arrays of bytes. Each value must be read sequentially. • Text — The message is a java.lang.String. • XML Text — The message is XML text.

Advanced

The Advanced tab has the following fields.

Field	Global Var?	Description
Delivery Mode	Yes	The delivery mode of the message. It can be one of the following: • Persistent: signifies the messages are stored and forwarded. • Non-Persistent messages are not stored and may be lost due to failures in transmission. • TIBCO EMS Reliable: this mode is only available when using TIBCO Enterprise Message Service. See the TIBCO Enterprise Message Service documentation for more information about this mode.
JMSExpiration (secs)	Yes	Corresponds to JMSExpiration property that specifies how long the message can remain active (in seconds). If set to 0, the message does not expire. This field is set in seconds, but the JMSExpiration property is displayed in milliseconds.
Priority	Yes	Priority of the message. You may set the priority to a value from 0-9. The default value is 4.
Type	Yes	The value to supply to the JMSType header property.
JMS Application Properties	No	Any application-specific message properties that will be part of the message. This is specified by the JMS Application Properties shared configuration resource. Once specified, these properties appear on the Output tab as "OtherProperties".

Input Editor

The Input Editor tab defines the schema to use for outgoing replies where the message type is Map, Stream, or XML Text. Map messages are name/value pairs, and the schema allows you to define the structure of the outgoing message. Once defined, the schema on the Input Editor tab becomes the structure used for the body of the message displayed on the Input tab.

See Appendix A, Specifying Data Schema for a complete description of using the Input Editor tab.

Input

See TIBCO ActiveMatrix BusinessWorks Process Design for more information about mapping and transforming input data.

The input for the activity is the following.

Input Item	Datatype	Description
Delivery mode	Long	The delivery mode of the message. Can be one of the following: • Persistent : signifies the messages are stored and forwarded. • Non-Persistent : messages are not stored and may be lost due to failures in transmission. • TIBCO EMS Reliable: this mode is only available when using TIBCO Enterprise Message Service. See the TIBCO Enterprise Message Service documentation for more information about this mode.
JMSExpiration (secs)	String	Corresponds to JMSExpiration property that specifies how long the message can remain active (in seconds). If set to 0, the message does not expire. This field is set in seconds, but the JMSExpiration property is displayed in milliseconds.
JMSPriority	string	Priority of the message. You may set the priority to a value from 0-9. This item overrides the value specified on the Configuration tab.
JMSCorrelationID	string	This ID is used to link a response message with its related request message. This property is usually set to the message ID of the message you are replying to, but any value can be used. For example, you may use another field in the body of the message (such as orderID) to correlate request and reply messages. The JMSCorrelationID of the reply message is set in this input element. If this element is not set, the correlation ID is set as follows: • If the JMSCorrelationID input element is not set, the value of the JMSCorrelationID property in the message you are replying to is used. • If neither this input element nor the JMSCorrelationID of the message you are replying to are set, the message ID of the message you are replying to is used. • If none of the above values are set, the JMSCorrelationID of the reply message is set to null.
JMSType	string	The type of the message. This item overrides the value specified on the Advanced tab.
JMSProperties	complex	The message properties for the message. See JMS Properties for more information about message properties. Only properties applicable to this type of message are displayed.
OtherProperties	complex	If the JMS Application Properties field is specified on the Advanced tab, the OtherProperties group lists the application-specific properties in the selected JMS Application Properties shared configuration object.
Body	depends upon message type	The body of the message.
DynamicProperties	complex	The dynamic properties is an additional parameter to add runtime property to the Outgoing JMS Messages which is specified in the Input tab. This is an optional element with only one instance. Dynamic property can have multiple property elements. Each property element denotes a single dynamic property and can contain the following elements: Name — Required. Name of the property with one instance. Value — Required. Value of the property with one instance. Type — Optional. Type of the property. If not provided, it will be considered as string. Following Types are supported: • string • boolean • shortx • integer • long • float • double • byte Note: The DynamicProperty will overwrite the value of a property (with the same name) added using the JMS Application Property. Also, DynamicProperties will be added to the outgoing message.

Output

The activity has no output.

Error Output

The Error Output tab lists the possible exceptions that can be thrown by this activity. See TIBCO ActiveMatrix BusinessWorks Error Codes for more information about error codes and corrective action to take.

Exception	Thrown When...
JMSInvalidInputException	Input to the activity is not valid.
JMSMessageCreateException	The JMS message could not be created.
JMSSessionCreateException	The JMS session could not be created.
JMSSendException	The JMS send operation failed.

Copyright © Cloud Software Group, Inc. All Rights Reserved