Download File
Downloads one file from an SFTP or FTP server into a File variable.
Download File fetches one file from your SFTP or FTP server and puts it in a File variable, so the next steps can read it, attach it to an email, convert it or upload it somewhere else.
Before you start
The action connects through an FTP credential that you create once in the Credential Manager (host, port, protocol FTP or SFTP, an optional Directory path, and a user name with a password or a key file). See FTP Credential.
Add the action
In the Process Designer toolbox, open SFTP and pick Download File (or type Download File in the search box).
Inputs and outputs
| Field | Direction | Type | Required | What to put / what you get |
|---|---|---|---|---|
| Select SFTP credentials | Input | FTP credential | Yes | The credential of the server to read from. |
| Source Folder | Input | Text | Yes | The folder that holds the file, relative to the credential's Directory path, for example inbox. |
| File Name | Input | Text | Yes | The name of the file, with its extension, for example invoice-001.pdf. |
| Result | Output | File | Yes | The downloaded file. |
Example
Source Folder inbox, File Name invoice-001.pdf โ Result is a File variable holding invoice-001.pdf.
Good to know
- Files up to 100 MB are supported.
- Paths are relative to the Directory path set in the credential. Don't repeat that path in Source Folder.
- File and folder names are case-sensitive on most SFTP servers.
- If the file can't be downloaded (wrong name, no access, server unreachable), the step fails with "Error while trying to download file from folder."
- An empty (0-byte) file comes back as an empty Result, without an error. Check the variable before you use it if empty files can occur.
- To download several files in one step, use Download Bulk.