SFTP Put

Description

SFTP Put transfers one or more files from a local directory to a remote server over the Secure FTP (SFTP) protocol. Use this step when your workflow needs to securely deliver output files — such as reports, exports, or data extracts — to a remote system. It supports key-based and password-based authentication, proxy connections, optional compression, and post-transfer actions like deleting or moving the source file. You can also feed filenames dynamically from the workflow stream, making it easy to upload a variable list of files within a loop or batch process.

Configurations

Field Name	Description
Step name	Specify the name of the step as it appears in the workflow workspace. This name has to be unique in a single workflow.
Server settings:
Server	Specify the name of the SFTP server or the IP address.
Port	Specify the TCP port to use. This is usually 22.
Username	Specify the user name to log into the SFTP server.
Password	Specify the password to log into the SFTP server.
Use keyfile	Enable this Checkbox to indicate whether or not a private keyfile is to be used.
Keyfile	If “Use keyfile” above is checked then this field is enabled. The file can be browsed to using the browse button to the right of the field. The Private Key should be in the PEM file format. For PuTTY-based Private Keys, use PuTTYgen to convert the file into “OpenSSH” format.
Key password	If “Use keyfile” above is checked then this field is enabled. If a passphrase is required then enter it here.
Use old algorithm for SSH Communication	Select the checkbox to enforce the internal library to use older or weaker algorithms for SSH communication. Important: Selecting the checkbox is required when the client or source machine with updated SSH environment is trying to communicate with a target machine which has older SSH environment. If not selected, then user will get “Algorithm negotiation failed” error. Recommendation: We recommend using modern and secure algorithms wherever possible. Using old algorithms for SSH communication can be a security risk.
Proxy type	Specify the proxy type (SOCKS5, HTTP) of the specified proxy server.
Proxy host	Specify the host name or the IP address of the proxy server.
Proxy port	Specify the port of the proxy server to connect to.
Proxy username	Specify the username to log into the proxy server as.
Proxy password	Specify the password associated with “Proxy username”.
Button: Test Connection	Click this button to test SFTP connection.
Compression	Specify the compression to use in the file transfer. Current options are “none” and “zlib”.
Files tab
Source(local) files:
Input is a stream	Enable this checkbox to indicate that input filename is coming from the workflow stream.
Source filename field	Choose a field in the stream containing the filename.
Add filename to result	Enable checkbox to add filename to result.
After SFTP Put	Specify the action to take after the file is transferred. Actions are “Do nothing”,”Delete file” and “Move file to”.
Destination folder	Specify the target directory on the local machine where files will be moved after they are successfully uploaded. - Dynamic values: We can use field variables to define the destination folder dynamically. - Automatic folder creation: If the Create Destination Folder is checked, the specified folder will be created on the local machine if it does not exist. Note: When the After FTP Put option is set to Move file to, the fields Destination folder and Create destination folder are available and mandatory.
Create destination folder	Enabled if “After SFTP Put” is set to “Move file to”. If the “Destination folder” does not exist check this option to create it.
Target (remote) folder:
Remote directory	Specify the target directory on the remote SFTP server where files will be uploaded. Specify the full path to the directory on the remote server. - Automatic folder creation: If the Create folder option is checked, the specified directory will be created automatically on the remote server if it does not exist. - Dynamic interaction: Use reference fields from previous steps to dynamically set the directory path. Note: On blank or missing field value, the error message Remote folder field name is missing! will be seen.
Create folder	Check this option if the destination folder does not exist and should be created.
Remote filename	Provide a remote filename.