FTP

◷ Reading Time: 5 minutes

FTP Toolbox

FTP toolbox in Flow and Workflow documents allows users to connect to an FTP server and conduct some file and folder operations on the server remotely.

This tutorial explains all FTP functionalities under the FTP ToolBox section (e.g., How to check if a specific file already exists on an FTP server or how to upload a file to an FTP server, etc.).

Check File Exists

The ‘Check File Exists’ tool in the toolbox allows you to check the existence of a file on the remote FTP server.

This Flow shows how to check if a file already exists on an FTP Server (depending on the result of this Flow, a notification can be generated).

The settings are shown below and also properties need to be set for using the ‘Check File Exists’ functionality from the FTP ToolBox section:

• FTP Connection: This is the FTP Server Address and its credentials. In our sample project, we ran the FTP server on our Localhost(username: “user1” and password:123123).
• Remote File Address: This is the name of the file that needs to be checked if it exists (make sure the file name starts with “/”).
• Copy Result To: Depending on the result of the File Exists step, we need to decide what we want to do next. As such we copy the result (which would be a Boolean) to a variable that has been added as a new Output variable (called “found” in this project).

Upload

The ‘Upload’ tool from the toolbox allows a file to be uploaded to an FTP server by specifying the credential to log in to the server and the file to be uploaded.

The Flow below shows the ‘Upload’ functionality:

Make sure the FTP user has Read/Write access to upload a file to your FTP server.

The settings are shown below and also properties need to be set for using the “Upload” functionality from the FTP ToolBox section:

• FTP Connection: This is the FTP server address and its credential.
• Local File Address: This is the file path of the file from a local machine that needs to be uploaded to the FTP server.
• Save File Remotely As: This is where the file will be saved on a server (the file name starts with “/”).

Download

The ‘Download’ tool from the toolbox allows a file to be downloaded from an FTP server by specifying the credential to log in to the server and the file. The Flow below shows the ‘Download’ functionality:

The settings are shown below and also properties need to be set for using the ‘Download functionality from the FTP ToolBox section:

• FTP Connection: This is the FTP Server Address and its credential.
• Remote File Address: This is the name of the file that needs to be downloaded from the FTP server (the file name needs to start with “/”).
• Save File Locally As: This is the full address of a local file. After the file is downloaded from FTP Server, it will be saved in this path.

List File and Folder

The ‘List File and Folder’ tool from the toolbox allows you to see the list of files and the folder uploaded to the FTP server by specifying the credential login.

The Flow below shows the ‘List File and Folder’ functionality:

The settings below and also properties need to be set for using the ‘List File and Folder’ functionality from the FTP ToolBox section:

• FTP Connection: This is the FTP Server Address and its credential.
• Remote File Address: This is the name of the file or folder that needs to be listed from the FTP server (if the total list is needed, just type: “/”).
• Copy Result To: The result of this check needs to be copied to a variable. This variable has been added as a new Output variable (it calls “resultFound” in this project).

After running the Flow, ‘resultFound’ will have the list of existing files and folders on the FTP server: