Description:

The Upload File workflow step transfers a file from a local path to an SFTP server.

The step uses a configured SFTP connection, identifies the local source file, and specifies the relative path where the file should be saved on the server. It can optionally store the relative destination path in a FlowWright Variable or a global variable.

The step supports:

• Uploading a local file to an SFTP server.
• Selecting a configured SFTP connection.
• Specifying the local source file path.
• Specifying the relative destination path on the SFTP server.
• Optionally storing the relative destination path in a Variable or Global variable.
• Returning a success or failure result.

This step can be used for:

• Sending files to external systems.
• Automated file transfers.
• Publishing workflow-generated files.
• Exchanging files with partners or customers.
• Exporting reports or data files.
• Transferring documents to an SFTP-based repository.
• Integrating FlowWright workflows with SFTP file-transfer processes.

Usage:

The Upload File step is typically used when a workflow needs to transfer a locally available file to an SFTP server.

The source file can be generated or obtained by an earlier workflow activity, while the destination path identifies where the file should be placed on the SFTP server.

The optional relative-path Variable/Global can make the destination information available to later workflow activities.

Typical uses include:

• Sending generated reports to external partners.
• Uploading invoices or other business documents.
• Transferring data exports.
• Publishing files to an external SFTP repository.
• Sending files to customer or partner systems.
• Moving workflow-generated output to an integration endpoint.
• Supporting automated batch file exchanges.

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

A sample connection configuration is provided below for reference. 

Typical Workflow Suggestions:

Automated Report Delivery

Use Upload File to send a generated report to an external SFTP location.

Example:

Generate Report → Upload File → Notify Recipient → Complete

This is useful when external systems or partners retrieve reports from an SFTP server.

Invoice Transfer

Upload invoices to an external financial or accounting system.

Example:

Generate Invoice → Upload File → Record Transfer → Complete

Customer File Delivery

Use the step to deliver files to a customer-specific SFTP location.

Example:

Generate Customer File → Upload File → Send Notification → Complete

The destination path can identify the appropriate customer directory.

Partner File Exchange

Use Upload File as part of an automated partner-integration workflow.

Example:

Prepare Partner File → Upload File → Record Transfer → Complete

Data Export

Transfer a workflow-generated data export to an external system.

Example:

Query Data → Generate CSV → Upload File → Complete

Document Publishing

Publish a completed document to an SFTP repository.

Example:

Create Document → Review → Upload File → Complete

Scheduled File Delivery

Use the step in a scheduled workflow that periodically generates and transfers files.

Example:

Start Scheduled Process → Generate File → Upload File → Log Result

Batch File Processing

Transfer multiple files to an SFTP server as part of an automated batch process.

Example:

Prepare Files → Upload File → Verify Processing → Complete

The Individual Upload File steps can be used when each file requires a separate configured source and destination.

Store Destination Path for Later Processing

Use the optional Variable/Global property when subsequent activities need to know where the file was sent.

Example:

Generate File → Upload File → Store Relative Path → Send Transfer Confirmation

The XML explicitly provides an optional property for storing the relative path.

Failure Handling

Use the False return path to handle an unsuccessful upload.

Example:

Upload File → True → Complete

↳ False → Log Failure / Retry / Notify Administrator

The step explicitly provides True and False return values.

Example:

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

• Create a new definition called “sftpSendFileDef” and open the definition in designer mode. 
• Drag an “sftpSendFile” step to the canvas. 
• Connect the dots between the “Start” and “sftpSendFile” steps, as shown above. 
• 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, additional configuration options are available. 
• Define a variable or a global variable to store the result. 
• Click the “sftpSendFile” step to configure its “Required” properties. Select the “SFTP” connection string from the dropdown. Provide the local path to the source file to upload. Provide the relative path to store the file on the server. Click the Save button. Note: Click the "AI Predict" button for the Copilot to add new process steps that match your process description. 

• Click the “sftpSendFile” step to configure its “Optional” properties. Provide a variable or a global reference to store the relative file path.

• The “Logging” configuration is necessary for documentation and also measures workflow progress and 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 instance, and execute it. Render the process instance. Click the process step to view its properties. When the workflow reaches the Upload File step, FlowWright uses the selected SFTP connection to transfer the specified local source file to the configured relative destination path. If configured, the relative path is also stored in the specified Variable or Global variable. The workflow then follows the True or False return path according to the result.

Tips:

• Select the correct configured SFTP connection.
• Verify that the selected SFTP connection points to the intended server.
• Ensure that the source file exists and is accessible to the FlowWright environment when the step executes.
• Verify the Local path of the source file to be uploaded.
• Carefully verify the Relative path to save the file to the server.
• Use workflow Variables when the source or destination path needs to be determined dynamically.
• Use the optional Variable/Global to store the relative path when downstream activities need the destination path.
• Use consistent destination-folder and file-naming conventions.
• Verify that the selected SFTP connection has permission to write to the target location.
• Test file transfers using representative files before deploying the workflow.
• Test both the True and False paths.
• Consider adding logging or notification to the False path.
• Consider retry or exception-handling logic when an external SFTP server may be temporarily unavailable.
• Avoid hard-coding environment-specific paths when deploying the same workflow across environments.
• Verify that dynamically generated destination paths resolve to the intended SFTP location.
• Confirm the transferred file is available at the expected destination as part of end-to-end testing.

Notes:

The Upload File step is defined in the SFTP category with the internal name sftpsendfile, label Upload file to SFTP server, and display name Upload File.

The step is implemented by FlowWright.Workflow.SFTPSendFile in FlowWright.Workflow.dll and is a Process step with 2 incoming connections and 2 outgoing connections.

The XML defines four configurable properties. The first three—SFTP connection, source file path, and destination file path—are required. The relative-path Variable/Global property is optional.

The Select SFTP property uses the ClsSFTPConnections data type, implemented by FlowWright.DataTypes.ClsSFTPConnections. 

The source-file path, destination-file path, and optional relative-path storage property use the standard string data type, implemented by FlowWright.DataTypes.ClsTextBox. 

The step provides two predefined return values: False and True.

Definition Sample:

You may download the sample definition(s) from the link provided and import them into your FlowWright Process Definition.

Note: Verify and complete any missing configuration after importing the sample, including:

• SFTP connection
• Local source file path
• SFTP relative destination path
• Optional Variable/Global mapping for the relative path
• Environment-specific SFTP settings
• Downstream True and False workflow paths

After verifying the configuration, save the Process Definition before execution.

Click here to download the sample file.