Read Text File

Reads a text file into a string.

Behaviour

Risk: None · 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.readTextFile

Properties#

Input#

Path#

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

The full path of the text file to read.

Encoding#

Encoding · String · Optional · Default: UTF-8

How to decode a file that carries no byte order mark. Empty means UTF-8.

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

Output#

Content#

Content · String · Output

The whole file as one string, line breaks included.

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
• Delete Folder

Generated from VeloPhex.System.Activities 0.7.1-rc.12. Category: File System. Keywords: file, read, text, load, content.

Properties

Input

Output

Retry and risk

Related activities