/n software Adapters for BizTalk
Version 22.0 [Build 8376]

AMQPClassic Adapter

Properties   Config Settings  

An easy-to-use AMQP 0.9.1 client implementation, with support for RabbitMQ extensions.

Remarks

The AMQPClassic adapter provides an easy-to-use AMQP 0.9.1 client implementation, and it also supports certain RabbitMQ extensions to the AMQP 0.9.1 specification. The adapter supports both plaintext and TLS-enabled connections over TCP.

Connecting

The AMQP 0.9.1 transport protocol has two layers: an overall connection between the client and server, and one or more channels running over that connection.

AMQPClassic Receive Adapter

At a minimum, you must supply an RemoteHost, RemotePort, and ChannelName for the connection. In order to authenticate with the AMQPClassic 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 adapter.

Setting ChannelName will create a channel with the specified name on the broker. Once the adapter has connected to the server it is possible to manipulate exchanges and queues and consume messages.

AMQPClassic Send Adapter

At a minimum, you must supply an RemoteHost, RemotePort, and ChannelName for the connection. In order to authenticate with the AMQPClassic 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 adapter.

Setting ChannelName will create a channel with the specified name on the broker. Once the adapter has connected to the server it is possible to manipulate exchanges and queues and publish messages.

By default, the adapter will attempt to send the contents of the outbound BizTalk Server message as the message body. This can be overridden by setting a static message in the send port's MessageBody property at design-time. To set a dynamic message, you can write to the same property in the message context at runtime. The adapter will send the contents of the MessageBody property.

The AMQPClassic Sender and Receiver Adapters have support for SSL transport layer security. This may be enabled by setting SSLStartMode, SSLCert and SSLAcceptServerCert to appropriate values.

Declaring Exchanges

Set DeclareExchange to true to declare an exchange. ChannelName, ExchangeName, ExchangeType, ExchangeType, ExchangePassive, and ExchangeAutoDelete may also be set.

Declaring Queues

Set DeclareQueue to true to declare a queue. ChannelName, QueueName, QueuePassive, QueueDurable, QueueExclusive, and QueueAutoDelete may also be set.

Binding Queues to Exchanges

Set BindQueue to true to bind a exchange with specified RoutingKey.

Creating Consumers

The receiver adapter will use the Consumer properties to start a consumer for QueueName. Please refer to the section on adapter configuration for a description of how to configure receive locations and send ports for this adapter.

Receiver Property List


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

AppIdThe Id of the application that created the message.
AsynchronousModeIndicates whether the server handles the request in asynchronous mode.
AuthSchemeThe authentication scheme to use when connecting.
BindQueueBind the queue to the exchange with given RoutingKey.
ChannelNameThe name of the channel the message is associated with.
ClientPropertiesA collection of table fields that describe properties of the client.
ConsumerExclusiveWhether the consumer is exclusive.
ConsumerNoAckWhether each message is acknowledged by the component.
ConsumerNoLocalWhether the consumer will consume messages published on the same channel.
ConsumerTagThe consumer tag used to uniquely identify a consumer on a channel.
ContentEncodingThe content encoding of the message's body.
ContentTypeThe content type (MIME type) of the message's body.
CorrelationIdThe correlation Id of the message.
DeclareExchangeThis is used to verify that an exchange named ExchangeName exists, and potentially creates it if no such exchange exists.
DeclareQueueThis is used to verify that a queue named QueueName exists; and potentially creates it if no such queue exists.
DeleteExchangeSpecifies whether delete the exchange named ExchangeName.
DeleteQueueDeletes a queue.
DeliveryModeThe delivery mode of the message.
ExchangeAutoDeleteThis specifies whether the server should automatically delete the exchange when all queues have been unbound from it.
ExchangeDurableThis specifies what happens to the exchange in the event of a server restart.
ExchangeIfUnusedSpecifies whether the server will delete the exchange if no queues are bound to it.
ExchangeNameThe name of the exchange.
ExchangePassiveThis specifies how the server will deal with a preexisting exchange.
ExchangeTypeThis specifies the exchange type.
ExpirationThe time-to-live value for this message.
FirewallA set of properties related to firewall access.
HeadersHeaders associated with the message.
MaxThreadsThe maximum number of threads that the component may consume.
MessageIdThe unique Id of the message.
MessageTypeThe message's type.
OtherDefines a set of configuration settings to be used by the component.
PasswordA password to use for SASL authentication.
PersistentConnectionInstructs the component whether to keep the connection to the server open.
PriorityThe priority of the message.
QueueAutoDeleteThis specifies whether the server should automatically delete the queue when all consumers have finished using it.
QueueDurableDurable specifies what happens to the queue in the event of a server restart.
QueueExclusiveExclusive , if True , indicates that the queue may only be accessed by the current connection.
QueueIfEmptySpecifies whether to delete the queue when consumers are attached.
QueueIfUnusedSpecifies whether to delete the queue when no messages are in it.
QueueNameThe name of the queue.
QueuePassiveThis specifies how the server will deal with a preexisting queue.
RemoteHostThe address of the remote host. Domain names are resolved to IP addresses.
RemotePortThe port of the AQMP server (default is 5672). The default port for SSL is 5671.
ReplyToThe address to send replies to for the message.
RequeueThis property controls how the server should attempt to redeliver the messages awaiting acknowledgement.
RequeueEndpointsWhether to requeue receive endpoints if the polling interval has not been reached.
RoutingKeyThe RoutingKey parameter specifies the binding's routing key.
RuntimeLicenseSpecifies the component runtime license key.
SSLAcceptServerCertInstructs the component to unconditionally accept the server certificate that matches the supplied certificate.
SSLCertThe certificate to use for client authentication during the SSL handshake.
SSLStartModeDetermines how the component starts the SSL negotiation.
TimeoutA timeout for the component.
TimestampThe message's timestamp.
TransportLogTells the component where and how to report information about its operations.
UnBindQueueUnbind the queue to the exchange with given RoutingKey.
URIThe Uniform Resource Identifier (URI) of the send port or receive location.
UserA username to use for SASL authentication.
UserIdThe identity of the user responsible for producing the message.
VirtualHostThe virtual host to connect to.

Sender Property List


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

AppIdThe Id of the application that created the message.
AsynchronousModeIndicates whether the server handles the request in asynchronous mode.
AuthSchemeThe authentication scheme to use when connecting.
BindQueueBind the queue to the exchange with given RoutingKey.
ChannelNameThe name of the channel the message is associated with.
ClientPropertiesA collection of table fields that describe properties of the client.
ConnectionLifetimeInstructs the component whether or not to leave the connection to the server open.
ContentEncodingThe content encoding of the message's body.
ContentTypeThe content type (MIME type) of the message's body.
CorrelationIdThe correlation Id of the message.
DeclareExchangeThis is used to verify that an exchange named ExchangeName exists, and potentially creates it if no such exchange exists.
DeclareQueueThis is used to verify that a queue named QueueName exists; and potentially creates it if no such queue exists.
DeleteExchangeSpecifies whether delete the exchange named ExchangeName.
DeleteQueueDeletes a queue.
DeliveryModeThe delivery mode of the message.
ExchangeAutoDeleteThis specifies whether the server should automatically delete the exchange when all queues have been unbound from it.
ExchangeDurableThis specifies what happens to the exchange in the event of a server restart.
ExchangeIfUnusedSpecifies whether the server will delete the exchange if no queues are bound to it.
ExchangeNameThe name of the exchange.
ExchangePassiveThis specifies how the server will deal with a preexisting exchange.
ExchangeTypeThis specifies the exchange type.
ExpirationThe time-to-live value for this message.
FirewallA set of properties related to firewall access.
HeadersHeaders associated with the message.
ImmediateControls what the server should do if the message cannot be immediately delivered to any consumer.
MandatoryControls what the server should do if a message cannot be routed to any queue.
MaxPersistentConnectionsThe maximum number of simultaneous persistent connections when sending.
MaxThreadsThe maximum number of threads that the component may consume.
MaxTransmissionBatchSizeThe maximum number of messages that can be sent in a single batch.
MessageBodyThe message body.
MessageIdThe unique Id of the message.
MessageTypeThe message's type.
OtherDefines a set of configuration settings to be used by the component.
PasswordA password to use for SASL authentication.
PriorityThe priority of the message.
PublishConfirmsEnables publish confirmations mode for a channel.
QueueAutoDeleteThis specifies whether the server should automatically delete the queue when all consumers have finished using it.
QueueDurableDurable specifies what happens to the queue in the event of a server restart.
QueueExclusiveExclusive , if True , indicates that the queue may only be accessed by the current connection.
QueueIfEmptySpecifies whether to delete the queue when consumers are attached.
QueueIfUnusedSpecifies whether to delete the queue when no messages are in it.
QueueNameThe name of the queue.
QueuePassiveThis specifies how the server will deal with a preexisting queue.
RecoverRequests the server to redeliver all messages on a given channel that have not been acknowledged.
RemoteHostThe address of the remote host. Domain names are resolved to IP addresses.
RemotePortThe port of the AQMP server (default is 5672). The default port for SSL is 5671.
ReplyToThe address to send replies to for the message.
RequeueThis property controls how the server should attempt to redeliver the messages awaiting acknowledgement.
RoutingKeyThe RoutingKey parameter specifies the binding's routing key.
RuntimeLicenseSpecifies the component runtime license key.
SSLAcceptServerCertInstructs the component to unconditionally accept the server certificate that matches the supplied certificate.
SSLCertThe certificate to use for client authentication during the SSL handshake.
SSLStartModeDetermines how the component starts the SSL negotiation.
TimeoutA timeout for the component.
TimestampThe message's timestamp.
TransactionModeWhether the channel is operating in Transaction mode.
TransmitBatchModeHow the transmitter processes batches.
TransportLogTells the component where and how to report information about its operations.
UnBindQueueUnbind the queue to the exchange with given RoutingKey.
URIThe Uniform Resource Identifier (URI) of the send port or receive location.
UserA username to use for SASL authentication.
UserIdThe identity of the user responsible for producing the message.
VirtualHostThe virtual host to connect to.

Config Settings


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

GlobalThe scope which the QoS request should apply to.
PrefetchCountThe number of unacknowledged messages the server will limit itself to sending.
PrefetchSizeThe window size in bytes.
SetQoSrequest a specific quality of service for a certain scope.
TransactionMaxCountThe max value of max transaction size.
ReuseSSLSessionDetermines if the SSL session is reused.
SSLCipherStrengthThe minimum cipher strength used for bulk encryption.
SSLEnabledCipherSuitesThe cipher suite to be used in an SSL negotiation.
SSLEnabledProtocolsUsed to enable/disable the supported security protocols.
SSLIncludeCertChainWhether the entire certificate chain is included in the SSLServerAuthentication event.
SSLSecurityFlagsFlags that control certificate verification.
TLS12SignatureAlgorithmsDefines the allowed TLS 1.2 signature algorithms when UseInternalSecurityAPI is True.
TLS12SupportedGroupsThe supported groups for ECC.
TLS13KeyShareGroupsThe groups for which to pregenerate key shares.
TLS13SignatureAlgorithmsThe allowed certificate signature algorithms.
TLS13SupportedGroupsThe supported groups for (EC)DHE key exchange.
AbsoluteTimeoutDetermines whether timeouts are inactivity timeouts or absolute timeouts.
LocalHostThe name of the local host or user-assigned IP interface through which connections are initiated or accepted.
TcpNoDelayWhether or not to delay when sending packets.
UseInternalSecurityAPITells the component whether or not to use the system security libraries or an internal implementation.

AMQPClassic Receiver

How to Configure a AMQPClassic Receive Location with the BizTalk Server Administration Console

To configure the receive location by using the BizTalk Server Administration console, use the following procedure:

NOTE: Before completing the following procedure you must have already added a one-way receive port. For more information, see How to Create a Receive Port.

To configure receive location variables for a AMQPClassic receive location:

  1. In the BizTalk Server Administration console, expand BizTalk Server Administration, expand BizTalk Group, expand Applications, and then expand the application you want to create a receive location in.
  2. In the left pane, click the Receive Port node. Then in the right pane, right-click the receive port that is associated with an existing receive location or that you want to associate with a new receive location, and then click Properties.
  3. In the left pane of the Receive Port Properties dialog box, select Receive Locations, and in the right pane double-click an existing receive location or click New to create a new receive location.
  4. In the Receive Location Properties dialog box, in the Transport section next to Type, select nsoftware.AMQPClassic 2022 from the drop-down list, and then click Configure to configure the transport properties for the receive location.
  5. In the nsoftware.AMQPClassic 2022 Transport Properties dialog box, you will find the following properties:
    AppId

    The Id of the application that created the message.

    Type: xs:string    Default Value: ""

    AsynchronousMode

    Indicates whether the server handles the request in asynchronous mode.

    Type: bool    Default Value: false

    AuthScheme

    The authentication scheme to use when connecting.

    Type: xs:int    Default Value: 0

    BindQueue

    Bind the queue to the exchange with given RoutingKey.

    Type: bool    Default Value: false

    ChannelName

    The name of the channel the message is associated with.

    Type: xs:string    Default Value: ""
    NOTE: This property must have a value.

    ClientProperties

    A collection of table fields that describe properties of the client.

    Type: xs:string    Default Value: ""

    ConsumerExclusive

    Whether the consumer is exclusive.

    Type: bool    Default Value: false

    ConsumerNoAck

    Whether each message is acknowledged by the component.

    Type: bool    Default Value: false

    ConsumerNoLocal

    Whether the consumer will consume messages published on the same channel.

    Type: bool    Default Value: false

    ConsumerTag

    The consumer tag used to uniquely identify a consumer on a channel.

    Type: xs:string    Default Value: ""

    ContentEncoding

    The content encoding of the message's body.

    Type: xs:string    Default Value: ""

    ContentType

    The content type (MIME type) of the message's body.

    Type: xs:string    Default Value: ""

    CorrelationId

    The correlation Id of the message.

    Type: xs:string    Default Value: ""

    DeclareExchange

    This is used to verify that an exchange named ExchangeName exists, and potentially creates it if no such exchange exists.

    Type: bool    Default Value: false

    DeclareQueue

    This is used to verify that a queue named QueueName exists; and potentially creates it if no such queue exists.

    Type: bool    Default Value: false

    DeleteExchange

    Specifies whether delete the exchange named ExchangeName.

    Type: bool    Default Value: false

    DeleteQueue

    Deletes a queue.

    Type: bool    Default Value: false

    DeliveryMode

    The delivery mode of the message.

    Type: xs:int    Default Value: 0

    ExchangeAutoDelete

    This specifies whether the server should automatically delete the exchange when all queues have been unbound from it.

    Type: bool    Default Value: false

    ExchangeDurable

    This specifies what happens to the exchange in the event of a server restart.

    Type: bool    Default Value: false

    ExchangeIfUnused

    Specifies whether the server will delete the exchange if no queues are bound to it.

    Type: bool    Default Value: false

    ExchangeName

    The name of the exchange.

    Type: xs:string    Default Value: ""

    ExchangePassive

    This specifies how the server will deal with a preexisting exchange.

    Type: bool    Default Value: false

    ExchangeType

    This specifies the exchange type.

    Type: xs:int    Default Value: 0

    Expiration

    The time-to-live value for this message.

    Type: xs:string    Default Value: ""

    Firewall

    A set of properties related to firewall access.

    Type: Firewall    Default Value: null

    Headers

    Headers associated with the message.

    Type: xs:string    Default Value: ""

    MaxThreads

    The maximum number of threads that the component may consume.

    Type: xs:int    Default Value: 20

    MessageId

    The unique Id of the message.

    Type: xs:string    Default Value: ""

    MessageType

    The message's type.

    Type: xs:string    Default Value: ""

    Other

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

    Type: xs:string    Default Value: ""

    Password

    A password to use for SASL authentication.

    Type: baf:Password    Default Value: ""

    PersistentConnection

    Instructs the component whether to keep the connection to the server open.

    Type: bool    Default Value: false

    Priority

    The priority of the message.

    Type: xs:int    Default Value: 0

    QueueAutoDelete

    This specifies whether the server should automatically delete the queue when all consumers have finished using it.

    Type: bool    Default Value: false

    QueueDurable

    Durable specifies what happens to the queue in the event of a server restart.

    Type: bool    Default Value: false

    QueueExclusive

    Exclusive , if True , indicates that the queue may only be accessed by the current connection.

    Type: bool    Default Value: false

    QueueIfEmpty

    Specifies whether to delete the queue when consumers are attached.

    Type: bool    Default Value: false

    QueueIfUnused

    Specifies whether to delete the queue when no messages are in it.

    Type: bool    Default Value: false

    QueueName

    The name of the queue.

    Type: xs:string    Default Value: ""

    QueuePassive

    This specifies how the server will deal with a preexisting queue.

    Type: bool    Default Value: false

    RemoteHost

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

    Type: xs:string    Default Value: ""
    NOTE: This property must have a value.

    RemotePort

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

    Type: xs:int    Default Value: 5672

    ReplyTo

    The address to send replies to for the message.

    Type: xs:string    Default Value: ""

    Requeue

    This property controls how the server should attempt to redeliver the messages awaiting acknowledgement.

    Type: bool    Default Value: false

    RequeueEndpoints

    Whether to requeue receive endpoints if the polling interval has not been reached.

    Type: bool    Default Value: false

    RoutingKey

    The RoutingKey parameter specifies the binding's routing key.

    Type: xs:string    Default Value: ""

    RuntimeLicense

    Specifies the component runtime license key.

    Type: xs:string    Default Value: ""

    SSLAcceptServerCert

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

    Type: Certificate    Default Value: null

    SSLCert

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

    Type: Certificate    Default Value: null
    NOTE: The digital id must have a private key associated with it.

    SSLStartMode

    Determines how the component starts the SSL negotiation.

    Type: xs:int    Default Value: 0

    Timeout

    A timeout for the component.

    Type: xs:int    Default Value: 60

    Timestamp

    The message's timestamp.

    Type: xs:string    Default Value: "0"

    TransportLog

    Tells the component where and how to report information about its operations.

    Type: Log    Default Value: null

    UnBindQueue

    Unbind the queue to the exchange with given RoutingKey.

    Type: bool    Default Value: false

    URI

    The Uniform Resource Identifier (URI) of the send port or receive location.

    Type: xs:string    Default Value: ""

    User

    A username to use for SASL authentication.

    Type: xs:string    Default Value: ""

    UserId

    The identity of the user responsible for producing the message.

    Type: xs:string    Default Value: ""

    VirtualHost

    The virtual host to connect to.

    Type: xs:string    Default Value: "/"

  6. Click OK.
  7. Enter the appropriate values in the Receive Location Properties dialog box to complete the configuration of the receive location and click OK to save settings. For information about the Receive Locations Properties dialog box, see How to Create a Receive Location.

AMQPClassic Transmitter

Setting the AMQPClassic Adapter Configuration Properties for a Dynamic Send Port

A dynamic send port does not provide any transport configuration options in BizTalk Explorer because it is expected that these properties will be provided with the context properties associated with the message. These properties can be set in a custom pipeline or in an orchestration. To set message configuration properties in an orchestration you can do the following:

  • Add a Construct Message shape to your orchestration.
  • Configure the Construct Message shape to construct a new message. (for example Message_2)
  • Add a Message Assignment shape to the Construct Message shape.
  • Add code to the Message Assignment shape to initialize the message that you constructed and to set the appropriate configuration properties for the message.

Configuring the AMQPClassic Send Port with the BizTalk Server Administration Console

To configure the send port by using the BizTalk Server Administration console, use the following procedure:

To configure variables for a AMQPClassic send port:

  1. In the BizTalk Server Administration console, create a new send port or double-click an existing send port to modify it. For more information, see How to Create a Send Port. Configure all of the send port options and specify nsoftware.AMQPClassic 2022 for the Type option in the Transport section of the General tab.
  2. On the General tab, in the Transport section, click the Configure button next to Type.
  3. In the nsoftware.AMQPClassic 2022 Transport Properties dialog box, use the following properties to:


    AppId The Id of the application that created the message.
    Type: xs:string    Default Value: ""
    AsynchronousMode Indicates whether the server handles the request in asynchronous mode.
    Type: bool    Default Value: false
    AuthScheme The authentication scheme to use when connecting.
    Type: xs:int    Default Value: 0
    BindQueue Bind the queue to the exchange with given RoutingKey.
    Type: bool    Default Value: false
    ChannelName The name of the channel the message is associated with.
    Type: xs:string    Default Value: ""
    NOTE: This property must be specified.
    ClientProperties A collection of table fields that describe properties of the client.
    Type: xs:string    Default Value: ""
    ConnectionLifetime Instructs the component whether or not to leave the connection to the server open.
    Type: xs:int    Default Value: 0
    ContentEncoding The content encoding of the message's body.
    Type: xs:string    Default Value: ""
    ContentType The content type (MIME type) of the message's body.
    Type: xs:string    Default Value: ""
    CorrelationId The correlation Id of the message.
    Type: xs:string    Default Value: ""
    DeclareExchange This is used to verify that an exchange named ExchangeName exists, and potentially creates it if no such exchange exists.
    Type: bool    Default Value: false
    DeclareQueue This is used to verify that a queue named QueueName exists; and potentially creates it if no such queue exists.
    Type: bool    Default Value: false
    DeleteExchange Specifies whether delete the exchange named ExchangeName.
    Type: bool    Default Value: false
    DeleteQueue Deletes a queue.
    Type: bool    Default Value: false
    DeliveryMode The delivery mode of the message.
    Type: xs:int    Default Value: 0
    ExchangeAutoDelete This specifies whether the server should automatically delete the exchange when all queues have been unbound from it.
    Type: bool    Default Value: false
    ExchangeDurable This specifies what happens to the exchange in the event of a server restart.
    Type: bool    Default Value: false
    ExchangeIfUnused Specifies whether the server will delete the exchange if no queues are bound to it.
    Type: bool    Default Value: false
    ExchangeName The name of the exchange.
    Type: xs:string    Default Value: ""
    ExchangePassive This specifies how the server will deal with a preexisting exchange.
    Type: bool    Default Value: false
    ExchangeType This specifies the exchange type.
    Type: xs:int    Default Value: 0
    Expiration The time-to-live value for this message.
    Type: xs:string    Default Value: ""
    Firewall A set of properties related to firewall access.
    Type: Firewall    Default Value: null
    Headers Headers associated with the message.
    Type: xs:string    Default Value: ""
    Immediate Controls what the server should do if the message cannot be immediately delivered to any consumer.
    Type: bool    Default Value: false
    Mandatory Controls what the server should do if a message cannot be routed to any queue.
    Type: bool    Default Value: false
    MaxPersistentConnections The maximum number of simultaneous persistent connections when sending.
    Type: xs:int    Default Value: 1
    MaxThreads The maximum number of threads that the component may consume.
    Type: xs:int    Default Value: 20
    MaxTransmissionBatchSize The maximum number of messages that can be sent in a single batch.
    Type: xs:int    Default Value: 1
    MessageBody The message body.
    Type: xs:string    Default Value: ""
    MessageId The unique Id of the message.
    Type: xs:string    Default Value: ""
    MessageType The message's type.
    Type: xs:string    Default Value: ""
    Other Defines a set of configuration settings to be used by the component.
    Type: xs:string    Default Value: ""
    Password A password to use for SASL authentication.
    Type: baf:Password    Default Value: ""
    Priority The priority of the message.
    Type: xs:int    Default Value: 0
    PublishConfirms Enables publish confirmations mode for a channel.
    Type: bool    Default Value: false
    QueueAutoDelete This specifies whether the server should automatically delete the queue when all consumers have finished using it.
    Type: bool    Default Value: false
    QueueDurable Durable specifies what happens to the queue in the event of a server restart.
    Type: bool    Default Value: false
    QueueExclusive Exclusive , if True , indicates that the queue may only be accessed by the current connection.
    Type: bool    Default Value: false
    QueueIfEmpty Specifies whether to delete the queue when consumers are attached.
    Type: bool    Default Value: false
    QueueIfUnused Specifies whether to delete the queue when no messages are in it.
    Type: bool    Default Value: false
    QueueName The name of the queue.
    Type: xs:string    Default Value: ""
    QueuePassive This specifies how the server will deal with a preexisting queue.
    Type: bool    Default Value: false
    Recover Requests the server to redeliver all messages on a given channel that have not been acknowledged.
    Type: bool    Default Value: false
    RemoteHost The address of the remote host. Domain names are resolved to IP addresses.
    Type: xs:string    Default Value: ""
    NOTE: This property must be specified.
    RemotePort The port of the AQMP server (default is 5672). The default port for SSL is 5671.
    Type: xs:int    Default Value: 5672
    ReplyTo The address to send replies to for the message.
    Type: xs:string    Default Value: ""
    Requeue This property controls how the server should attempt to redeliver the messages awaiting acknowledgement.
    Type: bool    Default Value: false
    RoutingKey The RoutingKey parameter specifies the binding's routing key.
    Type: xs:string    Default Value: ""
    RuntimeLicense Specifies the component runtime license key.
    Type: xs:string    Default Value: ""
    SSLAcceptServerCert Instructs the component to unconditionally accept the server certificate that matches the supplied certificate.
    Type: Certificate    Default Value: null
    SSLCert The certificate to use for client authentication during the SSL handshake.
    Type: Certificate    Default Value: null
    NOTE: The digital id must have a private key associated with it.
    SSLStartMode Determines how the component starts the SSL negotiation.
    Type: xs:int    Default Value: 0
    Timeout A timeout for the component.
    Type: xs:int    Default Value: 60
    Timestamp The message's timestamp.
    Type: xs:string    Default Value: "0"
    TransactionMode Whether the channel is operating in Transaction mode.
    Type: bool    Default Value: false
    TransmitBatchMode How the transmitter processes batches.
    Type: xs:int    Default Value: 0
    TransportLog Tells the component where and how to report information about its operations.
    Type: Log    Default Value: null
    UnBindQueue Unbind the queue to the exchange with given RoutingKey.
    Type: bool    Default Value: false
    URI The Uniform Resource Identifier (URI) of the send port or receive location.
    Type: xs:string    Default Value: ""
    User A username to use for SASL authentication.
    Type: xs:string    Default Value: ""
    UserId The identity of the user responsible for producing the message.
    Type: xs:string    Default Value: ""
    VirtualHost The virtual host to connect to.
    Type: xs:string    Default Value: "/"

  4. Click OK and OK again to save settings.

AppId Property (AMQPClassic Adapter)

The Id of the application that created the message.

Data Type

String

Default Value

""

Remarks

This field holds the Id of the application that created the message. It may be empty if the message does not have an application Id set.

This value must be specified as a string no longer than 255 characters.

AsynchronousMode Property (AMQPClassic Adapter)

Indicates whether the server handles the request in asynchronous mode.

Data Type

Boolean

Default Value

false

Remarks

If true, the server will execute the request asynchronously. For asynchronous request handling, the server only sends back a response in case of an error.

AuthScheme Property (AMQPClassic Adapter)

The authentication scheme to use when connecting.

Data Type

Enumeration

Possible Values

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

Default Value

0

Remarks

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

Valid values are:

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

BindQueue Property (AMQPClassic Adapter)

Bind the queue to the exchange with given RoutingKey.

Data Type

Boolean

Default Value

false

Remarks

When set, the adapter will bind to the exchange with specified RoutingKey.

ChannelName Property (AMQPClassic Adapter)

The name of the channel the message is associated with.

Data Type

String

Default Value

""

Remarks

This property is associated with the name of the channel the message was accessed or sent over.

ClientProperties Property (AMQPClassic Adapter)

A collection of table fields that describe properties of the client.

Data Type

String

Default Value

""

Remarks

This property holds a collection of table fields that represent client properties. During the connection process, these properties will be sent to the server.

Each line contains a AMQP table field. The table field structure should follow this pattern: "key, type(int), value".

Key must be an ASCII string that:

  • Starts with an ASCII letter, $, or $ character.
  • Only contains ASCII letters, digits, underscores, $, and $ characters.
  • Is unique among all sibling table field key names.
  • Is no longer than 128 characters.
Value is table field's value and must be formatted according to the type. Type is the table field's value type. Acceptable value types are:

Value Type JSON Value TypeDescriptionValue Format
fvtBoolean (0) boolean Boolean "True" or "False"
fvtByte (1) byte Byte -128 to 127
fvtUbyte (2) ubyte Unsigned byte 0 to 255
fvtShort (3) short Short -32768 to 32767
fvtUshort (4) ushort Unsigned short 0 to 65535
fvtInt (5) int Integer -2147483648 to 2147483647
fvtUint (6) uint Unsigned integer 0 to 4294967295
fvtLong (7) long Long -9223372036854775808 to 9223372036854775807
fvtUlong (8) ulong Unsigned long 0 to 18446744073709551615
fvtFloat (9) float Float IEEE 754 32-bit floating point number
fvtDouble (10) double Double IEEE 754 64-bit floating point number
fvtDecimal (11) decimal Decimal Hex-encoded byte string
fvtSstring (12) sstring Short string UTF-8 string data, limited to 255 bytes; may not contain null bytes (\0)
fvtString (13) string String String data
fvtArray (14) array Array JSON array of type-value pairs
fvtTimestamp (15) timestamp Timestamp Number of milliseconds since the Unix epoch (January 1, 1970 00:00:00 UTC)
fvtTable (16) table Table JSON object containing name-type-value tuples
fvtNull (17 - default)null Null N/A (Value is ignored)

For the fvtArray (14) value type, the Value should be specified as a JSON array of type-value pairs; for example: [ { "type": "int", "value": 23 }, { "type": "int", "value": -52 }, { "type": "int", "value": 153325 } ]

For the fvtTable (16) value type, theValue; should be specified as a JSON object containing name-type-value tuples; for example: { { "name": "Test1", "type": "long", "value": 12345678901234 }, { "name": "Test2", "type": "boolean", "value": "false" }, { "name": "Test3", "type": "string", "value": "This is a test." } }

Notes regarding fvtArray (14) and fvtTable (16) type Value:

  • All "type" fields in the JSON content must be set to one of the value types in the table above.
  • For fvtTable (16) type Value, all "name" fields must adhere to the rules described above by the Key documentation.
  • Nesting and mixing multiple levels of arrays and tables in the JSON is allowed.

While the adapter does not send any client properties by default, it is common for AMQP clients to send "product", "version", and "platform" properties to help identify themselves.

ConnectionLifetime Property (AMQPClassic Adapter)

Instructs the component whether or not to leave the connection to the server open.

Data Type

Enumeration

Possible Values

Automatic (0)
Per Batch (1)
Persisted (2)

Default Value

0

Remarks

This property is used when uploading batches of messages to a server that use the same connection properties. In order to minimize connection-related protocol overhead, connections may be persisted with various lifetimes:

Automatic (0 - default)The connection to the server will be established as needed per each message. When the message transmission is complete, the adapter will disconnect from the server.
Per Batch (1)During each batch, the connection to the server will be established as needed per each message. If a connection already exists to the server, that will be used as opposed to creating a new one. At the end of the batch, all such connections will be disconnected.
Persisted (2)Connections will be established as needed and stored. If a connection already exists for a server, that will be used as opposed to creating a new one. The connections will not be disconnected until the adapter is terminated by the BizTalk Message Engine.

This property is not available in the Receiver.

ConsumerExclusive Property (AMQPClassic Adapter)

Whether the consumer is exclusive.

Data Type

Boolean

Default Value

false

Remarks

The ConsumerExclusive property, if True, will cause the adapter to request that the server create an exclusive consumer. Attaching an exclusive consumer to a queue prevents any other consumers from consuming messages from that queue.

This property is not available in the Sender.

ConsumerNoAck Property (AMQPClassic Adapter)

Whether each message is acknowledged by the component.

Data Type

Boolean

Default Value

false

Remarks

The ConsumerNoAck property controls whether the server will expect the adapter to acknowledge each message delivered.

This property is not available in the Sender.

ConsumerNoLocal Property (AMQPClassic Adapter)

Whether the consumer will consume messages published on the same channel.

Data Type

Boolean

Default Value

false

Remarks

The ConsumerNoLocal property, if True, ensures that the consumer never consumes messages published on the same channel. (Note that this functionality is not available on RabbitMQ servers, which ignore the NoLocal parameter).

This property is not available in the Sender.

ConsumerTag Property (AMQPClassic Adapter)

The consumer tag used to uniquely identify a consumer on a channel.

Data Type

String

Default Value

""

Remarks

ConsumerTag is a string which uniquely identifies the new consumer on the specified channel. If empty string is passed for ConsumerTag, the server will generate a consumer tag automatically when it creates the consumer.

This property is not available in the Sender.

ContentEncoding Property (AMQPClassic Adapter)

The content encoding of the message's body.

Data Type

String

Default Value

""

Remarks

This field holds the content encoding of the message's body. It may be empty if the message does not have a content encoding set.

This value must be specified as a string no longer than 255 characters.

ContentType Property (AMQPClassic Adapter)

The content type (MIME type) of the message's body.

Data Type

String

Default Value

""

Remarks

This field holds the content type (MIME type) of the message's body. It may be empty if the message does not have a content type set.

This value must be specified as a string no longer than 255 characters.

CorrelationId Property (AMQPClassic Adapter)

The correlation Id of the message.

Data Type

String

Default Value

""

Remarks

This field holds the correlation Id of the message. It may be empty if the message does not have a correlation Id set.

This value must be specified as a string no longer than 255 characters.

DeclareExchange Property (AMQPClassic Adapter)

This is used to verify that an exchange named ExchangeName exists, and potentially creates it if no such exchange exists.

Data Type

Boolean

Default Value

false

Remarks

ChannelName, ExchangeName, ExchangeType, ExchangeType, ExchangePassive, and ExchangeAutoDelete may also be set.

ChannelName controls what channel the component will send the request over. While any channel can technically be used, keep in mind that the server will close it if a channel error occurs. For this reason, it is good practice to make requests such as this one using a channel that is not involved in message publishing or consumption.

ExchangeName must be a non-empty string consisting only of letters, digits, hyphens, underscores, periods, and colons. It must be no longer than 255 characters, and must not begin with amq. unless ExchangePassive is True.

ExchangeType specifies the exchange type. All servers support the direct and fanout exchange types, and most should also support the topic and header exchange types. Some servers may support additional, custom exchange types as well. Refer to your server's documentation for more information about each exchange type, and to determine what exchange types it supports other than direct and fanout.

If ExchangePassive is True, the server will only verify that an exchange with the given ExchangeName actually exists (regardless of how it is configured).

If ExchangePassive is False, and no exchange named ExchangeName currently exists, the server will create one.

If ExchangePassive is False, and there is a preexisting exchange named ExchangeName, the server will verify that its current configuration matches the given parameters and arguments.

ExchangeType specifies what happens to the exchange in the event of a server restart. Durable exchanges will be recreated, while non-durable (transient) exchanges will not.

ExchangeAutoDelete specifies whether the server should automatically delete the exchange when all queues have been unbound from it. Note that this parameter is only sent if the RabbitMQCompatible configuration setting is enabled; it is ignored otherwise.

DeclareQueue Property (AMQPClassic Adapter)

This is used to verify that a queue named QueueName exists; and potentially creates it if no such queue exists.

Data Type

Boolean

Default Value

false

Remarks

ChannelName, QueueName, QueuePassive, QueueDurable, QueueExclusive, and QueueAutoDelete may also be set.

ChannelName controls what channel the component will send the request over. While any channel can technically be used, keep in mind that the server will close it if a channel error occurs. For this reason, it is good practice to make requests such as this one using a channel that is not involved in message publishing or consumption.

If creating a new queue, empty string can be passed for QueueName to have the server automatically generate a name for the new queue (which can then be retrieved using the QueueName configuration setting). In all other cases, QueueName must be a non-empty string consisting only of letters, digits, hyphens, underscores, periods, and colons. It must be no longer than 255 characters, and must not begin with amq. unless the Passive parameter is True.

If QueuePassive is True, the server will only verify that a queue with the given QueueName actually exists (regardless of how it is configured).

If QueuePassive is False, and no queue named QueueName currently exists, the server will create one.

If QueuePassive is False, and there is a preexisting queue named QueueName, the server will verify that its current configuration matches the given parameters and arguments.

QueueDurable specifies what happens to the queue in the event of a server restart. A durable queue will be recreated, while non-durable (transient) queue will not. (Note that the messages in durable queues will still be lost unless they are marked as persistent.)

QueueExclusive, if True, indicates that the queue may only be accessed by the current connection. Exclusive queues are deleted when the current connection closes.

QueueAutoDelete specifies whether the server should automatically delete the queue when all consumers have finished using it. (Note that auto-delete queues aren't eligible for deletion until after a consumer attaches to them for the first time.)

DeleteExchange Property (AMQPClassic Adapter)

Specifies whether delete the exchange named ExchangeName.

Data Type

Boolean

Default Value

false

Remarks

Set this property to true to delete the exchange named ExchangeName.

DeleteQueue Property (AMQPClassic Adapter)

Deletes a queue.

Data Type

Boolean

Default Value

false

Remarks

Set to true to delete the queue.

ChannelName, QueueName, QueueIfUnused, and QueueIfEmpty must also be set.

ChannelName controls what channel the component will send the request over. While any channel can technically be used, keep in mind that the server will close it if a channel error occurs. For this reason, it is good practice to make requests such as this one using a channel that is not involved in message publishing or consumption.

QueueName must be a non-empty string consisting only of letters, digits, hyphens, underscores, periods, and colons. It must be no longer than 255 characters, and must not begin with amq.

When QueueIfUnused is True, the server will only delete the queue if no consumers are attached to it.

When QueueIfEmpty is True, the server will only delete the queue if it has no messages in it. (When QueueIfEmpty is False, servers will typically move any remaining messages to a dead-letter queue, if one is available.)

DeliveryMode Property (AMQPClassic Adapter)

The delivery mode of the message.

Data Type

Enumeration

Possible Values

Unspecified (0)
Nonpersistent (1)
Persistent (2)

Default Value

0

Remarks

This field holds the delivery mode of the message; possible values are:

  • 0: Unspecified.
  • 1: Non-persistent; the message may be lost if the server encounters an error.
  • 2: Persistent; the message will not be lost, even in case of server errors.

The default is 0, which indicates that the message does not have an explicit delivery mode set.

ExchangeAutoDelete Property (AMQPClassic Adapter)

This specifies whether the server should automatically delete the exchange when all queues have been unbound from it.

Data Type

Boolean

Default Value

false

Remarks

Note that this parameter is only sent if the RabbitMQCompatible configuration setting is enabled; it is ignored otherwise.

ExchangeDurable Property (AMQPClassic Adapter)

This specifies what happens to the exchange in the event of a server restart.

Data Type

Boolean

Default Value

false

Remarks

Durable exchanges will be recreated, while non-durable (transient) exchanges will not.

ExchangeIfUnused Property (AMQPClassic Adapter)

Specifies whether the server will delete the exchange if no queues are bound to it.

Data Type

Boolean

Default Value

false

Remarks

When True, the server will only delete the exchange if no queues are bound to it.

ExchangeName Property (AMQPClassic Adapter)

The name of the exchange.

Data Type

String

Default Value

""

Remarks

ExchangeName must be a non-empty string consisting only of letters, digits, hyphens, underscores, periods, and colons. It must be no longer than 255 characters, and must not begin with amq. unless the ExchangePassive parameter is True.

ExchangePassive Property (AMQPClassic Adapter)

This specifies how the server will deal with a preexisting exchange.

Data Type

Boolean

Default Value

false

Remarks

If ExchangePassive is True, the server will only verify that an exchange with the given ExchangeName actually exists (regardless of how it is configured).

If ExchangePassive is False, and no exchange named ExchangeName currently exists, the server will create one.

If ExchangePassive is False, and there is a preexisting exchange named ExchangeName, the server will verify that its current configuration matches the given parameters and arguments.

ExchangeType Property (AMQPClassic Adapter)

This specifies the exchange type.

Data Type

Enumeration

Possible Values

Direct (0)
Fanout (1)
Topic (2)
Header (3)

Default Value

0

Remarks

ExchangeType specifies the exchange type. All servers support the direct and fanout exchange types, and most should also support the topic and header exchange types. Some servers may support additional, custom exchange types as well. Refer to your server's documentation for more information about each exchange type, and to determine what exchange types it supports other than direct and fanout.

Expiration Property (AMQPClassic Adapter)

The time-to-live value for this message.

Data Type

String

Default Value

""

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.

Firewall Property (AMQPClassic Adapter)

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 adapter will attempt to connect.

Headers Property (AMQPClassic Adapter)

Headers associated with the message.

Data Type

String

Default Value

""

Remarks

This property holds additional Headers associated with the message. It may be empty if the message does not have any headers set.

This property must be specified as a JSON object containing name-type-value tuples; for example: { { "name": "Header1", "type": "long", "value": 12345678901234 }, { "name": "Header2", "type": "boolean", "value": "false" }, { "name": "Header3", "type": "string", "value": "This is a test." } }

All "name" values must be ASCII strings that:

  • Start with an ASCII letter, $, or $ character.
  • Only contain ASCII letters, digits, underscores, $, and $ characters.
  • Are unique among their siblings.
  • Are no longer than 128 characters.

The following table describes all valid "type" values, and how to format the "value" field for each:

JSON Value TypeDescriptionValue Format
boolean Boolean "True" or "False"
byte Byte -128 to 127
ubyte Unsigned byte 0 to 255
short Short -32768 to 32767
ushort Unsigned short 0 to 65535
int Integer -2147483648 to 2147483647
uint Unsigned integer 0 to 4294967295
long Long -9223372036854775808 to 9223372036854775807
ulong Unsigned long 0 to 18446744073709551615
float Float IEEE 754 32-bit floating point number
double Double IEEE 754 64-bit floating point number
decimal Decimal Hex-encoded byte string
sstring Short string UTF-8 string data, limited to 255 bytes; may not contain null bytes (\0)
string String String data
array Array JSON array of type-value pairs
timestamp Timestamp Number of milliseconds since the Unix epoch (January 1, 1970 00:00:00 UTC)
table Table JSON object containing name-type-value tuples
null Null N/A (Value is ignored)

Note: The ulong and sstring value types are not supported when the RabbitMQCompatible configuration setting is enabled.

Headers of the table type should be specified in the same manner as shown above, while headers of the array type should be specified as a JSON array of type-value pairs; for example: [ { "type": "int", "value": 23 }, { "type": "int", "value": -52 }, { "type": "int", "value": 153325 } ]

Nesting and mixing multiple levels of arrays and tables is allowed.

Immediate Property (AMQPClassic Adapter)

Controls what the server should do if the message cannot be immediately delivered to any consumer.

Data Type

Boolean

Default Value

false

Remarks

The Immediate property controls what the server should do if the message can't be immediately delivered to any consumer (either because it cannot be routed to a queue, or because the queues it can be routed to have no active consumers attached to them).

If True, the server will return the message. If False, the server will queue the message if possible, or drop it if not.

This property is not available in the Receiver.

Mandatory Property (AMQPClassic Adapter)

Controls what the server should do if a message cannot be routed to any queue.

Data Type

Boolean

Default Value

false

Remarks

The Mandatory property controls what the server should do if the message can't be routed to any queue (either because it isn't eligible for any of the queues bound to the specified exchange because of how their bindings are configured, or because no queues are bound to the exchange in the first place). If True, the server will return the message. If False, the server will drop the message.

This property is not available in the Receiver.

MaxPersistentConnections Property (AMQPClassic Adapter)

The maximum number of simultaneous persistent connections when sending.

Data Type

Integer

Default Value

1

Remarks

This setting specifies the maximum number of simultaneous persistent connections when sending.

The default value is 1, which limits the adapter to using one persistent connection for the adapter at any one time. This means when ConnectionLifetime is set to Persisted the send adapter will first check to see if an existing connection is present before transmitting data. In the case where a connection exists but another instance of the send port is using the connection the adapter will wait for the connection to become free. A value of 1 effectively serializes all communication for the send port through one persistent connection.

By setting a value greater than 1 a pool of persistent connections can be created. This allows multiple simultaneous persistent connections to be used. When the send adapter is active it will check to see if there are any existing connections. In the case where a connection exists but is being used by another instance of the send port it will attempt to create a new persistent connection. If creating a new persistent connection would exceed the limit specified in this setting the adapter will instead wait for a connection to become free. Setting this to a value greater than 1 allows multiple simultaneous connections to be made while still taking advantage of persistent connections to reduce the overhead of re-connecting.

Note: This only applies to the send adapter.

The default value is 1.

This property can only be configured through the adapter's static handler property page in the BizTalk Server administration console.

This property is not available in the Receiver.

MaxThreads Property (AMQPClassic Adapter)

The maximum number of threads that the component may consume.

Data Type

Integer

Default Value

20

Remarks

This property limits the number of concurrent threads that the adapter may consume while completing its work.

This property can only be configured through the adapter's static handler property page in the BizTalk Server administration console.

MaxTransmissionBatchSize Property (AMQPClassic Adapter)

The maximum number of messages that can be sent in a single batch.

Data Type

Integer

Default Value

1

Remarks

This property controls the maximum size of an outbound message batch.

Note: be careful when modifying this property as it directly effects the efficiency of the transmit adapter. Setting MaxTransmissionBatchSize to a low value in an environment that requires transmission of large quantities of data will result in the adapter accumulating several small batches. If TransmitBatchMode is set to Parallel, this will result in the adapter transmitting many small batches at once and can put a heavy load on the processor.

Conversely, if TransmitBatchMode is set to Serial, setting MaxTransmissionBatchSize to a large value may result in long transmission delays as the adapter will wait on existing work to complete before accepting new messages from the BizTalk Message Engine. This is especially true when the adapter is transmitting large data.

This property can only be configured through the adapter's static handler property page in the BizTalk Server administration console.

This property is not available in the Receiver.

MessageBody Property (AMQPClassic Adapter)

The message body.

Data Type

String

Default Value

""

Remarks

This property holds the body of the message. It may be empty.

This property is not available in the Receiver.

MessageId Property (AMQPClassic Adapter)

The unique Id of the message.

Data Type

String

Default Value

""

Remarks

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

This value must be specified as a string no longer than 255 characters.

MessageType Property (AMQPClassic Adapter)

The message's type.

Data Type

String

Default Value

""

Remarks

This property holds the type of the message. It may be empty if the message does not have a type set.

This value must be specified as a string no longer than 255 characters.

Other Property (AMQPClassic Adapter)

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

Data Type

String

Default Value

""

Remarks

The adapter 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 adapter, 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 (AMQPClassic Adapter)

A password to use for SASL authentication.

Data Type

Password

Default Value

""

Remarks

This property contains a password to use for SASL authentication.

PersistentConnection Property (AMQPClassic Adapter)

Instructs the component whether to keep the connection to the server open.

Data Type

Boolean

Default Value

false

Remarks

If set to true, the adapter will first attempt to use an existing connection. If no such connection exists, it will create a new connection. When the adapter completes, it will persist the connection so that the adapter will reuse it during the next polling interval. Setting this property to true can improve performance if you are polling very frequently.

Priority Property (AMQPClassic Adapter)

The priority of the message.

Data Type

Integer

Default Value

0

Remarks

This property holds the priority of the message. Valid priority values are 0-9; any other value causes the message to have unspecified priority when sent.

PublishConfirms Property (AMQPClassic Adapter)

Enables publish confirmations mode for a channel.

Data Type

Boolean

Default Value

false

Remarks

If true, the channel specified by ChannelName will have publish confirmations mode enabled. While a channel is in publish confirmations mode, the server will acknowledge each message published by the component.

Note that a channel will stay in publish confirmations mode, once enabled, until it is deleted.

This property is not available in the Receiver.

QueueAutoDelete Property (AMQPClassic Adapter)

This specifies whether the server should automatically delete the queue when all consumers have finished using it.

Data Type

Boolean

Default Value

false

Remarks

Note that auto-delete queues aren't eligible for deletion until after a consumer attaches to them for the first time.

QueueDurable Property (AMQPClassic Adapter)

Durable specifies what happens to the queue in the event of a server restart.

Data Type

Boolean

Default Value

false

Remarks

A durable queue will be recreated, while a non-durable (transient) queue will not. (Note that the messages in durable queues will still be lost unless they are marked as persistent).

QueueExclusive Property (AMQPClassic Adapter)

Exclusive , if True , indicates that the queue may only be accessed by the current connection.

Data Type

Boolean

Default Value

false

Remarks

Exclusive queues are deleted when the current connection closes.

QueueIfEmpty Property (AMQPClassic Adapter)

Specifies whether to delete the queue when consumers are attached.

Data Type

Boolean

Default Value

false

Remarks

When True, the server will only delete the queue if no consumers are attached to it.

QueueIfUnused Property (AMQPClassic Adapter)

Specifies whether to delete the queue when no messages are in it.

Data Type

Boolean

Default Value

false

Remarks

When True, the server will only delete the queue if it has no messages in it. (When QueueIfEmpty is False, servers will typically move any remaining messages to a dead-letter queue, if one is available.)

QueueName Property (AMQPClassic Adapter)

The name of the queue.

Data Type

String

Default Value

""

Remarks

QueueName must be a non-empty string consisting only of letters, digits, hyphens, underscores, periods, and colons. This value must be specified as a string no longer than 255 characters.

QueuePassive Property (AMQPClassic Adapter)

This specifies how the server will deal with a preexisting queue.

Data Type

Boolean

Default Value

false

Remarks

If QueuePassive is True, the server will only verify that a queue with the given QueueName actually exists (regardless of how it is configured).

If QueuePassive is False, and no queue named QueueName currently exists, the server will create one.

If QueuePassive is False, and there is a preexisting queue named QueueName, the server will verify that its current configuration matches the given parameters and arguments.

Recover Property (AMQPClassic Adapter)

Requests the server to redeliver all messages on a given channel that have not been acknowledged.

Data Type

Boolean

Default Value

false

Remarks

Set this property to true to request that the server redeliver all messages that it previously sent to the component on the channel specified by ChannelName which are still awaiting acknowledgement.

This property is not available in the Receiver.

RemoteHost Property (AMQPClassic Adapter)

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. 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. If the component is configured to use a SOCKS firewall, the value assigned to this property may be preceded with an "*". If this is the case, the host name is passed to the firewall unresolved and the firewall performs the DNS resolution.

RemotePort Property (AMQPClassic Adapter)

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

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.

ReplyTo Property (AMQPClassic Adapter)

The address to send replies to for the message.

Data Type

String

Default Value

""

Remarks

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

This value must be specified as a string no longer than 255 characters.

Requeue Property (AMQPClassic Adapter)

This property controls how the server should attempt to redeliver the messages awaiting acknowledgement.

Data Type

Boolean

Default Value

false

Remarks

If set to True, the server will simple put the messages back on their original queues, and they will be delivered like any other queued messages (potentially to other consumers). If set to False, the server will redeliver the messages to the component directly.

RequeueEndpoints Property (AMQPClassic Adapter)

Whether to requeue receive endpoints if the polling interval has not been reached.

Data Type

Boolean

Default Value

false

Remarks

This setting controls whether receive endpoints are requeued for later processing if the polling interval has not yet been reached. When this setting is set to No (default) each thread will block until the polling interval for the corresponding receive location is reached. If there exist more active receive locations than MaxThreads it is possible for some threads to block the execution of others since they may be waiting for a polling interval.

When this setting is set to Yes if the polling interval has not been reached the thread will not block until the polling interval is reached, and instead the endpoint will be requeued to be processed later. This lets subsequent endpoints in the queue to be processed.

If MaxThreads is set to a low value and there are a larger number of receive locations setting this to Yes will help assure that polling intervals are respected and receive locations poll in a timely manner.

The default value is No.

This property can only be configured through the adapter's static handler property page in the BizTalk Server administration console.

This property is not available in the Sender.

RoutingKey Property (AMQPClassic Adapter)

The RoutingKey parameter specifies the binding's routing key.

Data Type

String

Default Value

""

Remarks

Exchanges that use routing-key-based logic make some sort of comparison between the routing keys of incoming messages and this value to decide which messages should be forwarded to the specified queue. Examples of exchange types which use routing keys include:

  • direct exchanges, which compare (for equality) the routing keys of incoming messages to the routing keys of each queue bound to them.
  • topic exchanges, which match the routing keys of incoming messages against the routing pattern of each queue bound to them.

Not all exchange types make use of routing keys, in which case empty string can be passed for the RoutingKey parameter. Examples of exchange types which don't use routing keys include:

  • fanout exchanges simply forward incoming messages to all queues bound to them, unconditionally.
  • header exchanges only forward messages that include certain headers. When binding a queue to a header exchange, add items to the to describe the headers that eligible messages must have, and whether they must have any or all of those headers.

Note that the format of the RoutingKey parameter and/or the content of the may differ slightly between server implementations. Refer to your server's documentation to determine what it expects to receive for each exchange type that it supports.

RuntimeLicense Property (AMQPClassic Adapter)

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 adapter license.

This property may be configured on the adapter's static handler property page in the BizTalk Server administration console.

SSLAcceptServerCert Property (AMQPClassic Adapter)

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 adapter 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 adapter 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 adapter will attempt to verify that certificate selection. If successful, the subject of the certificate will be displayed in the property field. If the adapter was not able to verify the selection, a dialog box will appear instead detailing the verification error.

Note: You may also set the Accept Any field to Yes without opening the certificate selection dialog to force the adapter to unilaterally authenticate any server during the security handshake. It is strongly recommended that you use this only for testing purposes. Set the LogMode to Info to cause the adapter to report the server's credentials to Location.

SSLCert Property (AMQPClassic Adapter)

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 adapter will attempt to verify that certificate selection. If successful, the subject of the certificate will be displayed in the property field. If the adapter was not able to verify the selection, a dialog box will appear instead detailing the verification error.

SSLStartMode Property (AMQPClassic Adapter)

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:

AutomaticIf the remote port is set to the standard plaintext port of the protocol (where applicable), the adapter will behave the same as if SSLStartMode is set to Explicit. In all other cases, SSL negotiation will be implicit (Implicit).
ImplicitThe SSL negotiation will start immediately after the connection is established.
ExplicitThe adapter will first connect in plaintext, and then explicitly start SSL negotiation through a protocol command such as STARTTLS.
NoneNo SSL negotiation, no SSL security. All communication will be in plaintext mode.

Timeout Property (AMQPClassic Adapter)

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 adapter will wait for the operation to complete before returning control.

If Timeout expires, and the operation is not yet complete, the adapter 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 adapter may be changed to absolute timeouts, i.e. the adapter 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).

Timestamp Property (AMQPClassic Adapter)

The message's timestamp.

Data Type

String

Default Value

"0"

Remarks

This property holds the timestamp of the message, specified as milliseconds since the Unix epoch (January 1, 1970 00:00:00 UTC). It may be less than or equal to 0 (default) if the message does not have a timestamp set.

TransactionMode Property (AMQPClassic Adapter)

Whether the channel is operating in Transaction mode.

Data Type

Boolean

Default Value

false

Remarks

If set to true, the channel will operate in transaction mode. While a channel is in transaction mode, all messages published and acknowledgements sent over it will be part of a transaction, and the server will wait to process them until the transaction is either committed or rolled back.

By default this is false and channels will operate in normal mode.

This property is not available in the Receiver.

TransmitBatchMode Property (AMQPClassic Adapter)

How the transmitter processes batches.

Data Type

Enumeration

Possible Values

Parallel (0)
Serial (1)

Default Value

0

Remarks

This property controls how the transmitter processes message batches:

ParallelThe adapter will process however many batches the BizTalk Message Engine sends it.

The number of maximum concurrent batches may be controlled by the MaxThreads property.

SerialThe adapter will queue batches from the BizTalk Message Engine and process them one at a time.

This property can only be configured through the adapter's static handler property page in the BizTalk Server administration console.

This property is not available in the Receiver.

TransportLog Property (AMQPClassic Adapter)

Tells the component where and how to report information about its operations.

Data Type

Log

Remarks

This is a Log type property which contains fields describing how and where the adapter will record information about its execution.

This property may be configured on the adapter's static handler property page in the BizTalk Server administration console.

UnBindQueue Property (AMQPClassic Adapter)

Unbind the queue to the exchange with given RoutingKey.

Data Type

Boolean

Default Value

false

Remarks

When set to true, the adapter will unbind the queue to the exchange with specified RoutingKey.

URI Property (AMQPClassic Adapter)

The Uniform Resource Identifier (URI) of the send port or receive location.

Data Type

String

Default Value

""

Remarks

This property specifies a URI for the send port or receive location. Setting this property is optional.

By default the adapter will automatically generate a URI. You may choose to specify your own value here to be used in place of the generated URI.

If this value is specified it must begin with the correct prefix, as seen in the default value.

User Property (AMQPClassic Adapter)

A username to use for SASL authentication.

Data Type

String

Default Value

""

Remarks

This property contains a username to use for SASL authentication.

UserId Property (AMQPClassic Adapter)

The identity of the user responsible for producing the message.

Data Type

String

Default Value

""

Remarks

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

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

This value must be specified as a string no longer than 255 characters.

VirtualHost Property (AMQPClassic Adapter)

The virtual host to connect to.

Data Type

String

Default Value

"/"

Remarks

This property specifies the virtual host to connect to on the server, and is set to / by default.

Note that the configuration of the server defines what virtual hosts are available.

This setting cannot be changed while connected.

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

Store
String

The name of the certificate store for the client certificate.

The StoreType field specifies the type of the certificate store specified by Store. If the store is password protected, specify the password in StorePassword.

Store is used in conjunction with the Subject field in order to specify client certificates. If Store has a value, and Subject is set, a search for a certificate is initiated. Please refer to the Subject field for details.

Designations of certificate stores are platform-dependent.

The following are designations of the most common User and Machine certificate stores in Windows:

MYA certificate store holding personal certificates with their associated private keys.
CACertifying authority certificates.
ROOTRoot certificates.
SPCSoftware publisher certificates.

In Java, the certificate store normally is a file containing certificates and optional private keys.

When the certificate store type is PFXFile, this property must be set to the name of the file. When the type is PFXBlob, the property must be set to the binary contents of a PFX file (i.e. PKCS12 certificate store).

If the provider is OpenSSL, the certificate store is a file containing a certificate and a private key. This property must be set to the name of the file.

StorePassword
String

If the certificate store is of a type that requires a password, this property is used to specify that password in order to open the certificate store.

StoreType
CertStoreTypes

The type of certificate store for this certificate.

The adapter supports both public and private keys in a variety of formats. When the cstAuto value is used the adapter will automatically determine the type. This field can take one of the following values:

0 (cstUser - default)For Windows, this specifies that the certificate store is a certificate store owned by the current user. Note: this store type is not available in Java.
1 (cstMachine)For Windows, this specifies that the certificate store is a machine store. Note: this store type is not available in Java.
2 (cstPFXFile)The certificate store is the name of a PFX (PKCS12) file containing certificates.
3 (cstPFXBlob)The certificate store is a string (binary or base64-encoded) representing a certificate store in PFX (PKCS12) format.
4 (cstJKSFile)The certificate store is the name of a Java Key Store (JKS) file containing certificates. Note: this store type is only available in Java.
5 (cstJKSBlob)The certificate store is a string (binary or base64-encoded) representing a certificate store in Java Key Store (JKS) format. Note: this store type is only available in Java.
6 (cstPEMKeyFile)The certificate store is the name of a PEM-encoded file that contains a private key and an optional certificate.
7 (cstPEMKeyBlob)The certificate store is a string (binary or base64-encoded) that contains a private key and an optional certificate.
8 (cstPublicKeyFile)The certificate store is the name of a file that contains a PEM- or DER-encoded public key certificate.
9 (cstPublicKeyBlob)The certificate store is a string (binary or base64-encoded) that contains a PEM- or DER-encoded public key certificate.
10 (cstSSHPublicKeyBlob)The certificate store is a string (binary or base64-encoded) that contains an SSH-style public key.
11 (cstP7BFile)The certificate store is the name of a PKCS7 file containing certificates.
12 (cstP7BBlob)The certificate store is a string (binary) representing a certificate store in PKCS7 format.
13 (cstSSHPublicKeyFile)The certificate store is the name of a file that contains an SSH-style public key.
14 (cstPPKFile)The certificate store is the name of a file that contains a PPK (PuTTY Private Key).
15 (cstPPKBlob)The certificate store is a string (binary) that contains a PPK (PuTTY Private Key).
16 (cstXMLFile)The certificate store is the name of a file that contains a certificate in XML format.
17 (cstXMLBlob)The certificate store is a string that contains a certificate in XML format.
18 (cstJWKFile)The certificate store is the name of a file that contains a JWK (JSON Web Key).
19 (cstJWKBlob)The certificate store is a string that contains a JWK (JSON Web Key).
20 (cstSecurityKey)The certificate is present on a physical security key accessible via a PKCS11 interface.

To use a security key the necessary data must first be collected using the CERTMGR adapter. The ListStoreCertificates method may be called after setting CertStoreType to cstSecurityKey, CertStorePassword to the PIN, and CertStore to the full path of the PKCS11 dll. The certificate information returned in the CertList event's CertEncoded parameter may be saved for later use.

When using a certificate, pass the previously saved security key information as the Store and set StorePassword to the PIN.

Code Example: SSH Authentication with Security Key certmgr.CertStoreType = CertStoreTypes.cstSecurityKey; certmgr.OnCertList += (s, e) => { secKeyBlob = e.CertEncoded; }; certmgr.CertStore = @"C:\Program Files\OpenSC Project\OpenSC\pkcs11\opensc-pkcs11.dll"; certmgr.CertStorePassword = "123456"; //PIN certmgr.ListStoreCertificates(); sftp.SSHCert = new Certificate(CertStoreTypes.cstSecurityKey, secKeyBlob, "123456", "*"); sftp.SSHUser = "test"; sftp.SSHLogon("myhost", 22);

21 (cstBCFKSFile)The certificate store is the name of a file that contains a BCFKS (Bouncy Castle FIPS Key Store). Note: this store type is only available in Java and .NET.
22 (cstBCFKSBlob)The certificate store is a string (binary or base64-encoded) representing a certificate store in BCFKS (Bouncy Castle FIPS Key Store) format. Note: this store type is only available in Java and .NET.
99 (cstAuto)The store type is automatically detected from the input data. This setting may be used with both public and private keys and can detect any of the supported formats automatically.

Subject
String

The subject of the certificate used for client authentication.

When this property is set, a search is performed in the current certificate store certificate with matching subject.

If an exact match is not found, the store is searched for subjects containing the value of the property.

When setting the property to a partial subject, CN= should be omitted. For example, the following code would find the certificate with subject CN=Test Certificate, OU=People, C=US

Example (Searching with partial subject)

Control.CertSubject = "Test"

If a match is not found, the property is set to an empty string, and no certificate is selected.

The special value "*" picks a random certificate in the certificate store.

If a matching certificate is found, Subject is set to the full subject of the matching certificate.

Thumbprint
String

The thumbprint of the certificate.

This field is used to specify the thumbprint of the certificate. When there are multiple certificates in the store that have the same subject, the thumbprint will be used to distinguish between them.

Constructors

Constructors are only relevant when configuring adapters in orchestrations.

public Certificate();

Creates a Certificate instance whose properties can be set.

public Certificate(string certificateFile);

Opens CertificateFile and reads out the contents as an X509 public key.

public Certificate(byte[] certificateData);

Parses CertificateData as an X509 public key.

public Certificate(CertStoreTypes certStoreType, string store, string storePassword, string subject);

CertStoreType identifies the type of certificate store to use. See StoreType for descriptions of the different certificate stores. Store is a file containing the certificate store. StorePassword is the password used to protect the store. After the store has been successfully opened, the constructor will attempt to find the certificate identified by Subject . This can be either a complete or a substring match of the X509 certificate's subject Distinguished Name (DN).

public Certificate(CertStoreTypes certStoreType, string store, string storePassword, byte[] encoded);

CertStoreType identifies the type of certificate store to use. See StoreType for descriptions of the different certificate stores. Store is a file containing the certificate store. StorePassword is the password used to protect the store. After the store has been successfully opened, the constructor will load Encoded as an X509 certificate and search the opened store for a corresponding private key.

public Certificate(CertStoreTypes certStoreType, byte[] storeBlob, string storePassword, string subject);

CertStoreType identifies the type of certificate store to use. See StoreType for descriptions of the different certificate stores. Store is a string (binary- or base64-encoded) containing the certificate store. StorePassword is the password used to protect the store. After the store has been successfully opened, the constructor will attempt to find the certificate identified by Subject . This can be either a complete or a substring match of the X509 certificate's subject Distinguished Name (DN).

public Certificate(CertStoreTypes certStoreType, byte[] storeBlob, string storePassword, byte[] encoded);

CertStoreType identifies the type of certificate store to use. See StoreType for descriptions of the different certificate stores. Store is a string (binary- or base64-encoded) containing the certificate store. StorePassword is the password used to protect the store. After the store has been successfully opened, the constructor will load Encoded as an X509 certificate and search the opened store for a corresponding private key.

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

AutoDetect
Boolean

Tells the adapter whether or not to automatically detect and use firewall system settings, if available.

FirewallType
FirewallTypes

Determines the type of firewall to connect through. The applicable values are the following:

fwNone (0)No firewall (default setting).
fwTunnel (1)Connect through a tunneling proxy. Port is set to 80.
fwSOCKS4 (2)Connect through a SOCKS4 Proxy. Port is set to 1080.
fwSOCKS5 (3)Connect through a SOCKS5 Proxy. Port is set to 1080.

Host
String

Name or IP address of firewall (optional). If a Host is given, requested connections will be authenticated through the specified firewall when connecting.

If the Host field is set to a Domain Name, a DNS request is initiated. Upon successful termination of the request, the Host field is set to the corresponding address. If the search is not successful, an error is returned.

Password
String

A password if authentication is to be used when connecting through the firewall. If Host is specified, the User and Password fields are used to connect and authenticate to the given firewall. If the authentication fails, a trappable error is fired.

Port
Integer

The TCP port for the firewall Host. See the description of the Host field for details.

Note that the Port is set automatically when FirewallType is set to a valid value. See the description of the FirewallType field for details.

User
String

A user name if authentication is to be used connecting through a firewall. If the Host is specified, the User and Password fields are used to connect and authenticate to the given Firewall. If the authentication fails, a trappable error is fired.

Constructors

Constructors are only relevant when configuring adapters in orchestrations.

public Firewall();

Log Type

A log where the component will record information about its operations.

Remarks

This describes how and where the adapter will record information describing its execution.

Fields

Location
String

This field describes the location where the logging information is to be written.

If the EventLog LogType has been chosen, this field must contain the name of the Event Log to which the information should be written. The default value for this field is "Application". If a value other than "Application" is set the computer must be restarted for the change to take effect. Note that the same event log must be used for all send ports and receive locations that use the same adapter.

If the File LogType has been chosen, this field must contain the location of the file to write logging information to on the file system.

The adapter also supports logging to files based on the current date and time. This allows for log files to be organized by days, months, or other intervals as specified. When specifying a log filename include a valid .NET date and time format string within the < and > characters. For instance C:\logs\sftp_<yyyyMMdd>.log or C:\logs\as2_<yyyyMMdd>T<hhmm>.log.

LogMode
LogModes

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

VerboseThe adapter will report all information regarding the transport.
Info The adapter will report all major operations, as well as all warnings and errors.
WarningThe adapter will report any conditions that could result in unpredictable behavior as well as errors.
ErrorThe adapter will report all errors that prevent normal operations from completing.
FatalThe adapter will report only serious errors that cause the adapter to completely stop functioning.

LogType
LogTypes

This property controls where the adapter will log the information. The possible values have the following affect on the adapter's behavior:

NoneThe adapter will not report any logging information.
EventLogThe adapter will report all logging information to the event log. The specific event log must be defined in the Location field when this type is selected.
FileThe adapter will report all logging information to a file. The desired file must be specified in the Location field when this type has been selected.

Constructors

Constructors are only relevant when configuring adapters in orchestrations.

public Log();
public Log(LogTypes logType, string location, LogModes logMode);

Config Settings (AMQPClassic Adapter)

The adapter 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 adapter, access to these internal properties is provided through the Other property.

AMQPClassic Config Settings

Global:   The scope which the QoS request should apply to.

It is interpreted differently based on whether the server is RabbitMQ or not. Refer to this table:

Global is...RabbitMQ Other Servers
False QoS will be applied individually to each new consumer on the specified channel (existing consumers are unaffected).QoS applied to all existing and new consumers on the specified channel.
True QoS applied to all existing and new consumers on the specified channel. QoS applied to all existing and new consumers on the whole connection.

PrefetchCount:   The number of unacknowledged messages the server will limit itself to sending.

A PrefetchCount of 0 indicates no limit.

PrefetchSize:   The window size in bytes.

The server will stop sending messages if the total size of all of the currently unacknowledged messages already sent, plus the size of the next message that could be sent, exceeds PrefetchSize bytes. A PrefetchSize of 0 indicates no limit. (Note that RabbitMQ does not support prefetch size limits.)

SetQoS:   request a specific quality of service for a certain scope.

When the PrefetchSize and/or PrefetchCount are set for a certain scope, the server will limit how many messages it sends to the adapter before stopping to wait for or or more of them to be acknowledged.Keep the following things in mind when using QoS:

  • The limits specified by a QoS request only affect messages that require acknowledgement.
  • How the server chooses to handle interactions between QoS settings at different scopes is server-dependent.

TransactionMaxCount:   The max value of max transaction size.

This config will only take effect when TrasactionMode is on.

SSL Config Settings

ReuseSSLSession:   Determines if the SSL session is reused.

If set to true, the adapter will reuse the context if and only if the following criteria are met:

  • The target host name is the same.
  • The system cache entry has not expired (default timeout is 10 hours).
  • The application process that calls the function is the same.
  • The logon session is the same.
  • The instance of the adapter is the same.

SSLCipherStrength:   The minimum cipher strength used for bulk encryption.

This minimum cipher strength largely dependent on the security modules installed on the system. If the cipher strength specified is not supported, an error will be returned when connections are initiated.

Please note that this setting contains the minimum cipher strength requested from the security library.

Use this setting with caution. Requesting a lower cipher strength than necessary could potentially cause serious security vulnerabilities in your application.

SSLEnabledCipherSuites:   The cipher suite to be used in an SSL negotiation.

The enabled cipher suites to be used in SSL negotiation.

By default, the enabled cipher suites will include all available ciphers ("*").

The special value "*" means that the adapter will pick all of the supported cipher suites. If SSLEnabledCipherSuites is set to any other value, only the specified cipher suites will be considered.

Multiple cipher suites are separated by semicolons.

Example values when UseInternalSecurityAPI is False (default): // The "Other" property could contain ONE of the following lines: SSLEnabledCipherSuites=* SSLEnabledCipherSuites=CALG_AES_256 SSLEnabledCipherSuites=CALG_AES_256;CALG_3DES Possible values when UseInternalSecurityAPI is False (default) include:

  • CALG_3DES
  • CALG_3DES_112
  • CALG_AES
  • CALG_AES_128
  • CALG_AES_192
  • CALG_AES_256
  • CALG_AGREEDKEY_ANY
  • CALG_CYLINK_MEK
  • CALG_DES
  • CALG_DESX
  • CALG_DH_EPHEM
  • CALG_DH_SF
  • CALG_DSS_SIGN
  • CALG_ECDH
  • CALG_ECDH_EPHEM
  • CALG_ECDSA
  • CALG_ECMQV
  • CALG_HASH_REPLACE_OWF
  • CALG_HUGHES_MD5
  • CALG_HMAC
  • CALG_KEA_KEYX
  • CALG_MAC
  • CALG_MD2
  • CALG_MD4
  • CALG_MD5
  • CALG_NO_SIGN
  • CALG_OID_INFO_CNG_ONLY
  • CALG_OID_INFO_PARAMETERS
  • CALG_PCT1_MASTER
  • CALG_RC2
  • CALG_RC4
  • CALG_RC5
  • CALG_RSA_KEYX
  • CALG_RSA_SIGN
  • CALG_SCHANNEL_ENC_KEY
  • CALG_SCHANNEL_MAC_KEY
  • CALG_SCHANNEL_MASTER_HASH
  • CALG_SEAL
  • CALG_SHA
  • CALG_SHA1
  • CALG_SHA_256
  • CALG_SHA_384
  • CALG_SHA_512
  • CALG_SKIPJACK
  • CALG_SSL2_MASTER
  • CALG_SSL3_MASTER
  • CALG_SSL3_SHAMD5
  • CALG_TEK
  • CALG_TLS1_MASTER
  • CALG_TLS1PRF
Example values when UseInternalSecurityAPI is True: // The "Other" property could contain ONE of the following lines: SSLEnabledCipherSuites=* SSLEnabledCipherSuites=TLS_DHE_DSS_WITH_AES_128_CBC_SHA SSLEnabledCipherSuites=TLS_DHE_DSS_WITH_AES_128_CBC_SHA;TLS_DH_ANON_WITH_AES_128_CBC_SHA Possible values when UseInternalSecurityAPI is True include:
  • TLS_DHE_DSS_WITH_AES_128_GCM_SHA256
  • TLS_DHE_DSS_WITH_AES_256_GCM_SHA384
  • TLS_DHE_DSS_WITH_3DES_EDE_CBC_SHA
  • TLS_DHE_DSS_WITH_AES_128_CBC_SHA
  • TLS_DHE_DSS_WITH_AES_128_CBC_SHA256
  • TLS_DHE_DSS_WITH_AES_256_CBC_SHA
  • TLS_DHE_DSS_WITH_AES_256_CBC_SHA256
  • TLS_DHE_DSS_WITH_DES_CBC_SHA
  • TLS_DHE_RSA_WITH_AES_128_GCM_SHA256
  • TLS_DHE_RSA_WITH_AES_256_GCM_SHA384
  • TLS_DHE_RSA_WITH_3DES_EDE_CBC_SHA
  • TLS_DHE_RSA_WITH_AES_128_CBC_SHA
  • TLS_DHE_RSA_WITH_AES_128_CBC_SHA256
  • TLS_DHE_RSA_WITH_AES_256_CBC_SHA
  • TLS_DHE_RSA_WITH_AES_256_CBC_SHA256
  • TLS_DHE_RSA_WITH_DES_CBC_SHA
  • TLS_RSA_WITH_AES_256_GCM_SHA384
  • TLS_RSA_WITH_AES_128_GCM_SHA256
  • TLS_RSA_WITH_3DES_EDE_CBC_SHA
  • TLS_RSA_WITH_AES_128_CBC_SHA
  • TLS_RSA_WITH_AES_128_CBC_SHA256
  • TLS_RSA_WITH_AES_256_CBC_SHA
  • TLS_RSA_WITH_AES_256_CBC_SHA256
  • TLS_RSA_WITH_DES_CBC_SHA
  • TLS_RSA_WITH_RC4_128_MD5
  • TLS_RSA_WITH_RC4_128_SHA

If SSLEnabledProtocols is configured to use TLS 1.3 the following values are supported:

  • TLS_AES_128_GCM_SHA256
  • TLS_AES_256_GCM_SHA384

SSLEnabledCipherSuites is used together with SSLCipherStrength.

SSLEnabledProtocols:   Used to enable/disable the supported security protocols.

Used to enable/disable the supported security protocols.

Not all supported protocols are enabled by default (the value of this setting is 4032). If you want more granular control over the enabled protocols, you can set this property to the binary 'OR' of one or more of the following values:

TLS1.312288 (Hex 3000) (Experimental)
TLS1.23072 (Hex C00) (Default)
TLS1.1768 (Hex 300) (Default)
TLS1 192 (Hex C0) (Default)
SSL3 48 (Hex 30)
SSL2 12 (Hex 0C)

Note: TLS 1.1 and TLS1.2 support are only available starting with Windows 7.

Note: Enabling TLS 1.3 will automatically set UseInternalSecurityAPI to True.

SSLIncludeCertChain:   Whether the entire certificate chain is included in the SSLServerAuthentication event.

This setting specifies whether the transport log contains the full certificate chain. By default this value is False and only the leaf certificate will be present.

If set to True all certificates returned by the server will be present in the transport log. This includes the leaf certificate, any intermediate certificate, and the root certificate.

Note: When UseInternalSecurityAPI is set to True this value is automatically set to True. This is needed for proper validation when using the internal provider.

SSLSecurityFlags:   Flags that control certificate verification.

The following flags are defined (specified in hexadecimal notation). They can be or-ed together to exclude multiple conditions:

0x00000001Ignore time validity status of certificate.
0x00000002Ignore time validity status of CTL.
0x00000004Ignore non-nested certificate times.
0x00000010Allow unknown Certificate Authority.
0x00000020Ignore wrong certificate usage.
0x00000100Ignore unknown certificate revocation status.
0x00000200Ignore unknown CTL signer revocation status.
0x00000400Ignore unknown Certificate Authority revocation status.
0x00000800Ignore unknown Root revocation status.
0x00008000Allow test Root certificate.
0x00004000Trust test Root certificate.
0x80000000Ignore non-matching CN (certificate CN not-matching server name).

TLS12SignatureAlgorithms:   Defines the allowed TLS 1.2 signature algorithms when UseInternalSecurityAPI is True.

This setting specifies the allowed server certificate signature algorithms when UseInternalSecurityAPI is True and SSLEnabledProtocols is set to allow TLS 1.2.

When specified the adapter will verify that the server certificate signature algorithm is among the values specified in this setting. If the server certificate signature algorithm is unsupported the adapter will fail with an error.

The format of this value is a comma separated list of hash-signature combinations. For instance: // The "Other" could contain ALL of these lines: UseInternalSecurityAPI=true SSLEnabledProtocols=3072 TLS12SignatureAlgorithms=sha1-rsa,sha1-dsa,sha256-rsa,sha256-dsa The default value for this setting is "sha1-rsa,sha1-dsa,sha224-rsa,sha224-dsa,sha256-rsa,sha256-dsa,sha384-rsa,sha384-dsa,sha512-rsa,sha512-dsa".

In order to not restrict the server's certificate signature algorithm, specify an empty string as the value for this setting, which will cause the signature_algorithms TLS 1.2 extension to not be sent.

TLS12SupportedGroups:   The supported groups for ECC.

This setting specifies a comma separated list of named groups used in TLS 1.2 for ECC.

The default value is ecdhe_secp256r1,ecdhe_secp384r1,ecdhe_secp521r1.

When using TLS 1.2 and UseInternalSecurityAPI is set to True, the values refer to the supported groups for ECC. The following values are supported:

  • "ecdhe_secp256r1" (default)
  • "ecdhe_secp384r1" (default)
  • "ecdhe_secp521r1" (default)

TLS13KeyShareGroups:   The groups for which to pregenerate key shares.

This setting specifies a comma separated list of named groups used in TLS 1.3 for key exchange. The groups specified here will have key share data pregenerated locally before establishing a connection. This can prevent an additional round trip during the handshake if the group is supported by the server.

The default value is set to balance common supported groups and the computational resources required to generate key shares. As a result only some groups are included by default in this setting.

Note: All supported groups can always be used during the handshake even if not listed here, but if a group is used which is not present in this list it will incur an additional round trip and time to generate the key share for that group.

In most cases this setting does not need to be modified. This should only be modified if there is a specific reason to do so.

The default value is ecdhe_x25519,ecdhe_secp256r1,ecdhe_secp384r1,ffdhe_2048,ffdhe_3072

The values are ordered from most preferred to least preferred. The following values are supported:

  • "ecdhe_x25519" (default)
  • "ecdhe_x448"
  • "ecdhe_secp256r1" (default)
  • "ecdhe_secp384r1" (default)
  • "ecdhe_secp521r1"
  • "ffdhe_2048" (default)
  • "ffdhe_3072" (default)
  • "ffdhe_4096"
  • "ffdhe_6144"
  • "ffdhe_8192"

TLS13SignatureAlgorithms:   The allowed certificate signature algorithms.

This setting holds a comma separated list of allowed signature algorithms. Possible values are:

  • "rsa_pkcs1_sha256" (default)
  • "rsa_pkcs1_sha384" (default)
  • "rsa_pkcs1_sha512" (default)
The default value is rsa_pkcs1_sha256,rsa_pkcs1_sha384,rsa_pkcs1_sha512. This setting is only applicable when SSLEnabledProtocols includes TLS 1.3.
TLS13SupportedGroups:   The supported groups for (EC)DHE key exchange.

This setting specifies a comma separated list of named groups used in TLS 1.3 for key exchange. This setting should only be modified if there is a specific reason to do so.

The default value is ecdhe_x25519,ecdhe_x448,ecdhe_secp256r1,ecdhe_secp384r1,ecdhe_secp521r1,ffdhe_2048,ffdhe_3072,ffdhe_4096,ffdhe_6144,ffdhe_8192

The values are ordered from most preferred to least preferred. The following values are supported:

  • "ecdhe_x25519" (default)
  • "ecdhe_x448" (default)
  • "ecdhe_secp256r1" (default)
  • "ecdhe_secp384r1" (default)
  • "ecdhe_secp521r1" (default)
  • "ffdhe_2048" (default)
  • "ffdhe_3072" (default)
  • "ffdhe_4096" (default)
  • "ffdhe_6144" (default)
  • "ffdhe_8192" (default)

General Config Settings

AbsoluteTimeout:   Determines whether timeouts are inactivity timeouts or absolute timeouts.

If AbsoluteTimeout is set to True, any method which does not complete within Timeout seconds will be aborted. By default, AbsoluteTimeout is False, and the timeout is an inactivity timeout.

LocalHost:   The name of the local host or user-assigned IP interface through which connections are initiated or accepted.

The LocalHost configuration contains the name of the local host as obtained by the Gethostname() system call, or if the user has assigned an IP address, the value of that address.

In multihomed hosts (machines with more than one IP interface) setting LocalHost to the value of an interface will make the adapter initiate connections (or accept in the case of server adapters) only through that interface.

If the adapter is connected, the LocalHost configuration shows the IP address of the interface through which the connection is made in internet dotted format (aaa.bbb.ccc.ddd). In most cases, this is the address of the local host, except for multihomed hosts (machines with more than one IP interface).

TcpNoDelay:   Whether or not to delay when sending packets.

When true, the socket will send all data that is ready to send at once. When false, the socket will send smaller buffered packets of data at small intervals. This is known as the Nagle algorithm.

By default, this config is set to false.

UseInternalSecurityAPI:   Tells the adapter whether or not to use the system security libraries or an internal implementation.

By default the adapter will use the system security libraries to perform cryptographic functions where applicable. When set to False calls to unmanaged code will be made. In certain environments this is not desirable. To use a completely managed security implementation set this setting to True. Setting this to True tells the adapter to use the internal implementation instead of using the system's security API.

Note: This setting is static. The value set is applicable to all adapters used in the application.

When this value is set the product's system DLL is no longer required as a reference, as all unmanaged code is stored in that file.

Supported Macros

The adapter also supports the following Macros. These values are not case sensitive and would be supplied to a property in the form %MacroName%.

TempThis is resolved to the full path to the system's temporary directory.
MessageIDGlobally unique identifier (GUID) of the message in BizTalk Server.
SourceFileNameThe original file name. This includes the extension and excludes the file path, for example, Sample.xml
SourceFileNameNoExtThe original file name without the extension or file path, for example, Sample
RemoteFileNameThe name of the file as it was uploaded to the remote server. This includes the extension and excludes the file path, for example, Sample.xml. Valid only for AS3, FTP, and SFTP Send Adapters.
DestinationPartyName of the destination party.
DestinationPartyQualifierQualifier of the destination party.
SourcePartyName of the source party.
SourcePartyQualifierQualifier of the source party.
DateTime:CustomFormatThis special value allows you to specify your own custom time format. For instance DateTime:yyyy would be resolved to the 4 digit year.
DateThe date format yyyy-MM-dd.
DateTimeThe date format yyyy-MM-ddThhmmss.
TimeThe date format hhmmss.
DateTime_BTS2000The date format yyyyMMddhhmmssf.
DateTime.TZThe date format yyyy-MM-ddThhmmsszzz.
Time.TZThe date format hhmmsszzz.
Property#<Schema>#<Name>This special value allows you to include a property from the incoming message. For instance "PROPERTY#http://schemas.microsoft.com/BizTalk/2003/system-properties#ReceivePortName" would resolve to the ReceivePortName property of the message.

Copyright (c) 2022 /n software inc. - All rights reserved.
/n software Adapters for BizTalk - Version 22.0 [Build 8376]