ftpRenameFolder Step

Use this feature to rename an existing folder on a configured FTP server by specifying the folder's current path and the new folder name.

Last published at: September 18th, 2026

Description:

The FTPRenameFolder workflow step renames a folder on an FTP server. It uses a configured FTP connection, the folder path to rename, and the new folder name.

The step supports:

  • Selecting a configured FTP connection.
  • Specifying the existing folder path.
  • Specifying the new folder name.
  • Renaming folders as part of an automated workflow.
  • Organizing FTP-based file-processing workflows.
  • Returning a True or False result for subsequent workflow processing.

 

Inputs

  • ftpConnection – The Select FTP property specifies the FTP connection that should be used to rename the folder.
  • folderPath – The Path of folder to be renamed property specifies the existing folder whose name should be changed.
  • renameTo – The Rename folder to property specifies the new name to assign to the folder.
 

 

Returns

  • True – The True return path can be connected to the next workflow activity after the folder rename operation succeeds.
  • False – The False return path can be used for error handling or an alternative workflow path if the rename operation does not succeed.
 

 

Usage:

The FTPRenameFolder step is typically used when a workflow needs to change the state or name of an FTP folder as part of file-based processing.

A typical workflow pattern is:

Process Files → Rename Folder → Continue Process

For example, a workflow could process files from:

/Inbound/Orders/Processing
and rename the folder after processing to:
/Inbound/Orders/Completed
This can provide a folder-based indication that processing has reached a particular stage.

Typical uses include:

  • Renaming a processing folder after successful file processing.
  • Moving a folder through a business-process naming convention.
  • Marking a folder as completed.
  • Renaming folders as part of an FTP integration.
  • Organizing inbound and outbound processing areas.
  • Preparing a folder for a subsequent workflow stage.
  • Separating processed and unprocessed files through folder naming.
  • Handling workflow-specific FTP folder structures.

 

 

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

 

A sample FTP connection configuration is provided here for reference.

 

Typical Workflow Suggestions:

Rename a Processing Folder After Successful Processing

A common workflow pattern is to rename a folder after processing all files within it.

Example:

Process Files
     ↓
Rename Folder
     ↓
Continue Workflow
For example:
/Inbound/Orders/Processing
could be renamed to:
/Inbound/Orders/Completed
The exact folder naming convention should be defined by the workflow design.

 

Mark a Folder as Completed

Use the step to indicate that a particular processing stage has finished.

Example:

/Files/Current
       ↓
   Process Files
       ↓
Rename Folder
       ↓
/Files/Completed
This can provide a simple folder-based processing-state convention.

 

Rename an Inbound Folder

An inbound file-processing workflow can rename a folder after receiving and processing its contents.

Example:

FTP Inbound Folder
       ↓
Read Files
       ↓
Validate Files
       ↓
Process Files
       ↓
Rename Folder
The folder can be renamed according to the workflow's processing convention.

 

Rename a Folder After File Validation

Place FTPRenameFolder after validation when a folder should be renamed only after its files have passed validation.

Example:

Read Files
    ↓
Validate Files
    ↓
Decision
   ↓
Valid
   ↓
Rename Folder
An invalid branch can be connected to separate exception handling.

 

Rename a Folder After Integration Processing

File-based integrations can use folder names to distinguish processing states.

Example:

Receive Integration Files
          ↓
Process Integration
          ↓
Rename Folder
          ↓
Complete Integration
For example:
/Inbound/Processing
can be renamed to:
/Inbound/Processed

 

Rename a Folder Based on Workflow Data

The folder path and new folder name are string properties, so the workflow can be designed around values determined during execution, where supported by the FlowWright string-property configuration.

Example:

Determine Folder
      ↓
Determine New Name
      ↓
Rename Folder
      ↓
Continue
This can be useful when folder names contain workflow-specific information.

 

Rename a Folder After a Batch Completes

When a batch of files is processed as a unit, rename the associated folder after the batch operation.

Example:

Get Batch
    ↓
Process Files
    ↓
Validate Results
    ↓
Rename Folder
    ↓
Complete Batch
This keeps the folder operation at the end of the processing sequence.

 

Rename Folders Using a Date-Based Convention

A workflow may use a date-oriented naming convention for processed folders.

Example:

/Inbound/Orders/Current
          ↓
      Process
          ↓
Rename Folder
          ↓
/Inbound/Orders/2026-09-18
Implement the dynamic-value configuration using FlowWright's supported Variable/Global and string mechanisms.

 

Rename a Folder for Archival Processing

A workflow can rename a folder before or after an archival stage.

Example:

Process Documents
       ↓
Archive Documents
       ↓
Rename Folder
       ↓
Complete
A naming convention such as:
/Archive/Pending
to:
/Archive/Completed
can make processing stages easier to distinguish.

 

Rename a Folder After Export

Use FTPRenameFolder after generating and exporting files.

Example:

Generate Export
      ↓
Upload/Process Files
      ↓
Rename Folder
      ↓
Finish
This can be useful when the folder name represents the state of an export batch.

 

Rename a Folder After Upload Processing

A workflow that receives a folder of files can rename the folder after the files have been processed.

Example:

Read FTP Folder
       ↓
Process Files
       ↓
Rename Folder
       ↓
Send Notification
The notification can then be associated with the completion of the folder-processing operation.

 

Rename Different Folders on Different Workflow Branches

You can place the step on different workflow branches when different outcomes require different folder names.

Example:

                    ┌─ Successful → Rename Folder
Process Result ─────┤
                    └─ Exception → Exception Handling
You can configure the appropriate source folder and new name for each branch.

 

Handle Rename Failure

The step provides True and False return paths, allowing a workflow to distinguish between the two outcomes.

Example:

                    ┌─ True → Continue
Rename Folder ──────┤
                    └─ False → Log/Handle Error
A failure branch can be used for logging, retrying, notifications, or other workflow-specific handling.

 

Rename a Folder Before a Subsequent Processing Stage

Folder renaming can also be used as a transition between processing stages.

Example:

/Inbound/Ready
      ↓
Rename Folder
      ↓
/Inbound/Processing
      ↓
Process Files
This pattern makes the folder state match the current processing stage.

 

Organize FTP Processing Folders

A workflow can use a sequence of folder names to represent processing states.

Example:

/Inbound/Ready
      ↓
/Inbound/Processing
      ↓
/Inbound/Completed
The FTPRenameFolder step can perform an individual folder-name transition within such a design.

The exact naming convention and sequence are application-specific.

 

Rename a Folder as Part of Cleanup

A cleanup workflow can rename a folder after completing its cleanup operation.

Example:

Identify Folder
      ↓
Cleanup Files
      ↓
Rename Folder
      ↓
Complete Cleanup
This can distinguish a folder that has already undergone cleanup from one awaiting processing.

 

Use a Specific FTP Connection

The Select FTP property is based on ClsFTPConnections, which provides the configured FTP connections.

Example:

Prepare Processing
       ↓
Rename Folder
       ↓
Selected FTP Connection
When multiple FTP connections are configured, select the connection associated with the target folder.

 

Example:

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

  • Create a new definition named “ftpRenameFolderDef” and open it in designer mode. 
  • Drag an “ftpRenameFolder” step to the canvas.
  • Connect the dots between the “Start” and “ftpRenameFolder” 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 folder path.  
  • Click the “ftpRenameFolder” step to configure its “Required” properties. Enter a step name, the source folder path to rename, and the new name. Then 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 instance, and execute it. Render the process instance and click the Rename Folder step to view its properties. When the workflow reaches the FTPRenameFolder step, FlowWright uses the selected FTP connection, existing folder path, and new folder name to perform the configured folder-renaming operation. The workflow then follows the appropriate True or False return path. After successful execution, verify the folder on the FTP server using the expected new name.

 

Tips:

  • Configure all three required properties before executing the step.
  • Select the correct configured FTP connection.
  • The Select FTP property is required. 
  • Verify that the selected FTP connection has access to the folder being renamed.
  • Make sure the source folder exists before executing the step.
  • The Path of folder to be renamed property is required. 
  • Use the correct folder path syntax for the configured FTP connection.
  • Verify the new folder name before executing the workflow.
  • The Rename folder to property is required. 
  • Use meaningful and consistent folder-naming conventions.
  • Test the rename operation with a non-production folder before deploying it to a production FTP location.
  • Verify the renamed folder on the FTP server after execution.
  • Consider placing the rename operation after all required file processing has completed.
  • Use the rename operation to represent meaningful processing-state transitions.
  • Avoid renaming a folder while another process may still be writing or reading files from it.
  • Verify whether the destination folder name already exists before relying on the rename operation.
  • Test behavior when the source folder does not exist.
  • Test behavior when the destination name conflicts with an existing folder.
  • Test behavior when the FTP connection is unavailable.
  • Test behavior when the configured account does not have sufficient permissions.
  • Consider connecting the False path to appropriate error handling.
  • Connect the True path to the normal continuation of the workflow.
  • If the folder name is generated dynamically, test the resulting name before using it in production.
  • Keep folder naming conventions documented when multiple workflows interact with the same FTP server.
  • When several workflows share the same FTP directory structure, coordinate folder-state naming conventions to avoid conflicts.
  • Avoid exposing FTP credentials in workflow configuration documentation or logs.
  • If the FTP connection uses secure transport, verify that security settings are configured in the FTP connection rather than assuming them from the step name.
  • The supplied XML does not expose retry, timeout, overwrite, directory-creation, locking, or conflict-resolution settings for this step.
  • Do not assume that renaming a folder automatically changes or moves the files inside it beyond the behavior provided by the FTP server and FlowWright implementation.
  • Test the complete workflow when folder renaming affects subsequent file-processing activities.

 

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 a workflow containing the FTPRenameFolder step, verify:

  1. The Rename Folder step has been added to the Process Definition.
  2. A valid FTP connection has been selected.
  3. The FTP connection has access to the required folder.
  4. The existing folder path has been configured.
  5. The source folder exists on the FTP server.
  6. The new folder name has been configured.
  7. The new folder name follows the required naming convention.
  8. The True path is connected to the normal continuation path.
  9. The False path is connected to appropriate alternate or error handling where required.
  10. Logging has been configured if workflow progress needs to be documented.
  11. The rename operation has been tested with a representative FTP folder.
  12. Verify the resulting folder name on the FTP server.
  13. Any possible destination-folder conflict has been considered.
  14. Environment-specific FTP permissions have been confirmed.
  15. The Process Definition has been saved before execution.

Click here to download the sample file.