SFTP Adapter
Properties Configuration Settings
The SFTP Component adds SSH-secured file transfer capabilities to your BizTalk Server.
Remarks
The SFTP Adapter adds a complete SFTP client to your BizTalk Server that enables it with SSH-secured file download and upload functionality.
SFTP Receive Adapter
The SFTP Receive Adapter requires that a single property be set: SSHHost. You may also set an SSHPort if the server is not running on the default SSH port. In order to authenticate with the SSH server, you will need to specify an SSHUser, and either SSHPassword or SSHCert depending upon the SSHAuthMode to be used.
The adapter will connect to the SFTP 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.
SFTP Send Adapter
The SFTP Send Adapter requires both an SSHHost and a RemoteFile. You may also set an SSHPort if the server is not running on the default SSH port. In order to authenticate with the SSH server, you will need to specify an SSHUser, and either SSHPassword or SSHCert depending upon the SSHAuthMode to be used.
The adapter will connect to the SFTP server whenever it has a message to send. The adapter will attempt to upload to the specified RemotePath. If Overwrite is set to True, the adapter will delete or overwrite remote files as necessary to complete the operation.
In order to prevent parallel processing by another application before your upload is complete, you may need to set a temporary upload directory via RemoteTempPath. If the temporary directory is set, the file will first be uploaded to the specified temporary directory, and will be moved to the final destination path once the upload has completed.
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.
| AfterConnect | A set of FTP-style commands to be executed immediately after connecting to the SSHHost . |
| AfterGet | A set of FTP-style commands to be executed after the download. |
| BeforeGet | A set of FTP-style commands to be executed before the download. |
| CertPassSSOAffiliate | Specifies the name of the SSO Affiliate Application that holds the certificate password. This is only used when the certificate password is blank. |
| DeleteMode | Controls if and when the remote file is deleted after download. |
| ErrorThreshold | The maximum number of errors before the component shuts down. |
| FileMask | Indicates the type of files to download from the SSH server. |
| Firewall | A set of properties related to firewall access. |
| MaxBatchSize | The maximum size, in MB, of the current batch (0 indicates no limit). |
| MaxFileCount | The maximum number of files in the current batch (0 indicates no limit). |
| MaxFileSize | The maximum size, in MB, of a file in the current batch (0 indicates no limit). |
| MaxThreads | The maximum number of threads that the component may consume. |
| Other | Defines a set of configuration settings to be used by the component. |
| PersistentConnection | Instructs the component whether to keep the connection to the server open. |
| PollingInterval | The amount of time, in seconds, between download attempts. |
| ReceivedFileDate | The date of the remote file received by the SFTP component. |
| ReceivedFileName | The name of the remote file received by the SFTP component. |
| ReceivedFilePath | The remote path of the file received by the SFTP component. |
| ReceivedFileSize | The size of the remote file received by the SFTP component. |
| ReceivedFileSSHUser | The SSH user name used by the SFTP component when downloading the remote file. |
| RemotePath | The current path on the SSH server. |
| RequeueEndpoints | Whether to requeue receive endpoints if the polling interval has not been reached. |
| RuntimeLicense | Specifies the component runtime license key. |
| SSHAcceptServerHostKey | Instructs the component to accept the server host key that matches the supplied key. |
| SSHAuthMode | The type of authentication used by the component. |
| SSHCert | The certificate to use for client authentication during the SSH handshake. |
| SSHCompressionAlgorithms | A comma-separated list of compression algorithms allowed for this connection. |
| SSHHost | The address of the SSH host. |
| SSHPassword | The password for SSH password-based authentication. |
| SSHPort | The port on the SSH server where the SSH service is running; by default, 22. |
| SSHUser | The username for SSH authentication. |
| SSOAffiliate | Specifies the name of the SSO Affiliate Application. |
| TempPath | A temporary local directory where data can be stored before the component processes it. |
| Timeout | A timeout for the component. |
| TransportLog | Tells the component where and how to report information about its operations. |
| URI | The Uniform Resource Identifier (URI) of the send port or receive location. |
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.
| AfterConnect | A set of FTP-style commands to be executed immediately after connecting to the SSHHost . |
| AfterPut | A set of FTP-style commands to be executed after the upload. |
| Append | Whether or not the component should append data to the RemoteFile . |
| BeforePut | A set of FTP-style commands to be executed before the upload. |
| CertPassSSOAffiliate | Specifies the name of the SSO Affiliate Application that holds the certificate password. This is only used when the certificate password is blank. |
| ConnectionLifetime | Instructs the component whether or not to leave the connection to the server open. |
| Firewall | A set of properties related to firewall access. |
| MaxPersistentConnections | The maximum number of simultaneous persistent connections when sending. |
| MaxThreads | The maximum number of threads that the component may consume. |
| MaxTransmissionBatchSize | The maximum number of messages that can be sent in a single batch. |
| Other | Defines a set of configuration settings to be used by the component. |
| Overwrite | Whether or not the component should overwrite files during transfer. |
| RemoteFile | The name of the destination file on the SSH server for uploading. |
| RemotePath | The current path on the SSH server. |
| RemoteTempPath | A temporary directory on the server to store files before moving them to RemotePath . |
| RuntimeLicense | Specifies the component runtime license key. |
| SSHAcceptServerHostKey | Instructs the component to accept the server host key that matches the supplied key. |
| SSHAuthMode | The type of authentication used by the component. |
| SSHCert | The certificate to use for client authentication during the SSH handshake. |
| SSHCompressionAlgorithms | A comma-separated list of compression algorithms allowed for this connection. |
| SSHHost | The address of the SSH host. |
| SSHPassword | The password for SSH password-based authentication. |
| SSHPort | The port on the SSH server where the SSH service is running; by default, 22. |
| SSHUser | The username for SSH authentication. |
| SSOAffiliate | Specifies the name of the SSO Affiliate Application. |
| Timeout | A timeout for the component. |
| TransmitBatchMode | How the transmitter processes batches. |
| TransportLog | Tells the component where and how to report information about its operations. |
| URI | The Uniform Resource Identifier (URI) of the send port or receive location. |
Configuration Settings
The following is a list of configuration settings for the adapter with short descriptions. Click on the links for further details.
| DeleteAfterDownload | If set to true, deletes the file after download. |
| DeleteOnSuspend | Specifies whether files may be deleted from server when message is suspended. |
| DeleteOnUploadError | Whether to delete the remote file when an error occurs after upload begins. |
| DisableRealPath | Controls whether or not the SSH_FXP_REALPATH request is sent. |
| Download | If set to true, the send component will download files instead of upload. |
| DownloadCacheFile | When set, only new files will be downloaded from the server. |
| DownloadCacheFileDuration | The number of minutes that a file name will remain in the download cache. |
| DownloadSingleFile | If set to true, the send component will download a file instead of upload. |
| EnableFileDetailsComparison | Whether the receive component should consider metadata differences when deciding whether to download a file again. |
| ExcludeMask | Instructs the component to exclude some files when downloading. |
| FileMaskDelimiter | Specifies a delimiter to use for setting multiple file masks. |
| FilePermissions | Specifies the permissions of a file to be set after a successful upload. |
| IgnoreEmptyFiles | Instructs the component to ignore empty files when downloading. |
| IgnoreFileMaskCasing | Instructs the component to ignore casing of when FileMask is set. |
| KeyRenegotiationThreshold | Sets the threshold for the SSH Key Renegotiation. |
| ListDirBeforeDownload | Determines if the directory is listed on download. |
| ListDirectory | If set to true, the send component will list the directory instead of upload. |
| LocalEOL | When TransferMode is set, this specifies the line ending for the local system. |
| LocalFile | Specifies the local file to upload or download. |
| LogSSHPackets | If True, detailed SSH packet logging is performed. |
| MaxFileData | Specifies the maximum payload size of an SFTP packet. |
| MaxFilesPerPollingInterval | The maximum number of files that will be downloaded from the server during a single poll. |
| MonitorFileGrowth | Specifies whether the adapter checks for file growth before downloading. |
| ProtocolVersion | The highest allowable SFTP version to use. |
| RenameMode | The condition under which RenameTo is used. |
| RenameTo | A filename to which RemoteFile will be renamed. |
| ServerEOL | When TransferMode is set, this specifies the line ending for the remote system. |
| SortCriteria | Determines sort order before downloading files. |
| SSHAcceptServerHostKeyFingerPrint | Instructs the component to accept the server's host key with this fingerprint. |
| SSHEncryptionAlgorithms | A comma-separated list containing all allowable compression algorithms. |
| SSHFingerprintHashAlgorithm | The algorithm used to calculate the fingerprint. |
| SSHKeyExchangeAlgorithms | Specifies the supported key exchange algorithms. |
| SSHMacAlgorithms | Specifies the supported Mac algorithms. |
| SSHPublicKeyAlgorithms | Specifies the supported public key algorithms. |
| TemporaryDownloadExtension | An extension to be appended during download. |
| TemporaryUploadExtension | An extension to be appended during upload. |
| TransferMode | The transfer mode (ASCII or Binary). |
| WaitForServerDisconnect | Causes the component to wait for the server to close the connection. |
| AbsoluteTimeout | Determines whether timeouts are inactivity timeouts or absolute timeouts. |
| LocalHost | The name of the local host or user-assigned IP interface through which connections are initiated or accepted. |
| TcpNoDelay | Whether or not to delay when sending packets. |
| UseInternalSecurityAPI | Tells the component whether or not to use the system security libraries or an internal implementation. |