Versions Compared

Old Version 21

changes.mady.by.user Kalpana Malladi

Saved on

compared with

New Version 22

changes.mady.by.user Kalpana Malladi

Saved on

Key

  • This line was added.
  • This line was removed.
  • Formatting was changed.

On In this Pagearticle

Table of Contents
maxLevel2
excludeOlder Versions|Additional Resources|Related Links|Related Information

Overview

Snap type:

Read

Description:

This Snap reads Prerequisites:

[None]

Support and limitations:Works in 

You can use this Snap to read a file from Box as binary data.

  • Expected upstream Snaps: File reader followed by any file parser followed by  Structure.
  • Expected downstream Snaps: File Writer.
  • Expected input: File ID and File path.
  • Expected output: Reads the file to the specified file path.

Image Added

Prerequisites

None.

Support for Ultra Pipelines

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:
InputThis Snap has at most one document input view.
OutputThis Snap has exactly one document output view.
ErrorThis Snap has at most one document error view and produces zero or more documents in the view.

Settings

Label

Required. The

 

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

Required. Specifies Specifies Required. Specifies retries interval Anaplan Read
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

Pipeline. 

Default Value: Box Read
Example: Box Read

File ID

*



N/A

Specify the Box ID for a file to be read from Box.

Note
Due to the design of Box API, reading Box files by ID is much more efficient than by using the file path, and hence we recommend you to use File ID wherever possible. 

Format: String 

Default: None 
Example: 67970216081  67970216081 or $FileID (Expression property)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 is not supplied. 

Note

The disallowed These characters are (\/*?":<>|

Example: folder1/folder2/file1.pdf

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


Note

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.

Multiexcerpt include macro
nameSnap Execution
pageSOAP Execute

Multiexcerpt include macro
nameSnap_Execution_Introduced
page


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

Multiexcerpt include macro
nameTemporary Files
pageJoin

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
Box Snap Pack
Box Snap Pack
nopaneltrue