Write Text File

Writes a string to a text file, replacing its contents.

Behaviour

Risk: Low · Idempotent: Yes · 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.writeTextFile

Properties#

Input#

Path#

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

The full path of the text file to write.

Content#

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

The text to write. An empty string writes an empty file.

Encoding#

Encoding · String · Optional · Default: UTF-8

How the text is encoded. Empty means UTF-8 without a byte order mark.

Allowed values: UTF-8, Auto, UTF-8 BOM, UTF-16, UTF-16BE, UTF-32, ANSI, ASCII, Latin-1.

Overwrite#

Overwrite · Boolean · Optional · Default: False

Replace a file already at the path. When false, an existing file fails the step.

Create Directory If Missing#

CreateDirectoryIfMissing · Boolean · Optional · Default: False

Create the file's folder, and any folder above it, when it does not exist.

Output#

Full Path#

FullPath · String · Output

The full path of the file that was written.

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, write, text, save, content.

Properties

Input

Output

Retry and risk

Related activities