...
On This Page
| Table of Contents |
|---|
...
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 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 standard Dropbox account, please refer to the Dropbox connector page.
Create Connection | User Interface
Select Connections > Add connection.
Select Dropbox for Business 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 for Business.
On the Dropbox API Request Authorization modal, enter the Email and Password required to log in to the account and select Sign In. Only an Administrator account can be used for Dropbox for Business. Standard accounts will return an error from the Dropbox for Business platform.
Select Allow when prompted to authorize the connection.
You will see a "Connection test succeeded" message on the Add connection modal. (If you don't see this message, repeat the sign in and authorization steps above.)
Select Done to finish creating the connection.
Add Connection Modal - Dropbox for Business
...
...
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, "Dropbox for Business." DryvIQ recommends that you edit the name to more readily identify the connection.
...
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.
...
Required when using custom credentials
...
Client Secret
...
This field displays only when you select Use custom client credentials. This value will be provided by your administrator.
...
Required when using custom credentials
Dropbox API Request Authorization modal
...
Allow Access to Dropbox
...
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 
...
Unsupported 
...
Other Features/Limitations 
...
(See Versioning below.)
...
...
< > \\ / : ? * \ | ~
...
...
...
File size maximum: 50 GB or smaller
All file uploads must be smaller than the account storage space.
...
...
...
Path length maximum: n/a
(See Path Lengths below.)
...
...
...
Segment path length: 255
(See Path Lengths below.)
...
...
Maximum number of files per folder: 10,000
...
...
No trailing spaces after file extensions
...
...
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."
Business Team Folders
Team folders transfer automatically with any transfer job; however, Team and Shared folders must first be mounted in Dropbox (Dropbox for Business API only surfaces mounted Team and Shared folders). If you include Job Filters | Filter Shared Content, Team Folders will not be transferred. The Dropbox for Business connector creates shared user folders by default. To create shared folders in a Team Folder, the root Team Folder must be created in the Dropbox UI and selected as the root of the job. Shared folders that are created in a Team Folder support permission disinheritance. Shared folders created in a user folder do not support disinheritance and will log a warning.
Character Sanitization
DryvIQ will sanitize file names that contain combined Unicode characters by replacing the characters with an underscore (_).
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.
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>.
Versioning
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"
}
}
} |
| 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.
| Info |
|---|
If you want to transfer just teams folders, you can use the Dropbox for Business Teams Folders connector to create a connection that will transfer only teams folders. |
Create Connection | REST API
Creating a Connection
Create a New Dropbox for Business Connection
The following GET will return a target URL. Use this URL to log in to the Dropbox for Business account to authenticate and create the connection. Make sure you connect using an Administrator account.
| Code Block |
|---|
GET {{url}}v1/connections/platforms/dfb/new |
Create a New Dropbox for Business Connection Using Custom Credentials
Create a new connection using custom credentials with the example call below. Replace the name, client_id, and client_secret with information relevant to your connection.
| Code Block |
|---|
{
"name": "Dropbox for Business",
"platform": {
"id": "dfb"
},
"auth": {
"client_id": "{{clientID}}",
"client_secret": "{{clientSecret}}"
}
}
|
Dropbox for Business with Single Sign-On (SSO)
Create a new connection using single sign-on with the example call below. You will need to obtain the applicable access token for your Dropbox for Business account.
| Code Block |
|---|
{
"name": "Dropbox for Business",
"platform": {
"id": "dfb"
},
"auth": {
"access_token": "{{access_token}}"
}
} |
...
Creating a Job
Create a simple transfer job using the example call below. Replace the information with information relevant to your job and connectors.
...
| Code Block |
|---|
{
"name":"Simple Job",
"kind": "transfer",
"transfer": {
"transfer_type": "copy",
"source": {
"connection": { "id": "{{DropboxForBusiness_Admin_ConnectionID}}" },
"impersonate_as": { "email": "user@company.com" },
"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}"
}
} |
Transferring Dropbox for Business Team Folders
Team folders will transfer automatically with any transfer job; however, Team and Shared folders must first be mounted in Dropbox (Dropbox for Business API only surfaces mounted Team and Shared folders)
If you include Job Filters | Filter Shared Content, Team Folders will not be transferred.
The Dropbox for Business connector creates shared user folders by default. To create shared folders in a Team Folder, the root Team Folder must be created in the Dropbox UI and selected as the root of the job.
Shared folders that are created in a Team Folder support permission disinheritance. Shared folders created in a user folder do not support disinheritance and will log a warning.
| Info |
|---|
| If you want to transfer just teams folders, you can use the Dropbox for Business Teams Folders connector to create a connection that will transfer only teams folders. |