Dropbox Read

This Snap reads files from Dropbox cloud storage and outputs the file content as binary data.

Supported Accounts

Prerequisites

None.

Limitations and known issues

None.

Snap views

Type Description Examples of upstream and downstream Snaps
Input

This Snap has at most one document input view. If an input view is defined, the Snap reads the file path from the incoming document.

If no input view is connected, the file path must be specified in the Snap settings.
Output

This Snap has exactly one binary output view. The Snap outputs the file content as binary data along with metadata about the file.
Learn more about Error handling.

Snap settings

Note: Learn about the common controls in the Snap settings dialog.
Field/Field set Description

Label

String

 Required.Specify a unique name for the Snap. Modify this to be more appropriate, especially if there are more than one of the same Snap in the pipeline.

Default value: Dropbox Read
File ID

String/Expression

 Specify the Dropbox file ID of the file to read. Use this field as an alternative to File path when you want to read a file by its immutable identifier, which does not change when the file is moved or renamed. If you specify both fields, the Snap uses the File ID.

Example: id:a4ayc_80_OEAAAAAAAAAYa

Default value: None
File path

String/Expression

 The path to the file in Dropbox to read. The path should start with a forward slash (/). This field is required unless you specify a File ID.

Example: /Documents/report.pdf

Default value: None
Maximum concurrency

Integer

 Specify the maximum number of files that the Snap reads in parallel. Increase this value to improve throughput when reading many files, keeping in mind the Dropbox API rate limits for your account.

Example: 5

Default value: 1
Paper export format

Dropdown list

 Select the format in which the Snap exports Dropbox Paper documents. This field applies only when the file being read is a Dropbox Paper document. The available options are:
  • HTML: Export the Paper document as HTML.
  • Markdown: Export the Paper document as Markdown.

Default value: HTML
Number of retries

Integer/Expression

 Specify the maximum number of retry attempts the Snap must make in case of a network failure.

Example: 3

Default value: 0
Retry interval (seconds)

Integer/Expression

 Specify the time interval between two successive retry requests. A retry happens only when the previous attempt resulted in an exception.

Example: 3

Default value: 1
Snap execution

Dropdown list
Choose 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: Validate & Execute