BoxClientService
Implementation: JsonConfigBasedBoxClientService
Controller Service used to obtain a Box API connection. | Folder ID | box-folder-id | | | The ID of the folder where the file is uploaded. Please see Additional Details to obtain Folder ID. Supports Expression Language: true (will be evaluated using flow file attributes and variable registry) |
Subfolder Name | 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 Supports Expression Language: true (will be evaluated using flow file attributes and variable registry) |
Create Subfolder | create-folder | false | | Specifies whether to check if the subfolder exists and to automatically create it if it does not. Permission to list folders is required.
This Property is only considered if the [Subfolder Name] Property has a value specified. |
Filename | file-name | ${filename} | | The name of the file to upload to the specified Box folder. Supports Expression Language: true (will be evaluated using flow file attributes and variable registry) |
Conflict Resolution Strategy | conflict-resolution-strategy | fail | | Indicates what should happen when a file with the same name already exists in the specified Box folder. |
Chunked Upload Threshold | chunked-upload-threshold | 20 MB | | 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. |
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 |
State management:
This component does not store state.Restricted:
This component is not restricted.Input requirement:
This component requires an incoming relationship.System Resource Considerations:
None specified.See Also:
ListBoxFile, FetchBoxFile