Provides a file resource for other components. The file needs to be available locally by Nifi (e.g. local disk or mounted storage). NiFi needs to have read permission to the file.


file, resource


In the list below, the names of required properties appear in bold. Any other properties (not in bold) are considered optional. The table also indicates any default values, and whether a property supports the NiFi Expression Language.

Display NameAPI NameDefault ValueAllowable ValuesDescription
File Pathfile-path${absolute.path}/${filename}Path to a file that can be accessed locally.

This property requires exactly one file to be provided..

Supports Expression Language: true (will be evaluated using flow file attributes and variable registry)

State management:

This component does not store state.


Required PermissionExplanation
read filesystemProvides operator the ability to read from any file that NiFi has access to.

System Resource Considerations:

None specified.