WebSphere MQ Series Listener

The WebSphere MQ Series Listener, in the eiConsole and eiPlatform, listens to a WebSphere MQ Series Queue for any incoming messages. There are several tabs for this Listener.

Listener (Adapter) Configuration Drop-Down List

Basic WebSphere MQ Series Listener Configuration Options

On the Basic tab, you will need to input:

• Queue Manager – specifies the Queue manager to acquire the Queue from
• Queue Name – specifies the Queue to attempt to listen on
• Host – specifies the Websphere MQ Host to attempt to connect to
• Channel – specifies the channel to utilize
• Port  – specifies the port to connect to the host on; 1414 by default
• Get Attempts – specifies the number of “get” operations to attempt per polling cycle
• Create Attribute for Correlation ID? – if true, writes the correlation ID to the attribute com.pilotfish.eip.modules.MQTransport.CorrellD

WebSphere MQ Series Listener Basic Configuration Options

Advanced WebSphere MQ Series Listener Configuration Options

The Advanced tab allows you to specify whether or not you should only run the Listener when it is triggered externally, and how many elements should be serialized.

Also, you can set:

• Allow Command-Line Invocation – if enabled, the 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 – this is the interval between updates or checks against that queue. Providing a queue name guarantees that a given Transport sends transactions in the same order that the Listener created them in.

WebSphere MQ Series Listener Advanced Configuration Options

Transaction Logging WebSphere MQ Series Listener Configuration Options

The Transaction Logging tab allows you to specify:

• Transaction Logging Enabled – if enabled, allows transaction events originating from this Listener to be logged by a TransactionEventListener
• Log Transaction Data – if enabled, logs transaction data body
• Log Transaction Data Base64 – if enabled, logs transaction data body as Base64
• Log Transaction Attributes – if enabled, logs transaction attributes
• Log All Attributes – if enabled, no attributes will be filtered
• Allowed Attributes –  attributes that are allowed to be logged

WebSphere MQ Series Listener Transaction Logging Configuration Options

Inactivity WebSphere MQ Series Listener Configuration Options

The Inactivity tab allows you to 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.
• Min. Transactions to Expect – the number of transactions to expect to be completed per monitoring interval
• Monitoring Interval – how often to check the specified number of transactions that have been processed
• Times to Monitor – if set, monitoring will be done during the defined times of the 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

WebSphere MQ Series Listener Inactivity Configuration Options

Throttling WebSphere MQ Series Listener Configuration Options

The Throttling tab allows you to 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.

WebSphere MQ Series 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

WebSphere MQ Series Listener Throttling Configuration Options

Scheduling WebSphere MQ Series Listener Configuration Options

The Scheduling tab allows you to create a schedule for how often the chosen Listener should be run. You can easily modify the start time or end time.

• Scheduled Start Time – specify the scheduled start time. If left blank, the system will defer to the polling interval listed on the Basic tab.
• Scheduled End Time – specify the scheduled end time. If left blank, the system will defer to the polling interval listed on the Basic tab.
• Week Days to Exclude – specify days of the week to exclude from scheduling
• Dates to Exclude – specify specific dates to exclude from scheduling
• Time Zone – specify the Time Zone that should be used for scheduling. By default, it is set to the Time Zone of the eiConsole during the initial configuration.

To modify the scheduled start or end time, choose the three dots next to the corresponding line. You will receive a dialogue box that looks like this:

WebSphere MQ Series Listener Scheduling Mode

GET Options 1 WebSphere MQ Series Listener Configuration Options

Other Option tabs allow you to specify Get and Open Options that you will use for this Listener. For example, on the GET Options 1 tab, you can specify the following options: WAIT, NO_WAIT, SYNCPOINT, NO_SYNCPOINT, BROWSE_FIRST, BROWSE_NEXT, BROWSE_MSG_UNDER_CURSOR.

WebSphere MQ Series Listener GET Options 1 Tab Mode

GET Options 2 WebSphere MQ Series Listener Configuration Options

On the GET Options 2 tab, you can specify the following options: MSG_UNDER_CURSOR,  LOCK, UNLOCK, ACCEPT_TRUNCATED_MSG, FAIL_IF_QUIESCING, CONVERT, UNMARKED_BROWSE_MSG.

WebSphere MQ Series Listener GET Options 2 Tab Mode

GET Options 3 WebSphere MQ Series Listener Configuration Options

On the GET Options 3 tab, you can specify the following options: MARK_BROWSE_HANDLE, MARK_BROWSE_CO_OP, UNMARK_BROWSE_CO_OP, UNMARK_BROWSE_HANDLE, NONE.

WebSphere MQ Series Listener GET Options 3 Tab Mode

OPEN Options 1 Tab WebSphere MQ Series Listener Configuration Options

On the OPEN Options 1 tab you can specify the following Options: INPUT_AS_Q_DEF, INPUT_SHARED, INPUT_EXCLUSIVE, BROWSE, OUTPUT, SAVE_ALL_CONTEXT, ALTERNATE_USER_AUTHORITY.

WebSphere MQ Series Listener OPEN Options 1 Tab Mode

OPEN Options 2 Tab WebSphere MQ Series Listener Configuration Options

On the OPEN Options 2 tab you can specify the following Options: FAIL_IF_QUIESCING, PASS_IDENTITY_CONTEXT, PASS_ALL_CONTEXT, SET_IDENTITY_CONTEXT, SET_ALL_CONTEXT, INQUIRE, SET.

WebSphere MQ Series Listener OPEN Options 2 Tab Mode

OPEN Options 3 Tab WebSphere MQ Series Listener Configuration Options

On the OPEN Options 3 tab, you can specify the following Options: BIND_ON_OPEN, BIND_NOT_FIXED, BIND_AS_Q_DEF, RESOLVE_NAMES, RESOLVE_LOCAL_Q, CO_OP.

WebSphere MQ Series Listener OPEN Options 3 Tab Mode