JMS Trigger
Discover more about the JMS Trigger and how to use it on the Digibee Integration Platform.
Let's say you want to use a trigger to make a subscription in a message queue. By using JMS Trigger, you'll be able to trigger a pipeline that enables the consumption of one message at a time.
Commit with delivery guarantee
With the Auto Commit property disabled, it's possible to give the message ack only after the well succeeded pipeline execution. For the IBM MQ broker, it's necessary to keep this field enabled at all times, because it's not supported to control the message ack or reject.
Supported queues and configuration parameters
The supported queues are:
Oracle Advanced Queue
Tibco EMS
SQS
IBM MQ
Take a look at the configuration options for the trigger. Parameters supported by Double Braces expressions are marked with (DB).
Account
Sets the account which will be used by the trigger. Supported types: Basic and AWS V4.
N/A
String
Auto Commit
When enabled, the JMS’s auto commit strategy will be used. Otherwise, the manual commit will be used.
False
Boolean
Destination
Sets the destination (Queue or Topic).
Queue
String
Name of the Queue or Topic
Single name given to the selected Queue or Topic.
Test
String
Which JMS Provider Will Be Used
Sets the selected queue (Oracle Advanced Queue, Tibco EMS, SQS, or IBM MQ).
SQS
String
Depending on the queue, different parameters can be accessed:
Oracle AQ
Hostname
Name of the JMS connection string host.
N/A
String
SID - Oracle Site Identifier
Oracle’s database instance name.
N/A
String
Port
Access port number to Oracle server.
N/A
Integer
JDBC Type
Oracle JDBC driver (e.g., THIN or OCI).
N/A
String
Durable Subscriber
Message consumer that receives all the messages published in a topic, including the ones published while the subscriber is inactive; when activated, it's necessary to inform the specific subscriber name in the Subscriber Name field.
False
Boolean
Subscriber Name
Name of the specific subscriber required when enabling the Durable Subscriber option in Oracle Advanced Queue.
N/A
String
Set Client ID
Property specifically used by a JMS provider to identify the client JMS connection and allow it to be durable.
False
Boolean
Message Selector
If your application needs to filter received messages, you can use a JMS API message selector, allowing the message consumer to specify which messages matter. The message selector assigns the filter process to the JMS provider.
N/A
String
Maximum Timeout
Maximum time (in milliseconds) for the pipeline to process information before returning a response. Limit: 900000.
30000
Integer
Allow Redelivery of Messages
If activated, this option allows messages to be delivered again if the Pipeline Engine fails.
False
Boolean
Tibco EMS
Connection String
JMS connection string in the format tcp://{host}:{port} for Tibco EMS.
N/A
String
Durable Subscriber
Message consumer that receives all the messages published in a topic, including the ones published while the subscriber is inactive; when activated, it's necessary to inform the specific subscriber name in the Subscriber Name field.
False
Boolean
Subscriber Name
Name of the specific subscriber required when enabling the Durable Subscriber option in Tibco EMS.
N/A
String
Set Client ID
Property specifically used by a JMS provider to identify the client JMS connection and allow it to be durable.
False
Boolean
Message Selector
If your application needs to filter received messages, you can use a JMS API message selector, allowing the message consumer to specify which messages matter. The message selector assigns the filter process to the JMS provider.
N/A
String
Maximum Timeout
Maximum time (in milliseconds) for the pipeline to process information before returning a response. Limit: 900000.
30000
Integer
Allow Redelivery of Messages
If activated, this option allows messages to be delivered again if the Pipeline Engine fails.
False
Boolean
SQS
Role ARN
The Amazon Resource Name (ARN) of the role to assume. Used in queue or IAM policies to define which role can interact with the SQS queue.
This parameter supports the use of Globals.
N/A
String
Role Session Name
A name that identifies the assumed role session. It helps trace who (or what) assumed the role and performed specific actions on the SQS queue.
This parameter supports the use of Globals.
N/A
String
Expiration (in ms)
The duration (in milliseconds) before the temporary credentials expire.
900
Integer
Connection String
JMS connection string in the format _https://{REGION_ENDPOINT}/queue. /{YOUR_ACCOUNT_NUMBER}/{YOUR_QUEUE_NAME}_
tcp://localhost:61616
String
Region
AWS region where the queue is installed.
N/A
String
Set Client ID
Property specifically used by a JMS provider to identify the client JMS connection and allow it to be durable.
False
Boolean
Message Selector
If your application needs to filter received messages, you can use a JMS API messages selector, allowing the message consumer to specify which of them matter.
N/A
String
Maximum Timeout
Maximum time (in milliseconds) for the pipeline to process information before returning a response. Limit: 900000.
30000
Integer
Allow Redelivery of Messages
If activated, this option allows messages to be delivered again if the Pipeline Engine fails.
False
Boolean
Visibility Timeout in Broker SQS must have a value equal or greater than the timeout of the pipeline. That's necessary, because Broker SQS is a distributed system and doesn't delete the message after its consumption, since there's no guarantee that's actually been consumed.
If the Visibility Timeout isn't configured in the mentioned conditions, a message under processing can be resent. Broker SQS sends the message again if it doesn't receive ACK or REJECT within the time configured in Visibility Timeout. For more information, check the SQS documentation.
IBM MQ
Hostname
String JMS connection host name.
N/A
String
Channel Name
Name of the channel to be used in the broker communication.
N/A
String
Queue Manager
Name of the IBM MQ queue manager.
N/A
String
Port
Number of the access port to the Oracle server.
N/A
Integer
Durable Subscriber
Message consumer that receives all the published messages in a topic, including the ones published when the subscriber is disabled; when enabled, it's necessary to inform the specific name of the subscriber in the Subscriber Name field.
False
Boolean
Set Client ID
Property specifically used by a JMS provider to identify the client JMS connection and allow it to last.
False
Boolean
Message Selector
If your application needs to filter the received messages, you can use a JMS API message selector, which allows the message consumer to specify which one of them matters - the message selector repasses the filtering to the JMS provider.
N/A
String
Maximum Timeout
Maximum time (in milliseconds) for the pipeline to process information before returning a response. Limit: 900000.
30000
Integer
Allow Redelivery of Messages
If activated, the option allows messages to be delivered again if the Pipeline Engine fails.
False
Boolean
JMS Trigger in action
If you want to deploy the trigger, it's necessary to publish the pipeline.
Check how to do it:
Click on Run, located in the superior part of the screen.
Select the environment, which can be test or prod.
Click on Create a new implantation.
Select the pipeline with its version and capacity.
Click on Confirm.
When triggered, the pipeline will receive a payload similar to the following one:
{
"data":"message"
}JMS Trigger supports the consumption of messages in a parallel way - the number of consumers configured when deploying the pipeline will be exactly the same for the JMS queue/topic.
Therefore, if 10 consumers are configured in the deploy, 10 consumers will be created for the JMS queue/topic.
That increases the throughput consumption of the messages, besides allowing the user to have control over how many simultaneous consumers can be created.
Formerly, there was only one consumer per trigger.
Last updated
Was this helpful?