Using the IBM MQ Source Component

The IBM MQ Source Component is an SSIS data flow pipeline component that can be used to read/receive data from IBM MQ/WebSphere MQ. The component includes the following two pages of configuration:

  • General
  • Columns

General Page

The General page allows you to configure various options that will help you receive the desired data from IBM MQ/WebSphere MQ.

IBM MQ source component

Connection Manager

The source component requires an active connection to access IBM MQ/WebSphere MQ. The Connection Manager drop-down will show a list of all IBM MQ Connection Managers that have been created in the current SSIS package.

Entity Type

When an active connection has been established there are two types of entities available to connect to: Queues and Topics.


Depending on the selected entity type, a list of Queues or Topics associated with the queue manager from the connection manager will be listed. If the Entity Type property is set to Queue a list of available queues will be presented and one can be selected. Messages will be retrieved from this queue.


If the Entity Type property is set to Topic the subscription field will be visible. The name of the subscription that will be used to retrieve messages from the topic can be entered here.

Receive Mode

There are two different modes for available for receiving messages: Peek and Receive and Delete.

  • Peek: Messages will be received from the queue without deleting them or modifying the queue in any way.
  • Receive and Delete: Messages will be retrieved and deleted from the queue.
Listener Mode

After the IBM MQ component has retrieved all available messages from the queue or topic it can continue to listen for more messages for a period of time. Listener modes other than None are only compatible with the Receive and Delete receive modes. There are three listener modes available:

  • Fixed Time: Allows the component to listen for messages for a specified period of time.
  • Wait Until: Allows the component to listen for messages until a specified date and time.
  • Wait Until Variable: Allows the component to listen for messages until a date and time specified in a variable.

When new messages are detected in listener mode they may not enter the SSIS pipeline immediately; this depends on the buffer settings of the SSIS task. Internally any row that is directed to an output goes to an SSIS buffer, and SSIS will not actually direct the rows in that buffer until the buffer is considered full, or the component has finished processing all of its data. While in listener mode the component is considered to be processing data until the listener time has expired, which is when the full buffer is guaranteed to be completely processed. To direct rows as fast as possible in listener mode consider lowering the DefaultBufferMaxRows property and DefaultBufferSize properties of the task to the lowest possible values.

Refresh Component Button

Clicking the Refresh Component button causes the component to retrieve the latest metadata and update each field to its most recent metadata. It will remove any custom fields that have been added to the columns page.

Expression fx Icon

Click the blue fx icon to launch SSIS Expression Editor to enable dynamic updates of the property at run time.

Generate Documentation Icon

Click the Generate Documentation icon to generate a Word document that describes the component's metadata including relevant mapping, and so on.

Columns Page

The Columns page shows you all available attributes of messages that will be retrieved. You may indicate which attributes to include in your source component by checking or unchecking the checkbox next to each attribute.

IBM MQ source component - columns