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. See
Creating an AMQP Connection for more details.
|
Queue Name
|
Yes
|
Enter the name of the queue from which you want to get the message.
|
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 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 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 value entered in the
queueName field overwrites the value entered in the
Queue Name field on the
General tab. The input item is not displayed on the
Input tab when
RabbitMQ-0-9 is selected.
|
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 and
ActiveMQ-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.
|
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.
|
Copyright © Cloud Software Group, Inc. All rights reserved.