AMQPGetMessage

You can use the AMQPGetMessage activity to retrieve messages from a specified queue.

General

The following table describes the configurations on the General tab of the AMQPGetMessage activity.

Field Module Property? Description
Name No Specifies a name of the activity displayed in the process. The default value is AMQPGetMessage.
Connection Yes Click to select an AMQP Connection shared resource. The AMQP Connection shared resource creates a connection between the plug-in and an AMQP server.

If no matching AMQP Connection shared resources are found, click Create Shared Resource to create one. For more details, see Creating an AMQP Connection.

Queue Name Yes

Enter the name of the queue from where the message is received.

Note: This field is available when RabbitMQ-1-0 is selected from the Broker Type list of the used AMQP Connection shared resource.
Entity Type No

Select an entity type from the following:

  • Queue
  • Topic

Note: This field is not available when RabbitMQ-1-0 is selected from the Broker Type list of the used AMQP Connection shared resource.

Entity Name Yes

Enter the name of the queue or topic entity from where the message is received.

Note: This field is not available when RabbitMQ-1-0 is selected from the Broker Type list of the used AMQP Connection shared resource.

Subscription Name Yes Enter the name of the subscription from where the message is received.

Note:
  • This field is not available when RabbitMQ-1-0 is selected from the Broker Type list of the used AMQP Connection shared resource.

  • This field is available only when Topic is selected as the Entity type.
Durable Subscription No

Select this checkbox to create a durable subscription.

Note:
  • This field is not available when RabbitMQ-1-0 or AzureSB-1-0 is selected from the Broker Type list of the used AMQP Connection shared resource.

  • This field is available only when Topic is selected as the Entity type.
Shared Subscription No

Select this checkbox to create a shared subscription.

Note:
  • A shared subscription is not supported with ActiveMQ-1-0, RabbitMQ-1-0 or AzureSB-1-0 from the Broker Type dropdown list of the used AMQP Connection resource.

  • This field is available only when Topic is selected as the Entity type.
Message Type No Select one of the following message types:

  • TextMessage: the message is in the String format.
  • BytesMessage: the message is in the Byte stream format.
  • Simple: the message does not have a message body.

Acknowledge Mode No Select one of the following acknowledge modes:

  • Auto: the message is automatically acknowledged when being received.
  • Client: the message is acknowledged after being received by the Confirm activity.
    Note: Ensure that the message can be confirmed when you use the Client mode. If the message is not confirmed before the process instance ends, the message is kept as Unacked status and is still in the queue.

The default value is Auto.

Description

On the Description tab, you can add a short description for the AMQPGetMessage activity.

Input

The Input tab displays the input schema of the activity as a tree structure. The input values vary depending on the value selected for Entity Type on the General tab. The value specified for the queueName or topicName field on the Input tab takes precedence over the value specified for theEntity Name field on the General tab. The following table describes the input elements on the Input tab of the AMQPGetMessage activity.

 

Input Item Data Type Description
queueName String Enter the name of the queue from which you want to get the message.
Note: The queueName field is only displayed when the Entity Type is selected as Queue on the General tab.
topicName String Enter the name of the topic from where the message is received.
Note: This field is not available when RabbitMQ-1-0 is selected from the Broker Type list of the used AMQP Connection shared resource and the Entity Type field on the General tab is Topic.
subscriptionName String Enter the name of the subscription from where the message is received.
Note: This field is not available when RabbitMQ-1-0 is selected from the Broker Type list of the used AMQP Connection shared resource and the Entity Type field on the General tab is Topic.

Note: The Input tab of the AMQPGetMessage activity is not available on projects created before version 6.0.2 of ActiveMatrix BusinessWorks Plug-in for AMQP.

Output

The following table describes the output elements on the Output tab of the AMQPGetMessage activity.

Output Item Data Type Description
UserProperties Complex The message header consists of the following user properties:
  • name (a String value): the name of the user property.
  • type: the property data type. The valid data types include String, Number, and Boolean.
  • value (a String value): the value of the user property.
    Note: If the property data type is Boolean, any other value except for true or True or TRUE is considered false.
MessageProperties Complex The message properties are listed as follows:
  • deliveryMode (a Boolean value): the delivery mode of the messages. If the value is set to true, the messages are stored before forwarding. If the value is set to false, the messages are not stored before forwarding. In this case, if the transmission failed, the messages might be lost.
  • messageID (a String value): the message ID of the received message.
  • timestamp (an Integer value): the time when the message is sent to the queue.
  • expiration (an Integer value): the time of the message remains active (in milliseconds).
    Note: For Qpid-1-0, AMQ-1-0, AzureSB-1-0, ActiveMQ-1-0, and ActiveMQ-Artemis-1-0 displays the point in time of the expiration. For RabbitMQ, displays the active time length.
  • priority (an Integer value): the delivery priority of the message.
  • type (a String value): the event type or command type the message represents.
  • contentType (a String value): value indicating the message content type.
  • correlationID (a String value): value specifying the context for the message for correlation.
    Note: This field is available only when AzureSB-1-0 is selected from the Broker Type list of the used AMQP Connection shared resource.
  • entityPath: relative path of the Queue or Topic entity depending on whether the activity is getting the message from an Azure Service Bus Queue or Topic.
    Note: Displayed only when AzureSB-1-0 is chosen as the broker type in the selected shared resource for this activity. If Queue is chosen as the Entity Type, the value would be the Queue name. If Topic is chosen as the Entity Type, the value would be of the form <topicname>/subscriptions/<subscriptionname>
body String/Byte The message body of the received message:
  • If TextMessage is selected from the Message Type list of the General tab, the message is in the String format.
  • If BytesMessage is selected from the Message Type list of the General tab, the message is in the String format.
Note: If Simple is selected from the Message Type list of the General tab, the body field is unavailable.

Fault

The following table describes the error schema elements on the Fault tab of the AMQPGetMessage activity.

Error Schema Element Description
AMQPPluginException This error message is displayed when the plug-in captures any exception related to the process of sending a message to an AMQP broker.
AMQPConnectionException This error message is displayed when any exception about the connection problem occurs in the process of sending a message to an AMQP broker.
Note: Connection Recovery is not applicable with AMQPGetMessage activity for the RabbitMQ broker.