ListBoxFileInfo

ListBoxFileInfo 2.4.0

Bundle: org.apache.nifi | nifi-box-nar
Description: Fetches file metadata for each file in a Box Folder. Takes a flowFile with a folder ID attribute and outputs flowFiles with records containing all file metadata.
Tags: box, fetch, files, folder, storage
Input Requirement: REQUIRED
Supports Sensitive Dynamic Properties: false

Properties

Box Client Service
Controller Service used to obtain a Box API connection.

Display Name

Box Client Service

Description

Controller Service used to obtain a Box API connection.

API Name

box-client-service

Service Interface

org.apache.nifi.box.controllerservices.BoxClientService

Service Implementations

org.apache.nifi.box.controllerservices.DeveloperBoxClientService

org.apache.nifi.box.controllerservices.JsonConfigBasedBoxClientService

Expression Language Scope

Not Supported

Sensitive

false

Required

true
Folder ID
The ID of the folder from which to fetch files.

Display Name

Folder ID

Description

The ID of the folder from which to fetch files.

API Name

Folder ID

Default Value

${box.folder.id}

Expression Language Scope

Environment variables and FlowFile Attributes

Sensitive

false

Required

true
Minimum File Age
The minimum age a file must be in order to be considered; any files younger than this will be ignored.

Display Name

Minimum File Age

Description

The minimum age a file must be in order to be considered; any files younger than this will be ignored.

API Name

Minimum File Age

Default Value

0 sec

Expression Language Scope

Not Supported

Sensitive

false

Required

true
Record Writer
Specifies the Controller Service to use for writing the metadata records. Must be set.

Display Name

Record Writer

Description

Specifies the Controller Service to use for writing the metadata records. Must be set.

API Name

Record Writer

Service Interface

org.apache.nifi.serialization.RecordSetWriterFactory

Service Implementations

org.apache.nifi.avro.AvroRecordSetWriter

org.apache.nifi.csv.CSVRecordSetWriter

org.apache.nifi.text.FreeFormTextRecordSetWriter

org.apache.nifi.json.JsonRecordSetWriter

org.apache.nifi.lookup.RecordSetWriterLookup

org.apache.nifi.record.script.ScriptedRecordSetWriter

org.apache.nifi.xml.XMLRecordSetWriter

Expression Language Scope

Not Supported

Sensitive

false

Required

true
Search Recursively
When 'true', will include files from sub-folders. Otherwise, will return only files that are within the folder defined by the 'Folder ID' property.
Display Name

Search Recursively

Description

When 'true', will include files from sub-folders. Otherwise, will return only files that are within the folder defined by the 'Folder ID' property.

API Name

Search Recursively

Default Value

true

Allowable Values
- true
- false
Expression Language Scope

Not Supported

Sensitive

false

Required

true

Relationships

Name	Description
failure	A FlowFile will be routed here if there is an error fetching file metadata from the folder.
not.found	FlowFiles for which the specified Box folder was not found will be routed to this relationship.
success	A FlowFile containing the file metadata records will be routed to this relationship upon successful processing.

Writes Attributes

Name	Description
box.folder.id	The ID of the folder from which files were fetched
record.count	The number of records in the FlowFile
mime.type	The MIME Type specified by the Record Writer
error.code	The error code returned by Box
error.message	The error message returned by Box