Help Manual - Premium Message Queue Task

Documentation on SSIS Premium Message Queue Task component

Using the Premium Message Queue Task Component

The Premium Message Queue Task component is used to send or receive messages to or from message queues. There are two pages to configure:

  • General
  • Error Handling

General Page

SSIS Premium Message Queue Task Component

Connection Manager

The task requires a connection manager. You can choose from the ones available below:

  • ActiveMQ (since v21.2)
  • Amazon SQS
  • AMQP
  • Azure Queue Storage (since v22.1)
  • Azure Service Bus
  • IBM MQ
  • Kafka (since v22.1)
  • MSMQ
  • RabbitMQ
Action
Receive Mode

Choose this mode for receiving messages from the queue.

Send Mode

Choose this mode to send messages to the queue.

Receive mode options (Available for Receive mode only)

You can choose between the actions. There are two different modes for available for receiving messages:

  • Peek: Messages will be received from the queue without deleting them or modifying the queue in any way.
  • Receive Messages and Delete: Messages will be retrieved and deleted from the queue.
Exchange (Only available to RabbitMQ connection)

The name of the exchange to receive messages from.

Queue

The name of the queue to receive messages from.

Encoding

Choose the encoding type from the list.

Message Label

Choose the message label as file or variable or none:

  • None
  • Variable - Choose from the available variables
  • File - Choose using the file browser
Message Body

Choose the message body as file or variable, or none:

  • None
  • Variable - Choose from the available variables
  • File - Choose using the file browser
Listener Mode (Only for receive mode)

There are three listener modes available:

  • Fixed Time Mode: Allows the component to exit the listener mode after a specified period if no message is received in the queue.
  • Wait Until Mode: Allows the component to exit the listener mode until a specified date and time if no message is received in the queue.
  • Wait Until Variable Mode: Allows the component to exit the listener mode until a date and time specified in a variable if no message is received in the queue.
  • Until Service is Stopped: Allows the component to listen till a message occurs
Expression fx Icon

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

Advanced Page

This page is available for Send mode only.

SSIS Premium Message Queue Task Component

Delivery Mode

The delivery mode can be set to Persistent or Non-Persistent.

  • Persistent: Messages are stored on disk on the server and will persist after a server restart.
  • Non-Persistent: Messages are only stored in memory.
Priority
The priority of sent messages.
Publisher Confirms
This could be set to True or False.

Error Handling Page

This page can be used to handle errors.

SSIS Premium Message Queue Task Component

You can choose among the three options below:

  • Fail on error
  • Write on error
  • Ignore error