Versions Compared


  • This line was added.
  • This line was removed.
  • Formatting was changed.


The IBM Websphere MQ Consumer step allows Pentaho Data Integration to receive text messages from any IBM Websphere MQ Server. This step is has been tested against the 7.x version of IBM Websphere MQ Server. 


License Information: Enterprise Edition only




Step Name

Optionally, you can change the name of this step to fit your needs.

MQ Connection

Enable MQ Connection if you are using an MQ connection string to connect to your IBM Websphere MQ Server.


Enter the appropriate connection URL. The syntax of the URL should follow:

host (required) should be the name or IP address of the IBM Websphere MQ Server host machine.
port (required) by IBM default is usually 1414. Your administrator may have changed this default.
queue_manager_name (required) is the name of the QueueManager you wish to contact (should be configured beforehand).
optional_channel_name (optional) is the name of the channel you wish to send or receive messages on. If the channel is not specified, the IBM default channel (SYSTEM.DEF.SVRCONN) is used.


Enter the IBM Websphere MQ Server authorized user name.


Enter the IBM Websphere MQ Server password.

Jndi Connection

Enable JNDI Connection if you are using the Java Naming and Directory Interface (JNDI) to connect to the IBM Websphere MQ Server.

Jndi URL

The URL for the JNDI connection.


Select Topic or Queue from the drop down list to specify whether you want to use a Topic or Queue delivery model.Topic uses a publish/subscribe delivery model meaning that a one message can be delivered to multiple consumers. Messages are delivered to the topic destination, and ultimately to all active consumers who are subscribers of the topic. Also, any number of producers can send messages to a topic destination; each message can be delivered to any number of subscribers. If there are no registered consumers, the topic destination does not hold messages unless it has durable subscription for inactive consumers. A durable subscription represents a consumer registered with the topic destination that can be inactive at the time the messages are sent to the topic.
Queue uses a point-to-point delivery model. In this model, a message is delivered from a single producer to a single consumer. The messages are delivered to the destination, which is a queue, and then delivered to one of the consumers registered for the queue. While any number of producers can send messages to the queue, each message is guaranteed to be delivered, and consumed by one consumer. If no consumers are registered to consume the messages, the queue holds them until a consumer registers to consume them.


Specify the queue or topic name.
When specifying a queue name, the following syntax should be used: queue:///queue_name
When specifying a topic string, follow IBM topic string syntax guide for syntax and wildcarding your topic string.

Receive Timeout

Specify the time to wait for incoming messages in milliseconds.Note: A timeout setting of zero never expires.

Field Name

Specify the field name that contains the contents of the message.

Context & Examples

Please see Processing Message Queues with IBM Websphere MQ