File Reader

General

The File module will read the contents of a file.

Notes

If you are having an issue with reading a file that is being changed frequently, the Await Write Finish option will try to wait for all pending write operations to complete before reading the contents.

Module Options

Await Write Finish

Type: boolean
Required: True
Default Value: true
Description: Whether the reader should wait up to Write Finish Threshold milliseconds for any pending write operations before reading the contents of the file. This is useful if a file is being written frequently.

Encoding

Type: enum
Required: False
Default Value: utf-8
Options: utf-8, ascii, base64, binary, utf16le
Description: Specify how the file is encoded. Most files can be read using UTF-8 encoding.

Missing File Mode

Type: enum
Required: False
Default Value: Error
Options: Error, Empty String
Description: Specifies what to do if a file does not exist or cannot be read.

• Error: The pipeline will have an error and processing will not continue
• Empy String: The pipeline will execute but the data will be an empty string

File Path

Type: file
Required: True
Description: The server-relative path to the file. This should be provided as an absolute path.

Good Example: C:\Users\Public\Documents\test.txt
Bad Example: ./test.txt

Write Finish Threshold

Type: integer
Required: True
Default Value: 250
Minumum: 10
Maximum: 5000
Description: How many milliseconds to wait for pending write operations if Await Write Finish is enabled.