Download File from FTP Server

Use this step to download a file from the FTP server.

Last published at: August 8th, 2023

ftpGetFile Step

Description:

This step downloads a file from the FTP server. 

Inputs

  • ftpConnection – Select FTP connection from dropdown
  • sourceFilePath – The relative path of the file in FTP server. Ex: - /folder1/test.txt
  • destinationFilePath – The physical path to be downloaded to in local.  Ex: - C:\Download
 

 

Returns

  • True – step executed successfully
  • False – step failed to execute
 

 

Usage:

 

To use this step, configure FTP in FlowWright FTP Connections.

A sample FTP connection configuration is included here for reference.

 

Example:

Let’s build and execute the “ftpGetFileDef” example.  

  • Create a new definition called “ftpGetFileDef”
  • Select the definition and click the “design” button
  • Drag a “ftpGetFile” step to the canvas
  • Connect the dots between the start and “ftpGetFile” step
  • Click on the “ftpGetFile” step to configure its “Settings” properties. Provide a name to the step. Select FTP connection from the drop down list. Provide the source file path to download. Provide the target file path to store. 
  • The “Logging” setting configuration is necessary for documentation and also measure the workflow progress and the percent complete. This is acheived by configuring the step state and percent fields individually as shown in the images below. Configure the “Logging” using the following properties.
  • Save the process definition, create a new process instance and execute. Render the process instance. Click on the process step to view the properties. The step should download the file from the FTP server.