This is documentation for Semarchy xDI 2023.3, which is no longer supported.

For more information, see our Global Support and Maintenance Policy.

AMQP Receive Message

AMQPReceive32x32

Description

Receive messages from an AMQP broker.
This action must be binded to another action.

Parameters

Name	Mandatory	Default	Description
Amqp Commit	No	False	If true, the action commits after the reception. Can be used only in SESSION_TRANSACTED Mode.
Amqp Connection	Yes		Connection used for the reception.
Amqp Addresses	Yes		A comma separated list of AMQP broker addresses, using the following pattern: <host>:<port>
Amqp Virtual Host	No		Name of the AMQP Virtual Host used.
Amqp Login	No		Login/Username of the AMQP Broker to use.
Amqp Password	No		Encrypted password of the User.
Amqp Uncrypted Password	No		Uncrypted password of the User.
Amqp Connection Timeout	No		TCP connection timeout.
Amqp Hand Shake Timeout	No		AMQP protocol handshake timeout.
Amqp Acknowledge Mode	No	SESSION_TRANSACTED	The acknowledge mode defines how the acknowledgement of messages is done. With a transaction in SESSION_TRANSACTED mode, or automatically with AUTO_ACKNOWLEDGE mode.
Amqp Session Name	No	T1	Name of the session. Note that each session represents an AMQP Channel on the Broker.
Amqp Queue Name	No		Name of the Queue to look for messages.
Amqp Message Count	No	–1	Number of messages to retrieve. The messages are retrieved in the order they arrived on the broker.
Amqp Receive Timeout	No	1000	Time to wait for messages in milliseconds.
Amqp Content Encoding	No		Encoding used to decode the message. By default, the action uses the Content Type attribute of the message. If this parameter is set, it will override it.

Name

Mandatory

Default

Description

Amqp Commit

False

If true, the action commits after the reception. Can be used only in SESSION_TRANSACTED Mode.

Amqp Connection

Yes

Connection used for the reception.

Amqp Addresses

Yes

A comma separated list of AMQP broker addresses, using the following pattern: <host>:<port>

Amqp Virtual Host

Name of the AMQP Virtual Host used.

Amqp Login

Amqp Password

Encrypted password of the User.

Amqp Uncrypted Password

Uncrypted password of the User.

Amqp Connection Timeout

TCP connection timeout.

Amqp Hand Shake Timeout

AMQP protocol handshake timeout.

Amqp Acknowledge Mode

SESSION_TRANSACTED

The acknowledge mode defines how the acknowledgement of messages is done. With a transaction in SESSION_TRANSACTED mode, or automatically with AUTO_ACKNOWLEDGE mode.

Amqp Session Name

Name of the session. Note that each session represents an AMQP Channel on the Broker.

Amqp Queue Name

Name of the Queue to look for messages.

Amqp Message Count

–1

Number of messages to retrieve. The messages are retrieved in the order they arrived on the broker.

Amqp Receive Timeout

1000

Time to wait for messages in milliseconds.

Amqp Content Encoding

Encoding used to decode the message. By default, the action uses the Content Type attribute of the message. If this parameter is set, it will override it.

Passwords are encrypted using the encrypt <password> command on the Runtime engine console (engine command line tool).

The following variables are available through the bind link on the target action:

variable	Description
Amqp_String_Content	The content of the message.
<headerName>	Custom headers defined when sending the message.
<attributeName>	Message’s attributes. Refer to the AMQP Send Actions for the list of available attributes. E.g. Amqp_Priority.

variable

Description

Amqp_String_Content

The content of the message.

Custom headers defined when sending the message.

Message’s attributes. Refer to the AMQP Send Actions for the list of available attributes. E.g. Amqp_Priority.