Copyright © Cloud Software Group, Inc. All Rights Reserved

JMS Topic Subscriber

Process Starter

Starts a process based on the receipt of a message for the specified JMS topic.

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 Topic	Yes	Name of the topic of the incoming message. The syntax of the topic name is specific to the JMS provider you are using. See your JMS provider documentation for more information about topic 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		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.
Durable Subscription	Yes	Specifies a durable subscription. You must specify a name in the Subscription name field that is registered with the JMS application as the durable subscription name.
Subscription Name	Yes	The subscription name registered with the JMS application for durable subscriptions. This field is only available when the Durable Subscription field is checked. Once a durable subscription is created, it can only be removed by accessing the administration tool of the JMS provider. See the documentation of your JMS provider for more information about managing durable subscriptions.
Suppress Local Messages	Yes	Specifies to not receive messages on the specified topic name when the message origin is the JMS application on the same connection as the process engine. If your process definition publishes and subscribes to messages with the same topic name, this option is useful if you want to specify whether to receive messages sent by the same JMS application that published the message. Checking this field prevents the process from receiving messages sent by the same connection. Unchecking this option specifies messages sent by the same connection should be received.
Acknowledge Mode	Yes	This field is available when a JMS transport is selected. This field specifies the acknowledgement mode to be used for incoming messages. It can be one of the following: • Auto : the message is automatically acknowledged when it is received. • Client: the message is acknowledged when the process implementing the operation ends successfully. • 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. • 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, are 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, a change occurs in the behavior of this feature. Now only the messages that are not confirmed, are 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, are 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. The messages however, would be lazily acknowledged.
Acknowledge Mode	Yes	• 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. • Local Transactional — this mode is used when a transaction involves only JMS messages. See TIBCO ActiveMatrix BusinessWorks Process Design for more information about creating transactions that JMS activities can participate in.
Max Sessions (Read Only)	No	When the Acknowledge Mode field is set to "Client", "Transactional" or "Local Transactional", this read-only field appears to notify you that only one session can receive incoming topic messages until the message is confirmed. When a JMS topic message is received, the session is blocked until the message is acknowledged. Because all sessions subscribed to JMS topics receive the same messages, only one session can actively listen for new messages until each message is confirmed.

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 to include in the message. This is specified by the JMS Application Properties shared configuration resource. Once specified, these properties appear on the Output tab as OtherProperties.
Receiver Timeout (seconds)	No	Specifies the polling interval to check for new messages. This default interval is set by the custom engine property bw.plugin.jms.receiverTimeout. If no value is specified for the property, the default polling interval is one second. Set a value in this field to specify the polling interval (in seconds) for this activity. The value in this field overrides the default polling interval.
Precreate Transactions	No	When checked, this field specifies that the transaction is created before a message arrives at the JMS receiver. Note: The Precreate Transactions feature should be used only with IBM MQ Websphere.
XA Transaction Manager Reference	No	Specifies the XA Transaction Manager Configuration used to create the XA transaction. This field is available when Precreate Transactions field is checked.

Misc

The Misc tab contains the following fields:

Field	Description
Sequencing Key	This field can contain an XPath expression that specifies which processes should run in order. Process instances with sequencing keys that evaluate to the same value are executed sequentially in the order the process instances were created. See TIBCO ActiveMatrix BusinessWorks Process Design for more information about controlling the execution order of process instances and about XPath expressions.
Custom Id	This field can contain an XPath expression that specifies a custom ID for the process instance. This ID is displayed in the View Service dialog of TIBCO Administrator, and it is also available in the $_processContext process variable.

Output Editor

The Output Editor tab defines the schema to use for incoming messages whose 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 incoming message. Once defined, the schema on the Output Editor tab becomes the structure used for the body of the message displayed 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.
JMSProperties	complex	The message properties for the message. See JMS Properties for more information about message properties.
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 the 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.

Copyright © Cloud Software Group, Inc. All Rights Reserved