Delete Folder
Description
Deletes a folder from a remote SFTP server.
The folder can be identified using either a Folder Reference or a remote folder path.
The activity returns a boolean indicating whether the folder was successfully deleted, allowing downstream logic to handle scenarios where the folder does not exist.
Common Capabilities
Process Data Support
This activity supports dynamic configuration using variables from the Process Data drawer.
You can bind values from Model Data, Form Data, System Data, Enterprise Variables, and Activity Outputs.
Learn more → Using Process Data
Design-Time Configuration
Connection Name
The name of the configured SFTP connection used to authenticate with the remote server.
If no connection exists, click Add Connection to create one inline.
Folder
The folder to delete.
You can provide either:
- A Folder Reference returned by a previous activity.
- A Remote Path identifying the folder on the SFTP server.
Examples:
/reports/reports/2024/reports/2024/january
When a remote path is used, you can browse the remote directory structure using the path browser, which connects through the selected SFTP connection.
Ignore If Not Exists
When enabled, the activity completes successfully even if the folder does not exist. In this case, the Deleted output is set to false.
When disabled, the activity faults if the folder cannot be found.
Defaults to off.
Wait All Incoming
Controls how this activity behaves when multiple incoming execution paths converge.
Determines whether the activity executes when:
- any incoming path completes, or
- all relevant paths have completed before execution
Learn more → Execution Control
On Error
Defines how the workflow behaves if this activity encounters a runtime error.
Supported strategies include Fault, Continue, Suspend, and Retry.
Output
Deleted
Indicates whether the folder was successfully deleted.
| Value | Meaning |
|---|---|
true | The folder existed and was successfully deleted. |
false | The folder did not exist and Ignore If Not Exists was enabled. |
Remarks
- Deleting a folder permanently removes it from the SFTP server.
- The activity does not move folders to a recycle bin or recovery location.
- The target folder must be empty unless the SFTP server and activity implementation support recursive folder deletion.
- If the folder is not empty, locked, or access is denied by the SFTP server, the activity faults unless handled through the configured error strategy.