ftpRenameFile Step
Description:
This step renames an existing file on the FTP server.
Inputs
- ftpConnection – Select FTP connection from dropdown
- filePath – The relative path of the file in FTP server. Ex: - /folder1/test.txt.
- renameTo – File name to be renamed to. Ex:- testNew.txt.
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 “ftpRenameFileDef” example.
- Create a new definition called “ftpRenameFileDef” and open the definition in designer mode.
- Drag an “ftpRenameFile” step to the canvas.
- Connect the dots between the “Start” and “ftpRenameFile” steps, as shown above.
- 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. Provide the source folder file to be renamed. Provide the new name. Click the Save button. Note: Click the "AI Predict" button for the Copilot to add new process steps that match your process description.

- 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 below. Configure the “Logging” using the following properties.

- Save the process definition, create a new instance, and then execute it. Render the process instance. Click the process step to view the properties. The step should rename the existing file on the FTP server.
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.
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.