Get Files with SecureFTP
Description
Get Files with Secure FTP downloads one or more files from a remote server using the SFTP protocol. Use this process entry when your process needs secure file retrieval with SSH-based authentication — for example, downloading encrypted data from a partner's SFTP server or retrieving files from a cloud system that requires key-based login. It supports private key authentication, proxy connections, and optional compression during transfer.
Configurations
| Field Name | Description |
|---|---|
| Process Entry name | Specifies the unique name of the process entry on the workspace area. A process entry can be placed on the canvas several times, yet it represents the same process entry. |
| SFTP-server name / IP | Specify the host name or the IP address of the SFTP server. For example, sftp.example.com or 192.168.1.50 |
| Port | The TCP port to use. This is usually 22 |
| User name | The user name to log into the SFTP server |
| Password | The password to log into the SFTP server |
| Use private keyfile | Indicates whether or not a private keyfile is to be used. |
| Private key filename | Specify the complete location of the private key file. Or, Select Browse to locate and add the file path. The field is available only if you select the Use private keyfile checkbox. For Example: C:\Desktop\key.pem Notes: - The private key must be in the PEM file format. - For PuTTY-based private keys, use PuTTYgen to convert the file into the OpenSSH format. |
| Key passphrase | Specify the passphrase of the private key file. If your private key file is encrypted, type the required passphrase here. Process Studio uses this passphrase to decrypt the local PEM file and authenticate the server connection. The field is available only when you select the Use private keyfile check box. |
| Use old algorithm for SSH Communication | Select the checkbox to enforce the internal library to use older or weaker algorithms for SSH communication. Important: Choosing 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 | Select from the list: HTTP/SOCKS5 |
| Proxy host | Proxy server host name |
| Proxy port | Proxy server port number |
| Proxy username | Proxy server account user name |
| Proxy password | Proxy server account password |
| Compression | Select from the list: none/zlib |
| Files tab: | |
| Source (remote) files: | |
| Copy previous results to args | If files to send are dynamically generated by another workflow or if you want to identify files to sent, check this option.PROCESS STUDIO will select files list from previous result rows (not result files) and send theses files. |
| Remote Directory | The remote directory on the SFTP server from which we get the files. Use the “test folder” button to connect to the remote server and validate that the folder exists. |
| Wildcard (regular expression) | Specify a regular expression here if you want to select multiple files. For example, .*\.csv — This expression get all the available files with extension .csv |
| Last Modified On (UTC Time) | Specify required From and To date-time to get the required modified file(s) from the server in UTC timezone (default). Example, To retrieve files modified between March 15, 2026 at 9:00 AM UTC and March 30, 2026 at 5:30 PM UTC: From: 2026-03-15 09:00:00 AM To: 2026-03-30 05:30:00 PM This returns all files where: From <= Last Modified Date <= To |
| From | Specify the date-time to retrieve the files from. This retrieves the modified files on or after the specified date-time. Supported Format: yyyy-MM-dd hh:mm:ss a For example: 2023-10-26 08:30:00 AM |
| To | Specify the date-time to retrieve the files until the date-time. This retrieves the modified files on or before the specified date-time. Supported Format: yyyy-MM-dd hh:mm:ss a For example: 2023-10-26 08:30:00 AM |
| Remove files after retrieval | Enable checkbox to delete the remote file after the file is transferred. |
| Target (local) files: | |
| Target Directory | Specify the local directory to save the files. Or, Click the Test folder button to validate that the local folder exists. Example: C:\Data\Processed| |
| Create target folder | Check this option if the destination folder does not exist and should be created. |
| Add filenames to result | If checked the name of the file is added to the result stream. |