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 locally. 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 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 the store.
- The “Logging” setting configuration is necessary for documentation and also measures the workflow progress and the percent complete. This is achieved 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.
Definition Sample:
You may download the sample definition(s) from the link here and later import it (drag-drop) to your FlowWright Process Definition (XML file) or Form Definition (HTML file) page.
NOTE: Please verify and complete the process steps for any missing configurations, such as file path references and database connections after import. Then, save the definition to confirm the changes.
Click here to download the sample file.