Rename Folder

Use this step to rename a folder in SFTP server.

Last published at: February 25th, 2025

sftpRenameFolder Step

Description:

This step renames a folder in the SFTP server.

 

Inputs

  • 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
 

 

Returns

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

 

Usage:

 

 

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

 

A sample connection configuration is included below for reference. 

 

Example:

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 the “sftpRenameFolder” step to configure its “Required” properties. Provide a name to the step. Select the “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 measures the workflow progress and the percent complete. This is achieved 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 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.

 

 

Definition Sample:

You may download the sample definition(s) from the link here and later import it (drag-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.

Click here to download the sample file.

 

How can we improve this article?

Share additional info and suggestions