WebSphereMQ Configuration

Applies to ReadyAPI 3.53, last modified on May 15, 2024

This topic describes how to install IBM WebSphereMQ on your computer and create a simple configuration.

1. Install WebSphere MQ

  1. Download the IBM WebSphereMQ installer from the IBM website and run it:


    Note: Please make sure to use an MQ Client 9.2.4 or higher version when using ReadyAPI 3.40.0 or later, as these versions of ReadyAPI use Java 17+. IBM recommends using MQ Client version 9.2.4 or higher for Java 17+. Please refer to this link for more information.
  2. Follow the instructions of the installation wizard.

  3. After the installation is complete, open the WebSphere MQ Explorer. The following steps show how you can use this application to create a basic configuration.

    Click the image to enlarge it.

2. Create a Queue Manager

Before creating a queue, you need to create a queue manager. Queue managers handle application connections to queues listed in the manager and manage the queues. They ensure that the commands are executed properly, events happen and messages are added to the appropriate queues. To create a queue manager:

  1. Right-click Queue Managers in the navigator panel and select New > Queue Manager

    Click the image to enlarge it.

  2. Specify a name for the queue manager.

    This name will be used later when configuring destinations.

    Click the image to enlarge it.

  3. Click Next > Next > Next and specify a port number in the Listen on port number field. You can leave the default port number and go to the next step.

  4. Click Finish to create the queue manager.

3. Disable Authentication

To simplify the connection process, disable authentication for the queue manager:

This step is not obligatory. You can still connect to the WebSphereMQ server that requires authentication.
  1. Right-click the created queue manager and select Properties.

  2. In the subsequent dialog, switch to the Communications tab and set the Channel authentication records option to Disabled.

    Click the image to enlarge it.

  3. Close the dialog.

  4. Make sure there are no items in the QueueManagerName > Channels > Channel Authentication Records panel.

4. Create a Queue

Queues in Websphere MQ are message containers. When an application is connected to a queue manager, it can retrieve messages from a queue or add them to a queue. To create a queue:

  1. Right-click the QueueManagerName > Queues item in the navigator panel and select New > Local Queue.

  2. In the subsequent dialog, specify the queue Name.

  3. Click Finish to create the queue with the default parameters, or click Next to configure advanced queue properties.

5. Create an Initial Context

An initial context provides applications that connect to WebSphere MQ with a context they can use to interact with it and a starting point for name resolution. Without it, an application will be unable to connect to a queue.

To add an initial context:

  1. Right-click JMS Administered Objects and select Add Initial Context.

  2. In the subsequent dialog, select the File System option.

  3. In the Binding directory field, specify the path to an empty folder.

  4. Click Finish.

  5. IMPORTANT: Save the Initial Context Factory and Provider URL values. You will need these values when you create a plugin or establish a manual connection.

6. Create a Connection Factory

A connection factory is a Java object that a client uses to create a connection to the JMS provider. To create it in WebSphere MQ:

  1. Right-click Initial Context > Connection Factories and select New > Connection Factory.

  2. In the subsequent dialog, specify a name for the connection factory.

  3. IMPORTANT: Save the connection factory name. You will need this value when you create a plugin or establish a manual connection.

  4. In the Messaging provider drop-down list, select WebSphere MQ.

  5. Click Next > Next.

  6. In the Transport drop-down list, select MQ Client.

  7. Follow the instructions of the wizard.

7. Create Destinations for Queues

Destinations add queues to an initial context so that an application that connects to WebSphere MQ and gets a context can find them.

  1. Right-click Initial Context > Destinations and select New > Destination.

  2. In the subsequent dialog, specify the destination name.

  3. Click Next > Next.

  4. In the Queue manager field, specify the name of the queue manager you created earlier.

  5. In the Queue field, specify the name of the queue you created earlier.

  6. Close the dialog. If necessary, create destinations for other queues you created.

Where to Go Next

You have configured the WebSphere MQ service. It is now ready to receive requests from applications and handle them. To continue working with it from ReadyAPI, create a JMS virtual service that will connect to the WebSphere MQ service directly:

See Also

JMS Request Test Step

Highlight search results