JMS Listener Configuration
Easily Connect to the Java Messaging Service with the eiConsole’s JMS Listener (Adapter)
The eiConsole’s JMS Adapter (Listener) will allow you to connect to the Java Messaging Service (JMS). The JMS Adapter component of the eiConsole offers the user a graphical interface with easy to configure screens. The JMS Adapter offers seven tabs: Basic, Advanced, Transaction Logging, Inactivity, Throttling, Credentials, and Data Source.
Listener (Adapter) Configuration Drop-Down List
Basic JMS Listener Configuration Options
On the Basic Tab, you can specify how often you would like to poll the queue for new messages. Please consult your JMS documentation to determine the naming context factor class and provider URL for the class that you are using.
- Listener Version – version of the JMS Listener to use
- Polling Interval – Version 1: Polling time between messages. Version 2: Reconnection interval. If the value is set with enhanced properties, the units are seconds.
- Naming Context Factory Class – specifies the factory used to generate naming contexts
- Provider URL – specifies the URL for the JMS Provider
- Text Encoding – the character encoding of received text messages
JMS Listener Basic Configuration Options
Advanced JMS Listener Configuration Options
On the Advanced tab, you can choose to initialize this Listener only when triggered.
- Initialize on Trigger Only – if enabled, the Listener doesn’t start up until a trigger initializes it
- Allow Command-Line Invocation – if enabled, Listener can be invoked using the CLI client application
- Restart on listening error – if enabled, the Listener will be restarted after an error occurs
- FIFO Queue Name – the FIFO options enable a “First In, First Out” queuing mechanism between Listeners and Transports. If a FIFO Queue Name is provided, it will be used as a key for a transaction queue. Transactions will be written to this queue before they reach a Transport. The transactions in this queue will be ordered according to when they were created by the Listener.
- FIFO Queue Delay – it is the interval between updates/checks against that queue. Providing a queue name guarantees that a given Transport sends transactions in the same order the Listener created them in
- Max Messages per Poll – specifies the maximum number of messages to pick up from the JMS Provider per polling cycle
- Reconnect on Error – determines if connections should be closed and reconnected when errors are encountered
- Synchronous Acknowledge– if enabled, message acknowledgment will not be sent until transport confirms the message has been processed
JMS Advanced Configuration Options (top half of screen)
- Synchronous Acknowledge – if enabled, the message acknowledgment will not be sent until a Synchronous Response confirms the message has been processed
- Synchronous Ack Timeout – maximum time in seconds before timing out
- JMS Client Type – for specialized JMS client types
JMS Advanced Configuration Options (middle half of screen)
Transaction Logging JMS Listener Configuration Options
On the Transaction Logging tab, you can enable transaction events logging. That data can be logged by a Transaction Event Listener (TransactionEventListener).
- Transaction Logging Enable – this checkbox allows transaction events originating from this listener to be logged by a Transaction Event Listener (TransactionEventListener)
- Log Transaction Data – if enabled, logs transaction data body
- Log Transaction Data Base64 – if enabled, logs transaction data body as Base64
- Log Transaction Attribute – if enabled, logs transaction attributes
- Log All Attributes – if enabled, no attributes will be filtered
- Allowed Attributes – attributes that are allowed to be logged
JMS Listener Transaction Logging Configuration Options
Inactivity JMS Listener Configuration Options
On the Inactivity tab you can specify:
- Enable Inactivity Monitor – check this box to enable inactivity monitoring. This will throw a non-transaction exception if the specified number of transactions haven’t been processed in the specified time interval.
- Minimum Transactions to Expect – the number of transactions to expect to be completed per monitoring interval
- Monitoring Interval – how often to check that the specified number of transactions have been processed
- Times to Monitor – if set, monitoring will be done during the defined times of day – to ignore, set start and end time equally
- Days to Exclude from Monitoring – inactivity monitoring will not occur on the days specified
- Include Errors in Transaction Count – if checked, transactions that attempted to start, but failed at the Listener stage, will also be counted
JMS Listener Inactivity Configuration Options
Throttling JMS Listener Configuration Options
On the Throttling tab, you can specify:
- Throttling Mode – The throttling mode to use for limiting the number of transactions or messages emitted by this Listener. “Timed” will limit transactions based on time intervals, while “Concurrent” will limit based on a concurrent number of transactions. “Concurrent” mode requires a Throttling Response Processor step later in your Interface workflow to acknowledge completion.
JMS Listener Throttling Mode
- Throttling Mechanism – the mechanism to use for throttling messages – “Blocking” prevents the Listener from continuing to process and emit messages altogether, while “Queued” pushes received messages into the interface queue or a default, in-memory queue.
- Max Concurrent Messages – how many messages can be concurrently processed, either by time-based limits (“Allow X per Second”) or synchronous (“Allow X at any Time”)
- Timed Emission Interval – the interval for time-based limits (“Allow X per X Timed Emission Interval”)
- Synchronous Timeout Interval – the interval to wait for a synchronous response before failing
JMS Listener Throttling Configuration Options
Credentials JMS Listener Configuration Options
On the Credentials tab, you can enter the User Name and Password used to connect to the JMS provider.
JMS Listener Credentials Configuration Options
Data Source JMS Listener Configuration Options
On the Data Source tab, you can specify a queue or topic that you would like to connect to. If connecting to a queue, select Point-to-Point. If connecting to a topic, select Publish/Subscribe.
For Point-to-Point, you will need to provide the Queue Name and the Queue Connection Factory Name (both present in your JMS configuration).
JMS Listener Data Source Configuration Options
For Publish/Subscribe, you will need to provide the Topic name and Connection Factory Name (both present in your JMS configuration).
JMS Listener Data Source Configuration Options