IBM WebSphere MQ Adapter Sample

About This Sample

This sample demonstrates the use of the TIBCO StreamBase® Adapter for IBM MQ Series.

IBM MQ Middleware Dependencies

You must obtain the required IBM MQ Java libraries directly from IBM. The easiest way to make the IBM MQ API accessible to StreamBase is install them as Maven dependencies into your Maven repository.

The IBM MQ sample comes with Studio launch files which perform a Maven install to the local Maven repository to aid in running the sample; simply copy the JAR files into the root of the sample project and run each launch config to install. It is however recommended you install to your main Maven repository to make sure they are available to all machines you may distribute your code to.

Obtain the following required IBM MQ JAR files from an IBM MQ Series 7.0 installation, or from IBM:

Importing This Sample into StreamBase Studio

In StreamBase Studio, import this sample with the following steps:

  • From the top-level menu, click FileLoad StreamBase Sample.

  • Type IBM to narrow the list of options.

  • Select ibm-websphere-mq from the StreamBase Messaging Adapters category.

  • Click OK.

StreamBase Studio creates a project for this sample.

Running ibm-websphere-mq.sbapp in StreamBase Studio


To use this sample, you must have access to a valid IBM WebSphere MQ server.

  1. In the Project Explorer, open the sample you just loaded.

  2. Open the src/main/eventflow folder.

  3. Open the package folder (most samples contain a single package folder. Open the top-level package folder if your sample contains more than one folder).

  4. Open the named application file.

    If you see red marks, wait a moment for the project in Studio to load its features.

    If red marks do not resolve themselves in a moment, select the project and right-click MavenUpdate Project from the context menu.

  5. Select the MQInput adapter icon to open the Properties view for the adapter.

  6. Select the Adapter Properties tab and enter valid values for Host Name, Port Number, Queue Manager, Queue Name, and Channel.

  7. Repeat the previous two steps for the MQOutput adapter. Enter values for Reply To Queue Manager and Reply To Queue Name as well.

  8. Click the Run button. This opens the SB Test/Debug perspective and starts the application.

  9. In the Test/Debug Perspective, open the Output Streams view. If connectivity to your IBM WebSphere MQ server is configured correctly, look for tuples emitted on the InputStatus and OutputStatus streams indicating the adapter has connected successfully.

  10. In the Manual Input view, select the SendMessage stream. Enter a value in the Payload field, set the MyTuple field to null, and press Send Data.

  11. Observe that the payload value is emitted on the ReceivedMessage stream.

  12. When done, press F9 or click the Stop Running Application button.

Sample Location

When you load the sample into StreamBase Studio, Studio copies the sample project's files to your Studio workspace, which is normally part of your home directory, with full access rights.


Load this sample in StreamBase Studio, and thereafter use the Studio workspace copy of the sample to run and test it, even when running from the command prompt.

Using the workspace copy of the sample avoids permission problems. The default workspace location for this sample is:


See Default Installation Directories for the default location of studio-workspace on your system.