AMQP Task

Properties   Config Settings  

An easy-to-use AMQP 1.0 client implementation.

Remarks

The AMQP task provides an easy-to-use AMQP 1.0 client implementation. The task supports both plaintext and TLS-enabled connections over TCP.

AMQP Send Task

At a minimum, you must supply an RemoteHost, RemotePort, and ContainerId for the connection. In order to authenticate with the AMQP broker you will need to specify a User and Password. The AuthScheme property contains a preferential list of authentication methods to be enabled on the task.

The task will send the contents of the MessageValue property.

The AMQP Sender Task has support for SSL transport layer security. This may be enabled by setting SSLStartMode, SSLCert and SSLAcceptServerCert to appropriate values.

Sender Property List

---

The following is the full list of the properties of the sender task with short descriptions. Click on the links for further details.

AuthScheme	The authentication scheme to use when connecting.
ContainerId	The container Id the component should advertise when connecting.
Firewall	A set of properties related to firewall access.
IdleTimeout	The maximum period of inactivity the component will allow before disconnecting.
LinkName	The name of the sender or receiver link.
LogFile	The file to write logging information to at runtime.
LogMode	What information gets logged during component execution.
MessageAbsoluteExpiryTime	The absolute time at which this message should be considered expired.
MessageApplicationProperties	The application properties for the message.
MessageContentEncoding	The content encoding of this message's data.
MessageContentType	The content type of this message's data.
MessageCorrelationId	The correlation Id of this message.
MessageCreationTime	The creation time of this message.
MessageDeliveryCount	How many previous attempts there have been to deliver this message.
MessageDurable	Whether this message is durable.
MessageFirstAcquirer	Whether this message may have been acquired by other links previously.
MessageGroupId	The Id of the group this message belongs to.
MessageGroupSequence	The position of this message within its group.
MessageId	The unique Id of this message.
MessagePriority	The priority of this message.
MessageReplyTo	The address of the node to send replies to for this message.
MessageReplyToGroupId	The Id of the group to send replies to for this message.
MessageSettled	Whether this message is settled.
MessageSubject	The subject of this message.
MessageTo	The address of the node which this message is intended for.
MessageTTL	The time-to-live value for this message.
MessageUserId	The identity of the user responsible for producing this message.
MessageValue	This message's value.
MessageValueType	This message's value data type.
Other	Defines a set of configuration settings to be used by the component.
Password	A password to use for SASL authentication.
RemoteHost	The address of the remote host. Domain names are resolved to IP addresses.
RemotePort	The port of the AQMP server (default is 5672).
RuntimeLicense	Specifies the component runtime license key.
SendTarget	The address of the node at the target receiver.
SessionName	The name of the session to send to or receive from.
SSLAcceptServerCert	Instructs the component to unconditionally accept the server certificate that matches the supplied certificate.
SSLAcceptServerCertAcceptAny	Tells the component to accept any server certificate.
SSLCert	The certificate to use for client authentication during the SSL handshake.
SSLStartMode	Determines how the component starts the SSL negotiation.
Timeout	A timeout for the component.
User	A username to use for SASL authentication.

Config Settings

---

The following is a list of config settings for the task with short descriptions. Click on the links for further details.

AuthorizationIdentity	The value to use as the authorization identity when SASL authentication is used.
BinaryMessageEncoding	Sets the expected message encoding to use for decoding binary messages.
DecodeBinaryMessage	Decodes binary message payloads.
DefaultCredit	The amount of credit to create new receiver links with.
DefaultCreditThreshold	The credit threshold to create new receiver links with.
DefaultIncomingWindow	The incoming window size to create new sessions with.
DefaultOutgoingWindow	The outgoing window size to create new sessions with.
DefaultReceiverSettleMode	The receiver settle mode to create new links with.
DefaultSenderSettleMode	The sender settle mode to create new links with.
GenerateCreationTime	Whether the message creation time should be automatically generated when sending a message.
GenerateMessageId	Whether a unique message Id should be automatically generated when sending a message.
InputFileEncoding	The encoding used for the sent messasge data.
MaxFrameSize	The maximum frame size.
MaxMessageSize	The maximum message size to restrict new links to.
MessageRelativeExpirationTime	Sets the number of seconds until the message expires.
ProtocolVersion	The AMQP protocol version to conform to.
ReuseSSLSession	Determines if the SSL session is reused.
SSLCipherStrength	The minimum cipher strength used for bulk encryption.
SSLEnabledCipherSuites	The cipher suite to be used in an SSL negotiation.
SSLEnabledProtocols	Used to enable/disable the supported security protocols.
SSLIncludeCertChain	Whether the entire certificate chain is included in the SSLServerAuthentication event.
SSLSecurityFlags	Flags that control certificate verification.
TLS12SignatureAlgorithms	Defines the allowed TLS 1.2 signature algorithms when UseInternalSecurityAPI is True.
TLS12SupportedGroups	The supported groups for ECC.
TLS13KeyShareGroups	The groups for which to pregenerate key shares.
TLS13SignatureAlgorithms	The allowed certificate signature algorithms.
TLS13SupportedGroups	The supported groups for (EC)DHE key exchange.
AbsoluteTimeout	Determines whether timeouts are inactivity timeouts or absolute timeouts.
LocalHost	The name of the local host or user-assigned IP interface through which connections are initiated or accepted.
TcpNoDelay	Whether or not to delay when sending packets.
UseInternalSecurityAPI	Whether or not to use the system security libraries or an internal implementation.

AuthScheme Property (AMQP Task)

The authentication scheme to use when connecting.

Data Type

Enumeration

Possible Values

None (0)
SASLAnonymous (1)
SASLPlain (2)

Default Value

1

Remarks

This property controls what authentication scheme the task should use when connecting to the remote host.

Valid values are:

• smNone (0)
• smSASLAnonymous (1) - Default
• smSASLPlain (2)

ContainerId Property (AMQP Task)

The container Id the component should advertise when connecting.

Data Type

String

Default Value

""

Remarks

This property specifies the container Id that the task should advertise when it's connecting to the remote host.

In AMQP, the top-level organizational grouping is called a "container", and each container can contain zero or more "nodes", which are the actual entities which send and receive messages over links.

Since this task handles multiple layers of the AMQP transport protocol (the overall connection, the sessions in that connection, and the links attached to those sessions), it must be given a unique container Id.

Note: The container Id cannot be changed while connected.

Firewall Property (AMQP Task)

A set of properties related to firewall access.

Data Type

Firewall

Remarks

This is a Firewall type property which contains fields describing the firewall through which the task will attempt to connect.

IdleTimeout Property (AMQP Task)

The maximum period of inactivity the component will allow before disconnecting.

Data Type

Integer

Default Value

0

Remarks

This property controls how long, in seconds, the task will allow the connection to sit idle before it disconnects from the remote host.

This property may be set to 0 to prevent the task from ever closing the connection due to inactivity.

Note: The idle timeout cannot be changed while connected.

LinkName Property (AMQP Task)

The name of the sender or receiver link.

Data Type

String

Default Value

""

Remarks

LinkName specifies the receiver link which should fetch a message; if there is no such link an error is thrown.

LogFile Property (AMQP Task)

The file to write logging information to at runtime.

Data Type

String

Default Value

""

Remarks

To write logging information to a file instead of using the task's logging API, set this property to a valid file on disk.

When set, any logging information is appended to the specified file and not written to the task's logging API.

LogMode Property (AMQP Task)

What information gets logged during component execution.

Data Type

Enumeration

Possible Values

Verbose (0)
Info (1)
Warning (2)
Error (3)
Fatal (4)

Default Value

3

Remarks

This property controls what information the task logs. The possible values have the following affect on the task's behavior:

MessageAbsoluteExpiryTime Property (AMQP Task)

The absolute time at which this message should be considered expired.

Data Type

String

Default Value

"0"

Remarks

This property specifies the absolute time at which this message should be considered expired. It may be -1 if this message does not have an absolute expiry time.

This property value should be specified in milliseconds relative to the Unix epoch (January 1, 1970 00:00:00 UTC).

MessageApplicationProperties Property (AMQP Task)

The application properties for the message.

Data Type

String

Default Value

""

Remarks

This property specifies optional application properties for the message, which can be used to pass arbitrary data.

For the sender, the expected format is:

"Key1=Value1\r\nKey2=Value2"

For the receiver, this would be available as a JSON string of the full application properties, for example:

{"descriptor":{"type":"ulong","value":116},"type":"map","value":["Key1","Value1","Key2","Value2"]}

MessageContentEncoding Property (AMQP Task)

The content encoding of this message's data.

Data Type

String

Default Value

""

Remarks

This property specifies the content encoding of this message's data. It may be empty if this message does not have a content encoding set.

When constructing a message for sending, this property is ignored if MessageValueType is not set to mvtBinary (16).

MessageContentType Property (AMQP Task)

The content type of this message's data.

Data Type

String

Default Value

""

Remarks

This property specifies the content type of this message's data. It may be empty if this message does not have a content type set.

When constructing a message for sending, this property is ignored if MessageValueType is not set to mvtBinary (16).

MessageCorrelationId Property (AMQP Task)

The correlation Id of this message.

Data Type

String

Default Value

""

Remarks

This property specifies the correlation Id of this message. It may be empty if this message does not have a correlation Id.

MessageCreationTime Property (AMQP Task)

The creation time of this message.

Data Type

String

Default Value

"0"

Remarks

This property specifies the absolute creation time of this message. It may be -1 if this message does not have a creation time set.

This property's value should be specified in milliseconds relative to the Unix epoch (January 1, 1970 00:00:00 UTC).

MessageDeliveryCount Property (AMQP Task)

How many previous attempts there have been to deliver this message.

Data Type

Integer

Default Value

0

Remarks

This property indicates how many (unsuccessful) previous attempts there have been to deliver this message.

MessageDurable Property (AMQP Task)

Whether this message is durable.

Data Type

Boolean

Default Value

false

Remarks

This property specifies whether this message is durable or not.

If a message is marked as durable, any intermediate nodes which cannot guarantee that the message won't be lost under any circumstances will not accept the message.

MessageFirstAcquirer Property (AMQP Task)

Whether this message may have been acquired by other links previously.

Data Type

Boolean

Default Value

false

Remarks

This property specifies whether this message might have previously been acquired by other links.

MessageGroupId Property (AMQP Task)

The Id of the group this message belongs to.

Data Type

String

Default Value

""

Remarks

This property specifies the Id of the group that this message belongs to. It may be empty if this message does not belong to a group.

MessageGroupSequence Property (AMQP Task)

The position of this message within its group.

Data Type

Integer

Default Value

0

Remarks

This property specifies the relative position of this message within its group. It may be -1 if this message does not belong to a group.

MessageId Property (AMQP Task)

The unique Id of this message.

Data Type

String

Default Value

""

Remarks

This property holds the unique Id of this message. It may be empty if this message does not have a unique Id.

MessageLinkName Property (AMQP Task)

The name of the link this message is associated with.

Data Type

String

Default Value

""

Remarks

This property holds the name of the link which this message was received on.

This property is not available in the Sender.

MessagePriority Property (AMQP Task)

The priority of this message.

Data Type

Integer

Default Value

4

Remarks

This property holds the priority of this message; the default is 4 (as defined by the AMQP specification).

MessageReplyTo Property (AMQP Task)

The address of the node to send replies to for this message.

Data Type

String

Default Value

""

Remarks

This property specifies the address of the node to send replies to for this message. It may be empty if this message does not have a specific reply-to node address.

MessageReplyToGroupId Property (AMQP Task)

The Id of the group to send replies to for this message.

Data Type

String

Default Value

""

Remarks

This property specifies the Id of the group to send replies to for this message. It may be empty if there is not a specific reply-to group for this message.

MessageSettled Property (AMQP Task)

Whether this message is settled.

Data Type

Boolean

Default Value

true

Remarks

This property specifies whether this message is settled or not.

Note that, when constructing a message for sending, this field is ignored if the send settle mode of the link it is sent on is not Mixed (2).

MessageSubject Property (AMQP Task)

The subject of this message.

Data Type

String

Default Value

""

Remarks

This property specifies the subject of this message. It may be empty if this message does not have a subject set.

MessageTo Property (AMQP Task)

The address of the node which this message is intended for.

Data Type

String

Default Value

""

Remarks

This property specifies the address of the node which this message is intended to be delivered to. It my be empty if this message is not intended for a specific destination node.

MessageTTL Property (AMQP Task)

The time-to-live value for this message.

Data Type

Integer

Default Value

-1

Remarks

This property specifies the time-to-live (TTL) value, in milliseconds, for this message. It may be -1 if this message does not have a TTL.

MessageUserId Property (AMQP Task)

The identity of the user responsible for producing this message.

Data Type

String

Default Value

""

Remarks

This property specifies the identity of the user responsible for producing this message. It may be empty if no specific user was responsible for creating this message.

A message's user Id may be used for verification or authentication by intermediates and/or the final receiver.

MessageValue Property (AMQP Task)

This message's value.

Data Type

String

Default Value

""

Remarks

This property specifies the contents to send in this message. If left unspecified the BizTalk message body will be used as the message content. The MessageValueType property should be used to specify the data type of the value.

This property is not available in the Receiver.

MessageValueType Property (AMQP Task)

This message's value data type.

Data Type

Enumeration

Possible Values

Null (0)
Boolean (1)
Ubyte (2)
Ushort (3)
Uint (4)
Ulong (5)
Byte (6)
Short (7)
Int (8)
Long (9)
Float (10)
Double (11)
Decimal (12)
Char (13)
Timestamp (14)
Uuid (15)
Binary (16)
String (17)
Symbol (18)
Json (19)

Default Value

0

Remarks

This property specifies the data type of this message's MessageValue.

The table below shows the possible value types, their descriptions, and how to format the data assigned to MessageValue. All numeric value types should use their standard string formatting (except for the mvtDecimal (12) type, which should be specified as hex-encoded bytes).

Other Property (AMQP Task)

Defines a set of configuration settings to be used by the component.

Data Type

String

Default Value

""

Remarks

The task accepts one or more configuration settings. Configuration settings are similar in functionality to properties, but they are rarely used. In order to avoid "polluting" the property namespace of the task, access to these internal properties is provided through the Other property.

The Other property may be set to one or more configuration settings (name/value pairs). Set one setting per line. For example: configname1=value1 configname2=value2

Password Property (AMQP Task)

A password to use for SASL authentication.

Data Type

Password

Default Value

""

Remarks

This property contains a password to use for SASL authentication.

ReceiveSource Property (AMQP Task)

The address of the node at the remote host acting as the sender.

Data Type

String

Default Value

""

Remarks

This property may be set to specify the address of the node at the remote host which should act as the sender. This may not be necessary in all environments, in which case an empty string will suffice.

This property is not available in the Sender.

RemoteHost Property (AMQP Task)

The address of the remote host. Domain names are resolved to IP addresses.

Data Type

String

Default Value

""

Remarks

This property specifies the IP address (IP number in dotted internet format) or Domain Name of the remote host. It is set before a connection is attempted and cannot be changed once a connection is established.

If this property is set to a Domain Name, a DNS request is initiated, and upon successful termination of the request, this property is set to the corresponding address. If the search is not successful, an error is returned.

RemotePort Property (AMQP Task)

The port of the AQMP server (default is 5672).

Data Type

Integer

Default Value

5672

Remarks

This property specifies a service port on the remote host to connect to.

A valid port number (a value between 1 and 65535) is required for the connection to take place. The property must be set before a connection is attempted and cannot be changed once a connection is established. Any attempt to change this property while connected will fail with an error.

RuntimeLicense Property (AMQP Task)

Specifies the component runtime license key.

Data Type

String

Default Value

""

Remarks

You can use the RuntimeLicense property to set the runtime key for the task license.

SendTarget Property (AMQP Task)

The address of the node at the target receiver.

Data Type

String

Default Value

""

Remarks

This property may be set to specify the address of the node at the remote host which should act as the receiver. This may not be necessary in all environments, in which case an empty string will suffice.

This property is not available in the Receiver.

SessionName Property (AMQP Task)

The name of the session to send to or receive from.

Data Type

String

Default Value

""

Remarks

This property specifies the name of a session to send to or receive from.

SSLAcceptServerCert Property (AMQP Task)

Instructs the component to unconditionally accept the server certificate that matches the supplied certificate.

Data Type

Certificate

Remarks

If it finds any issues with the certificate presented by the server, the task will normally terminate the connection with an error. You may override this behavior by supplying a value for SSLAcceptServerCert. If the certificate supplied in SSLAcceptServerCert is the same as the certificate presented by the server, then the server certificate is accepted unconditionally, and the connection will continue normally.

This property is used to set a Public Key Certificate.

Ordinarily, the system will attempt to locate the public key in trusted certificate stores in the system registry. If a match is found, the certificate is trusted, and the process proceeds without error. If the certificate is not trusted, the task will report an error.

You may explicitly set a public key, either to accept a key that is not installed on the system, or to ensure that a specific key is presented. Public key certificates may be loaded from the machine registry or from file. If you click on the ellipses, a certificate selection dialog will open. To select a public key from the system registry, select the System Store tab or the User Store tab, and highlight the appropriate registry store. The list of available certificates will be shown below.

Alternatively, you may specify a public key on file. Select the PEM or Certificate File tabs to load a public key from file. You can use the browse button to examine the file system for the certificate that you wish to use. Public keys typically are stored in .CER, .DER, or .PEM files, but other formats may be used. You can click on the Open button to examine the contents of the certificate. Or, if you have a certificate stored in memory, you can write the contents of the certificate into the text box provided. Note that if you are loading a certificate from memory, the certificate must be Base-64 encoded, or the string representation of the certificate may become corrupted and uninterpretable.

Regardless of how you selected the certificate, once you hit the OK button, the task will attempt to verify that certificate selection. If successful, the subject of the certificate will be displayed in the property field. If the task was not able to verify the selection, a dialog box will appear instead detailing the verification error.

Note: You may also set SSLAcceptServerCertAcceptAny to True without opening the certificate selection dialog to force the task to unilaterally authenticate any server during the security handshake. It is strongly recommended that you use this only for testing purposes.

SSLAcceptServerCertAcceptAny Property (AMQP Task)

Tells the component to accept any server certificate.

Data Type

Boolean

Default Value

false

Remarks

When set to true, the task will unilaterally authenticate any server during the security handshake. It is strongly recommended that you use this only for testing purposes.

SSLCert Property (AMQP Task)

The certificate to use for client authentication during the SSL handshake.

Data Type

Certificate

Remarks

This property is used to assign a specific certificate for SSL client authentication.

This field is used to set a Private Key Certificate.

Private key certificates may be loaded from the registry, from files in PKCS#12 format, or from a PEM file format. If you click on the ellipses, a certificate selection dialog will open. To select a private key from the system registry, select the System Store tab or the User Store tab, and highlight the appropriate registry store. The list of certificates which have private keys will be shown below.

To select a private key certificate from a file in PKCS#12 format, select the PFX Store tab. The browse button can be used to examine the file system for PKCS#12 (.pfx or .p12) certificates. If you wish to examine the certificate, provide the password in the field provided and click on the Open button to examine the file store for certificates present. To load a certificate from PEM files, select the PEM tab. Like the PFX file selection, you can specify the password and click the Open button to examine the certificates in the PEM store, or you may paste any PEM data stored in memory.

Regardless of how you selected the certificate, once you hit the OK button, the task will attempt to verify that certificate selection. If successful, the subject of the certificate will be displayed in the property field. If the task was not able to verify the selection, a dialog box will appear instead detailing the verification error.

SSLStartMode Property (AMQP Task)

Determines how the component starts the SSL negotiation.

Data Type

Enumeration

Possible Values

Automatic (0)
Implicit (1)
Explicit (2)
None (3)

Default Value

0

Remarks

The SSLStartMode property may have one of the following values:

Timeout Property (AMQP Task)

A timeout for the component.

Data Type

Integer

Default Value

60

Remarks

If the Timeout property is set to 0, all operations will run uninterrupted until successful completion, or an error condition is encountered.

If Timeout is set to a positive value, the task will wait for the operation to complete before returning control.

If Timeout expires, and the operation is not yet complete, the task fails with an error.

Please note that by default, all timeouts are inactivity timeouts, i.e. the timeout period is extended by Timeout seconds when data is successfully sent or received.

Optionally, the behavior of the task may be changed to absolute timeouts, i.e. the task will wait for a maximum of Timeout seconds since the beginning of the operation, without extending the timeout period during communications.

This behavior is controlled by the AbsoluteTimeout configuration setting.

The default value for the Timeout property is 60 (seconds).

User Property (AMQP Task)

A username to use for SASL authentication.

Data Type

String

Default Value

""

Remarks

This property contains a username to use for SASL authentication.

Certificate Type

The digital certificate being used.

Remarks

This type describes the current digital certificate. The certificate may be a public or private key. The fields are used to identify or select certificates.

Fields

Firewall Type

The firewall the component will connect through.

Remarks

When connecting through a firewall, this type is used to specify different properties of the firewall such as the firewall Host and the FirewallType.

Fields

Config Settings (AMQP Task)

The task accepts one or more of the following configuration settings. Configuration settings are similar in functionality to properties, but they are rarely used. In order to avoid "polluting" the property namespace of the task, access to these internal properties is provided through the Other property.

AMQP Config Settings

SSL Config Settings

General Config Settings