Box Write
On this Page
Overview
You can use this Snap to write binary data to a file on Box.
Prerequisites
None.
Support for Ultra Pipelines
Works in Ultra Task Pipelines.
Limitations
None.
Snap Input and Output
Input/Output | Type of View | Number of Views | Examples of Upstream and Downstream Snaps | Description |
|---|---|---|---|---|
Input | Document |
|
| File path. |
Output | Binary |
|
| Writes the file to the specified file path. |
Snap Settings
Field Name | Field Dependency | Description |
|
|---|---|---|---|
Label* | N/A | Specify the name of the Snap. You can modify this to be more specific, especially if you have more than one of the same Snap in your Pipeline. Default Value: Box Write | |
File path*
| N/A | Specify the destination path of the file to be written. Default Value: None | |
Write empty file | N/A | Select this checkbox to write an empty file when the incoming binary document has empty data, in which case a zero bye file is written to the output. If there is no incoming document at the input view of the Snap, no file is written regardless of the value of the property. Default Value: Selected | |
Action
| N/A | Select the action to perform if the file already exists. The available options are:
Default value: Append | |
Number of Retries | N/A | Specify the number of attempts the Snap must make in case of connection failure or timeout. If the retry value is more than zero, the Snap first stores the input data in a temporary local file before writing to the target Box file. Ensure that the local drive has sufficient free disk space as large as the expected target file size. Minimum value: 0 Default value: 0 | |
Retry Interval (seconds) | N/A | Specify the minimum number of seconds the Snap must wait before each retry attempt. Default value: 1 For existing Pipelines which have the Enable Staging (deprecated field) checkbox selected, this Snap retries the connection once even if the Number of retries is zero. | |
Snap Execution | N/A | Select one of the three modes in which the Snap executes. Available options are:
| |
Example
To write a file to Box, send a file from the File Reader Snap to the Box Write Snap where the file path is set to the destination path. If the Action property is set to Overwrite, it overwrites the existing file. If the Action property is set to Append, it appends the content to the existing file.