PutBoxFile

PutBoxFile 2.0.0

Bundle: org.apache.nifi | nifi-box-nar
Description: Puts content to a Box folder.
Tags: box, put, 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.JsonConfigBasedBoxClientService

Expression Language Scope

Not Supported

Sensitive

false

Required

true
Folder ID
The ID of the folder where the file is uploaded. Please see Additional Details to obtain Folder ID.

Display Name

Folder ID

Description

The ID of the folder where the file is uploaded. Please see Additional Details to obtain Folder ID.

API Name

box-folder-id

Expression Language Scope

Environment variables and FlowFile Attributes

Sensitive

false

Required

true
Chunked Upload Threshold
The maximum size of the content which is uploaded at once. FlowFiles larger than this threshold are uploaded in chunks. Chunked upload is allowed for files larger than 20 MB. It is recommended to use chunked upload for files exceeding 50 MB.

Display Name

Chunked Upload Threshold

Description

The maximum size of the content which is uploaded at once. FlowFiles larger than this threshold are uploaded in chunks. Chunked upload is allowed for files larger than 20 MB. It is recommended to use chunked upload for files exceeding 50 MB.

API Name

chunked-upload-threshold

Default Value

20 MB

Expression Language Scope

Not Supported

Sensitive

false

Required

false
Conflict Resolution Strategy
Indicates what should happen when a file with the same name already exists in the specified Box folder.
Display Name

Conflict Resolution Strategy

Description

Indicates what should happen when a file with the same name already exists in the specified Box folder.

API Name

conflict-resolution-strategy

Default Value

fail

Allowable Values
- fail
- ignore
- replace
Expression Language Scope

Not Supported

Sensitive

false

Required

true
Create Subfolder
Specifies whether to check if the subfolder exists and to automatically create it if it does not. Permission to list folders is required.
Display Name

Create Subfolder

Description

Specifies whether to check if the subfolder exists and to automatically create it if it does not. Permission to list folders is required.

API Name

create-folder

Default Value

false

Allowable Values
- true
- false
Expression Language Scope

Not Supported

Sensitive

false

Required

true

Dependencies
- Subfolder Name is set to any value specified
Filename
The name of the file to upload to the specified Box folder.

Display Name

Filename

Description

The name of the file to upload to the specified Box folder.

API Name

file-name

Default Value

${filename}

Expression Language Scope

Environment variables and FlowFile Attributes

Sensitive

false

Required

true
Subfolder Name
The name (path) of the subfolder where files are uploaded. The subfolder name is relative to the folder specified by 'Folder ID'. Example: subFolder, subFolder1/subfolder2

Display Name

Subfolder Name

Description

The name (path) of the subfolder where files are uploaded. The subfolder name is relative to the folder specified by 'Folder ID'. Example: subFolder, subFolder1/subfolder2

API Name

subfolder-name

Expression Language Scope

Environment variables and FlowFile Attributes

Sensitive

false

Required

false

Relationships

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

Reads Attributes

Name	Description
filename	Uses the FlowFile's filename as the filename for the Box object.

Writes Attributes

Name	Description
box.id	The id of the file
filename	The name of the file
path	The folder path where the file is located
box.size	The size of the file
box.timestamp	The last modified time of the file
error.code	The error code returned by Box
error.message	The error message returned by Box