Box Read
- Kalpana Malladi
- Aparna Tayi (Unlicensed)
- Mohammed Iqbal
In this article
Overview
You can use this Snap to read a file from Box as binary data.
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 ID and File path. |
| Output | Binary |
|
| Reads the file to the specified file path. |
Snap Settings
| Field Name | Field Dependency | Description | |
|---|---|---|---|
Label* | N/A | Specify a name for 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 Read | |
File ID* | N/A | Specify the Box ID for a file to be read from Box. Due to the design of Box API, reading Box files by ID is efficient than by using the file path, hence we recommend you to use File ID wherever possible. Format: String Default: None | |
File Path | N/A | Specify the file path of the file to be read. The file path is used if you do not provide the File ID. These characters are (\/*?":<>|) not supported. Format: String Default: None | |
Maximum concurrency* | N/A | Specify the maximum number of files which can be downloaded concurrently. If the value is more than 10, the Snap will set the value to 10 internally without throwing an exception. Format: Integer Default: 1 | |
| Number of Retries | N/A | Specify the number of attempts the Snap must make in case of connection failure or timeout. 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. Minimum value: 1 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:
| |
Temporary Files
During execution, data processing on Snaplex nodes occurs principally in-memory as streaming and is unencrypted. When larger datasets are processed that exceeds the available compute memory, the Snap writes Pipeline data to local storage as unencrypted to optimize the performance. These temporary files are deleted when the Snap/Pipeline execution completes. You can configure the temporary data's location in the Global properties table of the Snaplex's node properties, which can also help avoid Pipeline errors due to the unavailability of space. For more information, see Temporary Folder in Configuration Options.Example
To read a file, specify the file path of the located file in Box. You can obtain the file path from the Directory Browser Snap in the Box Snap Pack.