Skip to main content

Put Files With SecureFTP

Description

Use the step to securely upload files from your local computer to a remote server using SFTP (Secure File Transfer Protocol).This encrypts your data during transfer to protect sensitive information.You can use wildcards to filter specific files and configure the step to automatically move or delete the original local files after a successful upload.

Configurations

Configuration

Field NameDescription
Step NameSpecify a unique name for the step. The name identifies the step in your workflow and must be different from every other step in the same workflow.

General Tab

  • Server: Configure the connection to your SFTP server.
Field NameDescription
Server name / IP AddressSpecify the hostname or IP address of your SFTP server. For example: sftp.example.com or 192.168.1.100
Server PortSpecify the TCP port number for the connection.
Default Port for SFTP protocol: 22
UsernameSpecify the username for your SFTP account.
PasswordSpecify the password for your SFTP account.

If the checkbox Accept Value as variable/static is selected, then the password field appears as a text box and accepts static or variable values.

OR

If the checkbox Accept Value as variable/static is not selected, then the password field appears as a dropdown in which you can select a field from.
Use private keyfileSpecify Yes to authenticate with a private key file.

Private key authentication provides stronger security than passwords. Use this method when connecting to servers that require key-based authentication.
Allowed Values: Yes or No
Default Value: No
Private key filenameSpecify the path to your private key file
Or
Click Browse to locate the file.

Note:
- Supported file type is .pem and .ppk
- The field is available if Use private key file is Yes.
Key passPhraseSpecify the passphrase for your key file, if one is set. Leave blank if your key has no passphrase.
Note: The field is available if Use private key file is Yes.

Proxy Settings

  • Configure these settings if your network requires a proxy server to reach external SFTP servers
Field NameDescription
Proxy typeSpecify the proxy type.
Allowed values are:
- HTTP
- SOCKS5
Proxy HostSpecify the proxy server hostname.
Proxy portSpecify the proxy server port number.
Proxy usernameSpecify the username to authenticate with the proxy server.
Proxy passwordSpecify password of proxy server to sign on to server.

If the checkbox Accept Value as variable/static is selected, then the password field appears as a text box and accepts static or variable values.

OR

If the checkbox Accept Value as variable/static is not selected, then the password field appears as a dropdown in which you can select a field from.
Test ConnectionClick to verify that your server and authentication settings work correctly. Fix any errors before you save your workflow.

Files tab

Source (local) files

  • Define which files to upload and what to do with them after the transfer completes.
Field NameDescription
Local DirectorySpecify the folder path on your local machine that contains the files to upload.
Or
Click Folder to browse and select the path.
Wildcard (Regular Expression)Specify a pattern to upload specific file types.
Use commas to separate multiple patterns. Leave blank to upload all files in the directory.

For example:
- .txt - Uploads all text files
- .csv,.xlsx - Uploads all CSV and Excel files
- report_
.pdf - Uploads PDF files that start with "report_"
- (blank) - Uploads all files in the directory
Success when no fileSelect the checkbox to let the workflow continue successfully even if no files match the criteria. This is useful for optional file processing and helps avoid unnecessary failures.

If cleared, the step will fail when no files are found.
After SFTP PutSelect what happens to source files after a successful upload:
- Do nothing
- Delete file
- Move file to
Destination folderSpecify the folder path to move files to after upload.
Or
Click Folder to browse the destination folder to move the source file(s).

Note: If you select After SFTP Put as Move file to, only then the field will be available.
Create destination folderSpecify Yes to create the destination folder if it doesn't exist, otherwise specify No.
Allowed Values: Yes or No
Default Value: No
Note: If you select After SFTP Put as Move file to, only then the field will be available.
Add filename to resultSpecify Yes to add file name to the result stream.
Allowed Values: Yes or No
Default Value: No

Target Files

  • Configure the destination on the SFTP server.
Field NameDescription
Remote directorySpecify the folder path on the SFTP server where you want to upload files.
Click Test Folder to connect to remote server and validate whether the folder exist or not.
Create FolderSpecify Yes to create destination folder if dose not exist and should be created.
Allowed Values: Yes or No
Default Value: No

Additional Settings Tab

Advanced

Field NameDescription
TimeoutSpecify the timeout in milliseconds for SFTP server connection.
Specify the connection timeout in milliseconds. Increase this value for slow or unreliable network connections
CompressionSelect a compression method to reduce transfer time for large files:
- None
- zlib