Skip to main content

Integrating IBM MQ with Orkes Conductor

This developer guide includes the steps to integrate IBM MQ with Orkes Conductor. This integration lets you connect your IBM MQ server to Conductor to publish and subscribe messages to/from IBM MQ.

Get Configuration Credentials from IBM MQ

Before beginning the integration process, you must obtain certain configuration parameters from the IBM MQ console, such as hostname, port, queue manager, channel, etc.

You can get the host name & port while setting up IBM MQ.

Refer to the official IBM documentation for more configuration details.

Integrating with IBM MQ as a Message Broker

Once you have the required configuration credentials from IBM MQ, let’s integrate with Orkes Conductor.

  1. Navigate to Integrations from the left menu on the Conductor cluster.
  2. Click + New integration from the top-right corner of your window.
  3. Under the Message Broker section, choose IBM MQ.
  4. Click +Add and provide the following parameters:

Integration configuration for IBM MQ

Integration NameA name to identify your integration.
Host NameThe hostname or IP address of the IBM MQ server.
PortThe port number on which the IBM MQ server is configured to listen for incoming connections. The default port for IBM MQ is 1414, but it usually varies with the required connection.
Queue ManagerSpecify the queue manager to which Orkes Conductor will connect.

The queue manager should already be configured in your IBM MQ environment. Check out IBM MQ’s official documentation on configuring queue manager.
ChannelIBM MQ uses channels to establish connections between clients and queue managers. Specify the channel name the Conductor will use to communicate with IBM MQ.
UserThe username to authenticate the connection with the IBM MQ server.
PasswordThe password associated with the username to authenticate the connection with the IBM MQ server.
DescriptionProvide a description of the integration.
  1. You can toggle on the Active button to activate the integration instantly.
  2. Click Save.

Creating Event Handlers in Orkes Conductor

The integration is created successfully now. The next step is to create an event handler in Orkes Conductor.

To do this:

  1. Navigate to Definitions > Event Handler from the left menu on your Conductor console.
  2. Click the + Define event handler option from the top-right corner of the window.
  3. Create an event handler with the following configurations:

Configuring Event Handler for IBM MQ Integration

Event Handler ParametersDescription
NameProvide a name to identify your event handler definition.
EventProvide the event integration you have created in the following format:

Type : Config Name : Queue Name

Example: ibm_mq:ibm-mq:queue-name

Notes: The drop-down automatically lists the integration you’ve added to the Conductor cluster. You can choose that and add the queue name to which you want to publish/receive messages.
ConditionProvide the ECMAScript to control the message processing if required. Check out the event handler documentation for more details.
ActionsChoose the required actions to be carried out when sending/receiving the events from IBM MQ. It can take the following values:
  • Complete Task
  • Terminate Workflow
  • Update Variables
  • Fail Task
  • Start Workflow
Each type of action requires and supports a certain set of input parameters. Check out the event handler documentation for more details.
ActiveSet this to true or false. It determines if the event handler is running or not.

A sample JSON for the event handler is as follows:

"name": "event-handler-ibm",
"event": "ibm_mq:ibm-mq:queue_name",
"evaluatorType": "javascript",
"condition": "true",
"actions": [
"action": "start_workflow",
"start_workflow": {
"name": "http-test",
"version": "1"
"expandInlineJSON": false

RBAC - Governance on who can use Integrations

Once the integration is added, the next step is determining who can access these integrations.

The permissions can be granted to applications/groups within the Orkes Conductor cluster.

To provide explicit permission to Groups:

  1. From the left menu on your Conductor cluster, navigate to Access Control > Groups.
  2. Create a new group or choose an existing group.
  3. Under the Permissions section, click +Add Permission.
  4. From the Integrations sub-tab, choose the integration with required permissions.
  5. Click Add Permissions. This ensures that all the group members can access these integration models in their workflows.

Configuring RBAC for IBM MQ Integration

Similarly, you can also provide permissions to applications.

Creating Workflow in Orkes Conductor

This step involves creating a workflow with an event task in Orkes Conductor. Here, we are utilizing the IBM MQ queue as a sink for the event.

You can quickly build a workflow from UI in Orkes Conductor.

For this,

  1. Navigate to Definitions > Workflow, and click the Define Workflow button.
  2. Create a workflow and add an event task at the required point with the Sink in the format ibm_mq:ibm-mq:queue-name, where “ibm-mq” is the integration name and “queue-name” is the queue to which Conductor should send/receive messages.

Event task for IBM MQ Integration in Orkes Conductor

Executing Workflow in Orkes Conductor

The workflow can be run using different methods. You can use the Run Workflow button for quick testing, as shown in the image below:

Running workflow from Orkes Conductor UI

Upon successful execution, you can verify the message's delivery through the IBM MQ console.

The action added in the event handler definition was to start the workflow http-test. You can verify this from the Executions > Workflow page.

Starting workflow on sending events