FTP Download file function

The FTP Download file function in RPA.

Help CentreBuilding Processes

This article describes the RPA FTP functionality to download a file from a remote server.

For a full list of available functions, please read FTP functions.


Description

The Download file function downloads a single file from the remote server to a local path.


Setting it up

To use the Download file function, follow these instructions:

{{popups:rpas/add:action=ftp-download-file}}

Once on a process map:

  1. Navigate to the process where you would like to add the Download file function
  2. Click on the green button’s drop-down (right side of the green button labelled “Process”)
  3. On the menu that appears, click on the “+ Activity” item
  4. From here you can select the FTP Download file option
  5. Click "Add" once you are done

Input parameters

ParameterRequiredTypeDefaultDescription
NameYesText-The name of the FTP connection to use
Remote PathYesText-The path to the file on the remote server
Local PathYesText-The local path where the file should be saved

Output variables

This action does not produce output variables.


Errors

ErrorDescription
Connection not foundNo connection exists with the specified name
File not foundThe remote file does not exist
Permission deniedInsufficient permissions to read the remote file

Tips

  • Ensure the local directory exists before downloading
  • Use ftp-exists to verify the remote file exists before downloading

Related functions

See it working on your own data

Everything documented here ships with the platform – try the document tools free, or go live in 7 days.