Rename File

Renames a file, leaving it in the same folder.

Behaviour

Risk: Medium · Idempotent: No · Safe to retry: No · Recovery: Not replayed after a crash

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

Properties#

Input#

Path#

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

The full path of the file to rename.

New Name#

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

The new file name, including the extension, for example report-2026.csv. Not a path.

Overwrite#

Overwrite · Boolean · Optional · Default: False

Replace a file already carrying the new name. When false, an existing file of that name fails the step.

Keep Extension#

KeepExtension · Boolean · Optional · Default: False

Keep the current extension; New Name is then given without one, for example report-2026.

Output#

Full Path#

FullPath · String · Output

The full path of the renamed file.

Retry and risk#

This activity is not marked safe to retry: if it fails partway, check whether its work already happened before running it again. 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
• Delete Folder

Generated from VeloPhex.System.Activities 0.7.1-rc.12. Category: File System. Keywords: file, rename, name.

Properties

Input

Output

Retry and risk

Related activities