ftpGetFile Step

The FTPGetFile workflow step allows a FlowWright workflow to download a file from a configured FTP server and save it to a specified location on the local machine.

Last published at: September 18th, 2026

Description:

The Download File workflow step retrieves a file from the selected FTP server and saves the file to a specified location on the local machine.

The step supports:

  • Selecting a configured FTP connection.
  • Specifying the source file path on the FTP server.
  • Specifying the destination file path on the local machine.
  • Downloading files as part of an automated workflow.
  • Passing the downloaded file to subsequent workflow activities.
  • Connecting True and False return paths for subsequent workflow processing.

 

Inputs

  • ftpConnection – The Select FTP property specifies the configured FTP connection that FlowWright uses to access the FTP server.
  • sourceFilePath – The Path of the source file to be downloaded property specifies the location of the file on the FTP server.
  • destinationFilePath – The Path to save the file to local machine property specifies where the downloaded file should be saved on the local machine.
 

 

Returns

  • True – The True return path can be connected to the next workflow activity when the download operation succeeds.
  • False – The False return path can be used for an alternative workflow path or error-handling logic when the download operation does not succeed.
 

 

Usage:

Place the FTPGetFile step when a workflow needs to retrieve a file from an FTP server before additional processing.

A typical workflow pattern is:

FTP File Available → FTPGetFile → Process Downloaded File
For example:
FTP Source
    ↓
Download File
    ↓
Read / Process File
    ↓
Continue Workflow
The downloaded file can then be used by subsequent workflow activities for tasks such as:
  • Reading file contents.
  • Processing imported data.
  • Validating files.
  • Transforming file data.
  • Importing information into a database.
  • Sending the downloaded file to another system.
  • Performing document processing.
  • Archiving or moving the downloaded file.
  • Triggering subsequent workflow activities.

 

 

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

 

A sample FTP connection configuration is included here for reference.

 

Typical Workflow Suggestions:

Download an Inbound File for Processing

Use FTPGetFile when files are received through an FTP server and need to be processed by FlowWright.

Example:

FTP File Available
        ↓
FTPGetFile
        ↓
Read File
        ↓
Process Data
For example:
FTP Source:

/incoming/customer-order.xml

Local Destination:

C:\FlowWright\Inbound\customer-order.xml
The downloaded file can then be supplied to subsequent workflow processing.

 

Download a CSV File for Data Processing

Use FTPGetFile to retrieve a CSV file before importing or processing its contents.

Example:

FTP Server
    ↓
FTPGetFile
    ↓
Read CSV
    ↓
Validate Data
    ↓
Database Processing
For example:
Source:
/incoming/customer-data.csv

Destination:
C:\FlowWright\Data\customer-data.csv
This pattern can be useful for scheduled data-import workflows.

 

Download an XML File for Integration Processing

Use FTPGetFile to retrieve XML files that need to be processed by a workflow.

Example:

FTP XML File
     ↓
FTPGetFile
     ↓
Read XML
     ↓
Validate XML
     ↓
Process Data
For example:
Source:
/orders/order-1045.xml

Destination:
C:\FlowWright\Orders\order-1045.xml
The subsequent workflow activities can process the downloaded XML file.

 

Download a Report from an FTP Server

Use FTPGetFile when an external system publishes reports to an FTP location.

Example:

FTP Server
    ↓
FTPGetFile
    ↓
Store Local Report
    ↓
Process / Send Report
For example:
Source:
/reports/daily-report.pdf

Destination:
C:\FlowWright\Reports\daily-report.pdf
The downloaded report can then be used by subsequent workflow activities.

 

Download Files Before Validation

Place FTPGetFile before file validation when the workflow needs to inspect the file locally.

Example:

FTP File
   ↓
FTPGetFile
   ↓
Validate File
   ↓
Process File
The workflow can download the file first and then pass the local destination to subsequent processing steps.

 

Download a File Before Data Transformation

FTPGetFile can be used as the file-acquisition stage of a larger transformation workflow.

Example:

FTPGetFile
    ↓
Read File
    ↓
Transform Data
    ↓
Store Result
This clearly separates retrieving the source file from processing its contents.

 

Download Files for Database Import

Use FTPGetFile when an external system delivers database-import files through FTP.

Example:

FTP File
   ↓
FTPGetFile
   ↓
Validate File
   ↓
Import Data
   ↓
Database
For example:
Source:
/incoming/products.csv

Destination:
C:\FlowWright\Import\products.csv
The local file can then be used by the appropriate database or file-processing workflow activity.

 

Download Files for Document Processing

Use FTPGetFile to retrieve documents that need to be processed by FlowWright.

Example:

FTP Server
    ↓
FTPGetFile
    ↓
Document Processing
    ↓
Approval Workflow
Possible source files could include:
/incoming/invoice.pdf
/incoming/contract.docx
/incoming/application.xlsx
The XML defines the source and destination as string properties, allowing the workflow to specify the required file locations.

 

Download Multiple Files

For workflows that process multiple files, FTPGetFile can be used as the download operation for each selected source file.

Example:

Identify File
     ↓
FTPGetFile
     ↓
Process File
     ↓
Next File
A workflow can use the same download pattern for different source files, provided the configured paths identify the appropriate files.

 

Download a File Before External Integration

Use FTPGetFile when a file stored on an FTP server must first be retrieved before being submitted to another system.

Example:

FTP Server
    ↓
FTPGetFile
    ↓
External Integration
    ↓
Continue Workflow
The destination path provides the local location where the downloaded file is stored before the downstream integration activity.

 

Use Separate FTP Connections for Different Environments

The Select FTP property allows the workflow step to use a configured FTP connection.

A workflow can therefore use the appropriate connection for its target environment.

For example:

Development → Development FTP
Testing     → Test FTP
Production  → Production FTP
Verify environment-specific connection configuration before deploying the workflow.

 

Handle Download Failures

The step provides both True and False return paths, allowing the workflow to follow different paths based on the download result.

Example:

Request File
     ↓
FTPGetFile
   /      \
True     False
 ↓         ↓
Process   Error Handling
File
The False path can connect to appropriate workflow handling, such as recording the failure, notifying an administrator, or performing another recovery activity.

The XML does not specify the individual runtime conditions that cause the False result, so verify those conditions against the FlowWright implementation.

 

Example:

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

  • Create a new definition called “ftpGetFileDef” and open the definition in designer mode. 
  • Drag an “ftpGetFile” step to the canvas.
  • Connect the dots between the “Start” and “ftpGetFile” steps, as shown before.
  • Select the line between the steps to configure the “Connection Properties”. The default property values are “None, True, False, Error, and Evaluate”. Depending on the step’s purpose, you can configure additional values.
  • Define a variable or a global to store the path of the FTP source file.   
  • Click the “ftpGetFile” step to configure its “Required” properties. Provide a name for the step. Select the FTP connection from the drop-down list. Provide the source file path to download the file. Provide the target file path to store the file. Click the Save button. Note: Click the "AI Predict" button to have Copilot add new process steps that match your process description. 

 

  • The “Logging” configuration is necessary for documentation and also measures workflow progress and percent complete. Configure the step state and percent fields individually, as shown below. Configure the “Logging” using the following properties.

 

  • Save the process definition, create a new process instance, and execute it. Render the process instance and click the Download File step to view its configured properties. When the workflow reaches the FTPGetFile step, FlowWright uses the configured FTP connection to retrieve the file specified by the source file path and saves it to the configured local path. The workflow then continues through the configured True or False return path.

 

Tips:

  • Verify that the selected FTP connection is correctly configured.
  • Confirm that the FTP connection has access to the source file location.
  • Verify that the source file path is correct.
  • Make sure the source file exists on the FTP server before executing the workflow.
  • Verify that the local destination directory exists or is otherwise handled appropriately by the environment.
  • Make sure the FlowWright execution environment has the required access to the destination location.
  • Use meaningful and consistent local file paths.
  • Use consistent file naming conventions between FTP and local storage.
  • Test the workflow with representative files before deploying it.
  • Verify that the downloaded file exists at the expected destination after execution.
  • Check that the downloaded file can be opened or processed by subsequent workflow activities.
  • Consider connecting the False return path to appropriate error-handling logic.
  • Test the workflow when the source file is missing.
  • Test the workflow when the FTP connection is unavailable.
  • Test the workflow when the FTP server does not permit access to the source file.
  • Test the workflow when the local destination is inaccessible.
  • Verify that downstream activities use the correct local destination path.
  • For scheduled file-processing workflows, document the expected FTP source folder and local destination folder.
  • Use environment-appropriate FTP connections when moving workflows between development, test, and production environments.
  • When using dynamically constructed paths, test the resulting source and destination values with realistic data.
  • Avoid assuming that the step creates missing destination directories unless that behavior has been confirmed in the FlowWright implementation.
  • Avoid assuming specific FTP transfer modes, authentication behavior, retry behavior, or timeout behavior unless confirmed by the configured FTP connection and FlowWright implementation.
  • Test files with spaces and special characters in their names when such files are expected.
  • Consider how duplicate local destination files are handled, and verify the behavior in the target FlowWright environment.
  • Verify the downloaded file before passing it to critical downstream processing.
  • Keep the False path connected to an appropriate recovery or notification workflow where download failure requires attention.

 

Definition Sample:

You may download the sample definition(s) from the link here and later import them (drag-and-drop) to your FlowWright Process Definition (XML file) or Form Definition (HTML file) page.

Before executing a newly created or imported workflow, verify:

  • FTP connection is selected.
  • FTP connection is valid for the target environment.
  • Source FTP file path is correct.
  • Source file exists on the FTP server.
  • Local destination file path is correct.
  • Destination location is accessible to the FlowWright execution environment.
  • Any workflow values used to construct paths, if applicable, contain the expected values.
  • The True return path is connected appropriately.
  • The False return path is connected to appropriate handling.
  • Downstream workflow steps reference the correct local file.
  • Environment-specific FTP configuration has been verified.
  • The Process Definition has been saved before execution.

Click here to download the sample file.