FTP List files function

The FTP List files function in RPA.

Help CentreBuilding Processes

This article describes the RPA FTP functionality to list files on a remote server.

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


Description

The List files function retrieves a list of files and directories at a given path on the remote server.


Setting it up

To use the List files function, follow these instructions:

{{popups:rpas/add:action=ftp-list}}

Once on a process map:

  1. Navigate to the process where you would like to add the List files 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 List files option
  5. Click "Add" once you are done

Input parameters

ParameterRequiredTypeDefaultDescription
NameYesText-The name of the FTP connection to use
PathNoText.The remote directory path to list
VariableNoTextfilesVariable name to store the file list

Output variables

VariableTypeDescription
{files}ArrayArray of file and directory names at the specified path

Errors

ErrorDescription
Connection not foundNo connection exists with the specified name
Directory not foundThe remote directory does not exist

Tips

  • Use '.' for the current working directory on the remote server
  • Combine with a loop to process each file in the listing

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.