ftpRenameFolder Step

Use this step to rename an existing folder in the FTP server.

Last published at: January 19th, 2024


This step renames an existing folder in the FTP server.



  • ftpConnection – Select FTP connection from dropdown
  • folderPath – The relative path of the folder in FTP server. Ex: - /folder1.
  • renameTo – Folder name to be renamed to. Ex: - folder2.



  • True – step executed successfully
  • False – step failed to execute 



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

A sample FTP connection configuration is included here for reference.



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

  • Create a new definition called “ftpRenameFolderDef”
  • Select the definition and click the “design” button
  • Drag a “ftpRenameFolder” step to the canvas
  • Connect the dots between the start and “ftpRenameFolder” step
  • Click on the “ftpRenameFolder” step to configure its “Settings” properties. Provide a name to the step. Provide the source folder path to be renamed. Provide the new name. 
  • The “Logging” setting configuration is necessary for documentation and also measure the workflow progress and the percent complete. This is acheived 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 process instance and execute. Render the process instance. Click on the process step to view the properties. The step should rename the existing folder in the FTP server.