Rename folder in SFTP server

Use this step to rename a folder in SFTP server.

Last published at: August 1st, 2023

sftpRenameFolder Step


This step renames a folder in the SFTP server.


  • sftpConnection – Select the SFTP connection from dropdown
  • folderPath – The relative path of the folder in SFTP 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 SFTP in FlowWright SFTP Connections.



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

  • Create a new definition called “sftpRenameFolderDef” 
  • Select the definition and click the “design” button
  • Drag a “sftpRenameFolder” step from the toolbox
  • Connect the dots between the start and “sftpRenameFolder” step
  • Click on the “sftpRenameFolder” step to configure its “Settings” properties. Provide a name to the step. Select “SFTP” connection string from the dropdown list. Provide a relative file path of the folder to be renamed. Provide a new folder 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 folder path in the SFTP server.