Copyright © Cloud Software Group, Inc. All Rights Reserved

Get JMS Queue Message

Activity

The Get JMS Queue Message activity retrieves a message from the specified queue. This activity allows you to perform a receive operation on the queue as opposed to waiting for a queue message to be delivered to the Wait for JMS Queue Message activity or the JMS Queue Receiver process starter.

You can use the Message Selector field on the Advanced tab to retrieve a specific queue message from the queue.

The Get JMS Queue Message activity is different from the Wait for JMS Queue Message activity in the following ways:

•	Unlike the Wait for activity, which starts listening for messages from the time the BusinessWorks engine starts, this activity starts listening for incoming messages on the specified queue from the time the activity is triggered.

•	This activity can receive only one message from the specified queue at a time, when the Message Selector is not used.

•	Once triggered, this activity can either gets a message from the specified destination queue name before timeout and proceeds or it throws a timeout error and exits.

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 from which to retrieve the 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 or 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.
Acknowledge Mode	Yes	The acknowledge mode for incoming messages. It can be one of the following: • Auto — the message is automatically acknowledged when it is received. • Client — the message will be acknowledged at a later point by using the Confirm activity. If the message is not confirmed before the process instance ends, the message is redelivered and a new process instance is created to handle the new incoming message. Ensure that your process definition confirms the message when using this acknowledge mode.
Acknowledge Mode		• TIBCO EMS Explicit — (only available for TIBCO Enterprise Message Service) a message which is not acknowledged using the Confirm activity before the process instance ends, will be redelivered instead of all messages in the session. The session is not blocked and one session handles all incoming messages for each process instance. Note — In the TIBCO ActiveMatrix BusinessWorks 5.10 release, there is a change in the behavior of this feature. Now only the messages that are not confirmed, would be redelivered. • TIBCO EMS Explicit Dups OK — (only available for TIBCO Enterprise Message Service) a message which is not acknowledged using the Confirm activity before the process instance ends, will be redelivered instead of all messages in the session. The session is not blocked and one session handles all the incoming messages for each process instance. However, the messages would be lazily acknowledged. • TIBCO EMS No Acknowledge — the message is not acknowledged when it is received. • Dups OK — the message is acknowledged automatically when it is received. JMS provides this mode for lazy acknowledgement, but TIBCO ActiveMatrix BusinessWorks acknowledges messages upon receipt. • Transactional — this mode is used when a transaction that can process JMS messages is included in the process definition. The message is acknowledged when the transaction commits. See TIBCO ActiveMatrix BusinessWorks Process Design for more information about creating transactions that JMS activities can participate in.

Advanced

The Advanced tab has the following fields.

Field	Global Var?	Description
Message Selector	Yes	A string to determine whether a message should be received. The syntax of the message selector is determined by the JMS provider, but it is usually a subset of SQL92 (where message properties are used instead of table column names). See your JMS provider documentation for more information and syntax for a message selector string.
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

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.
timeout	integer	Specifies how long the message can remain active (in seconds). If set to 0, the message does not expire.
selector	string	A string to determine whether a message should be received. The value of this element overrides any value specified in the Message Selector field of the Advanced tab. The syntax of the message selector is determined by the JMS provider, but it is usually a subset of SQL92 (where message properties are used instead of table column names). See your JMS provider documentation for more information and syntax for a message selector string.

Output Editor

The Output Editor tab defines 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 retrieved queue message. 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 Output Editor tab.

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.
JMSSessionCreateException	The JMS session could not be created.
JMSReceiveException	The JMS receive operation failed.
ActivityTimedOutException	The specified timeout has been reached and the activity has not completed its execution.

 

Copyright © Cloud Software Group, Inc. All Rights Reserved