WebSphere MQ Adapter 6.5 | webMethods WebSphere MQ Adapter Documentation | webMethods WebSphere MQ Adapter Installation and User’s Guide Documentation | Adapter Notifications | Listeners | Configuring New Listeners | Configuring a New Listener
 
Configuring a New Listener
Perform the following procedure to configure a new listener.
*To configure a new listener
1. In the Adapters menu in the navigation area of Integration Server Administrator, click WebSphere MQ Adapter.
2. In the WebSphere MQ Adapter menu, click Listeners.
3. On the Listeners screen, click Configure New Listener.
4. On the Listener Types screen, select the type of listener:
*To configure a single-queue listener, click WebSphere MQ Single-Queue Listener Service.
*To configure a multi-queue listener, click WebSphere MQ Multi-Queue Listener Service.
5. On the Configure Listener Type screen, in the WebSphere MQ Adapter section, use the following fields:
Parameter
Description/Action
Package
The package in which to create the listener.
Create the listener in a user-defined package rather than in the adapter's package. For other important considerations when creating packages for WebSphere MQ Adapter, see Package Management.
You must create the package using Designer before you can specify it using this parameter. For general information about creating packages, see the webMethods Service Development Help for your release.
Folder Name
The folder in which to create the listener.
Listener Name
The name of the listener that listens for messages on a queue.
Connection Name
The connection to associate with the listener.
From the list of connections, select an appropriate connection that you created on the Configure Connections Type screen. You must use a transactional connection with listeners.
Important:
If you are using the adapter with Integration Server 8.0 SP1 or earlier, adapter services cannot use connections that are also used for adapter listeners. However, listeners can share connections with other listeners.
Retry Limit
The number of times the adapter tries to reconnect if the adapter fails to connect, or loses connection with the Queue Manager. Default: 5
Retry Backoff Timeout
The number of seconds that elapse between each of the retries specified in the retry limit. Default: 10
Important:
The listener name is prefixed by the folder name and is separated by a colon. For example: If the folder name is "Folder1" and the listener name is "Listener1", then the listener name in the "Listeners" screen will be "Folder1:Listener1".
6. In the Listener Properties section, use the following fields:
Note:
An asterisk (*) next to the filter fields indicates that WebSphere MQ Adapter passes the messages that match the filter criteria to the notification. Messages that do not match the specified filter criteria remain on the queue.
Parameter
Description/Action
Wait Interval (msec)
The time period that the listener waits for a message to appear on the queue before responding to a shutdown request from WebSphere MQ Adapter. Enter this value in milliseconds. Default: 60000
Filter on Message ID*
The listener instructs WebSphere MQ to deliver only those messages that match the specified Message ID value within the MQMD Header of each message.
If you use the filter criteria of the Message ID parameter with an asynchronous notification, then you need to set the following value, otherwise the trigger will only be executed once.
If you are using Integration Server 6.1 or later, then use Designer to set the Detect duplicates property on the trigger to false. For more information about setting this parameter, see the Publish-Subscribe Developer’s Guide for your release.
Filter on Correlation ID*
The listener instructs WebSphere MQ to deliver only those messages that match the specified Correlation ID value within the MQMD Header of each message.
Filter on Group ID*
The listener instructs WebSphere MQ to deliver only those messages that match the specified Group ID value within the MQMD Header of each message.
Filter on Sequence Number*
The listener instructs WebSphere MQ to deliver only those messages that match the specified Sequence Number value within the MQMD Header of each message.
Filter on Offset*
The listener instructs WebSphere MQ to deliver only those messages that match the specified Offset value within the MQMD Header of each message.
Handle Backout ReQueue
Select the queue to process undeliverable messages of a listener service:
*True The undeliverable messages are moved to the backout requeue defined in the corresponding Queue Manager of the WebSphere MQ server.
*False The undeliverable messages are moved to the dead letter queue.
Default: False
Dead Letter Queue Name
The name of the queue that will contain any messages that could not reach their destination.
If you do not specify a value for this field, then WebSphere MQ Adapter does not move the message to a dead letter queue if the message could not reach its destination.
If a message passes the filter criteria for the listener, but does not match any notification filter criteria, then the message is moved to the dead letter queue once it has passed the backout threshold.
Dead Letter Queue Manager Name
The name of the queue manager for the dead letter queue.
Deadletter Backout Threshold
The number of times to retrieve the message before it is sent to the dead letter queue. For example, specify 1 to attempt to retrieve the message once.
Headers to include in Dead Letter Message
Select which headers to include in the message sent to the dead letter queue:
*None Use when you do not want to include any headers along with the original payload in the message sent to the dead letter queue.
*DLH Use when you want to include only the DLH header along with the original payload in the message sent to the dead letter queue.
*MQMD Use when you want to include only the MQMD header along with the original payload in the message sent to the dead letter queue.
*DLH_&_MQMD Use when you want to include both DLH and MQMD headers along with the original payload in the message sent to the dead letter queue.
Default: DLH_&_MQMD
Note:
If you are using a listener configured using WebSphere MQ Adapter, the listener refers to the watt property watt.WmMQAdapter.deadLetterMessageHeaders. If this watt property is not set, then WebSphere MQ Adapter sets Headers to include in Dead Letter Message parameter to a default value DLH_&_MQMD.
Open Queue in Shared Mode?
Select how the queue is opened:
*True Use in shared mode to allow simultaneous access to the queue by other applications.
*False Use in exclusive mode to prevent simultaneous access to the queue by other applications.
Convert Application Data?
Select whether the service converts the message to the local character set and encoding:
*Checked The messages read using this service will be converted to the local character set and encoding.
*Unchecked The messages read using this service will not be converted to the local character set and encoding.
Default: Checked
Note:
If the property is Checked and the message format does not match the local character set and encoding, a warning message appears.
Note:
If you are using listeners configured using WebSphere MQ Adapter, the default value is Checked.
Inherit Parent Listener's Properties?
This parameter is available only for multi-queue listeners and it is used only by child listeners.
Select the properties the child listener should refer to:
*True Use the properties configured for the parent listener.
*False Use the properties configured for this particular listener by overriding the properties configured for the parent listener.
Default: False
Note:
For a parent listener, this property does not have any significance. It is always set to False for a parent listener.
7. Click Save Listener.
Important:
If you have configured a connection by selecting multiple queues, the single-queue listener will listen to the first queue in the selected list, and the multi-queue listener will create a single-queue listener for each queue selected in the list.