AMQP Adapter

An easy-to-use AMQP 1.0 client implementation.

Remarks

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

AMQP Receive Adapter

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

Setting SessionName will create a session with the specified name on the broker, and a receiver link will be created on the broker using the specified SessionName, LinkName, and (if necessary) a ReceiveSource for the sender to route the link creation request to.

The adapter will connect to the AMQP broker on the first PollingInterval and remain connected to receive incoming messages. It will remain connected until the adapter is shut down.

AMQP Send Adapter

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 MessageValue 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 MessageValue property.

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

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.


AuthScheme	The authentication scheme to use when connecting.
ContainerId	The container Id the component should advertise when connecting.
ErrorThreshold	The maximum number of errors before the component shuts down.
Firewall	A set of properties related to firewall access.
IdleTimeout	The maximum period of inactivity the component will allow before disconnecting.
LinkName	The name of the sender or receiver link.
MaxBatchSize	The maximum size, in MB, of the current batch (0 indicates no limit).
MaxFileCount	The maximum number of files in the current batch (0 indicates no limit).
MaxFileSize	The maximum size, in MB, of a file in the current batch (0 indicates no limit).
MaxThreads	The maximum number of threads that the component may consume.
MessageAbsoluteExpiryTime	The absolute time at which this message should be considered expired.
MessageApplicationProperties	The application properties for the message.
MessageContentEncoding	The content encoding of this message's data.
MessageContentType	The content type of this message's data.
MessageCorrelationId	The correlation Id of this message.
MessageCreationTime	The creation time of this message.
MessageDeliveryCount	How many previous attempts there have been to deliver this message.
MessageDurable	Whether this message is durable.
MessageFirstAcquirer	Whether this message may have been acquired by other links previously.
MessageGroupId	The Id of the group this message belongs to.
MessageGroupSequence	The position of this message within its group.
MessageId	The unique Id of this message.
MessageLinkName	The name of the link this message is associated with.
MessagePriority	The priority of this message.
MessageReplyTo	The address of the node to send replies to for this message.
MessageReplyToGroupId	The Id of the group to send replies to for this message.
MessageSettled	Whether this message is settled.
MessageSubject	The subject of this message.
MessageTo	The address of the node which this message is intended for.
MessageTTL	The time-to-live value for this message.
MessageUserId	The identity of the user responsible for producing this message.
MessageValueType	This message's value data type.
Other	Defines a set of configuration settings to be used by the component.
Password	A password to use for SASL authentication.
PollingInterval	The amount of time, in seconds, between download attempts.
ReceiveSource	The address of the node at the remote host acting as the sender.
RemoteHost	The address of the remote host. Domain names are resolved to IP addresses.
RemotePort	The port of the AQMP server (default is 5672).
RequeueEndpoints	Whether to requeue receive endpoints if the polling interval has not been reached.
RuntimeLicense	Specifies the component runtime license key.
SessionName	The name of the session to send to or receive from.
SSLAcceptServerCert	Instructs the component to unconditionally accept the server certificate that matches the supplied certificate.
SSLCert	The certificate to use for client authentication during the SSL handshake.
SSLStartMode	Determines how the component starts the SSL negotiation.
Timeout	A timeout for the component.
TransportLog	Tells the component where and how to report information about its operations.
URI	The Uniform Resource Identifier (URI) of the send port or receive location.
User	A username to use for SASL authentication.

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.


AuthScheme	The authentication scheme to use when connecting.
ConnectionLifetime	Instructs the component whether or not to leave the connection to the server open.
ContainerId	The container Id the component should advertise when connecting.
Firewall	A set of properties related to firewall access.
IdleTimeout	The maximum period of inactivity the component will allow before disconnecting.
LinkName	The name of the sender or receiver link.
MaxPersistentConnections	The maximum number of simultaneous persistent connections when sending.
MaxThreads	The maximum number of threads that the component may consume.
MaxTransmissionBatchSize	The maximum number of messages that can be sent in a single batch.
MessageAbsoluteExpiryTime	The absolute time at which this message should be considered expired.
MessageApplicationProperties	The application properties for the message.
MessageContentEncoding	The content encoding of this message's data.
MessageContentType	The content type of this message's data.
MessageCorrelationId	The correlation Id of this message.
MessageCreationTime	The creation time of this message.
MessageDeliveryCount	How many previous attempts there have been to deliver this message.
MessageDurable	Whether this message is durable.
MessageFirstAcquirer	Whether this message may have been acquired by other links previously.
MessageGroupId	The Id of the group this message belongs to.
MessageGroupSequence	The position of this message within its group.
MessageId	The unique Id of this message.
MessagePriority	The priority of this message.
MessageReplyTo	The address of the node to send replies to for this message.
MessageReplyToGroupId	The Id of the group to send replies to for this message.
MessageSettled	Whether this message is settled.
MessageSubject	The subject of this message.
MessageTo	The address of the node which this message is intended for.
MessageTTL	The time-to-live value for this message.
MessageUserId	The identity of the user responsible for producing this message.
MessageValue	This message's value.
MessageValueType	This message's value data type.
Other	Defines a set of configuration settings to be used by the component.
Password	A password to use for SASL authentication.
RemoteHost	The address of the remote host. Domain names are resolved to IP addresses.
RemotePort	The port of the AQMP server (default is 5672).
RuntimeLicense	Specifies the component runtime license key.
SendTarget	The address of the node at the target receiver.
SessionName	The name of the session to send to or receive from.
SSLAcceptServerCert	Instructs the component to unconditionally accept the server certificate that matches the supplied certificate.
SSLCert	The certificate to use for client authentication during the SSL handshake.
SSLStartMode	Determines how the component starts the SSL negotiation.
Timeout	A timeout for the component.
TransmitBatchMode	How the transmitter processes batches.
TransportLog	Tells the component where and how to report information about its operations.
URI	The Uniform Resource Identifier (URI) of the send port or receive location.
User	A username to use for SASL authentication.

Config Settings

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


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

AMQP Receiver

How to Configure a AMQP 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 AMQP receive location:

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.
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.
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.
In the Receive Location Properties dialog box, in the Transport section next to Type, select nsoftware.AMQP 2022 from the drop-down list, and then click Configure to configure the transport properties for the receive location.

In the nsoftware.AMQP 2022 Transport Properties dialog box, you will find the following properties:


AuthScheme	The authentication scheme to use when connecting. Type: xs:int Default Value: 1
ContainerId	The container Id the component should advertise when connecting. Type: xs:string Default Value: ""
ErrorThreshold	The maximum number of errors before the component shuts down. Type: xs:int Default Value: 5
Firewall	A set of properties related to firewall access. Type: Firewall Default Value: null
IdleTimeout	The maximum period of inactivity the component will allow before disconnecting. Type: xs:int Default Value: 0
LinkName	The name of the sender or receiver link. Type: xs:string Default Value: "" NOTE: This property must have a value.
MaxBatchSize	The maximum size, in MB, of the current batch (0 indicates no limit). Type: xs:int Default Value: 0
MaxFileCount	The maximum number of files in the current batch (0 indicates no limit). Type: xs:int Default Value: 10
MaxFileSize	The maximum size, in MB, of a file in the current batch (0 indicates no limit). Type: xs:int Default Value: 0
MaxThreads	The maximum number of threads that the component may consume. Type: xs:int Default Value: 20
MessageAbsoluteExpiryTime	The absolute time at which this message should be considered expired. Type: xs:string Default Value: "0"
MessageApplicationProperties	The application properties for the message. Type: xs:string Default Value: ""
MessageContentEncoding	The content encoding of this message's data. Type: xs:string Default Value: ""
MessageContentType	The content type of this message's data. Type: xs:string Default Value: ""
MessageCorrelationId	The correlation Id of this message. Type: xs:string Default Value: ""
MessageCreationTime	The creation time of this message. Type: xs:string Default Value: "0"
MessageDeliveryCount	How many previous attempts there have been to deliver this message. Type: xs:int Default Value: 0
MessageDurable	Whether this message is durable. Type: bool Default Value: false
MessageFirstAcquirer	Whether this message may have been acquired by other links previously. Type: bool Default Value: false
MessageGroupId	The Id of the group this message belongs to. Type: xs:string Default Value: ""
MessageGroupSequence	The position of this message within its group. Type: xs:int Default Value: 0
MessageId	The unique Id of this message. Type: xs:string Default Value: ""
MessageLinkName	The name of the link this message is associated with. Type: xs:string Default Value: ""
MessagePriority	The priority of this message. Type: xs:int Default Value: 4
MessageReplyTo	The address of the node to send replies to for this message. Type: xs:string Default Value: ""
MessageReplyToGroupId	The Id of the group to send replies to for this message. Type: xs:string Default Value: ""
MessageSettled	Whether this message is settled. Type: bool Default Value: true
MessageSubject	The subject of this message. Type: xs:string Default Value: ""
MessageTo	The address of the node which this message is intended for. Type: xs:string Default Value: ""
MessageTTL	The time-to-live value for this message. Type: xs:long Default Value: -1
MessageUserId	The identity of the user responsible for producing this message. Type: xs:string Default Value: ""
MessageValueType	This message's value data type. Type: xs:int Default Value: 0
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: ""
PollingInterval	The amount of time, in seconds, between download attempts. Type: xs:int Default Value: 60
ReceiveSource	The address of the node at the remote host acting as the sender. Type: xs:string Default Value: "" NOTE: This property must have a value.
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). Type: xs:int Default Value: 5672 NOTE: This property must have a value.
RequeueEndpoints	Whether to requeue receive endpoints if the polling interval has not been reached. Type: bool Default Value: false
RuntimeLicense	Specifies the component runtime license key. Type: xs:string Default Value: ""
SessionName	The name of the session to send to or receive from. Type: xs:string Default Value: "" NOTE: This property must have a 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
TransportLog	Tells the component where and how to report information about its operations. Type: Log Default Value: null
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: ""

Click OK.
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.

AMQP Transmitter

Setting the AMQP 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 AMQP 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 AMQP send port:

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.AMQP 2022 for the Type option in the Transport section of the General tab.
On the General tab, in the Transport section, click the Configure button next to Type.

In the nsoftware.AMQP 2022 Transport Properties dialog box, use the following properties to:


AuthScheme	The authentication scheme to use when connecting. Type: xs:int Default Value: 1
ConnectionLifetime	Instructs the component whether or not to leave the connection to the server open. Type: xs:int Default Value: 0
ContainerId	The container Id the component should advertise when connecting. Type: xs:string Default Value: ""
Firewall	A set of properties related to firewall access. Type: Firewall Default Value: null
IdleTimeout	The maximum period of inactivity the component will allow before disconnecting. Type: xs:int Default Value: 0
LinkName	The name of the sender or receiver link. Type: xs:string Default Value: "" NOTE: This property must be specified.
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
MessageAbsoluteExpiryTime	The absolute time at which this message should be considered expired. Type: xs:string Default Value: "0"
MessageApplicationProperties	The application properties for the message. Type: xs:string Default Value: ""
MessageContentEncoding	The content encoding of this message's data. Type: xs:string Default Value: ""
MessageContentType	The content type of this message's data. Type: xs:string Default Value: ""
MessageCorrelationId	The correlation Id of this message. Type: xs:string Default Value: ""
MessageCreationTime	The creation time of this message. Type: xs:string Default Value: "0"
MessageDeliveryCount	How many previous attempts there have been to deliver this message. Type: xs:int Default Value: 0
MessageDurable	Whether this message is durable. Type: bool Default Value: false
MessageFirstAcquirer	Whether this message may have been acquired by other links previously. Type: bool Default Value: false
MessageGroupId	The Id of the group this message belongs to. Type: xs:string Default Value: ""
MessageGroupSequence	The position of this message within its group. Type: xs:int Default Value: 0
MessageId	The unique Id of this message. Type: xs:string Default Value: ""
MessagePriority	The priority of this message. Type: xs:int Default Value: 4
MessageReplyTo	The address of the node to send replies to for this message. Type: xs:string Default Value: ""
MessageReplyToGroupId	The Id of the group to send replies to for this message. Type: xs:string Default Value: ""
MessageSettled	Whether this message is settled. Type: bool Default Value: true
MessageSubject	The subject of this message. Type: xs:string Default Value: ""
MessageTo	The address of the node which this message is intended for. Type: xs:string Default Value: ""
MessageTTL	The time-to-live value for this message. Type: xs:long Default Value: -1
MessageUserId	The identity of the user responsible for producing this message. Type: xs:string Default Value: ""
MessageValue	This message's value. Type: xs:string Default Value: ""
MessageValueType	This message's value data type. Type: xs:int Default Value: 0
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: ""
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). Type: xs:int Default Value: 5672 NOTE: This property must be specified.
RuntimeLicense	Specifies the component runtime license key. Type: xs:string Default Value: ""
SendTarget	The address of the node at the target receiver. Type: xs:string Default Value: "" NOTE: This property must be specified.
SessionName	The name of the session to send to or receive from. Type: xs:string Default Value: "" NOTE: This property must be specified.
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
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
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: ""

Click OK and OK again to save settings.

AuthScheme Property (AMQP Adapter)

The authentication scheme to use when connecting.

Data Type

Enumeration

Possible Values

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

Default Value

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)

ConnectionLifetime Property (AMQP 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

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.

ContainerId Property (AMQP Adapter)

The container Id the component should advertise when connecting.

Data Type

String

Default Value

Remarks

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

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

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

Note: The container Id cannot be changed while connected.

ErrorThreshold Property (AMQP Adapter)

The maximum number of errors before the component shuts down.

Data Type

Integer

Default Value

Remarks

This property limits the number of errors that the adapter can incur before it shuts down and stops processing messages.

If set to 0 the adapter will never shutdown.

Note that if the operation completes successfully the current error count will be reset.

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

This property is not available in the Sender.

Firewall Property (AMQP 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.

IdleTimeout Property (AMQP Adapter)

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

Data Type

Integer

Default Value

Remarks

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

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

Note: The idle timeout cannot be changed while connected.

LinkName Property (AMQP Adapter)

The name of the sender or receiver link.

Data Type

String

Default Value

Remarks

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

MaxBatchSize Property (AMQP Adapter)

The maximum size, in MB, of the current batch (0 indicates no limit).

Data Type

Integer

Default Value

Remarks

This property limits the maximum amount of data the adapter can store before finalizing and processing the current batch to the number of bytes indicated.

Note: the default value, "0" indicates that there is no limit on the size of the batch. This value is not recommended for production environments as it may result in extremely large batches being held in memory before the adapter moves the data to the next stage of processing.

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

This property is not available in the Sender.

MaxFileCount Property (AMQP Adapter)

The maximum number of files in the current batch (0 indicates no limit).

Data Type

Integer

Default Value

Remarks

This property places a limit on the number of files that can be transmitted in a single batch.

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

This property is not available in the Sender.

MaxFileSize Property (AMQP Adapter)

The maximum size, in MB, of a file in the current batch (0 indicates no limit).

Data Type

Integer

Default Value

Remarks

This property limits the maximum size of any file in the current transmission batch to the number of bytes indicated.

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

This property is not available in the Sender.

MaxPersistentConnections Property (AMQP Adapter)

The maximum number of simultaneous persistent connections when sending.

Data Type

Integer

Default Value

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 (AMQP Adapter)

The maximum number of threads that the component may consume.

Data Type

Integer

Default Value

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 (AMQP Adapter)

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

Data Type

Integer

Default Value

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.

MessageAbsoluteExpiryTime Property (AMQP Adapter)

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

Data Type

String

Default Value

"0"

Remarks

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

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

MessageApplicationProperties Property (AMQP Adapter)

The application properties for the message.

Data Type

String

Default Value

Remarks

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

For the sender, the expected format is:

"Key1=Value1\r\nKey2=Value2"

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

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

MessageContentEncoding Property (AMQP Adapter)

The content encoding of this message's data.

Data Type

String

Default Value

Remarks

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

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

MessageContentType Property (AMQP Adapter)

The content type of this message's data.

Data Type

String

Default Value

Remarks

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

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

MessageCorrelationId Property (AMQP Adapter)

The correlation Id of this message.

Data Type

String

Default Value

Remarks

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

MessageCreationTime Property (AMQP Adapter)

The creation time of this message.

Data Type

String

Default Value

"0"

Remarks

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

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

MessageDeliveryCount Property (AMQP Adapter)

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

Data Type

Integer

Default Value

Remarks

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

MessageDurable Property (AMQP Adapter)

Whether this message is durable.

Data Type

Boolean

Default Value

false

Remarks

This property specifies whether this message is durable or not.

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

MessageFirstAcquirer Property (AMQP Adapter)

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

Data Type

Boolean

Default Value

false

Remarks

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

MessageGroupId Property (AMQP Adapter)

The Id of the group this message belongs to.

Data Type

String

Default Value

Remarks

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

MessageGroupSequence Property (AMQP Adapter)

The position of this message within its group.

Data Type

Integer

Default Value

Remarks

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

MessageId Property (AMQP Adapter)

The unique Id of this message.

Data Type

String

Default Value

Remarks

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

MessageLinkName Property (AMQP Adapter)

The name of the link this message is associated with.

Data Type

String

Default Value

Remarks

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

This property is not available in the Sender.

MessagePriority Property (AMQP Adapter)

The priority of this message.

Data Type

Integer

Default Value

Remarks

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

MessageReplyTo Property (AMQP Adapter)

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

Data Type

String

Default Value

Remarks

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

MessageReplyToGroupId Property (AMQP Adapter)

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

Data Type

String

Default Value

Remarks

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

MessageSettled Property (AMQP Adapter)

Whether this message is settled.

Data Type

Boolean

Default Value

true

Remarks

This property specifies whether this message is settled or not.

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

MessageSubject Property (AMQP Adapter)

The subject of this message.

Data Type

String

Default Value

Remarks

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

MessageTo Property (AMQP Adapter)

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

Data Type

String

Default Value

Remarks

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

MessageTTL Property (AMQP Adapter)

The time-to-live value for this message.

Data Type

Integer

Default Value

-1

Remarks

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

MessageUserId Property (AMQP Adapter)

The identity of the user responsible for producing this message.

Data Type

String

Default Value

Remarks

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

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

MessageValue Property (AMQP Adapter)

This message's value.

Data Type

String

Default Value

Remarks

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

This property is not available in the Receiver.

MessageValueType Property (AMQP Adapter)

This message's value data type.

Data Type

Enumeration

Possible Values

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

Default Value

Remarks

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

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


Type	Description	Value Format
mvtNull (0 - default)	Null	N/A (MessageValue is ignored)
mvtBoolean (1)	Boolean	"True" or "False"
mvtUbyte (2)	Unsigned byte	0 to 255
mvtUshort (3)	Unsigned short	0 to 65535
mvtUint (4)	Unsigned integer	0 to 4294967295
mvtUlong (5)	Unsigned long	0 to 18446744073709551615
mvtByte (6)	Byte	-128 to 127
mvtShort (7)	Short	-32768 to 32767
mvtInt (8)	Integer	-2147483648 to 2147483647
mvtLong (9)	Long	-9223372036854775808 to 9223372036854775807
mvtFloat (10)	Float	IEEE 754 32-bit floating point number
mvtDouble (11)	Double	IEEE 754 64-bit floating point number
mvtDecimal (12)	Decimal	Hex-encoded byte string
mvtChar (13)	Char	Single character
mvtTimestamp (14)	Timestamp	Number of milliseconds since the Unix epoch (January 1, 1970 00:00:00 UTC).
mvtUuid (15)	UUID	Hex-encoded UUID in the form `XXXXXXXX-XXXX-XXXX-XXXX-XXXXXXXXXXXX` (hyphens optional, case-insensitive)
mvtBinary (16)	Binary data	Hex-encoded byte string
mvtString (17)	String	String
mvtSymbol (18)	Symbolic value	ASCII string
mvtJson (19)	Composite data	Composite data JSON

Other Property (AMQP 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 (AMQP Adapter)

A password to use for SASL authentication.

Data Type

Password

Default Value

Remarks

This property contains a password to use for SASL authentication.

PollingInterval Property (AMQP Adapter)

The amount of time, in seconds, between download attempts.

Data Type

Integer

Default Value

Remarks

The adapter will wait for the number of seconds indicated before attempting another download.

This property is not available in the Sender.

ReceiveSource Property (AMQP Adapter)

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

Data Type

String

Default Value

Remarks

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

This property is not available in the Sender.

RemoteHost Property (AMQP 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. It is set before a connection is attempted and cannot be changed once a connection is established.

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

RemotePort Property (AMQP Adapter)

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

Data Type

Integer

Default Value

5672

Remarks

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

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

RequeueEndpoints Property (AMQP 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.

RuntimeLicense Property (AMQP 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.

SendTarget Property (AMQP Adapter)

The address of the node at the target receiver.

Data Type

String

Default Value

Remarks

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

This property is not available in the Receiver.

SessionName Property (AMQP Adapter)

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

Data Type

String

Default Value

Remarks

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

SSLAcceptServerCert Property (AMQP 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 (AMQP 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.

SSLStartMode Property (AMQP Adapter)

Determines how the component starts the SSL negotiation.

Data Type

Enumeration

Possible Values

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

Default Value

Remarks

The SSLStartMode property may have one of the following values:


Automatic	If 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).
Implicit	The SSL negotiation will start immediately after the connection is established.
Explicit	The adapter will first connect in plaintext, and then explicitly start SSL negotiation through a protocol command such as STARTTLS.
None	No SSL negotiation, no SSL security. All communication will be in plaintext mode.

Timeout Property (AMQP Adapter)

A timeout for the component.

Data Type

Integer

Default Value

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).

TransmitBatchMode Property (AMQP Adapter)

How the transmitter processes batches.

Data Type

Enumeration

Possible Values

Parallel (0)
Serial (1)

Default Value

Remarks

This property controls how the transmitter processes message batches:


Parallel	The 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.
Serial	The 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 (AMQP 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.

URI Property (AMQP 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 (AMQP Adapter)

A username to use for SASL authentication.

Data Type

String

Default Value

Remarks

This property contains a username to use for SASL authentication.

Certificate Type

The digital certificate being used.

Remarks

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

Fields

Store
String
Default Value: "MY"

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:


MY	A certificate store holding personal certificates with their associated private keys.
CA	Certifying authority certificates.
ROOT	Root certificates.
SPC	Software 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
Default Value: ""

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
Default Value: 0

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 (PKCS#12) file containing certificates.
3 (cstPFXBlob)	The certificate store is a string (binary or Base64-encoded) representing a certificate store in PFX (PKCS#12) 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 PKCS#7 file containing certificates.
12 (cstP7BBlob)	The certificate store is a string (binary) representing a certificate store in PKCS#7 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).
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.
23 (cstPKCS11)	The certificate is present on a physical security key accessible via a PKCS#11 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 `cstPKCS11`, CertStorePassword to the PIN, and CertStore to the full path of the PKCS#11 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.cstPKCS11; 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.cstPKCS11, secKeyBlob, "123456", "*"); sftp.SSHUser = "test"; sftp.SSHLogon("myhost", 22);`
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
Default Value: ""

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 (read-only)
Default Value: ""

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
Default Value: False

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

FirewallType
FirewallTypes
Default Value: 0

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
Default Value: ""

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
Default Value: ""

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
Default Value: 0

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
Default Value: ""

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
Default Value: "Application"

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
Default Value: 3

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


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

LogType
LogTypes
Default Value: 1

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


None	The adapter will not report any logging information.
EventLog	The 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.
File	The 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 (AMQP 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.

AMQP Config Settings

AuthorizationIdentity: The value to use as the authorization identity when SASL authentication is used.

When AuthScheme is set to smSASLPlain you may use this setting to specify an authorization identity to be used when authenticating.

BinaryMessageEncoding: Sets the expected message encoding to use for decoding binary messages.

This is only valid if DecodeBinaryMessage is True AND no content-type was detected. In all other cases it is ignored.

Supports "utf8" (default) or "8bit".

DecodeBinaryMessage: Decodes binary message payloads.

If set to True the adapter attempts to read the incoming message's content-type, and if the content-type and charset are present they are used to decode.

If an unsupported charset is detected (currently supports utf8 and 8bit) an error is thrown and the message payload is left as hex-encoded byte string. If content-type is not present, then the BinaryMessageEncoding value is used to decode.

Default is False.

DefaultCredit: The amount of credit to create new receiver links with.

This setting controls the amount of credit that new receiver links are created with.

The default is 1024.

DefaultCreditThreshold: The credit threshold to create new receiver links with.

The setting controls the credit threshold that new receiver links are created with. When a link's credit reaches the credit threshold, the adapter will automatically set it back to the amount of credit the link initially had.

The default is 256.

DefaultIncomingWindow: The incoming window size to create new sessions with.

This setting controls the incoming window size (in frames) that new sessions are created with.

The default is 2014.

DefaultOutgoingWindow: The outgoing window size to create new sessions with.

This setting controls the outgoing window size (in frames) that new sessions are created with.

The default is 2014.

DefaultReceiverSettleMode: The receiver settle mode to create new links with.

This setting controls the receiver settle mode that new links (both sender and receiver) are created with. Possible values are:

0 (First - default): The receiver will settle all incoming messages.
1 (Second): The receiver will only settle messages after returning the message disposition and receiving the disposition from the sender indicating it has been settled.

Note: This setting can be used with Azure Service Bus to indicate the settlement mode. For example, "Peek-Lock" can be enabled by setting DefaultSenderSettleMode to 0 and DefaultReceiverSettleMode to 1.

DefaultSenderSettleMode: The sender settle mode to create new links with.

This setting controls the sender settle mode that new links (both sender and receiver) are created with. Possible values are:

0 (Unsettled): The sender will send messages to the receiver in an unsettled state.
1 (Settled): The sender will send messages to the receiver in a settled state.
2 (Mixed - default): The sender may send messages to the receiver in either a settled or an unsettled state.

GenerateCreationTime: Whether the message creation time should be automatically generated when sending a message.

This setting controls whether the adapter will automatically use the current time (overwriting any existing value in the process) when transmitter is called.

The default is False.

GenerateMessageId: Whether a unique message Id should be automatically generated when sending a message.

This setting controls whether the adapter will automatically generate a MessageId value (overwriting any existing value in the process) when transmitter is called.

The default is False.

InputFileEncoding: The encoding used for the sent messasge data.

This setting specifies the encoding of this message's data. Only available for the sender.

The default is False.

MaxFrameSize: The maximum frame size.

This setting controls the maximum frame size (in bytes) that the adapter will accept. This setting cannot be changed while connected.

The default is 4294967295 (0xFFFFFFFF), which is the maximum value allowed.

MaxMessageSize: The maximum message size to restrict new links to.

This setting controls the maximum message size (in bytes) which newly created links will be restricted to.

The default value is 1073741824 (0x40000000).

MessageRelativeExpirationTime: Sets the number of seconds until the message expires.

This setting can be used to set message expiration time relative to the creation time, in seconds. For example, setting this to 300 will set the message expiration time to 5 minutes after the message creation time.

ProtocolVersion: The AMQP protocol version to conform to.

This setting can be queried to determine what AMQP protocol version the adapter conforms to.

Note: Currently this setting will always return "1.0", and cannot be changed. The AMQPClassic adapter may be used instead of this one if AMQP 0.9.1 support is needed.

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.3	12288 (Hex 3000) (Experimental)
TLS1.2	3072 (Hex C00) (Default)
TLS1.1	768 (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:


0x00000001	Ignore time validity status of certificate.
0x00000002	Ignore time validity status of CTL.
0x00000004	Ignore non-nested certificate times.
0x00000010	Allow unknown Certificate Authority.
0x00000020	Ignore wrong certificate usage.
0x00000100	Ignore unknown certificate revocation status.
0x00000200	Ignore unknown CTL signer revocation status.
0x00000400	Ignore unknown Certificate Authority revocation status.
0x00000800	Ignore unknown Root revocation status.
0x00008000	Allow test Root certificate.
0x00004000	Trust test Root certificate.
0x80000000	Ignore 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: Whether or not to use the system security libraries or an internal implementation.

When set to False, the adapter will use the system security libraries by default to perform cryptographic functions where applicable. In this case, 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 configuration setting to True tells the adapter to use the internal implementation instead of using the system security libraries.

On Windows, this setting is set to False by default. On Linux/macOS, this setting is set to True by default.

If using the .NET Standard Library, this setting will be True on all platforms. The .NET Standard library does not support using the system security libraries.

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 dynamic link library (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.