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

MQTT Adapter

Properties   Config Settings  

The MQTT Component implements a lightweight, fully-featured MQTT client.

Remarks

The MQTT Adapter provides a lightweight, fully-featured MQTT client implementation with support for version 3.1.1 and 5.0. The Adapter supports plaintext and TLS-enabled connections over both standard TCP and WebSockets.

MQTT Receive Adapter

At a minimum, you must supply an RemoteHost, RemotePort, and ClientId for the connection. In order to authenticate with the MQTT server you will need to specify a User and Password. Topic and QOS should be set to subscribe to a topic to receive messages from.

MQTT Send Adapter

At a minimum, you must supply an RemoteHost, RemotePort, and ClientId for the connection. In order to authenticate with the MQTT server you will need to specify a User and Password. Topic and QOS should be set to publish a message to the specified Topic at the set QOS level.

The MQTT 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.

CleanSessionDetermines whether a clean session is used once connected.
ClientIdA string that uniquely identifies this instance of the component to the server.
DuplicateWhether the messages Duplicate flag is set.
FirewallA set of properties related to firewall access.
MaxThreadsThe maximum number of threads that the component may consume.
OtherDefines a set of configuration settings to be used by the component.
PacketIdThe message's packet Id.
PasswordA password if authentication is to be used.
PersistentConnectionInstructs the component whether to keep the connection to the server open.
ProtocolVersionThe MQTT protocol version that the component will conform to.
QOSThe messages QoS level.
RemoteHostThe address of the remote host. Domain names are resolved to IP addresses.
RemotePortThe port of the MQTT server (default is 1883). The default port for SSL is 8883.
RequeueEndpointsWhether to requeue receive endpoints if the polling interval has not been reached.
RetainedWhether or not this message's Retain flag is set.
RuntimeLicenseSpecifies the component runtime license key.
SSLAcceptServerCertInstructs the component to unconditionally accept the server certificate that matches the supplied certificate.
SSLCertThe certificate to use for client authentication during the SSL handshake.
SSLStartModeDetermines how the component starts the SSL negotiation.
TimeoutA timeout for the component.
TopicThe topic to subscribe or publish to.
TransportLogTells the component where and how to report information about its operations.
URIThe Uniform Resource Identifier (URI) of the send port or receive location.
UserA username if authentication is to be used.
WillMessageThe message that the server should publish in the event of an ungraceful disconnection.
WillTopicThe topic that the server should publish the WillMessage to in the event of an ungraceful disconnection.

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.

CleanSessionDetermines whether a clean session is used once connected.
ClientIdA string that uniquely identifies this instance of the component to the server.
ConnectionLifetimeInstructs the component whether or not to leave the connection to the server open.
FirewallA set of properties related to firewall access.
MaxPersistentConnectionsThe maximum number of simultaneous persistent connections when sending.
MaxThreadsThe maximum number of threads that the component may consume.
MaxTransmissionBatchSizeThe maximum number of messages that can be sent in a single batch.
MessageTextThe messages payload.
OtherDefines a set of configuration settings to be used by the component.
PasswordA password if authentication is to be used.
ProtocolVersionThe MQTT protocol version that the component will conform to.
QOSThe messages QoS level.
RemoteHostThe address of the remote host. Domain names are resolved to IP addresses.
RemotePortThe port of the MQTT server (default is 1883). The default port for SSL is 8883.
RuntimeLicenseSpecifies the component runtime license key.
SSLAcceptServerCertInstructs the component to unconditionally accept the server certificate that matches the supplied certificate.
SSLCertThe certificate to use for client authentication during the SSL handshake.
SSLStartModeDetermines how the component starts the SSL negotiation.
TimeoutA timeout for the component.
TopicThe topic to subscribe or publish to.
TransmitBatchModeHow the transmitter processes batches.
TransportLogTells the component where and how to report information about its operations.
URIThe Uniform Resource Identifier (URI) of the send port or receive location.
UserA username if authentication is to be used.
WillMessageThe message that the server should publish in the event of an ungraceful disconnection.
WillTopicThe topic that the server should publish the WillMessage to in the event of an ungraceful disconnection.

Config Settings


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

AutoReconnectWhether to automatically attempt to reconnect in the event of a connection error.
ClientTopicAliasMaxThe maximum value the client will accept for a topic alias sent by the server.
ConnectionTimeoutHow long to wait for a connection attempt to succeed.
ConnectPropertiesJSON string specifying properties to be included in the CONNECT packet.
DisconnectPropertiesJSON string containing DISCONNECT packet properties.
DisconnectReasonCodeCode describing the reason the client or server closed the connection.
DuplicateWhether to set the Duplicate flag when publishing a message.
LogLevelThe level of detail that is logged.
OutgoingMessagePropertiesJSON string specifying properties to be included in the PUBLISH packet.
RepublishIntervalHow many seconds to wait before republishing unacknowledged messages.
ResponseTopicTopic name for a response message.
RetainWhether to set the Retain flag when publishing a message.
SendCustomPacketSends a packet constructed using the supplied hex byte string.
SessionExpIntervalThe length of time in seconds the client and server should store session state data after the connection is closed.
SessionStateFileFile to use for saving and restoring session data.
SubscriptionIdentifierA numeric subscription identifier included in SUBSCRIBE packet which will be returned with messages delivered for that subscription.
TopicAliasValue that is used to identify the Topic instead of using the Topic Name in order to reduce packet size.
TopicDelimiterThe string to use as a delimiter in a topic filter list string.
TopicNLArrayList of No Local option flags for subscription topic filters.
TopicQOSArrayComma-separated list of topic filter QoS values to use when subscribing.
TopicRAPArrayList of Retain As Published option flags for subscription topic filters.
TopicRHArrayList of Retain Handling option values for subscription topic filters.
WillPropertiesJSON string specifying will properties to be included in the CONNECT packet.
WillQOSThe QoS value to use for the Will message.
WillRetainWhether the server should retain the Will message after publishing it.
ReuseSSLSessionDetermines if the SSL session is reused.
SSLCipherStrengthThe minimum cipher strength used for bulk encryption.
SSLEnabledCipherSuitesThe cipher suite to be used in an SSL negotiation.
SSLEnabledProtocolsUsed to enable/disable the supported security protocols.
SSLIncludeCertChainWhether the entire certificate chain is included in the SSLServerAuthentication event.
SSLSecurityFlagsFlags that control certificate verification.
TLS12SignatureAlgorithmsDefines the allowed TLS 1.2 signature algorithms when UseInternalSecurityAPI is True.
TLS12SupportedGroupsThe supported groups for ECC.
TLS13KeyShareGroupsThe groups for which to pregenerate key shares.
TLS13SignatureAlgorithmsThe allowed certificate signature algorithms.
TLS13SupportedGroupsThe supported groups for (EC)DHE key exchange.
AbsoluteTimeoutDetermines whether timeouts are inactivity timeouts or absolute timeouts.
LocalHostThe name of the local host or user-assigned IP interface through which connections are initiated or accepted.
TcpNoDelayWhether or not to delay when sending packets.
UseInternalSecurityAPITells the component whether or not to use the system security libraries or an internal implementation.

MQTT Receiver

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

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

    Determines whether a clean session is used once connected.

    Type: bool    Default Value: true

    ClientId

    A string that uniquely identifies this instance of the component to the server.

    Type: xs:string    Default Value: ""

    Duplicate

    Whether the messages Duplicate flag is set.

    Type: bool    Default Value: false

    Firewall

    A set of properties related to firewall access.

    Type: Firewall    Default Value: null

    MaxThreads

    The maximum number of threads that the component may consume.

    Type: xs:int    Default Value: 20

    Other

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

    Type: xs:string    Default Value: ""

    PacketId

    The message's packet Id.

    Type: xs:int    Default Value: 0

    Password

    A password if authentication is to be used.

    Type: baf:Password    Default Value: ""

    PersistentConnection

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

    Type: bool    Default Value: false

    ProtocolVersion

    The MQTT protocol version that the component will conform to.

    Type: xs:int    Default Value: 0

    QOS

    The messages QoS level.

    Type: xs:int    Default Value: 0
    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 MQTT server (default is 1883). The default port for SSL is 8883.

    Type: xs:int    Default Value: 1883

    RequeueEndpoints

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

    Type: bool    Default Value: false

    Retained

    Whether or not this message's Retain flag is set.

    Type: bool    Default Value: false

    RuntimeLicense

    Specifies the component runtime license key.

    Type: xs:string    Default Value: ""

    SSLAcceptServerCert

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

    Type: Certificate    Default Value: null

    SSLCert

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

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

    SSLStartMode

    Determines how the component starts the SSL negotiation.

    Type: xs:int    Default Value: 0

    Timeout

    A timeout for the component.

    Type: xs:int    Default Value: 60

    Topic

    The topic to subscribe or publish to.

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

    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 if authentication is to be used.

    Type: xs:string    Default Value: ""

    WillMessage

    The message that the server should publish in the event of an ungraceful disconnection.

    Type: xs:string    Default Value: ""

    WillTopic

    The topic that the server should publish the WillMessage to in the event of an ungraceful disconnection.

    Type: xs:string    Default Value: ""

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

MQTT Transmitter

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

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


    CleanSession Determines whether a clean session is used once connected.
    Type: bool    Default Value: true
    ClientId A string that uniquely identifies this instance of the component to the server.
    Type: xs:string    Default Value: ""
    ConnectionLifetime Instructs the component whether or not to leave the connection to the server open.
    Type: xs:int    Default Value: 0
    Firewall A set of properties related to firewall access.
    Type: Firewall    Default Value: null
    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
    MessageText The messages payload.
    Type: xs:string    Default Value: ""
    Other Defines a set of configuration settings to be used by the component.
    Type: xs:string    Default Value: ""
    Password A password if authentication is to be used.
    Type: baf:Password    Default Value: ""
    ProtocolVersion The MQTT protocol version that the component will conform to.
    Type: xs:int    Default Value: 0
    QOS The messages QoS level.
    Type: xs:int    Default Value: 0
    NOTE: This property must be specified.
    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 MQTT server (default is 1883). The default port for SSL is 8883.
    Type: xs:int    Default Value: 1883
    RuntimeLicense Specifies the component runtime license key.
    Type: xs:string    Default Value: ""
    SSLAcceptServerCert Instructs the component to unconditionally accept the server certificate that matches the supplied certificate.
    Type: Certificate    Default Value: null
    SSLCert The certificate to use for client authentication during the SSL handshake.
    Type: Certificate    Default Value: null
    NOTE: The digital id must have a private key associated with it.
    SSLStartMode Determines how the component starts the SSL negotiation.
    Type: xs:int    Default Value: 0
    Timeout A timeout for the component.
    Type: xs:int    Default Value: 60
    Topic The topic to subscribe or publish to.
    Type: xs:string    Default Value: ""
    NOTE: This property must be specified.
    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 if authentication is to be used.
    Type: xs:string    Default Value: ""
    WillMessage The message that the server should publish in the event of an ungraceful disconnection.
    Type: xs:string    Default Value: ""
    WillTopic The topic that the server should publish the WillMessage to in the event of an ungraceful disconnection.
    Type: xs:string    Default Value: ""

  4. Click OK and OK again to save settings.

CleanSession Property (MQTT Adapter)

Determines whether a clean session is used once connected.

Data Type

Boolean

Default Value

true

Remarks

This property determines whether or not the adapter should instruct the server to use a clean session when it connects.

By default, CleanSession is true, so the server will discard any state data previously associated with the current ClientId once the adapter has connected successfully. In addition, the server will not save any state data when the adapter disconnects.

Setting CleanSession to False before connecting will cause the server to re-associate any previously stored state data for the current ClientId. The server will also save any state data that exists when the adapter is disconnected.

The server-side session state consists of:

  • whether a session is present,
  • client subscriptions (including subscription identifiers in MQTT 5),
  • QoS 1 and 2 messages sent to the client pending transmission or completed acknowledgment (and optionally pending QoS 0 messages),
  • QoS 2 messages received from the client but not completely acknowledged, and
  • the SessionExpInterval (in MQTT 5).

Note that retained messages are not deleted as a result of a session ending, but are not part of the session state.

Client-Side Session State

The client-side session state consists of:

  • QoS 1 and QoS 2 messages which have been sent to the Server, but have not been completely acknowledged, and
  • QoS 2 messages which have been received from the Server, but have not been completely acknowledged.

MQTT 5 Notes

In MQTT 5, the "Clean Session" flag from v3.1.1 is split into a "Clean Start" flag indicating that the server should discard previously saved session data from this connection, and a SessionExpInterval controlling the length of time the server should preserve the session data after disconnection.

In MQTT 5, this property acts only as the "Clean Start" flag. It determines whether or not the adapter should instruct the server to discard any previously stored session data associated with the current ClientId and start a new clean session.

For more information on session expiration in MQTT 5, see the SessionExpInterval config. Setting CleanSession to True in v3.1.1 is equivalent to setting CleanSession to True AND setting SessionExpInterval to 0 in MQTT 5.

As with MQTT 3.1.1, it is important for the client to save and restore its own session data on connection and disconnection depending on the value of CleanSession, and to manage its preservation depending on SessionExpInterval.

ClientId Property (MQTT Adapter)

A string that uniquely identifies this instance of the component to the server.

Data Type

String

Default Value

""

Remarks

The ClientId string is used by the server to uniquely identify each client that is connected to it. In MQTT 5, when the SessionExpInterval config is set to a positive value, the server will also associate it with any session state data that needs to be saved for the length of time specified when the adapter is disconnected.

If ClientId is empty and CleanSession is True, the adapter will automatically generate a unique value for ClientId before connecting. If CleanSession is False, the adapter throws an exception.

ConnectionLifetime Property (MQTT Adapter)

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

Data Type

Enumeration

Possible Values

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

Default Value

0

Remarks

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

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

This property is not available in the Receiver.

Duplicate Property (MQTT Adapter)

Whether the messages Duplicate flag is set.

Data Type

Boolean

Default Value

false

Remarks

If true, the message will have the duplicate flag set.

This property is not available in the Sender.

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

MaxPersistentConnections Property (MQTT Adapter)

The maximum number of simultaneous persistent connections when sending.

Data Type

Integer

Default Value

1

Remarks

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

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

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

Note: This only applies to the send adapter.

The default value is 1.

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

This property is not available in the Receiver.

MaxThreads Property (MQTT Adapter)

The maximum number of threads that the component may consume.

Data Type

Integer

Default Value

20

Remarks

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

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

MaxTransmissionBatchSize Property (MQTT Adapter)

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

Data Type

Integer

Default Value

1

Remarks

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

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

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

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

This property is not available in the Receiver.

MessageText Property (MQTT Adapter)

The messages payload.

Data Type

String

Default Value

""

Remarks

This contains the message payload.

This property is not available in the Receiver.

Other Property (MQTT 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

PacketId Property (MQTT Adapter)

The message's packet Id.

Data Type

Integer

Default Value

0

Remarks

The packet Id uniquely identifies a message for a client and broker.

This property is not available in the Sender.

Password Property (MQTT Adapter)

A password if authentication is to be used.

Data Type

Password

Default Value

""

Remarks

This property can be set to a password if authentication is to be used.

In MQTT 3.1.1, while a User may be specified without a Password, setting a Password without a User is not supported; attempting to do so will cause the server to reject the connection attempt.

In MQTT 5, a Password may be set without a User, allowing the field to be used for credentials other than a password.

PersistentConnection Property (MQTT Adapter)

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

Data Type

Boolean

Default Value

false

Remarks

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

ProtocolVersion Property (MQTT Adapter)

The MQTT protocol version that the component will conform to.

Data Type

Enumeration

Possible Values

V3 (0)
V5 (1)

Default Value

0

Remarks

This property specifies the version of the MQTT protocol to use. Possible values are:

0 (mvV3 - default) MQTT 3.1.1
1 (mvV5) MQTT 5

This property must be set before connecting.

QOS Property (MQTT Adapter)

The messages QoS level.

Data Type

Integer

Default Value

0

Remarks

This property should be set to publish or receive messages at the specified QOS level.

QoS values set the service level for delivery of a message. Values range from 0 to 2 and have the following meanings:

Value Description
0 At most once delivery - The published message is sent once, and if it does not arrive it is lost.
1 At least once delivery - Guarantees that the published message arrives, but there may be duplicates.
2 Exactly once delivery - Guarantees that the publish message arrives and that there are no duplicates.

RemoteHost Property (MQTT 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.

By default the adapter will connect in plaintext. To enable SSL set SSLStartMode

In addition, WebSocket connections are supported. To connect using WebSockets specify a hostname beginning with ws:// (plaintext) or wss:// (SSL). For instance, ws://test.mosquitto.org.

RemotePort Property (MQTT Adapter)

The port of the MQTT server (default is 1883). The default port for SSL is 8883.

Data Type

Integer

Default Value

1883

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 (MQTT 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.

Retained Property (MQTT Adapter)

Whether or not this message's Retain flag is set.

Data Type

Boolean

Default Value

false

Remarks

If true, the message's Retain flag will be set.

Publishing a message with the Retain flag set will cause it to be retained by the server, which means the server will automatically deliver that message to any new subscribers to the topic.

This property is not available in the Sender.

RuntimeLicense Property (MQTT Adapter)

Specifies the component runtime license key.

Data Type

String

Default Value

""

Remarks

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

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

SSLAcceptServerCert Property (MQTT 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 (MQTT Adapter)

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

Data Type

Certificate

Remarks

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

This field is used to set a Private Key Certificate.

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

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

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

SSLStartMode Property (MQTT Adapter)

Determines how the component starts the SSL negotiation.

Data Type

Enumeration

Possible Values

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

Default Value

0

Remarks

The SSLStartMode property may have one of the following values:

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

Timeout Property (MQTT Adapter)

A timeout for the component.

Data Type

Integer

Default Value

60

Remarks

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

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

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

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

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

This behavior is controlled by the AbsoluteTimeout configuration setting.

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

Topic Property (MQTT Adapter)

The topic to subscribe or publish to.

Data Type

String

Default Value

""

Remarks

This property should be set to the topic name to subscribe or publish to.

Topic names are case-sensitive, must be 1-65535 characters long, and may include any characters except wildcard characters (# and +) and the null character. The / character separates levels within a topic name, which is important in the context of subscribing.

TransmitBatchMode Property (MQTT Adapter)

How the transmitter processes batches.

Data Type

Enumeration

Possible Values

Parallel (0)
Serial (1)

Default Value

0

Remarks

This property controls how the transmitter processes message batches:

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

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

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

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

This property is not available in the Receiver.

TransportLog Property (MQTT 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 (MQTT 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 (MQTT Adapter)

A username if authentication is to be used.

Data Type

String

Default Value

""

Remarks

This property can be set to a username if authentication is to be used.

In MQTT 3.1.1, while a User may be specified without a Password, setting a Password without a User is not supported; attempting to do so will cause the server to reject the connection attempt.

In MQTT 5, a Password may be set without a User, allowing the field to be used for credentials other than a password.

WillMessage Property (MQTT Adapter)

The message that the server should publish in the event of an ungraceful disconnection.

Data Type

String

Default Value

""

Remarks

This property may be set before calling Connect to specify to the server a message that should be published on WillTopic if the connection is closed ungracefully.

Note that the WillMessage will only be sent to the server if WillTopic is set.

Refer to WillTopic for more information about MQTT Will functionality.

WillTopic Property (MQTT Adapter)

The topic that the server should publish the WillMessage to in the event of an ungraceful disconnection.

Data Type

String

Default Value

""

Remarks

This property may be set to specify the topic name that the server should publish the WillMessage on if the connection is closed ungracefully.

MQTT Wills

The Will feature of MQTT allows a client to specify to the server a WillMessage to publish (as well as a WillTopic to publish it on) in the event of an ungraceful disconnection.

If there is not an ungraceful disconnection the server discards the Will message without publishing it. Note that in MQTT 5, the client can set a DisconnectReasonCode of 0x04 to instruct the server to publish the Will message anyway.

In addition to the WillTopic and WillMessage properties, the WillQOS setting may be used to specify the Will message's QoS level, and the WillRetain setting to set the Will message's Retain flag. Refer to those settings for more information.

If WillTopic is set to empty string (default), the adapter will not send a Will to the server.

In MQTT 5, the "WillDelayInterval" value in the WillProperties config can specify a delay between the ending of the connection and sending the will message, so that the WillMessage will not be sent if a connection is re-established within a certain period of time.

Certificate Type

The digital certificate being used.

Remarks

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

Fields

Store
String

The name of the certificate store for the client certificate.

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

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

Designations of certificate stores are platform-dependent.

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

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

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

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

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

StorePassword
String

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

StoreType
CertStoreTypes

The type of certificate store for this certificate.

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

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

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

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

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

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

Subject
String

The subject of the certificate used for client authentication.

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

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

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

Example (Searching with partial subject)

Control.CertSubject = "Test"

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

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

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

Thumbprint
String

The thumbprint of the certificate.

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

Constructors

Constructors are only relevant when configuring adapters in orchestrations.

public Certificate();

Creates a Certificate instance whose properties can be set.

public Certificate(string certificateFile);

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

public Certificate(byte[] certificateData);

Parses CertificateData as an X509 public key.

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

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

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

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

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

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

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

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

Firewall Type

The firewall the component will connect through.

Remarks

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

Fields

AutoDetect
Boolean

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

FirewallType
FirewallTypes

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

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

Host
String

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

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

Password
String

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

Port
Integer

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

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

User
String

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

Constructors

Constructors are only relevant when configuring adapters in orchestrations.

public Firewall();

Log Type

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

Remarks

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

Fields

Location
String

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

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

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

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

LogMode
LogModes

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

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

LogType
LogTypes

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

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

Constructors

Constructors are only relevant when configuring adapters in orchestrations.

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

Config Settings (MQTT 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.

MQTT Config Settings

AutoReconnect:   Whether to automatically attempt to reconnect in the event of a connection error.

When enabled, the adapter will automatically attempt to reconnect to the server if the connection is interrupted due to a connection error. This behavior is disabled by default.

ClientTopicAliasMax:   The maximum value the client will accept for a topic alias sent by the server.

The client uses this value to limit the number of aliases it is willing to hold on this connection. A value of 0 (default) indicates that the client does not accept any topic aliases on this connection.

This value is sent to the server in the CONNECT packet. It is also available in the ConnectProperties config. See the TopicAlias config for more details.

Valid only for MQTT 5.

ConnectionTimeout:   How long to wait for a connection attempt to succeed.

This setting controls how long the adapter will wait, in seconds, for connection attempt to succeed before timing out. The default is 60 seconds.

ConnectProperties:   JSON string specifying properties to be included in the CONNECT packet.

The values listed below are available. If a value is absent in the CONNECT packet, the server will treat its value as the default listed.

To reset an individual value so that it is no longer included in the CONNECT packet (after it has previously been set), set it to "", or -1 for integers. To reset all ConnectProperties values, set the config JSON string to "".

Name Type Default Description
ClientTopicAliasMax Integer 0 See ClientTopicAliasMax.
MaximumPacketSize Integer Unlimited Maximum Packet Size the Client is willing to accept (cannot be 0).
ReceiveMaximum Integer 65,535 The number of QoS 1 and QoS 2 publications the client is willing to process concurrently.
RequestProblemInformation Boolean True Indicates the server is allowed to return a Reason String and or User Properties on packets other than PUBLISH, CONNACK or DISCONNECT.
RequestResponseInformation Boolean False Indicates the client requests the server to return response information in the CONNACK packet.
SessionExpInterval Integer 0 See SessionExpInterval.

To set these values, set the ConnectProperties config to a string JSON object containing one or more key/value pairs to set. For example, to set all values: { "ClientTopicAliasMax":"20", "MaximumPacketSize":"128000", "ReceiveMaximum":"12", "RequestResponseInformation":"false", "RequestProblemInformation":"true", "SessionExpInterval":"1234" }

Valid only for MQTT 5.

DisconnectProperties:   JSON string containing DISCONNECT packet properties.

This property contains properties to be sent by the client in the DISCONNECT packet, or is set when the client receives a DISCONNECT packet from the server.

Supported properties are:

Name Type Default Description
SessionExpInterval Integer Value in CONNECT Can only be sent by client. A new length of time for the client and server to store session state data. Cannot be non-zero if the client set it to zero in the CONNECT packet. If absent, the client and server should use the value specified in the CONNECT packet.
ReasonString String N/A A human readable string designed for diagnostics.

To reset an individual value so that it is no longer included in the DISCONNECT packet (after it has previously been set), set it to "", or -1 for integers. To reset all DisconnectProperties values, set the config JSON string to "".

Valid only for MQTT 5.

DisconnectReasonCode:   Code describing the reason the client or server closed the connection.

Either the client or server may set a reason code before disconnecting to be included in the DISCONNECT packet.

This value will be populated when the adapter receives a DISCONNECT packet from the server.

For a full list of values applicable to be sent by the client, server or both, see the MQTT 5 specification. They include:

  • 0x00: Normal disconnection - Close the connection normally. Do not send the Will Message.
  • 0x04: Disconnect with Will Message (Client only) - The Client wishes to disconnect but requires that the Server also publishes its Will Message.
  • 0x80: Unspecified error - The Connection is closed but the sender either does not wish to reveal the reason, or none of the other Reason Codes apply.

Valid only for MQTT 5.

Duplicate:   Whether to set the Duplicate flag when publishing a message.

When enabled, the adapter will set the Duplicate flag when a message is published using PublishData or PublishMessage. By default, this is disabled; and manually enabling it is not recommended. Prefer instead to let the adapter handle republishing packets, which it will do automatically so long as RepublishInterval is set to a non-zero value (default).

This setting is ignored when messages are published with a QoS of 0.

Note: The Duplicate flag in an MQTT PUBLISH packet refers to the Id of the packet, not the message itself. According to the MQTT specification, it is possible (and perfectly legal) that a client could receive two QoS 1 PUBLISH packets with different Ids despite having the exact same message data.

LogLevel:   The level of detail that is logged.

This setting controls the level of detail that is logged through the Log event. Possible values are:

0 (None) No events are logged.
1 (Info - default) Informational events are logged.
2 (Verbose) Detailed data is logged.
3 (Debug) Debug data is logged.

OutgoingMessageProperties:   JSON string specifying properties to be included in the PUBLISH packet.

The values listed below are available. If a value is absent in the PUBLISH packet, the server will treat its value as the default listed.

To reset an individual value so that it is no longer included in the PUBLISH packet (after it has previously been set), set it to "", or -1 for integers. To reset all OutgoingMessageProperties values, set the config JSON string to "".

Name Type Default Description
ContentType String N/A String describing content of message to be sent to all subscribers receiving the message.
CorrelationData String N/A Hex-encoded binary string used by the sender of a request message to identify which request the response message is for when received (See ResponseTopic).
MessageExpInterval Integer No exp. Length of time after which the server must stop delivery to a subscriber if not yet processed.
PayloadFormatIndicator Integer 0x00 0x00 = unspecified bytes. 0x01 = UTF-8 encoded character data. Sent to all subscribers receiving the message.
ResponseTopic String N/A See ResponseTopic.
TopicAlias Integer N/A See TopicAlias.
UserProperty String "" String key:value pair to be included in the header properties. The UserProperty can appear multiple times to represent multiple name, value pairs.

To set these values, set the OutgoingMessageProperties config to a string JSON object containing one or more key/value pairs to set. For example: { "ContentType":"plain/text", "CorrelationData":"00000000", "MessageExpInterval":"1000", "PayloadFormatIndicator":"1", "ResponseTopic": "ResponseTopic", "TopicAlias":"1", "UserProperty":"prp1:val1", "UserProperty":"prp2:val2" } Valid only for MQTT 5.

RepublishInterval:   How many seconds to wait before republishing unacknowledged messages.

In MQTT 3.1.1 this setting determines how long the adapter will wait to receive a PUBACK (QoS 1) or PUBREC (QoS 2) for an outgoing message before republishing it. Republished messages will automatically use the same packet Id and have their Duplicate flag set.

The default RepublishInterval is 60 seconds. Specify a RepublishInterval of 0 to prevent the adapter from automatically republishing messages.

In MQTT 5, messages are only republished if the client is disconnected before receiving a PUBACK or PUBREC. This property is only valid for MQTT 3.1.1.

ResponseTopic:   Topic name for a response message.

The receiver of a message with a Response Topic sends a response by using the Response Topic as the Topic Name of a PUBLISH. If the Request Message contains a Correlation Data, the receiver of the Request Message should also include this Correlation Data as a property in the PUBLISH packet of the Response Message.

To send a Request Message, set this value before calling PublishMessage.

To reset the value once it has been previously set, so that it is no longer included in future packets, set it to "".

ResponseTopic and Correlation Data are also accessible in the OutgoingMessageProperties config.

Valid only for MQTT 5.

Retain:   Whether to set the Retain flag when publishing a message.

When enabled, the adapter will set the Retain flag when a message is published using PublishData or PublishMessage. By default, this is disabled.

Publishing a non-empty message with the Retain flag set and a non-zero QoS will cause the server to store it (replacing any previously retained message in the process) so that it can be delivered to any clients which subscribe to the topic in the future. (If the QoS is 0, the server can store the message, but it is not required to do so indefinitely, if at all.)

If the adapter publishes an empty message with the Retain flag set, then (regardless of its QoS) the server will remove any previously retained message for the topic.

Note that messages with the Retain flag set are still processed by the server and delivered as usual to clients currently subscribed to the topic, regardless of whether they are empty or not. Also note that retained messages are not part of a session's state, they are retained until they are either removed or replaced by another retained message, regardless of whether or not the client connected with CleanSession set to True.

SendCustomPacket:   Sends a packet constructed using the supplied hex byte string.

Setting this setting to a string with hex bytes will cause the adapter to construct and send a custom packet. This should not be necessary except for debugging purposes.

SessionExpInterval:   The length of time in seconds the client and server should store session state data after the connection is closed.

If 0 (default), the session ends on disconnection. If 0xFFFFFFFF, the session does not expire.

The server may override this value. Additionally, the client may send a new value in the DisconnectProperties (as long as it was not 0 originally).

See CleanSession for more details on stored sessions in MQTT 5. This property also available in ConnectProperties.

Valid only for MQTT 5.

SessionStateFile:   File to use for saving and restoring session data.

This can be set to a valid file path before calling SaveSession or RestoreSession to have the adapter automatically save and restore the session state data to and from a file.

SubscriptionIdentifier:   A numeric subscription identifier included in SUBSCRIBE packet which will be returned with messages delivered for that subscription.

To instruct the server to establish a subscription identifier mapping and return this value with any future PUBLISH packets for a topic filter, set this config before calling Subscribe for the desired topic.

Note that this value applies only to SUBSCRIBE packets and not to outgoing or incoming messages. The client is not permitted to send a PUBLISH packet with a subscription id - the server will include it when it sends PUBLISH packets to subscribing clients if those clients have established ids. To access subscription ids of incoming messages, see the "SubscriptionIdentifiers" field in the MQTTMessage type.

To reset the value once it has been previously set, so that it is no longer included in future packets, set it to -1.

Valid only for MQTT 5.

TopicAlias:   Value that is used to identify the Topic instead of using the Topic Name in order to reduce packet size.

To establish a topic alias mapping, set this to a unique value before calling PublishMessage with the desired topic filter. Then, next time the client publishes a message to this topic, it may set TopicAlias to the value established and call PublishMessage with an empty topic filter string. The message will be published to the proper topic without sending the topic filter.

A sender can modify the Topic Alias mapping by sending another PUBLISH in the same Network Connection with the same Topic Alias value and a different non-zero length Topic Name.

Note that a topic alias must have a value greater than zero and less than or equal to the maximum supported by the server. Topic alias mappings exist only within a connection and are not a part of stored session state data. The Topic Alias mappings used by the Client and Server are independent from each other.

To reset the value once it has been previously set, so that it is no longer included in future packets, set it to -1.

Also accessible in the OutgoingMessageProperties config.

Valid only for MQTT 5.

TopicDelimiter:   The string to use as a delimiter in a topic filter list string.

When the Subscribe and Unsubscribe methods are called, the adapter parses the topic filters string passed to them into a list of topic filters by splitting it, using this setting's current value as the delimiter. By default, this is set to ,.

TopicNLArray:   List of No Local option flags for subscription topic filters.

The value of this config should be a comma-separated list of boolean values.

For topic filters subscribed to with a True flag, messages will not be forwarded to the same ClientId they were published from.

By default, this value is empty and all flags are False.

Valid only for MQTT 5.

TopicQOSArray:   Comma-separated list of topic filter QoS values to use when subscribing.

This can be set to a comma-separated list of individual QoS values to use for each topic filter passed to the Subscribe method, causing the adapter to ignore the QoS value passed to Subscribe. When doing this, the number of QoS values set to this setting must match the number of topic filters passed to Subscribe.

If this setting is set to the empty string (default) when Subscribe is called with multiple topic filters, the adapter will use the QoS value passed to Subscribe for all of them.

TopicRAPArray:   List of Retain As Published option flags for subscription topic filters.

The value of this config should be a comma-separated list of boolean values.

For topic filters subscribed to with a True flag, messages forwarded for this subscription will keep the retain flag they were published with (as opposed to always being set to False).

By default, this value is empty and all flags are False.

Valid only for MQTT 5.

TopicRHArray:   List of Retain Handling option values for subscription topic filters.

The value of this config should be a comma-separated list of integer values specifying whether retained messages are sent when the subscription is established. Possible values are:

  • 0 = send retained messages at the time of the subscribe
  • 1 = send retained messages at subscribe only if the subscription does not currently exist
  • 2 = do not send retained messages at the time of the subscribe

By default, this value is empty and all values are 0.

Valid only for MQTT 5.

WillProperties:   JSON string specifying will properties to be included in the CONNECT packet.

The values listed below are available. If a value is absent in the CONNECT packet, the server will treat its value as the default listed.

To reset an individual value so that it is no longer included in the CONNECT packet (after it has previously been set), set it to "", or -1 for integers. To reset all WillProperties values, set the config JSON string to "".

Name Type Default Description
ContentType String N/A String describing content of will message.
CorrelationData String N/A Hex-encoded binary string used by the sender of a request message to identify which request the response message is for when received.
MessageExpInterval Integer No exp. Length of time after which the server must stop delivery of the will message to a subscriber if not yet processed.
PayloadFormatIndicator Integer 0x00 0x00 = unspecified bytes.
ReponseTopic String N/A Used as a topic name for a response message.
WillDelayInterval Integer 0 Delay in seconds after disconnection until the server should publish the client WillMessage.

Note that these values will be ignored if WillTopic is empty.

To set these values, set the ConnectProperties config to a string JSON object containing one or more key/value pairs to set. For example, to set all values: { "ContentType":"text/plain", "CorrelationData":"00000000", "MessageExpInterval":"3600", "PayloadFormatIndicator":"1", "ResponseTopic": "ResponseTopic", "WillDelayInterval":"10" }

Valid only for MQTT 5.

WillQOS:   The QoS value to use for the Will message.

If WillTopic is set to a non-empty string this is the QoS value that will be used for the Will message; possible values are 0 (default), 1, and 2. (Note that this setting is ignored if WillTopic is empty.)

Refer to WillTopic for more information.

WillRetain:   Whether the server should retain the Will message after publishing it.

If WillTopic is set to a non-empty string this determines whether or not the server will treat the Will message as retained. By default, this is disabled. (Note that this setting is ignored if WillTopic is empty.)

See Retain for general information about how retained messages are handled by the server.

Refer to WillTopic for more information.

SSL Config Settings

ReuseSSLSession:   Determines if the SSL session is reused.

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

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

SSLCipherStrength:   The minimum cipher strength used for bulk encryption.

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

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

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

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

The enabled cipher suites to be used in SSL negotiation.

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

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

Multiple cipher suites are separated by semicolons.

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

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

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

  • TLS_AES_128_GCM_SHA256
  • TLS_AES_256_GCM_SHA384

SSLEnabledCipherSuites is used together with SSLCipherStrength.

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

Used to enable/disable the supported security protocols.

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

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

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

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

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

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

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

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

SSLSecurityFlags:   Flags that control certificate verification.

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

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

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

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

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

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

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

TLS12SupportedGroups:   The supported groups for ECC.

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

The default value is ecdhe_secp256r1,ecdhe_secp384r1,ecdhe_secp521r1.

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

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

TLS13KeyShareGroups:   The groups for which to pregenerate key shares.

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

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

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

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

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

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

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

TLS13SignatureAlgorithms:   The allowed certificate signature algorithms.

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

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

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

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

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

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

General Config Settings

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

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

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

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

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

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

TcpNoDelay:   Whether or not to delay when sending packets.

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

By default, this config is set to false.

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

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

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

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

Supported Macros

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

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

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