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
InputDocument
  • Min:0
  • Max:1
  • File Reader
  • File Parser
File ID and File path.
OutputBinary
  • Min:1
  • Max:1
  • File Writer
Reads the file to the specified file path.

Snap Settings

Field NameField DependencyDescription

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
Example: 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 
Example: 67970216081 or $FileID (Expression property)

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
Example: folder1/folder2/file1.pdf

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
Example: 5

Number of RetriesN/A

Specify the number of attempts the Snap must make in case of connection failure or timeout.

Minimum value: 0

Default value: 0
Example: 3

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
Example: 3


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:

  • Validate & Execute: Performs limited execution of the Snap, and generates a data preview during Pipeline validation. Subsequently, performs full execution of the Snap (unlimited records) during Pipeline runtime.

  • Execute only: Performs full execution of the Snap during Pipeline execution without generating preview data.

  • Disabled: Disables the Snap and all Snaps that are downstream from it.

    Default Value: Execute only
    Example: Validate & Execute

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.