AMQP Send File

AMQPSend32x32

Description

Send a message retrieved from a file on an AMQP broker.

Parameters

Common Parameters

Name	Mandatory	Default	Description
Amqp Commit	No	False	If true, the action commits after sending the message. Can be used only in SESSION_TRANSACTED Mode.
Amqp Wait Confirmation	No	False	If true, the action waits confirmation from the broker that the message is well sent. Can be used only in AUTO_ACKNOWLEDGE Mode and is specific to RabbitMQ.
Amqp Connection	Yes		Connection used to send the message.
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 Exchange Name	No		Name of the Exchange on which the message is sent.
Amqp Routing Key	No		Routing Key used to send the message.
Amqp Queue Name	No		Name of the Queue on which the message will be routed. This parameter is used to perform direct routing to a Queue.
In File Mask	No		Mask of the files to send.
In File Dir	No		Directory containing the message files.
Amqp Sent Files Dir	No		Directory in which sent files will be stored after being sent if Amqp Sent Files Behaviour property is set to move or copy.
Amqp Sent Files Behaviour	No		What to do with sent files.
Amqp Content Encoding	No		Encoding used to encode the message before sending it.

Name

Mandatory

Default

Description

Amqp Commit

False

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

Amqp Wait Confirmation

False

If true, the action waits confirmation from the broker that the message is well sent. Can be used only in AUTO_ACKNOWLEDGE Mode and is specific to RabbitMQ.

Amqp Connection

Yes

Connection used to send the message.

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 Exchange Name

Name of the Exchange on which the message is sent.

Amqp Routing Key

Routing Key used to send the message.

Amqp Queue Name

Name of the Queue on which the message will be routed. This parameter is used to perform direct routing to a Queue.

In File Mask

Mask of the files to send.

In File Dir

Directory containing the message files.

Amqp Sent Files Dir

Directory in which sent files will be stored after being sent if Amqp Sent Files Behaviour property is set to move or copy.

Amqp Sent Files Behaviour

What to do with sent files.

Amqp Content Encoding

Encoding used to encode the message before sending it.

If you are using the Amqp Queue Name parameter to perform direct routing, Amqp Exchange Name and Amqp Routing Key must be left empty.

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

Sent Files Behaviour:

keep: keep it where it is.
move: move it in the directory set in `Jms Sent Files Dir' property.
copy: copy it in the directory set in `Jms Sent Files Dir' property.
delete: delete it.

AMQP attributes

The AMQP attributes are optional and may be interpreted and used differently depending on the broker implementation. They are mostly used for informational purpose. They are added to the message and can be retrieved when the message is received with the AMQP Receive Actions.

Name	Type	Description
Amqp_App_Id	String	The application sending the message.
Amqp_Content_Type	String	Message’s content type.
Amqp_Message_Id	String	An identifier for the message.
Amqp_Reply_To	String	Address to reply to.
Amqp_Priority	String	A number representing the priority of the message. The range of priorities depends on the effective implementation of the broker used.
Amqp_Expiration	String	Message’s expiration. Brokers implementing this attribute use it to define the expiration of the message. The format depends on the broker. For RabbitMQ, it is a number of milliseconds.

Name

Type

Description

Amqp_App_Id

String

The application sending the message.

Amqp_Content_Type

String

Message’s content type.

Amqp_Message_Id

String

An identifier for the message.

Amqp_Reply_To

String

Address to reply to.

Amqp_Priority

String

A number representing the priority of the message. The range of priorities depends on the effective implementation of the broker used.

Amqp_Expiration

String

Message’s expiration. Brokers implementing this attribute use it to define the expiration of the message. The format depends on the broker. For RabbitMQ, it is a number of milliseconds.

AMQP headers

The action offers the possibility to add AMQP headers to the message.
Particularly useful for headers Exchanges.
To add an AMQP header to the message, add an AMQP_HEADER_<headerName> parameter to the action.
You can create as many headers as you want.

Name

Type

Description

AMQP_HEADER_<headerName>

String

A custom header.