PutFile

PutFile 2.0.0

Bundle: org.apache.nifi | nifi-standard-nar
Description: Writes the contents of a FlowFile to the local file system
Tags: archive, copy, files, filesystem, local, put
Input Requirement: REQUIRED
Supports Sensitive Dynamic Properties: false

Properties

Conflict Resolution Strategy
Indicates what should happen when a file with the same name already exists in the output directory
Display Name

Conflict Resolution Strategy

Description

Indicates what should happen when a file with the same name already exists in the output directory

API Name

Conflict Resolution Strategy

Default Value

fail

Allowable Values
- replace
- ignore
- fail
Expression Language Scope

Not Supported

Sensitive

false

Required

true
Create Missing Directories
If true, then missing destination directories will be created. If false, flowfiles are penalized and sent to failure.
Display Name

Create Missing Directories

Description

If true, then missing destination directories will be created. If false, flowfiles are penalized and sent to failure.

API Name

Create Missing Directories

Default Value

true

Allowable Values
- true
- false
Expression Language Scope

Not Supported

Sensitive

false

Required

true
Directory
The directory to which files should be written. You may use expression language such as /aa/bb/${path}

Display Name

Directory

Description

The directory to which files should be written. You may use expression language such as /aa/bb/${path}

API Name

Directory

Expression Language Scope

Environment variables and FlowFile Attributes

Sensitive

false

Required

true
Group
Sets the group on the output file to the value of this attribute. You may also use expression language such as ${file.group}.

Display Name

Group

Description

Sets the group on the output file to the value of this attribute. You may also use expression language such as ${file.group}.

API Name

Group

Expression Language Scope

Environment variables and FlowFile Attributes

Sensitive

false

Required

false
Last Modified Time
Sets 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}.

Display Name

Last Modified Time

Description

Sets 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}.

API Name

Last Modified Time

Expression Language Scope

Environment variables and FlowFile Attributes

Sensitive

false

Required

false
Maximum File Count
Specifies the maximum number of files that can exist in the output directory

Display Name

Maximum File Count

Description

Specifies the maximum number of files that can exist in the output directory

API Name

Maximum File Count

Expression Language Scope

Not Supported

Sensitive

false

Required

false
Owner
Sets the owner on the output file to the value of this attribute. You may also use expression language such as ${file.owner}. Note on many operating systems Nifi must be running as a super-user to have the permissions to set the file owner.

Display Name

Owner

Description

Sets the owner on the output file to the value of this attribute. You may also use expression language such as ${file.owner}. Note on many operating systems Nifi must be running as a super-user to have the permissions to set the file owner.

API Name

Owner

Expression Language Scope

Environment variables and FlowFile Attributes

Sensitive

false

Required

false
Permissions
Sets 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}.

Display Name

Permissions

Description

Sets 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}.

API Name

Permissions

Expression Language Scope

Environment variables and FlowFile Attributes

Sensitive

false

Required

false

Restrictions

Required Permission	Explanation
write filesystem	Provides operator the ability to write to any file that NiFi has access to.

Relationships

Name	Description
failure	Files that could not be written to the output directory for some reason are transferred to this relationship
success	Files that have been successfully written to the output directory are transferred to this relationship

Reads Attributes

Name	Description
filename	The filename to use when writing the FlowFile to disk.