Help Centre › Building Processes
This article describes the RPA FTP functionality to download a folder from a remote server.
For a full list of available functions, please read FTP functions.
Description
The Download folder function downloads an entire directory and its contents from the remote server to a local path. Returns an array of downloaded file paths.
Setting it up
To use the Download folder function, follow these instructions:
{{popups:rpas/add:action=ftp-download-folder}}
Once on a process map:
- Navigate to the process where you would like to add the Download folder function
- Click on the green button’s drop-down (right side of the green button labelled “Process”)
- On the menu that appears, click on the “+ Activity” item
- From here you can select the FTP Download folder option
- Click "Add" once you are done
Input parameters
| Parameter | Required | Type | Default | Description |
|---|---|---|---|---|
| Name | Yes | Text | - | The name of the FTP connection to use |
| Remote Path | Yes | Text | - | The path to the directory on the remote server |
| Local Path | Yes | Text | - | The local path where the folder should be saved |
| Variable | No | Text | downloaded_files | Variable name to store the list of downloaded files |
Output variables
| Variable | Type | Description |
|---|---|---|
| {downloaded_files} | Array | Array of local file paths that were downloaded |
Errors
| Error | Description |
|---|---|
| Connection not found | No connection exists with the specified name |
| Directory not found | The remote directory does not exist |
Tips
- The local directory is created automatically if it does not exist
- Downloads all files and subdirectories recursively