Rename File

Use this step to rename an existing file on the FTP server.

Last published at: March 31st, 2026

ftpRenameFile Step

Description:

The Rename File workflow step renames a file on the selected FTP server.

The step supports:

  • Selecting a configured FTP connection.
  • Specifying the path of the file to be renamed.
  • Providing a new file name.
  • Using workflow values in the file path and new name where supported by the configured FlowWright property values.
  • Connecting the True and False return paths to subsequent workflow activities.
  • Organizing files on an FTP server as part of a larger workflow process.

 

Inputs

  • ftpConnection – The Select FTP property specifies the configured FTP connection that the step uses to access the server.
  • filePath – The Path of file to be renamed property specifies the path of the existing file on the FTP server that should be renamed.
  • renameTo – The Rename file to property specifies the new name for the FTP file.
 

 

Returns

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

 

Usage:

The FTPRenameFile step is typically placed after a workflow has identified, created, uploaded, downloaded, or processed a file on an FTP server.

A typical workflow pattern is:

FTP File Processing → FTPRenameFile → Next Processing Stage
For example:
Upload File → Rename File → Continue Workflow
You can use the step to rename a file to indicate that a particular stage of processing is complete.

Common uses include:

  • Marking an FTP file as processed.
  • Moving a file into a naming convention without changing its contents.
  • Renaming inbound files after successful processing.
  • Adding a processing status to a file name.
  • Adding timestamps or business identifiers to file names.
  • Renaming files after an integration operation.
  • Organizing files in FTP-based workflows.
  • Creating different file names for different workflow branches.
  • Preparing a file for a subsequent integration process.

 

 

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

 

A sample FTP connection configuration is provided here for reference.

 

Typical Workflow Suggestions:

Mark an Inbound File as Processed

Use FTPRenameFile after an inbound file has been successfully processed.

Example:

FTP File Detection
       ↓
Read / Process File
       ↓
FTPRenameFile
       ↓
Continue Workflow
For example:
Input:

/incoming/customer-order.xml

Rename to:

customer-order.processed.xml
This naming convention distinguishes processed files from files still awaiting processing.

 

Rename a File After Successful Validation

Place the step after file validation.

Example:

Receive File → Validate File → Rename File → Continue
For example:
/incoming/invoice-10025.xml
can be renamed to:
/incoming/invoice-10025.validated.xml
The naming convention can help identify the processing state of files stored on the FTP server.

 

Rename a File After Successful Integration

Use the step after a file has been successfully passed to another system.

Example:

FTP File
   ↓
Process File
   ↓
External Integration
   ↓
FTPRenameFile
   ↓
Complete
For example:
customer-data.csv
can be renamed to:
customer-data.completed.csv
This can help distinguish files that have completed an integration stage.

 

Rename Files Based on Workflow Data

Use workflow values to construct meaningful file names when the workflow needs to distinguish files by business information.

Example:

Process Order
      ↓
FTPRenameFile
      ↓
Archive / Continue
A file naming convention might use values such as:
Order-1045-Processed.xml
or:
Customer-ACME-20260918.xml
The exact handling of workflow variables within the string properties should be verified against the FlowWright implementation used by the deployment.

 

Add a Processing Status to the File Name

A workflow can use different naming conventions to indicate processing stages.

For example:

invoice-1045.xml
could become:
invoice-1045.processed.xml
Other organizational conventions could use names such as:
invoice-1045.completed.xml
invoice-1045.validated.xml
invoice-1045.archived.xml
Standardize the naming convention for the workflow and downstream systems.

 

Rename Files After Upload

FTPRenameFile can be used after an FTP upload when the uploaded file needs a different name for the next processing stage.

Example:

Create File
    ↓
Upload File
    ↓
Rename File
    ↓
Notify / Continue
For example:
customer-export.tmp
could be renamed to:
customer-export.ready
This workflow can be useful when a downstream process recognizes a particular file-naming convention.

 

Organize Files Using Date-Based Names

A workflow can use a naming convention that incorporates a processing date.

For example:

daily-report.csv
could be renamed to:
daily-report-2026-09-18.csv
This can make files easier to identify when multiple versions are stored on the FTP server.

 

Rename Files After Batch Processing

For workflows that process multiple files, FTPRenameFile can be placed after the processing logic for each file.

Example:

Get File
   ↓
Process File
   ↓
Validate Result
   ↓
Rename File
   ↓
Next File
A processed file might be renamed from:
batch001.csv
to:
batch001.processed.csv
This provides a simple file-level indication of processing status.

 

Use Different Names for Different Workflow Branches

You can place the step on different workflow branches when different processing outcomes require different naming conventions.

Example:

Process File
     ↓
   Decision
   /      \
Success   Alternate
  ↓          ↓
Rename      Rename
File A      File B
For example:
Success:
order.xml → order.processed.xml

Alternate:
order.xml → order.review.xml
The True and False return paths of the FTPRenameFile step can also be connected to appropriate subsequent activities.

 

Rename a File Before a Subsequent FTP Operation

FTPRenameFile can be placed before another FTP operation when a subsequent step expects a specific file name.

Example:

Prepare File
    ↓
Rename File
    ↓
FTP File Operation
This lets the workflow set the expected file name before continuing.

 

Maintain an FTP File Naming Convention

Use FTPRenameFile as part of a standardized file-management process.

For example:

/incoming/
    order001.xml
    order002.xml

        ↓ Processing

/incoming/
    order001.processed.xml
    order002.processed.xml
A consistent naming convention makes workflow-managed FTP folders easier to understand and maintain.

 

Handle Rename Failures

Because the step provides both True and False return paths, the workflow can define separate processing paths for successful and unsuccessful rename operations.

Example:

Process File
     ↓
FTPRenameFile
   /       \
True      False
 ↓          ↓
Continue   Error Handling
The False path could be connected to a workflow activity that records the failure, sends an alert, or performs another appropriate recovery action.

The specific cause of a failed rename is not defined in the XML and should therefore be determined from the workflow execution and applicable FlowWright logging.

 

Example:

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

  • Create a new definition named “ftpRenameFileDef” and open it in designer mode. 
  • Drag an “ftpRenameFile” step to the canvas.
  • Connect the dots between the “Start” and “ftpRenameFile” 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, you can configure additional values.
  • Define a variable or a global to store the FTP file path.  
  • Click the “ftpRenameFile” step to configure its “Required” properties. Provide a name for the step. Specify the source folder and the file to rename. Enter the new name. 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 to measure workflow progress and percent complete. This is done by configuring 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 select the Rename File step to view its configured properties. When the workflow reaches the FTPRenameFile step, FlowWright uses the configured FTP connection, file path, and new file name for the rename operation. The workflow can then continue through the configured True or False return path. The XML explicitly defines these two return values.

 

Tips:

  • Verify that the selected FTP connection is configured correctly before executing the workflow.
  • Make sure the file path identifies the intended FTP file.
  • Use meaningful and consistent file naming conventions.
  • Test the workflow with representative FTP files before deploying it.
  • Verify that the source file exists at the expected FTP path before the rename operation.
  • Use a naming convention that clearly identifies processing status when appropriate.
  • Avoid ambiguous file names that could make files difficult to identify.
  • Consider using consistent extensions when downstream systems depend on file extensions.
  • Test the workflow with files containing spaces or special characters when those names are expected in the environment.
  • Verify the resulting file name on the FTP server after execution.
  • Consider connecting the False return path to appropriate error-handling logic.
  • Keep the selected FTP connection appropriate for the environment in which the workflow is executed.
  • Use separate naming conventions when files have different processing states.
  • Test workflows that process multiple files to make sure each file receives the expected name.
  • Verify that downstream activities expect the renamed file name.
  • Avoid assuming that a rename operation changes file contents; the XML defines the step in terms of renaming the file.
  • Do not assume specific FTP-server behavior for duplicate destination names, permissions, locking, or path handling unless confirmed by the FlowWright implementation and the FTP server.
  • Test the workflow when the source file does not exist.
  • Test the workflow when the configured FTP connection cannot access the target location.
  • Test the False return path as part of workflow error handling.
  • Keep environment-specific FTP connection configuration outside the reusable naming convention where possible.
  • When using workflow-generated values in the file name, test the resulting names with realistic data.
  • Verify that generated file names do not contain characters that are invalid or problematic for the target FTP environment.
  • Document the naming convention used by the workflow so that administrators and downstream integrations can understand the file states.

 

Definition Sample:

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

Before executing an imported or newly created workflow, verify:

  • FTP connection is selected.
  • FTP connection is valid for the target environment.
  • File path points to the intended FTP file.
  • New file name is specified.
  • New file name follows the required naming convention.
  • Workflow Variables used in the configuration, if any, contain expected values.
  • The True return path is connected appropriately.
  • The False return path is connected to appropriate handling.
  • Downstream steps reference the correct renamed file.
  • Environment-specific FTP settings have been verified.
  • The Process Definition has been saved before execution.

Click here to download the sample file.