On this Page
| Table of Contents | ||||
|---|---|---|---|---|
|
Overview
Snap type: | Read | |||||||||||||
|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|
Description: | This Snap reads a file from Box as binary data.
| |||||||||||||
| Prerequisites: | [None] | |||||||||||||
| Support and limitations: | Works in Ultra Task Pipelines. | |||||||||||||
| Account: | This Snap uses account references created on the Accounts page of SnapLogic Manager to handle access to this endpoint. See Configuring Box Accounts for information on setting up this type of account. | |||||||||||||
| Views: |
| |||||||||||||
Settings | ||||||||||||||
Label | Required. The 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. | |||||||||||||
File ID | Required. Specifies the Box ID for a file to be read from Box.
Example: 67970216081 or $FileID (Expression property) Format: String Default: None | |||||||||||||
File Path | Specifies the file path of the file to be read. The file path is used if the File ID is not supplied.
Example: folder1/folder2/file1.pdf Format: String Default: None | |||||||||||||
Maximum concurrency | Required. Specifies 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. Example: 5 Format: Integer Default: 1 | |||||||||||||
| Number of retries | Enter the integer value to specify Specify the number of attempts the snap should make to perform the selected operation Snap must make in case of connection failure or timeout. Minimum value: 0 Default value: 0 | |||||||||||||
| Retry interval (seconds) | Enter the time interval in seconds between retry attempts. Example: 3 Specify the minimum number of seconds the Snap must wait before each retry attempt. Minimum value: 1 Default value: 5: 1
| |||||||||||||
|
| |||||||||||||
Multiexcerpt include macro name Temporary Files page Join
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.
| Insert excerpt | ||||||
|---|---|---|---|---|---|---|
|