Copyright © Cloud Software Group, Inc. All Rights Reserved

JMS Queue Requestor

Activity

The JMS Queue Requestor activity is used to send a request to a JMS queue name and receive a response back from the JMS client.

This activity uses temporary destinations to ensure that reply messages are received only by the process that sent the request.

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.
JMS Connection	No	The JMS connection. See JMS Connection for more information about creating a JMS connection.
Destination Queue	Yes	Name of the queue of the outgoing message. The syntax of the queue name is specific to the JMS provider you are using. See your JMS provider documentation for more information about queue names. Note: If you are using TIBCO Enterprise Message Service as your JMS provider, you can use the Browse button next to this field after specifying a valid connection in the JMS Connection field. The Browse button displays a list of configured destinations in the JMS server that are appropriate for this activity.
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 when mapping 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. 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/Output Editor

The Input Editor/Output Editor tabs define the schema to use for messages of type Map, Stream, or XML Text. Map messages are name/value pairs, and the schema allows you to define the structure of the outgoing request and the incoming reply. The schema defined on the Input Editor tab becomes the body of the message on the Input tab. The schema defined on the Output Editor tab becomes the body of the message on the Output tab.

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

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
destinationQueue	string	The queue to which to send the request. This input item overrides the Destination Queue field on the Configuration tab.
JMSExpiration	integer	Specifies how long the message can remain active (in seconds). If set to 0, the message does not expire.
JMSPriority	string	The priority of the message. This item overrides the priority set on the Advanced tab.
JMSCorrelationID	string	This ID is used to link a response message with its related request message. This is usually the message ID of a request message when this field is found in a reply message, but you can set this element to any value.
JMSType	string	The type of the message. This item overrides the value specified on the Advanced tab.
requestTimeout	integer	The time to wait (in seconds) for the synchronous request-reply operation to complete. An error is returned if the operation does not complete in this time limit.
replyToDestination	string	The destination to use for replies for this activity. Note: If more than one job has the same replyToDestination (for example, you specify a constant in this field), then the correct reply may not be received by each job. Make certain that you specify an expression in this field that assigns a different replyToDestination to each process instance.
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 resource.
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 • short • 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 output for the activity is the following.

Output Item	Datatype	Description
JMSHeaders	complex	The message header fields for the message. See JMS Properties for more information about message header fields. Only properties applicable to this type of message are displayed.
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 resource.
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 • short • 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. The DynamicProperties will be also added to the outgoing message.

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.
JMSReceiveException	The JMS receive operation failed.
JMSActivityException	This activity fails.
ActivityTimedOutException	This activity has reached the specified time out and the response has not been received.

Copyright © Cloud Software Group, Inc. All Rights Reserved