MSMQ Connector

The MSMQ Connector allows you to send and receive data from MSMQ queues via the Anypoint Gateway for Windows.

After reading this page you can:

  • Download and install the MSMQ Connector

  • Build a simple example project

  • Upload, deploy, and run your project

Release Notes:

MuleSoft maintains this connector under the Select support policy.

Before You Begin

Installation and Configuration

Installing the MSMQ Connector in Anypoint Studio

Important: Install the Windows Gateway Service first before installing and configuring MSMQ.
  1. In Anypoint Studio, click the Exchange icon in the Studio taskbar.

  2. Click Login in Anypoint Exchange.

  3. Search for the connector and click Install.

  4. Follow the prompts to install the connector.

When Studio has an update, a message displays in the lower right corner, which you can click to install the update.

Load-Balanced Configuration

The Windows Gateway Services supports running in a load-balanced configuration to allow for fault tolerance. Visit the Windows Gateway Service documentation for more details.

Namespace and Schema Location

The namespace and schema location for the MSMQ connector should be included in your Mule application Configuration XML file automatically when you use Studio Visual Editor to design your app. Otherwise, include these manually, as shown in the example <mule> block.



Schema Location

Example defining namespace with schema location for MSMQ connector
<mule xmlns:msmq="http://www.mulesoft.org/schema/mule/msmq" xmlns="http://www.mulesoft.org/schema/mule/core" xmlns:doc="http://www.mulesoft.org/schema/mule/documentation"
	xsi:schemaLocation="http://www.springframework.org/schema/beans http://www.springframework.org/schema/beans/spring-beans-current.xsd
http://www.mulesoft.org/schema/mule/core http://www.mulesoft.org/schema/mule/core/current/mule.xsd
http://www.mulesoft.org/schema/mule/msmq http://www.mulesoft.org/schema/mule/msmq/current/mule-msmq.xsd">

MSMQ Connector Example

This example requires some basic familiarity with MSMQ and with Mule. The following documentation describes the Mule features in this example:

Set Up Demo Queue in MSMQ

Step 1: Create Queue

  1. Open the Computer Management console on the server where MSMQ is running.

  2. Expand Services and Applications.

  3. Expand Message Queuing.

  4. Right-click Private Queues, click New, and Private Queue.

  5. Name the new queue msmq-demo, and click OK.

Step 2: Grant Permissions

Set the appropriate permissions for the identity that the MSMQ Connector uses to interact with the queue.

  1. Right click the msmq-demo queue and click Properties.

  2. Click the Security Tab. For this demo, make sure that Everyone has permissions to the following:

    • Receive Message

    • Peek Message

    • Get Properties

    • Get Permissions

    • Send Message


Using MSMQ Connector in a Mule Application

Step 1: Create a New Mule Project

After Anypoint Studio launches, create a new project:

  1. Go to File > New > Mule Project.

  2. In the New Mule Project configuration menu, provide a name for this project: msmq-demo .

  3. Click Finish.

Step 2: Create a MSMQ Global Element

  1. Click the Global Elements tab.

  2. Click Create to display the Global Type dialog box.

  3. Search for msmq.

  4. Select MSMQ from Cloud Connectors section and click OK.

  5. Fill in Gateway Service Address using the format machinename/ip address:port. (For example, localhost:9333). Don’t use URLs as they are not supported.

  6. Fill in Gateway Access Token. You can find the configured token in the Windows Service configuration file (C:\Program Files(x86)\Anypoint Gateway for Windows\Mule.SelfHost.exe.config) under the mule-auth-token appSetting key.

  7. Fill in the Queue name using the supported syntax by MSMQ. For example, .\private$\msmq-demo for the private queue created above. Because the required permissions have been granted to Everyone, you do not need to specify a UserName and Password for this demo.

  8. If you are using a self-signed SSL certificate such as the one included out of the box, make sure Ignore SSL Warnings is checked.

  9. Click Test Connection to make sure everything was set up correctly.

  10. Click OK.


Building Flows

The sample flows send and receive messages from an existing queue. Transformers put the necessary information on the Mule Message for subsequent operations to consume. The end result looks like this:


Step 1: Building the Send Flow

  1. Search for http, and drag and drop an HTTP connector to the canvas. This creates a new flow msmq-demoFlow.

  2. Search for payload, and drag a Set Payload Transformer next to the HTTP connector.

  3. Search for logger, and drag a Logger component next to the Set Payload.

  4. Search for msmq, and drag a MSMQ connector next to the Logger.

  5. Double-click HTTP . After its properties dialog displays, select one-way from the Exchange Patterns group. Make sure Host is set to localhost and the Port is set to 9333. S ave the changes.

  6. Double-click Set Payload Transformer . After its properties dialog displays, set Value to #[header:INBOUND:http.relative.path] , and save the changes.

  7. Double-click Logger Component . After its properties dialog displays, set Message to Sending message: #[payload] , and save the changes.

  8. Double-click MSMQ Connector . After its properties dialog displays, select the Config Reference named MSMQ . Leave the rest of the fields with the default values, and save the changes.

Step 2: Building the Receive Flow

  1. Search for msmq and drag a MSMQ Connector to the canvas, outside of the existing flow msmq-demoFlow. This creates a new flow msmq-demoFlow1.

  2. Search for byte and drag a Byte Array To String Transformer next to the MSMQ Connector.

  3. Search for logger and place a Logger Component next to the Byte Array To String Transformer.

  4. Double-click MSMQ Connector . After its properties dialog displays, select the Config Reference named MSMQ , and leave the rest of the properties with the default values. Save the changes.

  5. Double-click the Logger Component. After its properties dialog displays, set Message to Received from queue: #[payload], and save the changes.

Step 3: Running the Flows

  1. Right-click msmq-demo.mflow and click Run As > Mule Application.

  2. Check the console to see when the application starts. You should see a message Started app 'msmq-demo' message if no errors occurred.

    + Started app 'msmq-demo'                                  +
  3. Access the endpoint at http://localhost:9333/Hello-World and check the operation payload.

  4. The following messages should display in the console.

    INFO  XXXX-XX-XX XX:XX:XX,XXX [[msmq-demo].msmq-demoFlow.stage1.02] org.mule.api.processor.LoggerMessageProcessor: Sending message: Hello-World
    INFO  XXXX-XX-XX XX:XX:XX,XXX [[msmq-demo].msmq-demoFlow1.stage1.02] org.mule.api.processor.LoggerMessageProcessor: Received from queue: Hello-World
    INFO  XXXX-XX-XX XX:XX:XX,XXX [[msmq-demo].msmq-demoFlow.stage1.02] org.mule.api.processor.LoggerMessageProcessor: Sending message: Hello-World
    INFO  XXXX-XX-XX XX:XX:XX,XXX [[msmq-demo].msmq-demoFlow1.stage1.02] org.mule.api.processor.LoggerMessageProcessor: Received from queue: Hello-World

See Also

Was this article helpful?

💙 Thanks for your feedback!

Edit on GitHub
Submit your feedback!
Share your thoughts to help us build the best documentation experience for you!
Take our latest survey!