S3 Adapter

The S3 Component provides access to Amazon's Simple Storage Service (S3), as well as other S3-like services.

Remarks

The S3 Adapter allows you to access Amazon's Simple Storage Service (S3), and other S3-like services, securely over an SSL connection. S3 services allow you to store arbitrary data objects in buckets and access them from anywhere using an Internet connection. Please refer to the Amazon S3 documentation (or the documentation for another S3-like service provider) for additional details.

To select which S3 service provider the S3 Adapter should communicate with, use the ServiceProvider property. Possible values are:

spAmazonS3 (0) (default): Amazon S3
spDigitalOcean (1): Digital Ocean Spaces
spGoogleStorage (2): Google Cloud Storage
spWasabi (3): Wasabi
spBackblazeB2 (4): Backblaze B2
spIBM (7): IBM Cloud Object Storage
spOracle (8): Oracle Cloud Object Storage
spLinode (9): Linode Object Storage
spOther (255): Other Provider

Authentication

You will need to sign up for an account with the desired S3 service and obtain an access key and secret key for it. Once you have a valid access key and secret key, use them to set the AccessKey and SecretKey properties. Once this is done, you may begin uploading/downloading files to and from your buckets.

Note: AccessKey and SecretKey must be set before attempting to use the adapter, unless ServiceProvider is set to spGoogleStorage (2) and you wish to authenticate using OAuth 2.0; refer to the OAuthAuthorization and GoogleProjectId properties for more information.

S3 Receive Adapter

The S3 Receive Adapter will download objects specified by the ObjectMask property contained within the specified Bucket.

S3 Send Adapter

The S3 Send Adapter requires a Bucket and a ObjectKey to specify the location to upload files to.

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.


AccessKey	The access key to use for authentication.
Bucket	The name of the bucket to make requests against.
DeleteMode	Controls if and when the remote object is deleted after download.
EncryptionAlgorithm	The encryption algorithm.
EncryptionPassword	The encryption password.
ErrorThreshold	The maximum number of errors before the component shuts down.
Firewall	A set of properties related to firewall access.
FollowRedirects	Determines what happens when the server issues a redirect.
GoogleProjectId	A Google Cloud Platform project Id string.
HTTPProxy	A set of properties related to proxy access.
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.
OAuthAuthorization	OAuth Authorization Information.
ObjectDelimiter	The delimiter string to use when listing objects.
ObjectMask	Indicates the type of files to download from the S3 server.
ObjectPrefix	A prefix used to restrict the results returned when listing objects.
OracleNamespace	The Oracle Cloud Object Storage namespace string.
Other	Defines a set of configuration settings to be used by the component.
PollingInterval	The amount of time, in seconds, between download attempts.
ReceivedObjectDate	The date of the remote object received by the S3 component.
ReceivedObjectName	The name of the remote object received by the S3 component.
ReceivedObjectSize	The size of the remote object received by the S3 component.
Region	The region the component will make requests against.
RequeueEndpoints	Whether to requeue receive endpoints if the polling interval has not been reached.
RuntimeLicense	Specifies the component runtime license key.
SecretKey	The secret key to use for authentication.
ServiceProvider	The S3 service provider.
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.
TempPath	A temporary directory where data can be stored before the component processes it.
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.
UseSSL	Whether to use SSL/TLS when connecting.
UseVirtualHosting	Determines which style request to use.

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.


AccessKey	The access key to use for authentication.
AccessPolicy	The canned access policy to apply when uploading objects.
Bucket	The name of the bucket to make requests against.
ContentDisposition	Content disposition to send when uploading objects.
ContentType	Content type to send when uploading objects.
EncryptionAlgorithm	The encryption algorithm.
EncryptionPassword	The encryption password.
Firewall	A set of properties related to firewall access.
FollowRedirects	Determines what happens when the server issues a redirect.
GoogleProjectId	A Google Cloud Platform project Id string.
HTTPProxy	A set of properties related to proxy access.
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.
OAuthAuthorization	OAuth Authorization Information.
ObjectKey	This is the name of file being uploaded to the server.
OracleNamespace	The Oracle Cloud Object Storage namespace string.
Other	Defines a set of configuration settings to be used by the component.
Region	The region the component will make requests against.
RuntimeLicense	Specifies the component runtime license key.
SecretKey	The secret key to use for authentication.
ServiceProvider	The S3 service provider.
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.
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.
UseSSL	Whether to use SSL/TLS when connecting.
UseVirtualHosting	Determines which style request to use.

Config Settings

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


DeleteOnSuspend	Specifies whether files may be deleted from server when message is suspended.
DeleteOnUploadError	Whether to delete the remote file when an error occurs after upload begins.
DirDelimiter	The delimiter for subfolders on the S3 server that should not be maintained in the local directory.
DownloadCacheFile	When set, only new files will be downloaded from the server.
DownloadCacheFileDuration	The number of minutes that a file name will remain in the download cache.
EnableFileDetailsComparison	Whether the receive component should consider metadata differences when deciding whether to download a file again.
IgnoreBucketRestrictions	Allows the user to ignore Amazon-defined bucket name restrictions.
IncludeObjectMD5	Includes the MD5 digest of the object data if set.
MaxObjects	The maximum number of objects for the server to return.
ProcessAllPages	Whether or not to continue processing if results are paged.
SessionToken	The session token to send in the request when using temporary credentials.
StorageClass	Specify the storage class to be used for the uploaded object.
URL	The URL to use for Other service providers.
UseEC2RoleCredentials	If set to true, authenticate requests with credentials obtained from the IAM role attached to the EC2 instance.
UseServerSideEncryption	If true, use server side encryption.
ReuseSSLSession	Determines if the SSL session is reused.
SSLCipherStrength	The minimum cipher strength used for bulk encryption.
SSLEnabledCipherSuites	The cipher suite to be used in an SSL negotiation.
SSLEnabledProtocols	Used to enable/disable the supported security protocols.
SSLIncludeCertChain	Whether the entire certificate chain is included in the SSLServerAuthentication event.
SSLSecurityFlags	Flags that control certificate verification.
TLS12SignatureAlgorithms	Defines the allowed TLS 1.2 signature algorithms when UseInternalSecurityAPI is True.
TLS12SupportedGroups	The supported groups for ECC.
TLS13KeyShareGroups	The groups for which to pregenerate key shares.
TLS13SignatureAlgorithms	The allowed certificate signature algorithms.
TLS13SupportedGroups	The supported groups for (EC)DHE key exchange.
AbsoluteTimeout	Determines whether timeouts are inactivity timeouts or absolute timeouts.
LocalHost	The name of the local host or user-assigned IP interface through which connections are initiated or accepted.
TcpNoDelay	Whether or not to delay when sending packets.
UseInternalSecurityAPI	Whether or not to use the system security libraries or an internal implementation.

S3 Receiver

How to Configure a S3 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 S3 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.S3 2024 from the drop-down list, and then click Configure to configure the transport properties for the receive location.

In the nsoftware.S3 2024 Transport Properties dialog box, you will find the following properties:


AccessKey	The access key to use for authentication. Type: xs:string Default Value: ""
Bucket	The name of the bucket to make requests against. Type: xs:string Default Value: "" NOTE: This property must have a value.
DeleteMode	Controls if and when the remote object is deleted after download. Type: xs:int Default Value: 0
EncryptionAlgorithm	The encryption algorithm. Type: xs:int Default Value: 0
EncryptionPassword	The encryption password. Type: baf:Password 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
FollowRedirects	Determines what happens when the server issues a redirect. Type: xs:int Default Value: 0
GoogleProjectId	A Google Cloud Platform project Id string. Type: xs:string Default Value: ""
HTTPProxy	A set of properties related to proxy access. Type: Proxy Default Value: null
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
OAuthAuthorization	OAuth Authorization Information. Type: OAuthAuthorizationParam Default Value: null
ObjectDelimiter	The delimiter string to use when listing objects. Type: xs:string Default Value: ""
ObjectMask	Indicates the type of files to download from the S3 server. Type: xs:string Default Value: *""** NOTE: This property must have a value.
ObjectPrefix	A prefix used to restrict the results returned when listing objects. Type: xs:string Default Value: ""
OracleNamespace	The Oracle Cloud Object Storage namespace string. Type: xs:string Default Value: ""
Other	Defines a set of configuration settings to be used by the component. Type: xs:string Default Value: ""
PollingInterval	The amount of time, in seconds, between download attempts. Type: xs:int Default Value: 60
ReceivedObjectDate	The date of the remote object received by the S3 component. Type: xs:string Default Value: ""
ReceivedObjectName	The name of the remote object received by the S3 component. Type: xs:string Default Value: ""
ReceivedObjectSize	The size of the remote object received by the S3 component. Type: xs:long Default Value: 0
Region	The region the component will make requests against. Type: xs:string Default 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: ""
SecretKey	The secret key to use for authentication. Type: baf:Password Default Value: ""
ServiceProvider	The S3 service provider. Type: xs:int Default Value: 0
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.
TempPath	A temporary directory where data can be stored before the component processes it. Type: xs:string Default Value: ""
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: ""
UseSSL	Whether to use SSL/TLS when connecting. Type: bool Default Value: true
UseVirtualHosting	Determines which style request to use. Type: bool Default Value: true

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.

S3 Transmitter

Setting the S3 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 S3 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 S3 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.S3 2024 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.S3 2024 Transport Properties dialog box, use the following properties to:


AccessKey	The access key to use for authentication. Type: xs:string Default Value: ""
AccessPolicy	The canned access policy to apply when uploading objects. Type: xs:int Default Value: 0
Bucket	The name of the bucket to make requests against. Type: xs:string Default Value: "" NOTE: This property must be specified.
ContentDisposition	Content disposition to send when uploading objects. Type: xs:string Default Value: ""
ContentType	Content type to send when uploading objects. Type: xs:string Default Value: ""
EncryptionAlgorithm	The encryption algorithm. Type: xs:int Default Value: 0
EncryptionPassword	The encryption password. Type: baf:Password Default Value: ""
Firewall	A set of properties related to firewall access. Type: Firewall Default Value: null
FollowRedirects	Determines what happens when the server issues a redirect. Type: xs:int Default Value: 0
GoogleProjectId	A Google Cloud Platform project Id string. Type: xs:string Default Value: ""
HTTPProxy	A set of properties related to proxy access. Type: Proxy 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
OAuthAuthorization	OAuth Authorization Information. Type: OAuthAuthorizationParam Default Value: null
ObjectKey	This is the name of file being uploaded to the server. Type: xs:string Default Value: "%SourceFileName%" NOTE: This property must be specified.
OracleNamespace	The Oracle Cloud Object Storage namespace string. Type: xs:string Default Value: ""
Other	Defines a set of configuration settings to be used by the component. Type: xs:string Default Value: ""
Region	The region the component will make requests against. Type: xs:string Default Value: ""
RuntimeLicense	Specifies the component runtime license key. Type: xs:string Default Value: ""
SecretKey	The secret key to use for authentication. Type: baf:Password Default Value: ""
ServiceProvider	The S3 service provider. Type: xs:int Default Value: 0
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.
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: ""
UseSSL	Whether to use SSL/TLS when connecting. Type: bool Default Value: true
UseVirtualHosting	Determines which style request to use. Type: bool Default Value: true

Click OK and OK again to save settings.

AccessKey Property (S3 Adapter)

The access key to use for authentication.

Data Type

String

Default Value

Remarks

This property specifies the access key that should be used for authentication. Both this property and SecretKey must be set before attempting any operations which connect to the server. (Unless ServiceProvider is set to spGoogleStorage (2), in which case authentication may be performed using OAuth 2.0 by configuring the OAuthAuthorization and GoogleProjectId properties instead.)

AccessPolicy Property (S3 Adapter)

The canned access policy to apply when uploading objects.

Data Type

Enumeration

Possible Values

Private (0)
Public Read (1)
Public Read Write (2)
Authenticated Read (3)
Bucket Owner Read (4)
Bucket Owner Full Control (5)
None (6)

Default Value

Remarks

This property specifies what canned access policy should be applied to newly-created objects. Valid values are:


`ptPrivate (0)` (default)	Owner gets full control, no one else has access.
`ptPublicRead (1)`	Owner gets full control, everyone else gets read access.
`ptPublicReadWrite (2)`	Owner gets full control, everyone else gets read/write access.
`ptAuthenticatedRead (3)`	Owner gets full control, authenticated users get read access.
`ptBucketOwnerRead (4)`	Only applicable for objects. Object owner gets full control, bucket owner gets read access.
`ptBucketOwnerFullControl (5)`	Only applicable for objects. Both object and bucket owner get full control.
`ptNone (6)`	(Instructs the adapter to not explicitly set a canned access policy for a bucket or object.)

This property is not available in the Receiver.

Bucket Property (S3 Adapter)

The name of the bucket to make requests against.

Data Type

String

Default Value

Remarks

This property specifies the bucket that the adapter should make requests against.

When the S3 Transmitter is being used to upload an object, the specified bucket will be created if it does not already exist.

ContentDisposition Property (S3 Adapter)

Content disposition to send when uploading objects.

Data Type

String

Default Value

Remarks

This property's value, if non-empty, will be submitted during an upload as the object's Content-Disposition header value.

This property is not available in the Receiver.

ContentType Property (S3 Adapter)

Content type to send when uploading objects.

Data Type

String

Default Value

Remarks

This property's value, if non-empty, will be submitted during an upload as the object's Content-Type header value.

This property is not available in the Receiver.

DeleteMode Property (S3 Adapter)

Controls if and when the remote object is deleted after download.

Data Type

Enumeration

Possible Values

Never (0)
On Success (1)
On Failure (2)
Always (3)

Default Value

Remarks

This property informs the adapter as to whether or not it should delete a remote files from the server after a successful download. The possible values and their meanings are as follows:


Never	The remote file is never deleted.
OnSuccess	The remote file is deleted after a successful download.
OnFailure	The remote file is deleted if the transfer fails.
Always	The remote file is deleted regardless of success or failure of the transfer.

Note: the default value is Never for data protection purposes. Unless modified this will result in the adapter continuously receiving the same data.

This property is not available in the Sender.

EncryptionAlgorithm Property (S3 Adapter)

The encryption algorithm.

Data Type

Enumeration

Possible Values

AES (0)
Blowfish (1)
CAST (2)
DES (3)
IDEA (4)
RC2 (5)
RC4 (6)
TEA (7)
Triple DES (8)
Twofish (9)
Rijndael (10)
Cha Cha (11)
XSalsa 20 (12)

Default Value

Remarks

When EncryptionPassword is specified, the adapter will encrypt the file before uploading or decrypt the file after downloading.

This property specifies the encryption algorithm to be used. The maximum allowable key size is automatically used for the selected algorithm. Possible values are:


Algorithm	Key Size
0 (eaAES - default)	256
1 (eaBlowfish)	448
2 (eaCAST)	128
3 (eaDES)	64
4 (eaIDEA)	128
5 (eaRC2)	128
6 (eaRC4)	2048
7 (eaTEA)	128
8 (eaTripleDES)	192
9 (eaTwofish)	256
10 (eaRijndael)	256
11 (eaChaCha)	256
12 (eaXSalsa20)	256

EncryptionPassword Property (S3 Adapter)

The encryption password.

Data Type

Password

Default Value

Remarks

When this property is specified the adapter will attempt to encrypt or decrypt the file before uploading or after downloading.

The adapter uses the value specified here to generate the necessary encryption Key and IV values using the PKCS5 password digest algorithm. This provides a simpler alternative to creating and managed Key and IV values directly.

ErrorThreshold Property (S3 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 (S3 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.

FollowRedirects Property (S3 Adapter)

Determines what happens when the server issues a redirect.

Data Type

Enumeration

Possible Values

Never (0)
Always (1)
Same Scheme (2)

Default Value

Remarks

Normally, the adapter returns an error if the server responds with an "Object Moved" message. If FollowRedirects is set to frAlways (1) the new URL for the object is retrieved automatically every time.

If FollowRedirects is set to frSameScheme (2), the new URL is retrieved automatically only if the URL scheme is the same, otherwise the adapter generate a runtime error.

Furthermore, if either the new URL server and port are different than the existing one, HTTPUser and HTTPPassword are also reset to empty, unless FollowRedirects is set to frAlways (1), in which case the same credentials are used to connect to the new server.

The default value is frNever (0). In this case, redirects are never followed, and a runtime error is generated instead.

GoogleProjectId Property (S3 Adapter)

A Google Cloud Platform project Id string.

Data Type

String

Default Value

Remarks

This property specifies the Google Cloud Platform project Id string to use for authentication. This property must be set if ServiceProvider is set to spGoogleStorage (2) and the adapter is configured to use OAuth 2.0 authentication via the OAuthAuthorization property; in all other cases, it is ignored.

Note that the adapter will fall back to using an AccessKey and SecretKey for authentication if either this property or the OAuthAuthorization property is empty.

HTTPProxy Property (S3 Adapter)

A set of properties related to proxy access.

Data Type

Proxy

Remarks

This is a Proxy type property which contains fields describing the proxy through which the adapter will attempt to connect.

MaxBatchSize Property (S3 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 (S3 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 (S3 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 (S3 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 (S3 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 (S3 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.

OAuthAuthorization Property (S3 Adapter)

OAuth Authorization Information.

Data Type

OAuthAuthorizationParam

Remarks

This property holds details about the OAuth authorization. This includes the following fields:

AuthorizationScopes
AuthorizationString
CacheLocation
CallbackURL
ClientId
ClientSecret
ExpiresIn
RefreshToken
ServerAuthURL
ServerTokenURL
ServiceProvider
TimeStamp

Note that this property is only valid for use when ServiceProvider is set to one of the following:

spGoogleStorage (2) (the GoogleProjectId property must be set)

ObjectDelimiter Property (S3 Adapter)

The delimiter string to use when listing objects.

Data Type

String

Default Value

Remarks

Used by the ListObjects operation. The keys that contain the same string between the ObjectPrefix and the first occurrence of ObjectDelimiter will be rolled up into a single result element.

This property is not available in the Sender.

ObjectKey Property (S3 Adapter)

This is the name of file being uploaded to the server.

Data Type

String

Default Value

"%SourceFileName%"

Remarks

This should be the name of the file as it appears on the server when it is uploaded.

This property is not available in the Receiver.

ObjectMask Property (S3 Adapter)

Indicates the type of files to download from the S3 server.

Data Type

String

Default Value

"*"

Remarks

This property will limit what kinds of objects the adapter will download from the server. Only objects matching the pattern specified in ObjectMask will be retrieved.

The following special characters are supported for pattern matching:


?	Any single character.
*	Any characters or no characters (e.g., C*t matches Cat, Cot, Coast, Ct).
[,-]	A range of characters (e.g., [a-z], [a], [0-9], [0-9,a-d,f,r-z]).
\	The slash is ignored and exact matching is performed on the next character.

If these characters need to be used as a literal in a pattern, then they must be escaped by surrounding them with brackets []. Note: "]" and "-" do not need to be escaped. See below for the escape sequences:


Character	Escape Sequence
?	[?]
*	[*]
[	[[]
\	[\]

For example, to match the value [Something].txt, specify the pattern [[]Something].txt.

This property is not available in the Sender.

ObjectPrefix Property (S3 Adapter)

A prefix used to restrict the results returned when listing objects.

Data Type

String

Default Value

Remarks

Used by the ListObjects operation. This property, if non-empty, restricts the results returned to only the objects whose keys begin with the given value.

This property is not available in the Sender.

OracleNamespace Property (S3 Adapter)

The Oracle Cloud Object Storage namespace string.

Data Type

String

Default Value

Remarks

This property specifies the Oracle Cloud Object Storage namespace string the adapter should use. This property must be set if ServiceProvider is set to spOracle (8); in all other cases, it is ignored.

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

PollingInterval Property (S3 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.

ReceivedObjectDate Property (S3 Adapter)

The date of the remote object received by the S3 component.

Data Type

String

Default Value

Remarks

This value contains the date of the remote object being received by the S3 adapter. It can be read from the context of a message being received by an S3 adapter receive location.

This property is not available in the Sender.

ReceivedObjectName Property (S3 Adapter)

The name of the remote object received by the S3 component.

Data Type

String

Default Value

Remarks

This is the object name returned by the server.

This value is also placed in the File.ReceivedFileName and the S3.ReceivedObjectName context properties. This is to ensure compatibility with other adapters that poll those context properties when filling out macros such as %SourceFileName%.

This property is not available in the Sender.

ReceivedObjectSize Property (S3 Adapter)

The size of the remote object received by the S3 component.

Data Type

Integer

Default Value

Remarks

This value contains the size of the remote file being received by the S3 adapter. It can be read from the context of a message being received by an S3 adapter receive location.

This property is not available in the Sender.

Region Property (S3 Adapter)

The region the component will make requests against.

Data Type

String

Default Value

Remarks

This property controls which region the adapter will make requests against. If this property is empty (default), the default region for the provider currently selected by ServiceProvider will be used; refer to the tables below for more information.

Amazon S3 Regions


Value	Region
`us-east-1` (Default)	US East (N. Virginia)
`us-east-2`	US East (Ohio)
`us-west-1`	US West (N. California)
`us-west-2`	US West (Oregon)
`ap-east-1`	Asia Pacific (Hong Kong)
`ap-northeast-1`	Asia Pacific (Tokyo)
`ap-northeast-2`	Asia Pacific (Seoul)
`ap-northeast-3`	Asia Pacific (Osaka-Local)
`ap-south-1`	Asia Pacific (Mumbai)
`ap-southeast-1`	Asia Pacific (Singapore)
`ap-southeast-2`	Asia Pacific (Sydney)
`ca-central-1`	Canada (Central)
`cn-north-1`	China (Beijing)
`cn-northwest-1`	China (Ningxia)
`eu-central-1`	Europe (Frankfurt)
`eu-north-1`	Europe (Stockholm)
`eu-south-1`	Europe (Milan)
`eu-west-1`	Europe (Ireland)
`eu-west-2`	Europe (London)
`eu-west-3`	Europe (Paris)
`me-south-1`	Middle East (Bahrain)
`sa-east-1`	South America (Sao Paulo)

Backblaze B2 Regions

All BackblazeB2 region strings take the form us-west-###, where ### is a 3-digit number. By default, the adapter uses us-west-000.

To determine the exact region string, log into the Backblaze B2 web console and refer to the "S3 Endpoint" value which corresponds to the application keypair that will be used for authentication; this endpoint value will include the region string.

Note: The master application key for a Backblaze B2 account cannot be used with Backblaze's S3-compatible API; create a non-master application key if necessary.

Digital Ocean Regions


Value	Region
`ams2`	Amsterdam 2
`ams3`	Amsterdam 3
`blr1`	Bangalore 1
`fra1`	Frankfurt 1
`lon1`	London 1
`nyc1`	New York 1
`nyc2`	New York 2
`nyc3` (Default)	New York 3
`sfo1`	San Francisco 1
`sfo2`	San Francisco 2
`sgp1`	Singapore 1
`tor1`	Toronto 1

Google Cloud Storage Regions


Value	Region
`us`* (Default)	Multiple US data centers
`us-central1`	US Central (Iowa)
`us-east1`	US East (South Carolina)
`us-east4`	US East (Northern Virginia)
`us-west1`	US West (Oregon)
`us-west2`	US West (Los Angeles)
`asia`*	Multiple Asia data centers
`asia-east1`	Asia East (Taiwan)
`asia-east2`	Asia East (Hong Kong)
`asia-northeast1`	Asia Northeast (Tokyo)
`asia-south1`	Asia South (Mumbai)
`asia-southeast1`	Asia Southeast (Singapore)
`australia-southeast1`	Australia Southeast (Sydney)
`eu`*	Multiple EU data centers
`europe-north1`	Europe North (Finland)
`europe-west1`	Europe West (Belgium)
`europe-west2`	Europe West (London)
`europe-west3`	Europe West (Frankfurt)
`europe-west4`	Europe West (Netherlands)
`northamerica-northeast1`	Canada (Montreal)
`southamerica-east1`	Brazil (Sao Paulo)

(* denotes a multi-regional location)

IBM Cloud Object Storage Regions


Value	Region
*Cross-Region*
`us` (default)	US Cross Region
`dal.us`	US Cross Region (Dallas Access Point)
`sjc.us`	US Cross Region (San Jose Access Point)
`wdc.us`	US Cross Region (Washington DC Access Point)
`eu`	EU Cross Region
`ams.eu`	EU Cross Region (Amsterdam Access Point)
`fra.eu`	EU Cross Region (Frankfurt Access Point)
`mil.eu`	EU Cross Region (Milan Access Point)
`ap`	Asia Pacific Cross Region
`hkg.ap`	Asia Pacific Cross Region (Hong Kong Access Point)
`seo.ap`	Asia Pacific Cross Region (Seoul Access Point)
`tok.ap`	Asia Pacific Cross Region (Tokyo Access Point)
*Regional*
`au-syd`	Australia (Sydney)
`eu-de`	EU (Germany)
`eu-gb`	EU (United Kingdom)
`jp-tok`	Japan (Tokyo)
`us-east`	US (East)
`us-south`	US (South)
*Single-Site*
`ams03`	Netherlands (Amsterdam)
`che01`	India (Chennai)
`hkg02`	Hong Kong
`mel01`	Australia (Melbourne)
`mex01`	Mexico (Mexico City)
`mil01`	Italy (Milan)
`mon01`	Canada (Montreal)
`osl01`	Norway (Oslo)
`par01`	France (Paris)
`sao01`	Brazil (Sao Paulo)
`seo01`	South Korea (Seoul)
`sjc04`	US (San Jose)
`sng01`	Singapore
`tor01`	Canada (Toronto)

Note that private. or direct. may optionally be prepended to any of the values above; refer to IBM Cloud's Object Storage documentation for information on regions and endpoints.

Linode Object Storage Regions


Value	Region
`us-east-1` (default)	US East (Newark)
`eu-central-1`	EU Central (Frankfurt)

Oracle Cloud Object Storage Regions


Value	Region
*Commercial Cloud Regions*
`ap-hyderabad-1`	India South (Hyderabad)
`ap-melbourne-1`	Australia Southeast (Melbourne)
`ap-mumbai-1`	India West (Mumbai)
`ap-osaka-1`	Japan Central (Osaka)
`ap-seoul-1`	South Korea Central (Seoul)
`ap-sydney-1`	Australia East (Sydney)
`ap-tokyo-1`	Japan East (Tokyo)
`ca-montreal-1`	Canada Southeast (Montreal)
`ca-toronto-1`	Canada Southeast (Toronto)
`eu-amsterdam-1`	Netherlands Northwest (Amsterdam)
`eu-frankfurt-1`	Germany Central (Frankfurt)
`eu-zurich-1`	Switzerland North (Zurich)
`me-jeddah-1`	Saudi Arabia West (Jeddah)
`sa-saopaulo-1`	Brazil East (Sao Paulo)
`uk-london-1`	UK South (London)
`us-ashburn-1` (default)	US East (Ashburn, VA)
`us-phoenix-1`	US West (Phoenix, AZ)
*US Gov FedRAMP High Regions*
`us-langley-1`	US Gov East (Ashburn, VA)
`us-luke-1`	US Gov West (Phoenix, AZ)
*US Gov DISA IL5 Regions*
`us-gov-ashburn-1`	US DoD East (Ashburn, VA)
`us-gov-chicago-1`	US DoD North (Chicago, IL)
`us-gov-phoenix-1`	US DoD West (Phoenix, AZ)

Wasabi Regions


Value	Region
`eu-central-1`	Europe (Amsterdam)
`us-east-1` (Default)	US East (Ashburn, VA)
`us-east-2`	US East (Manassas, VA)
`us-west-1`	US West (Hillsboro, OR)

Note: The lists above are not necessarily exhaustive; refer to the appropriate service provider's documentation for a complete list of regions.

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

SecretKey Property (S3 Adapter)

The secret key to use for authentication.

Data Type

String

Default Value

Remarks

This property specifies the secret key that should be used for authentication. Both this property and AccessKey must be set before attempting any operations which connect to the server. (Unless ServiceProvider is set to spGoogleStorage (2), in which case authentication may be performed using OAuth 2.0 by configuring the OAuthAuthorization and GoogleProjectId properties instead.)

ServiceProvider Property (S3 Adapter)

The S3 service provider.

Data Type

Enumeration

Possible Values

Amazon S3 (0)
Digital Ocean (1)
Google Storage (2)
Wasabi (3)
Backblaze B2 (4)
IBM (7)
Oracle (8)
Linode (9)
Other (255)

Default Value

Remarks

This property specifies the S3 service provider to which requests will be made. Possible values are:

spAmazonS3 (0) (default): Amazon S3
spDigitalOcean (1): Digital Ocean Spaces
spGoogleStorage (2): Google Cloud Storage
spWasabi (3): Wasabi
spBackblazeB2 (4): Backblaze B2
spIBM (7): IBM Cloud Object Storage
spOracle (8): Oracle Cloud Object Storage
spLinode (9): Linode Object Storage
spOther (255): Other Provider

Note that the following providers require additional configuration before requests can be made:

spOracle (8): An "Object Storage Namespace" must be specified using the OracleNamespace property.
spOther (255): A base URL must be specified using the URL setting.

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

TempPath Property (S3 Adapter)

A temporary directory where data can be stored before the component processes it.

Data Type

String

Default Value

Remarks

This property indicates a temporary directory where the adapter can store any data before the adapter processes it. If TempPath is empty, the adapter will receive all data to memory. If set, the adapter will generate and write all inbound data to a temporary file in the specified directory.

Once the file is submitted, the adapter will handle closing the file stream and deleting the temporary file. However, if the adapter is shut down during a transfer some temporary files may be left in the directory. To ensure optimal performance, server administrators should check the directory regularly and remove old or extraneous files.

This property accepts the "%TEMP%" macro, which will be replaced with the default system temporary directory at runtime. Note: by default, this property is empty and the adapter will use memory streams to store all inbound data before submitting it. It is recommended that you use a temporary directory when downloading large batches or batches containing large files to alleviate potential increased memory requirements.

This property is not available in the Sender.

Timeout Property (S3 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 (S3 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 (S3 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 (S3 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.

UseSSL Property (S3 Adapter)

Whether to use SSL/TLS when connecting.

Data Type

Boolean

Default Value

true

Remarks

This property specifies whether the adapter should use SSL/TLS when connecting.

Note that this property is not applicable when ServiceProvider is set to one of the following providers, which require SSL/TLS to be used:

spDigitalOcean (1)
spBackblazeB2 (4)
spOracle (8)

UseVirtualHosting Property (S3 Adapter)

Determines which style request to use.

Data Type

Boolean

Default Value

true

Remarks

When True, the adapter will use virtual-hosted-style URLs like, e.g., https://yourbucket.[SERVICE_PROVIDER_DOMAIN]/yourobjectpath.

When False, the adapter will use path-style URLs like, e.g., https://[SERVICE_PROVIDER_DOMAIN]/yourbucket/yourobject.

Important: Amazon has publicly announced that buckets created after September 30, 2020 will only support virtual-hosted-style URLs. Buckets created on or before September 30, 2020 will continue to support both URL styles.

Note that this property is ignored when ServiceProvider is spOracle (8); Oracle Cloud Object Storage only supports path-style URLs.

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

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

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

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

OAuthAuthorizationParam Type

This type holds details of the OAuth authorization.

Remarks

This type holds details of the OAuth authorization.

Fields

AuthorizationScopes
String
Default Value: ""

A space separated list of scopes as defined by the authorization server.

AuthorizationString
String
Default Value: ""

The OAuth Authorization string. This field holds the current OAuth authorization string. This is retrieved during the OAuth authorization process and is used to authenticate the request. This is a string like:

Bearer ya29.AHES6ZSZEJzATdZYjeihDn5W-VrXSsxEZu5p0pclxGdKKQ

CacheLocation
String
Default Value: ""

The location on disk of the OAuth Cache File.

This field specifies the location on disk of the OAuth cache file. This file holds OAuth credentials that may be automatically used during runtime and by other ports using the same provider. The adapter uses the data within the cache file to automatically refresh expired tokens at runtime. Do not alter the contents of the file directly.

One file for each provider is used by default. For instance for Box the value is: %APPDATA%\nsoftware\CloudStorage BizTalk Adapter\BoxOAuthCache.txt

This value may be specified manually as well.

CallbackURL
String
Default Value: ""

The Callback URL used during OAuth authorization.

This field specifies the local URL to which the browser is redirected when initially performing authorization. When initially establishing Authorization set this value to the redirect URI that is registered for your application with the service provider. For instance "http://localhost:7777".

The adapter will parse this URL and start a small embedded web server on the specified port to receive the OAuth response from the provider during OAuth authorization.

This value is required to perform OAuth authorization.

ClientId
String
Default Value: ""

The id of the client assigned when registering the application.

This field holds the id of the client that was assigned when initially registering the application.

This value is required to perform OAuth authorization.

ClientSecret
String
Default Value: ""

The secret of the client assigned when registering the application.

This field holds the secret of the client that was assigned when initially registering the application.

This value is required to perform OAuth authorization.

ExpiresIn
Integer
Default Value: 0

The expiration time of the current OAuth authorization string.

This value is populated after OAuth authorization and holds the expiration time of the OAuth access token as reported by the service provider. This is used at runtime to calculate whether the token should be refreshed before attempting an operation. If the token is expired the adapter will automatically refresh the token. If the token is not expired the adapter will use the current token.

This value should not be set manually.

Note: Not all providers provide this value. For instance Dropbox access tokens never expire.

RefreshToken
String
Default Value: ""

The refresh token received from or sent to the authorization server.

This field holds the refresh token received during the initial OAuth authorization. It is used by the adapter to automatically request a new AuthorizationString when the current value expires.

ServerAuthURL
String
Default Value: ""

The URL of the authorization server.

ServerTokenURL
String
Default Value: ""

The URL of the token server.

ServiceProvider
String
Default Value: ""

The service provider to authenticate with.

This field defines the service provider. This is used when performing OAuth authorization. OAuth authorization is only applicable to some providers. If the provider does not support OAuth a warning will be displayed. Possible values when using the Cloud Storage adapter are:

Amazon S3
Azure Blob
Azure File
Backblaze B2
Box.com
Digital Ocean Spaces
Dropbox
Google Cloud Storage
Google Drive
Hadoop DFS
IBM Cloud Object Storage
Linode Object Storage
Microsoft OneDrive
Wasabi

Possible values when using the Email adapter are:

Gmail
Other

TimeStamp
String
Default Value: "0"

The timestamp of the OAuth authorization string.

This field holds the timestamp of when the AuthorizationString was retrieved. This is used in conjunction with ExpiresIn to calculate if refreshing the token is required. For more details see ExpiresIn.

This value should not be set manually.

Constructors

Constructors are only relevant when configuring adapters in orchestrations.

public OAuthAuthorizationParam();

Proxy Type

The proxy the component will connect to.

Remarks

When connecting through a proxy, this type is used to specify different properties of the proxy such as the Server and the AuthScheme.

Fields

AuthScheme
ProxyAuthSchemes
Default Value: 0

Use the AuthScheme field to tell the adapter which type of authorization to perform when connecting to the proxy. This is only used when the User and Password fields are set.

AuthScheme should be set to authNone (3) when no authentication is expected.

By default, AuthScheme is authBasic (0), and if the User and Password fields are set, the component will attempt basic authentication. If AuthScheme is set to authDigest (1), digest authentication will be attempted instead.

If AuthScheme is set to authProprietary (2), then the authorization token will not be generated by the adapter. Look at the configuration file for the adapter being used to find more information about manually setting this token.

If AuthScheme is set to authNtlm (4), NTLM authentication will be used. This option is only available in the SSL package.

For security reasons, setting this property will clear the values of User and Password.

AutoDetect
Boolean
Default Value: False

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

Password
String
Default Value: ""

A password if authentication is to be used for the proxy.

If AuthScheme is set to Basic Authentication, the User and Password are Base64 encoded and the proxy authentication token will be generated in the form "Basic [encoded-user-password]".

If AuthScheme is set to Digest Authentication, the User and Password fields are used to respond to the Digest Authentication challenge from the server.

If AuthScheme is set to NTLM Authentication, the User and Password fields are used to authenticate through NTLM negotiation.

Port
Integer
Default Value: 80

The TCP port for the proxy Server (default 80). See the description of the Server field for details.

Server
String
Default Value: ""

If a proxy Server is given, then the HTTP request is sent to the proxy instead of the server otherwise specified.

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

SSL
ProxySSLTypes
Default Value: 0

Determines when to use SSL for the connection to the proxy. The applicable values are the following:


psAutomatic (0)	Default setting. The connection to the Server is SSL-enabled for 'https' URL-s, and non SSL-enabled for other URL-s.
psAlways (1)	The connection is always SSL-enabled.
psNever (2)	The connection is not SSL-enabled.
psTunnel (3)	The connection is through a tunneling (HTTP) proxy.

User
String
Default Value: ""

A user name, if authentication is to be used for the proxy.

If AuthScheme is set to Basic Authentication, the User and Password are Base64 encoded and the proxy authentication token will be generated in the form "Basic [encoded-user-password]".

If AuthScheme is set to Digest Authentication, the User and Password fields are used to respond to the Digest Authentication challenge from the server.

If AuthScheme is set to NTLM Authentication, the User and Password fields are used to authenticate through NTLM negotiation.

Constructors

Constructors are only relevant when configuring adapters in orchestrations.

public Proxy();

public Proxy(string server, int port);

public Proxy(string server, int port, string user, string password);

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

S3 Config Settings

DeleteOnSuspend: Specifies whether files may be deleted from server when message is suspended.

If true, the file on the server will be deleted in accordance with the option selected in DeleteMode even if the message is suspended.

The default value is False.

DeleteOnUploadError: Whether to delete the remote file when an error occurs after upload begins.

If an error occurs after an upload has started, the partial upload may remain on the remote server after the error is handled. If this setting is True, the send adapter will delete the partial upload while handling the error. The default value is False.

This is only applicable to the send adapter.

DirDelimiter: The delimiter for subfolders on the S3 server that should not be maintained in the local directory.

By default, a downloaded S3 object name will be appended to the LocalDirectory when the object is written to the local filesystem. If the object name includes folder and/or subfolder delimiters, these will be treated as actual folders within LocalDirectory. To ignore these folders/subfolders and write the files directly in the LocalDirectory, set this config to the character or string delimiting folders/subfolders on the S3 server.

For example, if the object is stored in S3 as "folder1/folder2/file.txt", and neither "folder1" nor "folder2" should be present inside the LocalDirectory, this config should be set to /.

DownloadCacheFile: When set, only new files will be downloaded from the server.

This may be set to the location of a file on disk that will hold the names of files that were previously downloaded from the server. On each PollingInterval the adapter will check to see if the file on the server exists in this list. If the file exists in this list, it is determined that the file was previously downloaded and is not downloaded on the current polling interval. The list is automatically updated on each polling interval. Please see DownloadCacheFileDuration and EnableFileDetailsComparison for more configuration options.

DownloadCacheFileDuration: The number of minutes that a file name will remain in the download cache.

If a file name is added to the DownloadCacheFile and is not seen on the server again within DownloadCacheFileDuration minutes, it will be removed from the cache. This can prevent the download cache file from growing too large in certain cases.

The default value is 0, meaning that files will never be removed.

This setting is only applicable if DownloadCacheFile is set.

EnableFileDetailsComparison: Whether the receive adapter should consider metadata differences when deciding whether to download a file again.

This setting is used in conjunction with DownloadCacheFile, and is only available on the receive adapter. If DownloadCacheFile is enabled, this setting can be used to control how the receive adapter uses the download file cache information when deciding whether to download a file again. (Similar to the "Enable Timestamp Comparison" property on Microsoft's FTP BizTalk Adapter.)

If this is set to False, the receive adapter will not download a file again if the cache contains any information about it (that is, if it has been downloaded before).

If this is set to True, the receive adapter will check the metadata of the remote file against its cached metadata, and will download the file again if any of the metadata differs.

IgnoreBucketRestrictions: Allows the user to ignore Amazon-defined bucket name restrictions.

Bucket name restrictions are enforced by default. This configuration settings allows you to override the adapter's validation, and set the Bucket property with any arbitrary string. The following restrictions are enforced:

Bucket names can contain lowercase letters, numbers, periods, underscores, and dashes.
Bucket names must start with a number or letter.
Bucket names must be between 3 and 63 characters long.
Bucket names should not end with a dash.
Bucket names cannot contain two adjacent periods.
Bucket names cannot contain dashes next to periods.
Bucket names must not be formatted as an IP address (eg: 192.168.5.4).

IncludeObjectMD5: Includes the MD5 digest of the object data if set.

If set to True the component will include the MD5 digest of the object data when creating an object. The server will use this value to verify the data was not corrupted during transfer. The default value is False.

MaxObjects: The maximum number of objects for the server to return.

The maximum number of objects to be returned at a time. The default value is -1, which causes the server's default limit (1000) to be used.

ProcessAllPages: Whether or not to continue processing if results are paged.

If set to True (default), the adapter will continue processing if the server indicates that there are more objects to process during a ReceiveObject, ListObjects, or DeleteObjects operation. If set to False, the adapter will only process the first page of results returned from the server.

SessionToken: The session token to send in the request when using temporary credentials.

When using temporary credentials, S3 requires you to send the session token provided with the temporary access and secret key in every request.

StorageClass: Specify the storage class to be used for the uploaded object.

When ServiceProvider is set to one of the following, this setting specifies the storage class to use for newly-created objects:

spAmazonS3 (0)
spGoogleStorage (2)

When ServiceProvider is set to spAmazonS3 (0), valid values are: STANDARD, REDUCED_REDUNDANCY, STANDARD_IA, ONEZONE_IA, INTELLIGENT_TIERING, GLACIER, DEEP_ARCHIVE

When ServiceProvider is set to spGoogleStorage (2), valid values are: STANDARD, MULTI_REGIONAL, REGIONAL, NEARLINE, COLDLINE

Refer to the appropriate service provider's documentation for more information about each storage class.

URL: The URL to use for Other service providers.

When ServiceProvider is set to spOther (255), this setting must be set to the URL of the service provider.

UseEC2RoleCredentials: If set to true, authenticate requests with credentials obtained from the IAM role attached to the EC2 instance.

When ServiceProvider is set to spAmazonS3 (0), and the adapter is running within an Amazon EC2 instance, this setting can be set to true in order to automatically authenticate requests as the IAM role attached to the instance using temporary credentials obtained from the EC2 instance itself.

In order for the adapter to be able to auto-obtain authentication credentials, the EC2 instance must have an "instance profile" with an appropriate IAM role attached to it. Refer to the "Using an IAM Role to Grant Permissions to Applications Running on Amazon EC2 Instances" page in the Amazon IAM documentation for more information.

By default, this setting is false. When set to true the adapter will do the following before each request:

Make a request against the EC2 instance to get the name of the role attached to it.
Make a request against the EC2 instance to obtain temporary security credentials for IAM role returned in the previous call.
Parse the response, automatically populating the AccessKey and SecretKey properties.
Execute the original request using the temporary security credentials that were acquired.

When using this setting, set the AccessKey and SecretKey properties to dummy values (e.g., "DUMMY").

UseServerSideEncryption: If true, use server side encryption.

This setting specifies whether Amazon S3 should enable server-side encryption for newly-created objects.

By default, this setting is False. This setting only applies when ServiceProvider is set to spAmazonS3 (0).

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 set to True, the socket will send all data that are ready to send at once. When set to False, the socket will send smaller buffered packets of data at small intervals. This is known as the Nagle algorithm.

By default, this configuration setting 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.