Dropbox Egress Connector

Dropbox Transfer Operations

Version: 17.07

Supported Since: 17.07

These connector operations can be used to preform data transfers (uploads/downloads) to/from Dropbox. Transferred payloads may come from or go into the message payload as well as to external files on the filesystem.

These operations are compatible only with the Dropbox Egress Connector. Accordingly, they automatically become available when you have selected the Dropbox Connector dependency.

Among the parameters of each operation,

Upload File Connector Operation

Upload File

The Upload File operation can be used to upload a local file (or the current message payload) to Dropbox. It is compatible with the Dropbox API operation upload. Note that this operation may not support large uploads (> 150MB).

Parameters

Path * #

Basic

Absolute path of the Dropbox folder where the uploaded file should be placed

Use External File

Basic

If enabled, upload content will be retrieved from an external file (specified by External File Path) rather than from the message payload.

External File Path #

Basic

Available under the Use External File option, this specifies external file from which upload content is to be read.

File Name #

Basic

Determines the name to be used for the uploaded file. This must be specified unless Use External File is used, in which case the name defaults to that of the external file. This value always takes precedence over the actual file name, even when Use External File is enabled.

Auto-Rename

Advanced

Enabling this option allows Dropbox to automatically use a non-conflicting name (e.g. File (1)) for the uploaded file if the intended target file (e.g. File) already exists. Note that if this option is disabled, the operation would raise an error if a name conflict occurs during the upload.

Client-Modified Timestamp #

Advanced

Last-modified timestamp to be set on the newly uploaded file. If unspecified, no attempt will be made to submit a value during the API invocation, and the modification timestamp of the resulting file will be at the discretion of the Dropbox API.

Write Mode

Advanced

Mode (ADD vs OVERWRITE) to be used for the upload. Defaults to OVERWRITE.

Mute Notifications

Advanced

If enabled, no Dropbox client notifications would be generated for the upload.

Download Entity Connector Operation

Download Entity

The Download Entity operation can be used to download an entity (file/folder) from Dropbox. It is compatible with the Dropbox API operation download. Usually a folder would get downloaded as an archived (zipped) file.

This operation is unique in the sense that it generates two distinct responses, namely the Dropbox API response for the download request and the downloaded content itself. Both of these can be retained in the emitted message, the first as a scope variable and the latter as either the message payload or a (different) scope variable, by configuring the egress connector and the connector operation appropriately.

Parameters

Path * #

Basic

Absolute path of the entity that should be downloaded

Destination #

Basic

Local directory where the downloaded file should be saved (which will be created if it is nonexistent). If unspecified, will default to /tmp/dropbox.

Revision #

Advanced

Revision of the file that should be downloaded. A revision number would usually be obtained via other Dropbox operations such as List Revisions. If unspecified, the current version of the entity will be downloaded.

Download as Payload

Advanced

Enabling this will set the downloaded local file as the message payload. Note that this may cause conflicts with the Result as Payload option of the parent egress connector, and hence both cannot be enabled at the same time.

Download Variable Name

Advanced

Available when Download as Payload is disabled, this facilitates the assignment of the API response recieved for the download request, to a scope variable, for further processing.

In this topic
In this topic
Contact Us