/n software BizTalk Adapters V4 - Online Help
Available for:
/n software BizTalk Adapters V4
Questions / Feedback?

SFTP Adapter

Properties   Configuration Settings  

The SFTP Adapter 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. 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. If Overwrite is set to True, the adapter will delete or overwrite remote files as necessary to complete the operation.

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-style commands to be executed immediately after connecting to the SSHHost .
AfterGetA set of FTP-style commands to be executed after the download.
BeforeGetA set of FTP-style commands to be executed before the download.
DeleteModeControls if and when the remote file is deleted after download.
ErrorThresholdThe maximum number of errors before the adapter shuts down.
FileMaskIndicates the type of files to download from the SSH server.
FirewallA set of properties related to firewall access.
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 adapter may consume.
OtherDefines a set of configuration settings to be used by the adapter.
PersistentConnectionInstructs the adapter 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 SFTP adapter.
ReceivedFileNameThe name of the remote file received by the SFTP adapter.
ReceivedFilePathThe remote path of the file received by the SFTP adapter.
ReceivedFileSizeThe size of the remote file received by the SFTP adapter.
ReceivedFileSSHUserThe SSH user name used by the SFTP adapter when downloading the remote file.
RemotePathThe current path on the SSH server.
RequeueEndpointsWhether to requeue receive endpoints if the polling interval has not been reached.
RuntimeLicenseSpecifies the adapter runtime license key.
SSHAcceptServerHostKeyInstructs the adapter to accept the server host key that matches the supplied key.
SSHAuthModeThe type of authentication used by the adapter.
SSHCertThe certificate to use for client authentication during the SSH handshake.
SSHCompressionAlgorithmsA comma-separated list of compression algorithms allowed for this connection.
SSHHostThe address of the SSH host.
SSHPasswordThe password for SSH password-based authentication.
SSHPortThe port on the SSH server where the SSH service is running; by default, 22.
SSHUserThe username for SSH authentication.
SSOAffiliateSpecifies the name of the SSO Affiliate Application..
TempPathA temporary local directory where data can be stored before the adapter processes it.
TimeoutA timeout for the adapter.
TransportLogTells the adapter where and how to report information about its operations.
URIThe 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.

AfterConnectA set of FTP-style commands to be executed immediately after connecting to the SSHHost .
AfterPutA set of FTP-style commands to be executed after the upload.
AppendWhether or not the adapter should append data to the RemoteFile .
BeforePutA set of FTP-style commands to be executed before the upload.
ConnectionLifetimeInstructs the adapter whether or not to leave the connection to the server open.
FirewallA set of properties related to firewall access.
MaxPersistentConnectionsThe maximum number of simultaneous persistent connections when sending.
MaxThreadsThe maximum number of threads that the adapter 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 adapter.
OverwriteWhether or not the adapter should overwrite files during transfer.
RemoteFileThe name of the destination file on the SSH server for uploading.
RemotePathThe current path on the SSH server.
RemoteTempPathA temporary directory on the server to store files before moving them to RemotePath .
RuntimeLicenseSpecifies the adapter runtime license key.
SSHAcceptServerHostKeyInstructs the adapter to accept the server host key that matches the supplied key.
SSHAuthModeThe type of authentication used by the adapter.
SSHCertThe certificate to use for client authentication during the SSH handshake.
SSHCompressionAlgorithmsA comma-separated list of compression algorithms allowed for this connection.
SSHHostThe address of the SSH host.
SSHPasswordThe password for SSH password-based authentication.
SSHPortThe port on the SSH server where the SSH service is running; by default, 22.
SSHUserThe username for SSH authentication.
SSOAffiliateSpecifies the name of the SSO Affiliate Application..
TimeoutA timeout for the adapter.
TransmitBatchModeHow the transmitter processes batches.
TransportLogTells the adapter where and how to report information about its operations.
URIThe 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.

DeleteOnSuspendSpecifies whether files may be deleted from server when message is suspended.
DownloadCacheFileWhen set, only new files will be downloaded from the server.
IgnoreFileMaskCasingInstructs the adapter to ignore casing of when FileMask is set.
FilePermissionsSpecifies the permissions of a file to be set after a successful upload.
LocalFileSpecifies the local file to upload or download.
MaxFileDataSpecifies the maximum payload size of an SFTP packet.
MonitorFileGrowthSpecifies whether the adapter checks for file growth before downloading.
ProtocolVersionThe highest allowable SFTP version to use.
ListDirBeforeDownloadDetermines if the directory is listed on download.
LocalEOLWhen TransferMode is set, this specifies the line ending for the local system.
ServerEOLWhen TransferMode is set, this specifies the line ending for the remote system.
TransferModeThe transfer mode (ASCII or Binary).
RenameToA filename to which RemoteFile will be renamed.
RenameModeThe condition under which RenameTo is used.
TemporaryDownloadExtensionAn extension to be appended during download.
TemporaryUploadExtensionAn extension to be appended during upload.
LogSSHPacketsIf True, detailed SSH packet logging is performed.
SSHAcceptServerHostKeyFingerPrintInstructs the adapter to accept the server's host key with this fingerprint.
SSHEncryptionAlgorithmsA comma-separated list containing all allowable compression algorithms.
SSHKeyExchangeAlgorithmsSpecifies the supported key exchange algorithms.
SSHMacAlgorithmsSpecifies the supported Mac algorithms.
DownloadSingleFileIf set to true, the send adapter will download a file instead of upload.
DownloadIf set to true, the send adapter will download files instead of upload.
DeleteAfterDownloadIf set to true, deletes the file after download.
ListDirectoryIf set to true, the send adapter will list the directory instead of upload.
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.
UseManagedSecurityAPITells the adapter whether or not to use the system security libraries or a managed implementation.
PersistedConnectionTimeoutHow long to leave a persisted connection alive.

 
 
Copyright (c) 2017 /n software inc. - All rights reserved.
Build 4.0.6240.0