PutFile

Description:

Writes the contents of a FlowFile to the local file system

Tags:

put, local, copy, archive, files, filesystem

Properties:

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.

NameDefault ValueAllowable ValuesDescription
DirectoryThe directory to which files should be written. You may use expression language such as /aa/bb/${path}
Supports Expression Language: true (will be evaluated using flow file attributes and variable registry)
Conflict Resolution Strategyfail
  • replace
  • ignore
  • fail
Indicates what should happen when a file with the same name already exists in the output directory
Create Missing Directoriestrue
  • true
  • false
If true, then missing destination directories will be created. If false, flowfiles are penalized and sent to failure.
Maximum File CountSpecifies the maximum number of files that can exist in the output directory
Last Modified TimeSets the lastModifiedTime on the output file to the value of this attribute. Format must be yyyy-MM-dd'T'HH:mm:ssZ. You may also use expression language such as ${file.lastModifiedTime}.
Supports Expression Language: true (will be evaluated using flow file attributes and variable registry)
PermissionsSets the permissions on the output file to the value of this attribute. Format must be either UNIX rwxrwxrwx with a - in place of denied permissions (e.g. rw-r--r--) or an octal number (e.g. 644). You may also use expression language such as ${file.permissions}.
Supports Expression Language: true (will be evaluated using flow file attributes and variable registry)
OwnerSets the owner on the output file to the value of this attribute. You may also use expression language such as ${file.owner}.
Supports Expression Language: true (will be evaluated using flow file attributes and variable registry)
GroupSets the group on the output file to the value of this attribute. You may also use expression language such as ${file.group}.
Supports Expression Language: true (will be evaluated using flow file attributes and variable registry)

Relationships:

NameDescription
successFiles that have been successfully written to the output directory are transferred to this relationship
failureFiles that could not be written to the output directory for some reason are transferred to this relationship

Reads Attributes:

NameDescription
filenameThe filename to use when writing the FlowFile to disk.

Writes Attributes:

None specified.

State management:

This component does not store state.

Restricted:

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

Input requirement:

This component requires an incoming relationship.

System Resource Considerations:

None specified.

See Also:

FetchFile, GetFile