Delete Folder

Deletes a folder, optionally with everything inside it.

Behaviour

Risk: High · Idempotent: Yes · Safe to retry: Yes · Recovery: Not replayed after a crash

Package System activities VeloPhex.System.Activities 0.7.1-rc.12 · Supported (Core profile) · type id velophex.system.deleteFolder

Properties#

Input#

Path#

Path · String · Required · Default: Not specified in package metadata

The full path of the folder to delete.

Recursive#

Recursive · Boolean · Optional · Default: False

Delete everything inside the folder as well. When false, a folder that still has contents fails the step.

Fail If Missing#

FailIfMissing · Boolean · Optional · Default: False

Fail the step when no folder is at the path. When false, a missing folder completes with Deleted set to false.

Output#

Deleted#

Deleted · Boolean · Output

True when a folder was found and deleted; false when the path was already empty.

Retry and risk#

This activity is safe to retry: running it again after a transient failure does not repeat a side effect. If a run is interrupted and the outcome of a step is unknown, the step is never retried automatically (what to do). How activities declare this: characteristics, retries and risk.

Every activity also has the engine's common properties: Timeout and Continue On Error.

Related activities#

• Append Line
• Compress/Zip Files
• Copy File
• Copy Folder
• Create File
• Create Folder
• Delete File
• Extract/Unzip Files

Generated from VeloPhex.System.Activities 0.7.1-rc.12. Category: File System. Keywords: folder, directory, delete, remove, clean up.

Properties

Input

Output

Retry and risk

Related activities