Creating MSMQ listener

The Transaction Server supports Microsoft Message Queuing (MSMQ) listeners. The MSMQ listener can be configured to listen on a remote MSMQ queue (command queue) where it will accept requests. Every correctly formatted listener command will result in a response being sent to a MSMQ queue defined as its reply queue.

Assumptions

Before you begin to create a MSMQ listener, it is assumed that the following occurred:

  • Microsoft Message Queuing 3.0 was installed on a Windows XP or Windows Server 2003 computer.
  • You have the IP address (or host name) of the computer where the Microsoft Message Queuing 3.0 product was installed.
  • The MSMQ administrator set up the message queue and gave you its name.

Procedures

To create a MSMQ listener, follow these steps:

  1. From the Workbench left pane, expand the node that you want to add the listener to.
  2. Expand Enterprise, right-click the Listeners icon to display its pop-up menu, and then click New.
    The Listener window appears.
  3. Use the Name box to type a unique name for the listener. The name can be up to 64 characters in length and can include letters, numbers, and the underscore character. Spaces are not allowed.
  4. From the Listener Type drop-down list, select MSMQ.
    The Listener window changes to accommodate parameters for the MSMQ listener.

    It is expected that you will have information from the MSMQ administrator in order to correctly fill in the parameter values.

Parameters tab

The following describes the parameter values to create a MSMQ listener.

Parameter Description
Host This is the host name or IP address of the computer where MSMQ is installed.
Domain If the MSMQ queue is defined on a computer that is in a Microsoft Active Directory domain (a managed environment), then specify the Active Directory domain name. If the MSMQ queue is defined on a computer located in an unmanaged environment then specify that computer name.
Note that the MSMQ queue must be accessed through a managed domain; otherwise, the value in Domain is ignored.
User This is the user ID to access the MSMQ queue. See your MSMQ administrator for this information.
Password This is the password to access the MSMQ queue. See your MSMQ administrator for this information.
Command Path This is the name of the MSMQ queue where the listener request will be placed for processing by the MSMQ listener.
Controlled Listener Select this check box to enable the listener to be controlled by the Get Message From Controlled Listener action.

The Get Message From Controlled Listener action determines when the listener should get the next request from the remote queue. Controlled Listener check box works in conjunction with the Delay (seconds) parameter (next). For more information, see Creating a controlled listener and the Get Message From Controlled Listener action.
Delay (Seconds) Works in conjunction with Controlled Listener parameter (previous).
Once the listener receives the request from the Get Message From Controlled Listener action, it checks the remote queue for the next request. If no request is available, the listener waits the seconds specified in Delay (seconds). If the request fails, a value is returned to the Get Message From Controlled Listener action indicating a timeout. For more information, see Creating a controlled listener.
Reply  Select the check box to indicate a reply queue.
 
The Transaction Server will place all responses on this queue. However, if the enterprise application specifies a different reply queue, that reply queue will override the reply queue specified here.
Reply Path This is the name of the MSMQ queue where the reply to the listener request will be placed after the MSMQ listener has processed the request.
Extended Attributes Use this button to display the Extended Attributes window that allows you to override some of the default MSMQ extended attributes on the reply message. Typically, these attributes are set to what was received on the listener request. For more information, see Extended attributes for the MSMQ listener.
Related topics

Listener Mapping Log tab

Listener Payload tab

What's Inside