sftpDeleteFolder Step

Use this step to delete a folder on the SFTP server.

Last published at: January 1st, 2026

Description:

This step deletes a folder on the SFTP server.

 

Inputs

  • sftpConnection – Select the SFTP connection from dropdown
  • folderPath – The relative path of the folder in SFTP server to delete. Ex:- /folder1
 

 

Returns

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

 

Usage:

 

 

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

 

A sample connection configuration is included below for reference.

 

Example:

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

  • Create a new definition called “sftpDeleteFolderDef” and open the definition in designer mode. 
  • Drag an “sftpDeleteFolder” step to the canvas. 
  • Connect the dots between the “Start” and “sftpDeleteFolder” steps, as shown above. 
  • Click the “sftpDeleteFolder” step to configure its “Required” properties. Provide a name for the step. Select the “SFTP” connection string from the dropdown. Enter the relative file path of the folder to delete. Click the Save button. Note: Click the "AI Predict" button to have the Copilot add new process steps that match your process description. 

 

  • The “Logging” configuration is necessary for documentation and also measures workflow progress and 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 it. Render the process instance. Click the process step to view its properties. The step should delete the folder path on the SFTP 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 the import. Then, save the definition to confirm the changes.

Click here to download the sample file.