You can start a process with the AMQPReceiveMessage activity. The process is triggered when the plug-in receives a message from a specified AMQP broker queue.
General
The following table lists the configurations on the
General tab of the AMQPReceiveMessage activity.
Field
|
Module Property?
|
Description
|
Name
|
No
|
The name of the activity displayed in the process. The default value is
AMQPReceiveMessage.
|
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 for the queue from which the message is received.
|
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 AMQPReceiveMessage activity.
Advanced
The following table describes the configurations on the
Advanced tab of the AMQPReceiveMessage activity.
Field
|
Module Property?
|
Description
|
Sequence Key
|
No
|
This field contains an XPath expression that specifies the order in which the process runs. Process instances with sequencing keys that have the same value are executed sequentially in the order in which the process instances are created.
See the TIBCO ActiveMatrix BusinessWorks documentation for more details.
|
Custom Job Id
|
No
|
This field contains an XPath expression that specifies a custom job ID for every job in the process instance.
See the TIBCO ActiveMatrix BusinessWorks documentation for more details.
|
Conversations
On the
Conversations tab, you can click the
Add New Conversation
icon to initiate a conversation. A conversation represents two or more related message exchanges in the same process that are correlated by the BusinessWorks engine.
Output
The following table describes the output elements on the
Output tab of the AMQPReceiveMessage 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, 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.
|
Copyright © Cloud Software Group, Inc. All rights reserved.