FTP Adapter

Properties   Config Settings  

The FTP Component adds SSL-enabled FTP send and receive capabilities to your BizTalk Server.

Remarks

The FTP Adapter adds a complete FTP client to your BizTalk Server and enables it with plaintext or SSL-secured file download and upload capability.

FTP Receive Adapter

A single property must be set: FTPServer. You may also set an FTPPort if the server is not set to the default protocol port. If your FTP server requires authentication, you should set the User, Password and/or Account properties. If you wish to enable SSL, you can turn it on by setting an appropriate SSLCert and SSLStartMode as well as supplying an SSLAcceptServerCert.

The adapter will connect to the FTP server every PollingInterval and list the directory specified by RemotePath. All files that match the FileMask will be downloaded and submitted to the BizTalk Message Engine as individual messages. In order to guarantee that files are not downloaded multiple times, you may set the DeleteMode. If you wish to do any other PRE- or POST-GET operation, you can specify them as scripts through the BeforeGet and AfterGet properties, respectively.

FTP Send Adapter

Two properties must be set: FTPServer and a RemoteFile. If your server does not operate on the default FTP port, you will need to specify the correct port via FTPPort. For servers that do not allow anonymous uploads, you may also need to set User, Password, and/or Account. To enable SSL, you should select a client SSLCert and a SSLAcceptServerCert as well as an SSLStartMode.

The adapter will connect to the FTP server whenever it has a message to send. The adapter will attempt to upload to the specified RemotePath. In order to prevent parallel processing by another application before your upload is complete, you may need to set a temporary extension via TemporaryUploadExtension. If Overwrite is set to True, the adapter will delete or overwrite remote files as necessary to complete the operation.

If you wish to do any other PRE- or POST-PUT operation, you can specify them as scripts through the BeforePut and AfterPut properties, respectively.

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.

AfterConnectA set of FTP commands to be executed immediately after connecting to the FTPServer .
AfterGetA set of FTP commands to be executed after the GET.
BeforeGetA set of FTP commands to be executed before the GET.
DeleteModeControls if and when the remote file is deleted after download.
ErrorThresholdThe maximum number of errors before the component shuts down.
FileMaskIndicates the type of files to download from the FTP server.
FirewallA set of properties related to firewall access.
FTPPortThe port for the FTP service (default is 21).
FTPServerThe domain name or IP address of the FTP server.
MaxBatchSizeThe maximum size, in MB, of the current batch (0 indicates no limit).
MaxFileCountThe maximum number of files in the current batch (0 indicates no limit).
MaxFileSizeThe maximum size, in MB, of a file in the current batch (0 indicates no limit).
MaxThreadsThe maximum number of threads that the component may consume.
OtherDefines a set of configuration settings to be used by the component.
PassiveControls whether to direct the server into passive mode. Recommended if behind a firewall.
PasswordThe password for login.
PersistentConnectionInstructs the component whether to keep the connection to the server open.
PollingIntervalThe amount of time, in seconds, between download attempts.
ReceivedFileDateThe date of the remote file received by the FTP component.
ReceivedFileNameThe name of the remote file received by the FTP component.
ReceivedFilePathThe remote path of the file received by the FTP component.
ReceivedFileSizeThe size of the remote file received by the FTP component.
ReceivedFileUserThe user name used by the FTP component when downloading the remote file.
RemotePathThe current path in the FTP server.
RequeueEndpointsWhether to requeue receive endpoints if the polling interval has not been reached.
RuntimeLicenseSpecifies the component runtime license key.
SSLAcceptServerCertInstructs the component to unconditionally accept the server certificate that matches the supplied certificate.
SSLCertThe certificate to use for client authentication during the SSL handshake.
SSLStartModeDetermines how the component starts the SSL negotiation.
SSOAffiliateSpecifies the name of the SSO Affiliate Application.
TempPathA temporary local directory where data can be stored before the component processes it.
TimeoutA timeout for the component.
TransferModeThe transfer mode (ASCII or Binary). If the value is 0 (default), the initial server mode will be used.
TransportLogTells the component where and how to report information about its operations.
URIThe Uniform Resource Identifier (URI) of the send port or receive location.
UserThe user id for login.
UseSimpleDirListInstructs the component to issue the NLST command instead of LIST.

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.

AfterConnectA set of FTP commands to be executed immediately after connecting to the FTPServer .
AfterPutA set of FTP commands to be executed after the PUT.
AppendWhether or not the component should append data to the RemoteFile .
BeforePutA set of FTP commands to be executed before the PUT.
ConnectionLifetimeInstructs the component whether or not to leave the connection to the server open.
FirewallA set of properties related to firewall access.
FTPPortThe port for the FTP service (default is 21).
FTPServerThe domain name or IP address of the FTP server.
MaxPersistentConnectionsThe maximum number of simultaneous persistent connections when sending.
MaxThreadsThe maximum number of threads that the component may consume.
MaxTransmissionBatchSizeThe maximum number of messages that can be sent in a single batch.
OtherDefines a set of configuration settings to be used by the component.
OverwriteWhether or not the component should overwrite files during transfer.
PassiveControls whether to direct the server into passive mode. Recommended if behind a firewall.
PasswordThe password for login.
RemoteFileThe name of the destination file on the FTP server for uploading.
RemotePathThe current path in the FTP server.
RemoteTempPathA temporary directory on the server to store files before moving them to RemotePath .
RuntimeLicenseSpecifies the component runtime license key.
SSLAcceptServerCertInstructs the component to unconditionally accept the server certificate that matches the supplied certificate.
SSLCertThe certificate to use for client authentication during the SSL handshake.
SSLStartModeDetermines how the component starts the SSL negotiation.
SSOAffiliateSpecifies the name of the SSO Affiliate Application.
TimeoutA timeout for the component.
TransferModeThe transfer mode (ASCII or Binary). If the value is 0 (default), the initial server mode will be used.
TransmitBatchModeHow the transmitter processes batches.
TransportLogTells the component where and how to report information about its operations.
URIThe Uniform Resource Identifier (URI) of the send port or receive location.
UserThe user id for login.
UseSimpleDirListInstructs the component to issue the NLST command instead of LIST.

Config Settings


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

AccountThe user account to login with.
AutoSelectDataIPAutomatically select the data connection IP.
CheckFileExistsWhether to check if the remote file exists before uploading.
DeleteAfterDownloadIf set to true, deletes the file after download.
DeleteOnSuspendSpecifies whether files may be deleted from server when message is suspended.
DeleteOnUploadErrorWhether to delete the remote file when an error occurs after upload begins.
DirEntryPatternAllows the use of regular expressions to parse non-standard directory entry formats.
DownloadIf set to true, the send component will download files instead of upload.
DownloadCacheFileWhen set, only new files will be downloaded from the server.
DownloadCacheFileDurationThe number of minutes that a file name will remain in the download cache.
DownloadSingleFileIf set to true, the send component will download a file instead of upload.
EnableFileDetailsComparisonWhether the receive component should consider metadata differences when deciding whether to download a file again.
ExcludeMaskInstructs the component to exclude some files when downloading.
IgnoreEmptyFilesInstructs the component to ignore empty files when downloading.
ListDirectoryIf set to true, the send component will list the directory instead of upload.
LocalFileSpecifies the local file to upload or download.
MaxFilesPerPollingIntervalThe maximum number of files that will be downloaded from the server during a single poll.
ModeZCompressionLevelUsed to specify the level of compression used.
MonitorFileGrowthSpecifies whether the adapter checks for file growth before downloading.
PortRangeAllows the specification of a port range the component listens to.
RenameModeThe condition under which RenameTo is used.
RenameToA filename to which RemoteFile will be renamed.
ReusePISSLSessionInDIWhether the PI SSL session will be reused for the DI connection.
ReuseSSLSessionInDIWhether the SSL session will be reused for the DI connection.
TemporaryDownloadExtensionAn extension to be appended during download.
TemporaryUploadExtensionAn extension to be appended during upload.
UseClearCommandChannelAllows for the Clear Command Channel (CCC) command.
UseClearDataChannelAllows for the PROT C command.
UseEPSVAllows extended passive mode.
UseFSwitchSpecifies whether or not the -F parameter is used when listing directory contents.
UseMLSDUses listings for machine processing.
UseModeZAllows compression to be used when transferring data.
UseProtWhenImplicitSends PROT P to the server.
UseRemoteHostAddressForPassiveInstructs the component to use the FTPServer in passive mode.
ReuseSSLSessionDetermines if the SSL session is reused.
SSLCipherStrengthThe minimum cipher strength used for bulk encryption.
SSLEnabledCipherSuitesThe cipher suite to be used in an SSL negotiation.
SSLEnabledProtocolsUsed to enable/disable the supported security protocols.
SSLIncludeCertChainWhether the entire certificate chain is included in the SSLServerAuthentication event.
SSLSecurityFlagsFlags that control certificate verification.
TLS12SignatureAlgorithmsDefines the allowed TLS 1.2 signature algorithms when UseInternalSecurityAPI is True.
TLS12SupportedGroupsThe supported groups for ECC.
TLS13KeyShareGroupsThe groups for which to pregenerate key shares.
TLS13SignatureAlgorithmsThe allowed certificate signature algorithms.
TLS13SupportedGroupsThe supported groups for (EC)DHE key exchange.
AbsoluteTimeoutDetermines whether timeouts are inactivity timeouts or absolute timeouts.
LocalHostThe name of the local host or user-assigned IP interface through which connections are initiated or accepted.
TcpNoDelayWhether or not to delay when sending packets.
UseInternalSecurityAPITells the component whether or not to use the system security libraries or an internal implementation.

FTP Receiver

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

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

    A set of FTP commands to be executed immediately after connecting to the FTPServer .

    Type: xs:string    Default Value: ""

    AfterGet

    A set of FTP commands to be executed after the GET.

    Type: xs:string    Default Value: ""

    BeforeGet

    A set of FTP commands to be executed before the GET.

    Type: xs:string    Default Value: ""

    DeleteMode

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

    Type: xs:int    Default Value: 0

    ErrorThreshold

    The maximum number of errors before the component shuts down.

    Type: xs:int    Default Value: 5

    FileMask

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

    Type: xs:string    Default Value: "*.*"

    Firewall

    A set of properties related to firewall access.

    Type: Firewall    Default Value: null

    FTPPort

    The port for the FTP service (default is 21).

    Type: xs:int    Default Value: 21

    FTPServer

    The domain name or IP address of the FTP server.

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

    MaxBatchSize

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

    Type: xs:int    Default Value: 0

    MaxFileCount

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

    Type: xs:int    Default Value: 10

    MaxFileSize

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

    Type: xs:int    Default Value: 0

    MaxThreads

    The maximum number of threads that the component may consume.

    Type: xs:int    Default Value: 20

    Other

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

    Type: xs:string    Default Value: ""

    Passive

    Controls whether to direct the server into passive mode. Recommended if behind a firewall.

    Type: bool    Default Value: true

    Password

    The password for login.

    Type: baf:Password    Default Value: ""

    PersistentConnection

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

    Type: bool    Default Value: false

    PollingInterval

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

    Type: xs:int    Default Value: 60

    ReceivedFileDate

    The date of the remote file received by the FTP component.

    Type: xs:string    Default Value: ""

    ReceivedFileName

    The name of the remote file received by the FTP component.

    Type: xs:string    Default Value: ""

    ReceivedFilePath

    The remote path of the file received by the FTP component.

    Type: xs:string    Default Value: ""

    ReceivedFileSize

    The size of the remote file received by the FTP component.

    Type: xs:long    Default Value: 0

    ReceivedFileUser

    The user name used by the FTP component when downloading the remote file.

    Type: xs:string    Default Value: ""

    RemotePath

    The current path in the FTP server.

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

    SSLAcceptServerCert

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

    Type: Certificate    Default Value: null

    SSLCert

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

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

    SSLStartMode

    Determines how the component starts the SSL negotiation.

    Type: xs:int    Default Value: 0

    SSOAffiliate

    Specifies the name of the SSO Affiliate Application.

    Type: baf:SSOList    Default Value: ""

    TempPath

    A temporary local 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

    TransferMode

    The transfer mode (ASCII or Binary). If the value is 0 (default), the initial server mode will be used.

    Type: xs:int    Default Value: 0

    TransportLog

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

    Type: Log    Default Value: null

    URI

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

    Type: xs:string    Default Value: ""

    User

    The user id for login.

    Type: xs:string    Default Value: ""

    UseSimpleDirList

    Instructs the component to issue the NLST command instead of LIST.

    Type: bool    Default Value: false

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

FTP Transmitter

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

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


    AfterConnect A set of FTP commands to be executed immediately after connecting to the FTPServer .
    Type: xs:string    Default Value: ""
    AfterPut A set of FTP commands to be executed after the PUT.
    Type: xs:string    Default Value: ""
    Append Whether or not the component should append data to the RemoteFile .
    Type: bool    Default Value: false
    BeforePut A set of FTP commands to be executed before the PUT.
    Type: xs:string    Default Value: ""
    ConnectionLifetime Instructs the component whether or not to leave the connection to the server open.
    Type: xs:int    Default Value: 0
    Firewall A set of properties related to firewall access.
    Type: Firewall    Default Value: null
    FTPPort The port for the FTP service (default is 21).
    Type: xs:int    Default Value: 21
    FTPServer The domain name or IP address of the FTP server.
    Type: xs:string    Default Value: ""
    NOTE: This property must be specified.
    MaxPersistentConnections The maximum number of simultaneous persistent connections when sending.
    Type: xs:int    Default Value: 1
    MaxThreads The maximum number of threads that the component may consume.
    Type: xs:int    Default Value: 20
    MaxTransmissionBatchSize The maximum number of messages that can be sent in a single batch.
    Type: xs:int    Default Value: 1
    Other Defines a set of configuration settings to be used by the component.
    Type: xs:string    Default Value: ""
    Overwrite Whether or not the component should overwrite files during transfer.
    Type: bool    Default Value: true
    Passive Controls whether to direct the server into passive mode. Recommended if behind a firewall.
    Type: bool    Default Value: true
    Password The password for login.
    Type: baf:Password    Default Value: ""
    RemoteFile The name of the destination file on the FTP server for uploading.
    Type: xs:string    Default Value: "%SourceFileName%"
    NOTE: This property must be specified.
    RemotePath The current path in the FTP server.
    Type: xs:string    Default Value: ""
    RemoteTempPath A temporary directory on the server to store files before moving them to RemotePath .
    Type: xs:string    Default Value: ""
    RuntimeLicense Specifies the component runtime license key.
    Type: xs:string    Default Value: ""
    SSLAcceptServerCert Instructs the component to unconditionally accept the server certificate that matches the supplied certificate.
    Type: Certificate    Default Value: null
    SSLCert The certificate to use for client authentication during the SSL handshake.
    Type: Certificate    Default Value: null
    NOTE: The digital id must have a private key associated with it.
    SSLStartMode Determines how the component starts the SSL negotiation.
    Type: xs:int    Default Value: 0
    SSOAffiliate Specifies the name of the SSO Affiliate Application.
    Type: baf:SSOList    Default Value: ""
    Timeout A timeout for the component.
    Type: xs:int    Default Value: 60
    TransferMode The transfer mode (ASCII or Binary). If the value is 0 (default), the initial server mode will be used.
    Type: xs:int    Default Value: 0
    TransmitBatchMode How the transmitter processes batches.
    Type: xs:int    Default Value: 0
    TransportLog Tells the component where and how to report information about its operations.
    Type: Log    Default Value: null
    URI The Uniform Resource Identifier (URI) of the send port or receive location.
    Type: xs:string    Default Value: ""
    User The user id for login.
    Type: xs:string    Default Value: ""
    UseSimpleDirList Instructs the component to issue the NLST command instead of LIST.
    Type: bool    Default Value: false

  4. Click OK and OK again to save settings.

AfterConnect Property (FTP Adapter)

A set of FTP commands to be executed immediately after connecting to the FTPServer .

Data Type

String

Default Value

""

Remarks

AfterConnect is a script that is executed immediately following a successful connection.

The script may contain any number of standard FTP commands.

Each line in the script is treated as a single command. By default, if the adapter encounters any errors while executing a command, it will log the error message and will continue to process the script. This behavior can be turned off by inserting "ONERROR FAIL" at any point in the script, which will cause the script to terminate on error but will not interrupt the normal operation of the adapter. The default behavior can be restored at any point in the script by inserting the line "ONERROR RESUME".

Valid additional scripting commands are listed below:

cd PathChange the remote directory to the specified path.
del FilenameDelete the specified file from the remote server.
mkdir DirectoryCreate the specified remote directory on the server.
rn Filename NewFilenameRename the remote file specified by Filename to the NewFilename.
move Filename NewFilenameMove the remote file located at Filename to the NewFilename.
rm FilenameRemove the specified file from the remote server.
rmdir DirectoryRemove the remote directory from the server.
touch FilenameCreate the specified file on the server.

AfterGet Property (FTP Adapter)

A set of FTP commands to be executed after the GET.

Data Type

String

Default Value

""

Remarks

AfterGet is a script that is executed immediately following each successful FTP GET operation.

The script may contain any number of standard FTP commands.

Each line in the script is treated as a single command. By default, if the adapter encounters any errors while executing a command, it will log the error message and will continue to process the script. This behavior can be turned off by inserting "ONERROR FAIL" at any point in the script, which will cause the script to terminate on error but will not interrupt the normal operation of the adapter. The default behavior can be restored at any point in the script by inserting the line "ONERROR RESUME".

Valid additional scripting commands are listed below:

cd PathChange the remote directory to the specified path.
del FilenameDelete the specified file from the remote server.
mkdir DirectoryCreate the specified remote directory on the server.
rn Filename NewFilenameRename the remote file specified by Filename to the NewFilename.
move Filename NewFilenameMove the remote file located at Filename to the NewFilename.
rm FilenameRemove the specified file from the remote server.
rmdir DirectoryRemove the remote directory from the server.
touch FilenameCreate the specified file on the server.

This property is not available in the Sender.

AfterPut Property (FTP Adapter)

A set of FTP commands to be executed after the PUT.

Data Type

String

Default Value

""

Remarks

AfterPut is a script that is executed immediately following each successful FTP PUT operation.

The script may contain any number of standard FTP commands.

Each line in the script is treated as a single command. By default, if the adapter encounters any errors while executing a command, it will log the error message and will continue to process the script. This behavior can be turned off by inserting "ONERROR FAIL" at any point in the script, which will cause the script to terminate on error but will not interrupt the normal operation of the adapter. The default behavior can be restored at any point in the script by inserting the line "ONERROR RESUME".

Valid additional scripting commands are listed below:

cd PathChange the remote directory to the specified path.
del FilenameDelete the specified file from the remote server.
mkdir DirectoryCreate the specified remote directory on the server.
rn Filename NewFilenameRename the remote file specified by Filename to the NewFilename.
move Filename NewFilenameMove the remote file located at Filename to the NewFilename.
rm FilenameRemove the specified file from the remote server.
rmdir DirectoryRemove the remote directory from the server.
touch FilenameCreate the specified file on the server.

This property is not available in the Receiver.

Append Property (FTP Adapter)

Whether or not the component should append data to the RemoteFile .

Data Type

Boolean

Default Value

false

Remarks

This property controls the adapter's upload behavior. When set to TRUE, the adapter will append data to the file specified by RemoteFile rather than creating or overwriting it.

This property is not available in the Receiver.

BeforeGet Property (FTP Adapter)

A set of FTP commands to be executed before the GET.

Data Type

String

Default Value

""

Remarks

BeforeGet is a script that is executed immediately before each successful FTP GET operation.

The script may contain any number of standard FTP commands.

Each line in the script is treated as a single command. By default, if the adapter encounters any errors while executing a command, it will log the error message and will continue to process the script. This behavior can be turned off by inserting "ONERROR FAIL" at any point in the script, which will cause the script to terminate on error but will not interrupt the normal operation of the adapter. The default behavior can be restored at any point in the script by inserting the line "ONERROR RESUME".

Valid additional scripting commands are listed below:

cd PathChange the remote directory to the specified path.
del FilenameDelete the specified file from the remote server.
mkdir DirectoryCreate the specified remote directory on the server.
rn Filename NewFilenameRename the remote file specified by Filename to the NewFilename.
move Filename NewFilenameMove the remote file located at Filename to the NewFilename.
rm FilenameRemove the specified file from the remote server.
rmdir DirectoryRemove the remote directory from the server.
touch FilenameCreate the specified file on the server.

This property is not available in the Sender.

BeforePut Property (FTP Adapter)

A set of FTP commands to be executed before the PUT.

Data Type

String

Default Value

""

Remarks

BeforePut is a script that is executed immediately before each successful FTP PUT operation.

The script may contain any number of standard FTP commands.

Each line in the script is treated as a single command. By default, if the adapter encounters any errors while executing a command, it will log the error message and will continue to process the script. This behavior can be turned off by inserting "ONERROR FAIL" at any point in the script, which will cause the script to terminate on error but will not interrupt the normal operation of the adapter. The default behavior can be restored at any point in the script by inserting the line "ONERROR RESUME".

Valid additional scripting commands are listed below:

cd PathChange the remote directory to the specified path.
del FilenameDelete the specified file from the remote server.
mkdir DirectoryCreate the specified remote directory on the server.
rn Filename NewFilenameRename the remote file specified by Filename to the NewFilename.
move Filename NewFilenameMove the remote file located at Filename to the NewFilename.
rm FilenameRemove the specified file from the remote server.
rmdir DirectoryRemove the remote directory from the server.
touch FilenameCreate the specified file on the server.

This property is not available in the Receiver.

ConnectionLifetime Property (FTP Adapter)

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

Data Type

Enumeration

Possible Values

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


Default Value

0

Remarks

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

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

This property is not available in the Receiver.

DeleteMode Property (FTP Adapter)

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

Data Type

Enumeration

Possible Values

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


Default Value

0

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:

NeverThe remote file is never deleted.
OnSuccessThe remote file is deleted after a successful download.
OnFailureThe remote file is deleted if the transfer fails.
AlwaysThe 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.

ErrorThreshold Property (FTP Adapter)

The maximum number of errors before the component shuts down.

Data Type

Integer

Default Value

5

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.

FileMask Property (FTP Adapter)

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

Data Type

String

Default Value

"*.*"

Remarks

As long as the server supports file masks, this property will limit what kinds of files the adapter will download from the server. Only files matching the pattern specified in FileMask 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:

CharacterEscape Sequence
? [?]
* [*]
[ [[]
\ [\]

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

This property is not available in the Sender.

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

FTPPort Property (FTP Adapter)

The port for the FTP service (default is 21).

Data Type

Integer

Default Value

21

Remarks

A valid port number (a value between 1 and 65535) is required for the connection to take place.

FTPServer Property (FTP Adapter)

The domain name or IP address of the FTP server.

Data Type

String

Default Value

""

Remarks

The FTPServer property specifies the IP address (IP number in dotted internet format) or Domain Name of the FTP server.

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

MaxBatchSize Property (FTP Adapter)

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

Data Type

Integer

Default Value

0

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

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

Data Type

Integer

Default Value

10

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

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

Data Type

Integer

Default Value

0

Remarks

This property limits the maximum size of any file in the current transmission 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.

MaxPersistentConnections Property (FTP Adapter)

The maximum number of simultaneous persistent connections when sending.

Data Type

Integer

Default Value

1

Remarks

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

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

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

Note: This only applies to the send adapter.

The default value is 1.

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

This property is not available in the Receiver.

MaxThreads Property (FTP Adapter)

The maximum number of threads that the component may consume.

Data Type

Integer

Default Value

20

Remarks

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

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

MaxTransmissionBatchSize Property (FTP Adapter)

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

Data Type

Integer

Default Value

1

Remarks

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

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

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

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

This property is not available in the Receiver.

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

Overwrite Property (FTP Adapter)

Whether or not the component should overwrite files during transfer.

Data Type

Boolean

Default Value

true

Remarks

This property is a value indicating whether or not the adapter should overwrite files on the server if they already exist. If Overwrite is false, an error will be thrown whenever RemoteFile exists before an upload operation.

This property is not available in the Receiver.

Passive Property (FTP Adapter)

Controls whether to direct the server into passive mode. Recommended if behind a firewall.

Data Type

Boolean

Default Value

true

Remarks

When false, FTP communications take place in Active mode. In an Active mode connection, data connections are established from server to client on an IP address and port specified by the client in a PORT command to the server.

Many firewalls will not allow the FTP server to open a connection from outside to the higher ports where the FTP client adapter expects them. By default, Passive is set to TRUE, and the adapter will request that FTP communications take place in Passive mode. In Passive mode, the adapter will use the PASV instead of the PORT command and data connections will be established from the client to the server.

Password Property (FTP Adapter)

The password for login.

Data Type

Password

Default Value

""

Remarks

This property must be set before the adapter connects to the FTP server.

PersistentConnection Property (FTP Adapter)

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

Data Type

Boolean

Default Value

false

Remarks

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

PollingInterval Property (FTP Adapter)

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

Data Type

Integer

Default Value

60

Remarks

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

This property is not available in the Sender.

ReceivedFileDate Property (FTP Adapter)

The date of the remote file received by the FTP component.

Data Type

String

Default Value

""

Remarks

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

This property is not available in the Sender.

ReceivedFileName Property (FTP Adapter)

The name of the remote file received by the FTP component.

Data Type

String

Default Value

""

Remarks

This is the filename returned by the server.

This value is also placed in the File.ReceivedFileName and the FTP.ReceivedFileName 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.

ReceivedFilePath Property (FTP Adapter)

The remote path of the file received by the FTP component.

Data Type

String

Default Value

""

Remarks

This is the remote path of the file returned by the server. It can be read from the context of a message being received by an FTP adapter receive location.

This property is not available in the Sender.

ReceivedFileSize Property (FTP Adapter)

The size of the remote file received by the FTP component.

Data Type

Integer

Default Value

0

Remarks

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

This property is not available in the Sender.

ReceivedFileUser Property (FTP Adapter)

The user name used by the FTP component when downloading the remote file.

Data Type

String

Default Value

""

Remarks

This property contains the value of the User used by the FTP adapter to authenticate before downloading the remote file. It can be read from the context of a message being received by an FTP adapter receive location.

This property is not available in the Sender.

RemoteFile Property (FTP Adapter)

The name of the destination file on the FTP server for uploading.

Data Type

String

Default Value

"%SourceFileName%"

Remarks

The RemoteFile is either an absolute file path, or a relative path based on RemotePath.

This property is not available in the Receiver.

RemotePath Property (FTP Adapter)

The current path in the FTP server.

Data Type

String

Default Value

""

Remarks

The RemotePath can be used to set the working directory by setting it to either an absolute directory path or a path relative to the initial remote directory when the adapter connects to the FTP server.

RemoteTempPath Property (FTP Adapter)

A temporary directory on the server to store files before moving them to RemotePath .

Data Type

String

Default Value

""

Remarks

If a value is specified, the adapter will directly upload the file to RemoteTempPath. Once the file transfer is complete, the adapter will move the file to the RemotePath.

This property is not available in the Receiver.

RequeueEndpoints Property (FTP 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 (FTP Adapter)

Specifies the component runtime license key.

Data Type

String

Default Value

""

Remarks

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

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

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

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

Data Type

Certificate

Remarks

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

This field is used to set a Private Key Certificate.

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

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

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

SSLStartMode Property (FTP Adapter)

Determines how the component starts the SSL negotiation.

Data Type

Enumeration

Possible Values

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


Default Value

0

Remarks

The SSLStartMode property may have one of the following values:

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

SSOAffiliate Property (FTP Adapter)

Specifies the name of the SSO Affiliate Application.

Data Type

String

Default Value

""

Remarks

This property allows the adapter to load credentials from an Enterprise Single Sign-On secret server.

TempPath Property (FTP Adapter)

A temporary local 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 (FTP Adapter)

A timeout for the component.

Data Type

Integer

Default Value

60

Remarks

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

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

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

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

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

This behavior is controlled by the AbsoluteTimeout configuration setting.

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

TransferMode Property (FTP Adapter)

The transfer mode (ASCII or Binary). If the value is 0 (default), the initial server mode will be used.

Data Type

Enumeration

Possible Values

Default (0)
ASCII (1)
Binary (2)


Default Value

0

Remarks

The valid options for the TransferMode property are as follows:

Default The initial mode of the FTP server is taken. No change.
ASCII Files are transferred in ASCII mode (TYPE A).
Binary Files are transferred in Binary mode (TYPE I).

TransmitBatchMode Property (FTP Adapter)

How the transmitter processes batches.

Data Type

Enumeration

Possible Values

Parallel (0)
Serial (1)


Default Value

0

Remarks

This property controls how the transmitter processes message batches:

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

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

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

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

This property is not available in the Receiver.

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

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

Data Type

String

Default Value

""

Remarks

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

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

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

User Property (FTP Adapter)

The user id for login.

Data Type

String

Default Value

""

Remarks

This property must be set before the adapter connects to the FTP server.

UseSimpleDirList Property (FTP Adapter)

Instructs the component to issue the NLST command instead of LIST.

Data Type

Boolean

Default Value

false

Remarks

When this is set to true, the adapter will send the NLST command to the server. This tells the server to return a more simply formatted listing. If the server's directory listing can not be parsed when this is false, setting this to true will be helpful.

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:

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

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

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

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

StorePassword
String

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 (PKCS12) file containing certificates.
3 (cstPFXBlob)The certificate store is a string (binary or base64-encoded) representing a certificate store in PFX (PKCS12) format.
4 (cstJKSFile)The certificate store is the name of a Java Key Store (JKS) file containing certificates. Note: this store type is only available in Java.
5 (cstJKSBlob)The certificate store is a string (binary or base64-encoded) representing a certificate store in Java Key Store (JKS) format. Note: this store type is only available in Java.
6 (cstPEMKeyFile)The certificate store is the name of a PEM-encoded file that contains a private key and an optional certificate.
7 (cstPEMKeyBlob)The certificate store is a string (binary or base64-encoded) that contains a private key and an optional certificate.
8 (cstPublicKeyFile)The certificate store is the name of a file that contains a PEM- or DER-encoded public key certificate.
9 (cstPublicKeyBlob)The certificate store is a string (binary or base64-encoded) that contains a PEM- or DER-encoded public key certificate.
10 (cstSSHPublicKeyBlob)The certificate store is a string (binary or base64-encoded) that contains an SSH-style public key.
11 (cstP7BFile)The certificate store is the name of a PKCS7 file containing certificates.
12 (cstP7BBlob)The certificate store is a string (binary) representing a certificate store in PKCS7 format.
13 (cstSSHPublicKeyFile)The certificate store is the name of a file that contains an SSH-style public key.
14 (cstPPKFile)The certificate store is the name of a file that contains a PPK (PuTTY Private Key).
15 (cstPPKBlob)The certificate store is a string (binary) that contains a PPK (PuTTY Private Key).
16 (cstXMLFile)The certificate store is the name of a file that contains a certificate in XML format.
17 (cstXMLBlob)The certificate store is a string that contains a certificate in XML format.
18 (cstJWKFile)The certificate store is the name of a file that contains a JWK (JSON Web Key).
19 (cstJWKBlob)The certificate store is a string that contains a JWK (JSON Web Key).
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 PKCS11 interface.

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

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

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

99 (cstAuto)The store type is automatically detected from the input data. This setting may be used with both public and private keys and can detect any of the supported formats automatically.

Subject
String

Default Value: ""

The subject of the certificate used for client authentication.

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

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

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

Example (Searching with partial subject)

Control.CertSubject = "Test"

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

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

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

Thumbprint
String (read-only)

Default Value: ""

The thumbprint of the certificate.

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

Constructors

Constructors are only relevant when configuring adapters in orchestrations.

public Certificate();

Creates a Certificate instance whose properties can be set.

public Certificate(string certificateFile);

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

public Certificate(byte[] certificateData);

Parses CertificateData as an X509 public key.

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

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

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

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

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

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

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

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

Firewall Type

The firewall the component will connect through.

Remarks

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

Fields

AutoDetect
Boolean

Default Value: False

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

FirewallType
FirewallTypes

Default Value: 0

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

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

Host
String

Default Value: ""

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

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

Password
String

Default Value: ""

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

Port
Integer

Default Value: 0

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

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

User
String

Default Value: ""

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

Constructors

Constructors are only relevant when configuring adapters in orchestrations.

public Firewall();

Log Type

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

Remarks

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

Fields

Location
String

Default Value: "Application"

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

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

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

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

LogMode
LogModes

Default Value: 3

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

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

LogType
LogTypes

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:

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

Constructors

Constructors are only relevant when configuring adapters in orchestrations.

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

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

FTP Config Settings

Account:   The user account to login with.

Some servers may require an Account for logon or in order to access specific privileges, like uploading or deleting files.

AutoSelectDataIP:   Automatically select the data connection IP.

This setting controls the selection logic of the data connection. By default, this value is True and the adapter will attempt to determine the best IP for the data connection based on the returned value from the server. It is recommended to leave this value set to True unless there is a reason to disable it.

In many cases, FTP servers are not configured to return a valid public IP in the PASV response. When Secure Sockets Layer/Transport Layer Security (SSL/TLS) is used any network address translation (NAT) done by the firewall cannot occur. The result is the client may receive an IP that is not accessible.

This setting is designed to allow the connection to succeed in as many cases as possible. When the IP for the data connection is received from the server, the adapter will inspect the value. If the received value is not within the known private IP ranges, the adapter will use it, assuming it is a valid public IP. If the received value is a private IP, the adapter will instead assume the data connection should be established to the same IP as the command connection (true in almost all cases).

When this setting is False, the adapter will not perform any checks on the received value. When set to False, UseRemoteHostAddressForPassive is applicable.

CheckFileExists:   Whether to check if the remote file exists before uploading.

If set to "FALSE" the adapter will not perform a directory listing to check for the presence of the file on the server before uploading the file.

NOTE: This setting is only applicable to the FTP Transmitter.

DeleteAfterDownload:   If set to true, deletes the file after download.

This setting is used in conjunction with either Download or DownloadSingleFile. It is only applicable to the send adapter. When the send adapter is configured to download a file this setting can also be specified to delete the file from the server after it is downloaded.

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.

DirEntryPattern:   Allows the use of regular expressions to parse non-standard directory entry formats.

In some cases, the server may return a directory entry format that cannot be automatically parsed by the adapter. In this case, the full entry format can be seen in the log when the TransportLog's LogMode field is set to Verbose. You can use this property to define a regular expression to parse the entry. The value of this setting is specified in the following format:

A,B,C,X=Y|RegEx

A,B,C, and X represent integer values that correspond to the capturing groups of the regular expression in the following order:

  • FileName
  • FileSize
  • FileTime
  • IsDir

Because group X represents the IsDir value, the user must specify Y to indicate what value that group must have in order for IsDir to be True.

Take, for instance, a simple entry in this format:

22 Test.txt

In this example, "22" is the FileSize and "Test.txt" is the FileName. To parse this entry, we will define the DirEntryPattern as follows:

2,1,-1,-1|([0-9]+)\s(.*)

The first value "2" indicates that the first field (FileName) corresponds to the second capturing group in the regular expression. The second value "1" indicates that the second field (FileSize) corresponds to the first capturing group in the regular expression. The capturing group is the regular expression in parenthesis. In the previous example, the first capturing group is ([0-9]+) and the second capturing group is (.*).

As seen in this example, -1 also can be specified as the integer value. When this is specified, that field is ignored.

Download:   If set to true, the send adapter will download files instead of upload.

This setting is used to download multiple files using the send adapter. It is only applicable to the send adapter. In situations where you want to initiate the download of files instead of using a receive adapter you can configure the send adapter to download the files. It is similar in use to DownloadSingleFile.

To do this you can not use a solicit response port. You must use a one way send port. In this case set the LocalFile setting to the directory to which you'd like to download the files.

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.

DownloadSingleFile:   If set to true, the send adapter will download a file instead of upload.

This setting is used to download a file from an orchestration using the send adapter. It is only applicable to the send adapter. In situations where you want to initiate the download of a file instead of using a receive adapter you can configure the send adapter to download the file.

In this case the adapter should be used as a solicit response adapter. Because a solicit response port can return only one message, you can only download one file at a time with the SFTP, SCP, FTP, and WebDAV send ports. To do this you'll need to set the DownloadSingleFile configuration setting to true. For instance: Message_2 = Message_1; Message_2(nsoftware.BizTalk.SFTP.SSHUser) = "test"; Message_2(nsoftware.BizTalk.SFTP.SSHPassword) = "test"; Message_2(nsoftware.BizTalk.SFTP.SSHHost) = "server"; Message_2(nsoftware.BizTalk.SFTP.SSHAcceptServerHostKeyAcceptAny) = true; Message_2(nsoftware.BizTalk.SFTP.RemotePath) = "temp"; Message_2(nsoftware.BizTalk.SFTP.RemoteFile) = "test.txt"; Message_2(nsoftware.BizTalk.SFTP.Other) = "DownloadSingleFile=true";

Note: You can also set DeleteAfterDownload in the Other property for FTP, SFTP, and WebDAV transfers to delete the file on the server once the download is complete. DeleteAfterDownload is not applicable to SCP. This can be done by setting one configuration setting per line in the Other property: Message_2(nsoftware.BizTalk.SFTP.Other) = "DownloadSingleFile=true\r\nDeleteAfterDownload=true";

It is also possible to download multiple files with the send adapters. To do this you can not use a solicit response port. You must use a one way send port. In this case set the LocalFile setting to the directory to which you'd like to download the files and set Download to true.

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.

ExcludeMask:   Instructs the adapter to exclude some files when downloading.

This configuration setting is used to specify a mask to exclude certain files when downloading. If a file matches both this mask and FileMask, the file will be not be downloaded.

IgnoreEmptyFiles:   Instructs the adapter to ignore empty files when downloading.

When this option is true the adapter will ignore any empty files when downloading from the server.

The default value is false.

Note: This is only applicable to the Receive adapter.

ListDirectory:   If set to true, the send adapter will list the directory instead of upload.

This setting is used to list the files in a remote directory on the server from an orchestration using the send adapter. It is only applicable to the send adapter. In situations where you want to list the contents of a directory you can configure the send adapter to do so.

In this case the adapter should be used as a solicit response adapter. In your orchestration after referencing the SFTP, FTP, or WebDAV adapter you can set the message context properties to configure the adapter. To specify that the adapter should list the directory set the Other property to ListDirectory=true. For instance: Message_2 = Message_1; Message_2(nsoftware.BizTalk.SFTP.SSHUser) = "test"; Message_2(nsoftware.BizTalk.SFTP.SSHPassword) = "test"; Message_2(nsoftware.BizTalk.SFTP.SSHHost) = "server"; Message_2(nsoftware.BizTalk.SFTP.SSHAcceptServerHostKeyAcceptAny) = true; Message_2(nsoftware.BizTalk.SFTP.RemotePath) = "temp"; Message_2(nsoftware.BizTalk.SFTP.RemoteFile) = "*.txt"; Message_2(nsoftware.BizTalk.SFTP.Other) = "ListDirectory=true"; The solicit response port will return a message with a body containing an XML formatted representation of the directory contents (The exact set of elements may vary depending on the adapter). For instance: <Directory name="temp"> <Directory name="subDir1"/> <Directory name="subDir2"/> <File name="file1.txt"> <Size>size</Size> <Time>time</Time> </File> <File name="file2.txt"> <Size>size</Size> <Time>time</Time> </File> <File name="file3.txt"> <Size>size</Size> <Time>time</Time> </File> </Directory>

Note: The SFTP adapter returns additional CTime and ATime elements representing the CreationTime and AccessTime. CreationTime is only supported on servers that support SFTP protocol version 4 or higher. To enable the adapter to use version 4 or higher you can set ProtocolVersion to "4".

LocalFile:   Specifies the local file to upload or download.

This setting overrides the overrides the default behavior of the adapter, causing it to ignore the normal message data and upload the file indicated. Likewise, the parsed local filename is used instead of the value in the RemoteFile property.

This may also be set to a local directory when Download is set to True in the send adapter.

MaxFilesPerPollingInterval:   The maximum number of files that will be downloaded from the server during a single poll.

By default, the adapter will download all available files (matching any filemasks) when polling the target directory. To limit the number of files that will be downloaded in a single poll, set this to the maximum number.

Note that to avoid downloading the same subset of files each poll, either DownloadCacheFile or DeleteMode should also be used.

ModeZCompressionLevel:   Used to specify the level of compression used.

The default value is 7. Valid values range from 0 to 9. A higher value indicates that a higher compression level is being used. This is valid only when UseModeZ is set to True.

MonitorFileGrowth:   Specifies whether the adapter checks for file growth before downloading.

If set to "TRUE" the adapter will store the file sizes of the remote files between polling intervals. If the file size does not change between polling intervals it will be downloaded and removed from the list. Otherwise it will be skipped for that interval. For example, if this option is set to TRUE, the adapter would do the following on the first two polling intervals:

Interval 1: The adapter will record the file size of the remote files.

Interval 2: The adapter will compare the recorded file size with the current file size of the remote files. If the file size has not changed then the adapter will download the file. If the file size has changed then the adapter will record the new file size but take no other actions.

PortRange:   Allows the specification of a port range the adapter listens to.

When set to use active mode (Passive = False), the adapter uses any available port to listen to incoming connections from the server. You can override this behavior by setting PortRange to a value containing the range of ports the adapter will be listening to.

The range is provided as start-end, for instance: "1024-" stands for anything higher than 1024, "1024-2048" stands for ports between 1024 and 2048 inclusive, "4000-4010, 50000-50010" stands for ports between 4000 and 40010 or between 50000 and 50010.

RenameMode:   The condition under which RenameTo is used.

This setting controls when the value specified by RenameTo is used. If RenameTo is not specified, this setting has no impact. By default, downloaded files are only renamed after being successfully submitted to BizTalk (a value of 1). Possible values are:

1 (OnSuccess - default)The file is renamed using the value in RenameTo only after the message is successfully submitted to BizTalk.
2 (OnFailure)The file is renamed using the value in RenameTo only after the message submission to BizTalk fails.
3 (Always) The file is renamed using the value in RenameTo regardless of the message submission result.
RenameTo:   A filename to which RemoteFile will be renamed.

After downloading a file, the file on the server may be renamed using this setting. This rename action will take place after the batch submission to BizTalk. If you need to perform actions on a file before this, use the AfterGet property. This setting is used in conjunction with RenameMode to conditionally rename a file. For instance, to rename a file after it has been successfully submitted to BizTalk set the Other property of the adapter like so: RenameTo=%SourceFileName%.done Macros such as %SourceFileName% are supported as in the given example. A full list of supported macros can be found at the bottom of this section.

ReusePISSLSessionInDI:   Whether the PI SSL session will be reused for the DI connection.

When set to True, the adapter will reuse the PI SSL session when creating the DI connection. The default value for this configuration setting is False, in which case, the adapter will create a separate SSL session for the DI connection.

ReuseSSLSessionInDI:   Whether the SSL session will be reused for the DI connection.

When set to True (default), the adapter will ask the server to reuse the existing DI SSL session. When set to False, a new SSL session will always be created for the DI connection.

TemporaryDownloadExtension:   An extension to be appended during download.

During download, it may be necessary for the file on the server to be renamed. After the download is complete the file will be renamed back to the original name.

TemporaryUploadExtension:   An extension to be appended during upload.

During upload, it may be necessary for the RemoteFile to be written to a temporary file name. For example, some business process may be set up to expect a specific file extension. Using this setting will allow the adapter to upload the file without the remainder of the process attempting to pick up the incomplete file.

UseClearCommandChannel:   Allows for the Clear Command Channel (CCC) command.

When set, the adapter will send the CCC command to the server requesting a clear (unprotected) command channel.

UseClearDataChannel:   Allows for the PROT C command.

When this is set, the adapter will use a clear (unprotected) data channel by sending the PROT C command to the server.

UseEPSV:   Allows extended passive mode.

When set, extended passive mode will be used.

UseFSwitch:   Specifies whether or not the -F parameter is used when listing directory contents.

This is only applicable when UseSimpleDirList is set to true. When UseSimpleDirList is true, the adapter issues the command "NLST -F <filemask>". The -F parameter tells the server to omit folder names from the response. Some server do not support the -F parameter. To disable the use of the -F parameter set UseFSwitch to False. The default value is True.

UseMLSD:   Uses listings for machine processing.

When this is set to True the adapter will list files in the directory using the MLSD command. This command is an extension to the protocol which defines a more standardized and reliable directory listing format. Not all servers support this command. The default value is False.

UseModeZ:   Allows compression to be used when transferring data.

The default value is False. When set to True, the adapter will issue the MODE Z command to the FTP server. This will enable deflate compression so that all data transferred are first compressed either by the server (when downloading) or by the adapter (when uploading). Note: Not all servers support this feature.

UseProtWhenImplicit:   Sends PROT P to the server.

The adapter will send the PROT P command to the server explicitly indicating that the data channel will be protected when this is set. This only applies when the SSLStartMode is set to sslImplicit.

UseRemoteHostAddressForPassive:   Instructs the adapter to use the FTPServer in passive mode.

This setting is only used when Passive is true. When this is set to false (default), the adapter parses the remote host to send replies to from the previous response from the server. If this is true, the adapter uses the value at FTPServer instead.

SSL Config Settings

ReuseSSLSession:   Determines if the SSL session is reused.

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

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

SSLCipherStrength:   The minimum cipher strength used for bulk encryption.

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

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

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

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

The enabled cipher suites to be used in SSL negotiation.

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

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

Multiple cipher suites are separated by semicolons.

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

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

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

  • TLS_AES_128_GCM_SHA256
  • TLS_AES_256_GCM_SHA384

SSLEnabledCipherSuites is used together with SSLCipherStrength.

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

Used to enable/disable the supported security protocols.

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

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

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

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

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

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

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

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

SSLSecurityFlags:   Flags that control certificate verification.

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

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

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

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

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

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

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

TLS12SupportedGroups:   The supported groups for ECC.

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

The default value is ecdhe_secp256r1,ecdhe_secp384r1,ecdhe_secp521r1.

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

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

TLS13KeyShareGroups:   The groups for which to pregenerate key shares.

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

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

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

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

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

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

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

TLS13SignatureAlgorithms:   The allowed certificate signature algorithms.

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

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

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

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

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

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

General Config Settings

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

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

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

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

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

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

TcpNoDelay:   Whether or not to delay when sending packets.

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

By default, this config is set to false.

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

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