SFTP Activities

The SFTP Activity adds SSH-secured file transfer capabilities to your WorkFlow.

Remarks

The SFTP Activity adds a complete SFTP client to your WorkFlow that enables it with SSH-secured file download and upload functionality.

SFTP Receive Activity

The SFTP Receive Activity 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 activity 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 WorkFlow as individual messages. In order to guarantee that files are not downloaded multiple times, you may set the DeleteMode.

SFTP Send Activity

The SFTP Send Activity 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 activity will connect to the SFTP server whenever it has a message to send. The activity 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 activity 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 activity 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.
Delete	Controls if the remote file is deleted after download.
DirList	Collection of the last directory listing entries.
FileMask	Indicates the type of files to download from the SSH server.
Firewall	A set of properties related to firewall access.
LocalDirectory	The directory on the local machine where files are downloaded.
LogFile	The file to write logging information to at runtime.
LogMode	What information gets logged during activity execution.
Operation	The operation which will be executed by the FTP task.
Other	Defines a set of configuration settings to be used by the activity.
Overwrite	Whether or not the activity should overwrite files during transfer.
PersistentConnection	Instructs the activity whether to keep the connection to the server open.
RemotePath	The current path on the SSH server.
RuntimeLicense	Specifies the activity runtime license key.
SSHAcceptServerHostKey	Instructs the activity to accept the server host key that matches the supplied key.
SSHAcceptServerHostKeyAcceptAny	Tells the activity to accept any server certificate.
SSHAuthMode	The type of authentication used by the activity.
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.
Timeout	A timeout for the activity.

Sender Property List

The following is the full list of the properties of the sender activity 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 activity should append data to the RemoteFile .
BeforePut	A set of FTP-style commands to be executed before the upload.
Firewall	A set of properties related to firewall access.
LocalFile	The path to a local file for upload.
LogFile	The file to write logging information to at runtime.
LogMode	What information gets logged during activity execution.
Other	Defines a set of configuration settings to be used by the activity.
Overwrite	Whether or not the activity should overwrite files during transfer.
PersistentConnection	Instructs the activity whether to keep the connection to the server open.
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 activity runtime license key.
SSHAcceptServerHostKey	Instructs the activity to accept the server host key that matches the supplied key.
SSHAcceptServerHostKeyAcceptAny	Tells the activity to accept any server certificate.
SSHAuthMode	The type of authentication used by the activity.
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.
Timeout	A timeout for the activity.

Configuration Settings

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


IgnoreFileMaskCasing	Instructs the activity to ignore casing of when FileMask is set.
FilePermissions	Specifies the permissions of a file to be set after a successful upload.
MaxFileData	Specifies the maximum payload size of an SFTP packet.
ProtocolVersion	The highest allowable SFTP version to use.
ListDirBeforeDownload	Determines if the directory is listed on download.
LocalEOL	When TransferMode is set, this specifies the line ending for the local system.
ServerEOL	When TransferMode is set, this specifies the line ending for the remote system.
TransferMode	The transfer mode (ASCII or Binary).
RenameTo	A filename to which RemoteFile will be renamed.
RenameMode	The condition under which RenameTo is used.
TemporaryDownloadExtension	An extension to be appended during download.
TemporaryUploadExtension	An extension to be appended during upload.
LogSSHPackets	If True, detailed SSH packet logging is performed.
SSHAcceptServerHostKeyFingerPrint	Instructs the activity to accept the server's host key with this fingerprint.
SSHEncryptionAlgorithms	A comma-separated list containing all allowable compression algorithms.
SSHKeyExchangeAlgorithms	Specifies the supported key exchange algorithms.
SSHMacAlgorithms	Specifies the supported Mac algorithms.
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.
UseManagedSecurityAPI	Tells the activity whether or not to use the system security libraries or a managed implementation.
PersistedConnectionTimeout	How long to leave a persisted connection alive.