/n software Adapters for BizTalk

Questions / Feedback?

AMQPClassic Adapter

Properties   Configuration 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 adapter.
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 adapter may consume.
MessageIdThe unique Id of the message.
MessageTypeThe message's type.
OtherDefines a set of configuration settings to be used by the adapter.
PasswordA password to use for SASL authentication.
PersistentConnectionInstructs the adapter 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 adapter runtime license key.
SSLAcceptServerCertInstructs the adapter 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 adapter starts the SSL negotiation.
TimeoutA timeout for the adapter.
TimestampThe message's timestamp.
TransportLogTells the adapter 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 adapter 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 adapter 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 adapter.
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 adapter runtime license key.
SSLAcceptServerCertInstructs the adapter 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 adapter starts the SSL negotiation.
TimeoutA timeout for the adapter.
TimestampThe message's timestamp.
TransactionModeWhether the channel is operating in Transaction mode.
TransmitBatchModeHow the transmitter processes batches.
TransportLogTells the adapter 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.

Configuration Settings


The following is a list of configuration 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 adapter whether or not to use the system security libraries or an internal implementation.

 
 
Copyright (c) 2021 /n software inc. - All rights reserved.
/n software Adapters for BizTalk - Version 20.0 [Build 7877]