Versions Compared

Key

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

...

On This Page

Table of Contents
minLevel1
maxLevel7

...

The Dropbox connector in DryvIQ allows you to analyze, migrate, copy, and synchronize files to your Dropbox account from cloud storage repositories and on-premise network file shares. The first step is to create the Dropbox connection by providing the connection information required for DryvIQ to connect to the server. The connector can be created using information refers to a standard Dropbox account or a Dropbox for Business account. However, when creating a connection using a Dropbox for Business account, you must use an Administrator account. Standard accounts will return an error from the Dropbox for Business platform. For more information on using a Dropbox for Business account, please refer to the Dropbox for Business connector page.

...

Select Connections > Add connection.

...

Select Dropbox as the platform on the Add connection modal.

...

Enter the connection information. Reference the table below for details about each field.

...

Select Sign in with Dropbox.

...

.

Creating a Connection

The following GET will return a target URL. Use this URL to log in to the Dropbox account

...

You will see a "Connection test succeeded" message on the Add connection modal. (If you don't see this message, repeat the sign in steps above.)

...

Select Done to finish creating the connection.

Add Connection Modal - Dropbox

...

...

Field

...

Description

...

Required

...

Display as

...

Enter the display name for the connection. If you will be creating multiple connections, ensure the name readily identifies the connection. The name displays in the application, and you can use it to search for the connection and filter lists.

If you do not add a display name, the connection will automatically be named using the account owner's name. For example, Dropbox (John Doe). If it will be useful for you to reference the connection by account, you should use the default name.

...

Optional

...

Platform API Client Credentials

...

Required

...

Use the system default client credentials

...

Select this option to use the default DryvIQ client application.

...

Use custom client credentials

...

Select this option to use custom client credentials provided by your administrator. When selected, two additional fields will be available to enter the credentials.  

...

Client ID

...

This field displays only when you select Use Custom Client Credentials. This value will be provided by your administrator.

...

Optional

...

Client Secret

...

This field displays only when you select Use Custom Client Credentials. This value will be provided by your administrator.

...

Optional

Dropbox - API Request Authorization

...

Connection Test Succeeded

...

Features and Limitations 

Platforms all have unique features and limitations. DryvIQ’s transfer engine manages these differences between platforms and allows you to configure actions based on Job Policies and Behaviors. Utilize the Platform Comparison tool to see how your integration platforms may interact regarding features and limitations.

Files and Folders

Below is list of Dropbox's supported and unsupported features as well as additional file/folder restrictions.

...

Supported (tick)

...

Unsupported (error)

...

Other Features/Limitations (warning)

...

Version preservation

(See How to Preserve Real Versions of Files below for additional details.)

...

Author/Owner preservation

...

Invalid characters

< > \\ / : ? * \ | ~

...

Timestamp preservation

...

File lock propagation

...

File size maximum: 50 GB or smaller
All file uploads must be smaller than the account storage space.

...

Mirror lock ownership

...

Path length maximum: n/a
(See Path Lengths below.)

...

Restricted types

...

Segment path length: 255
(See Path Lengths below.)

...

Account map

...

Maximum number of files per folder: 10,000

...

Group map

...

No trailing spaces after file extensions

...

Permission preservation

...

User impersonation

...

Metadata map

...

Tags map

Author Preservation

The Dropbox connector uses "per-request impersonation." This means DryvIQ makes requests to the platform on behalf of the account owner, not the administrator. Therefore, files created by other users will fail to upload unless the account owner mounts the shared parent folder into their Dropbox drive before uploading the file. (See https://help.dropbox.com/files-folders/add-shared-folder  for more information.) Failed uploads will be logged with a message similar to the following example: "[PermissionFailure] The account 'Joe Smith' is not authorized to perform the requested operation."

Dropbox Paper

DryvIQ does not support Dropbox paper. Dropbox Paper is a separate work space that stores Paper documents in your account on http://paper.dropbox.com . DryvIQ doesn't support have access to these documents as part of your Dropbox connection. 

How to Preserve Real Versions of Files

The Dropbox platform treats content version history differently than other cloud platforms, with each native move and rename tracked as a new version. In order to only transfer true version history, enable the Scripting option on step 6 during job creation and copy the following JSON into the scripting box:

Code Block
{
"transfer": {
"versioning": {
            "preserve": "native",
            "select": "published"
        }
    }
}

Image Removed

Info

💡  For more information about how to use Advanced Scripting, refer to the Advanced Scripting | Additional Configuration Options page.

Version Limits

While Dropbox allows you to store unlimited versions, the platform restricts version downloads to 100. This means only the most recent 100 versions for a given file will be transferred to the destination. Refer to the Dropbox API Documentation for more information.  You can also find additional information in the Dropbox Forum.

Path Lengths

Dropbox does not impose restrictions for the total path length.

Segment path lengths are limited to 255 character. Segments are delimited by a forward slash (/). For example, <max 255 characters>/<max 255 characters>.

...

to authenticate and create the connection.  

Code Block
GET {{url}}v1/connections/platforms/dropbox/new

Creating a Job

The sample code below shows how to create a job for a Dropbox connection.

Code Block
{
    "name":"Simple Job",
    "kind": "transfer",
    "transfer": {
      "transfer_type": "copy",
        "source": {
            "connection": { "id": "{{Dropbox_StandardAccount_ConnectionID}}" },
            "target": {
                "path": "/sourceFolder"
            }
        },
        "destination": {
            "connection": { "id": "{{OneDriveForBusiness_connection_destinationID}}" },
            "target": {
                "path": "/Documents/destinationFolder"
            }
        },
        "simulation_mode": false
    },
    "schedule": {
        "mode": "manual"
    },
    "stop_policy": {
        "on_success": 5,
        "on_failure": 5,
        "on_execute": 25
    },
    "category": {
      "name": "Report Category {Name}"
    }
}

...