DeleteFile

DeleteFile 2.0.0

Bundle: org.apache.nifi | nifi-standard-nar
Description: Deletes a file from the filesystem.
Tags: delete, file, files, filesystem, local, remove
Input Requirement: REQUIRED
Supports Sensitive Dynamic Properties: false

Properties

Directory Path
The path to the directory the file to delete is located in.

Display Name

Directory Path

Description

The path to the directory the file to delete is located in.

API Name

Directory Path

Default Value

${absolute.path}

Expression Language Scope

Environment variables and FlowFile Attributes

Sensitive

false

Required

true
Filename
The name of the file to delete.

Display Name

Filename

Description

The name of the file to delete.

API Name

Filename

Default Value

${filename}

Expression Language Scope

Environment variables and FlowFile Attributes

Sensitive

false

Required

true

Restrictions

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

Relationships

Name	Description
not found	All FlowFiles, for which the file to delete did not exist, are routed to this relationship
success	All FlowFiles, for which an existing file has been deleted, are routed to this relationship
failure	All FlowFiles, for which an existing file could not be deleted, are routed to this relationship

Use Cases

Delete source file only after its processing completed

Description

Delete source file only after its processing completed

Configuration

Retrieve a file from the filesystem, e.g. using 'ListFile' and 'FetchFile'.
Process the file using any combination of processors.
Store the resulting file to a destination, e.g. using 'PutSFTP'.
Using 'DeleteFile', delete the file from the filesystem only after the result has been stored.