DocumentationWorkfrontWorkfront Guide

Dropbox modules

Last update: Thu Nov 21 2024 00:00:00 GMT+0000 (Coordinated Universal Time)

CREATED FOR:

  • User

In an Adobe Workfront Fusion scenario, you can automate workflows that use Dropbox or Dropbox Business, as well as connect it to multiple third-party applications and services.This allows you to automate activities such as monitoring, searching, retrieving, listing, creating, and editing files and folders in your Dropbox.

If you need instructions on creating a scenario, see Create a scenario in Adobe Workfront Fusion.

For information about modules, see Modules in Adobe Workfront Fusion.

Access requirements

You must have the following access to use the functionality in this article:

Adobe Workfront plan*
Pro or higher
Adobe Workfront license*
Plan, Work
Adobe Workfront Fusion license**

Current license requirement: No Workfront Fusion license requirement.

Or

Legacy license requirement: Workfront Fusion for Work Automation and Integration

Product

Current product requirement: If you have the Select or Prime Adobe Workfront plan, your organization must purchase Adobe Workfront Fusion as well as Adobe Workfront to use functionality described in this article. Workfront Fusion is included in the Ultimate Workfront plan.

Or

Legacy product requirement: Your organization must purchase Adobe Workfront Fusion as well as Adobe Workfront to use functionality described in this article.

To find out what plan, license type, or access you have, contact your Workfront administrator.

For information on Adobe Workfront Fusion licenses, see Adobe Workfront Fusion licenses.

Prerequisites

  • To use Dropbox modules, you must have a Dropbox account.
IMPORTANT
Dropbox must approve applications with more than 50 users.
For more information, search for “Production approval” in the Dropbox developer guide.

Dropbox API information

The Dropbox connector uses the following:

Base URL
https://api.dropboxapi.com/2
API version
2
API tag

  • Dropbox

    v5.3.9

  • Dropbox Business

    v1.0.12

Create a connection to Dropbox

To create a connection for your Dropbox modules:

  1. Click Add next to the Connection box.

  2. Fill in the following fields:

    table 0-row-2 1-row-2 2-row-2 3-row-2 4-row-2 5-row-2 layout-auto html-authored no-header
    Connection name Enter a name for this connection.
    Environment Select whether this connection is for a production or non-production environment.
    Type Select whether you are connecting to a service account or a personal account.
    Client ID Enter your Dropbox Client ID.
    Client Secret Enter your Dropbox Client Secret.
    Account Type Select whether you are connecting to a personal Dropbox account or a business (Dropbox Business) account.

  3. Click Continue to save the connection and return to the module.## Dropbox modules and their fields

Dropbox modules and their fields

When you configure Dropbox modules, Workfront Fusion displays the fields listed below. Along with these, additional Dropbox fields might display, depending on factors such as your access level in the app or service. A bolded title in a module indicates a required field.

If you see the map button above a field or function, you can use it to set variables and functions for that field. For more information, see Map information from one module to another in Adobe Workfront Fusion.

Trigger modules

Watch Files

This Trigger type module returns file details when the file in a specified folder is modified.

Connection
For instructions about connecting your Dropbox account to Workfront Fusion, see Create a connection to Dropbox in this article.
Folder
Select the folder you want to watch for changes.
Watch also subfolders
Enable this option to also monitor subfolders in the selected folder for modified files.
Limit
Enter or map the maximum number of records you want the module to return during each scenario execution cycle.

Modules for getting Dropbox files and folders

Search Files/Folders

This search module looks for records in an object in Dropbox that match the search query you specify.

You can map this information in subsequent modules in the scenario.

Connection
For instructions about connecting your Dropbox account to Workfront Fusion, see Create a connection to Dropbox in this article.
Search
Enter the search term.
Folder
Select the folder you want to search. This module searches the entire Dropbox if you do not select a folder.
File Status
Select the file status to restrict the search to the selected file status.
File Categories
Select the file categories to restrict the search to the selected categories.
File extensions
Choose the file extensions you want to search for.
Limit
Enter or map the maximum number of records you want the module to return during each scenario execution cycle.

Download a File

This action module downloads a file from a folder.

You specify the file and its location.

The module returns the ID of the file and any associated fields, along with any custom fields and values that the connection accesses. You can map this information in subsequent modules in the scenario.

NOTE
This module is useful for providing files to subsequent modules.

When you are configuring this module, the following fields display.

Connection
For instructions about connecting your Dropbox account to Workfront Fusion, see Create a connection to Dropbox in this article.
Way of selecting files
Select whether you want to map the file path or select the file manually.
File Path / File

File Path

Enter or map the target path to the file.

File

Select the file from the menu.

Get a Folder Metadata

This action module retrieves shared folder details.

You specify the ID of the folder.

The module returns the ID of the folder and any associated fields, along with any custom fields and values that the connection accesses. You can map this information in subsequent modules in the scenario.

When you are configuring this module, the following fields display.

Connection
For instructions about connecting your Dropbox account to Workfront Fusion, see Create a connection to Dropbox in this article.
Shared Folder ID
Enter or map the ID of the folder you want to retrieve details about.

List All Files/Subfolders in a Folder

This action module lists files or folders in a particular folder.

You specify the ID of the folder.

The module returns the IDs of the files or foldes and any associated fields, along with any custom fields and values that the connection accesses. You can map this information in subsequent modules in the scenario.

When you are configuring this module, the following fields display.

Connection
For instructions about connecting your Dropbox account to Workfront Fusion, see Create a connection to Dropbox in this article.
List
Select whether you want to retrieve files or folders.
Show Only Downloadable Files
Enable this option to return only downloadable files. Some types of files, such as Google Docs, are not downloadable.
Folder
Enter or map the folder you want to retrieve files or folders from.
Limit
Enter or map the maximum number of records you want the module to list during each scenario execution cycle.

List File Revisions

This action module retrieves all file revisions (a version history) of a particular file.
You specify the ID of the file.

The module returns any standard fields associated with the record, along with any custom fields and values that the connection accesses. You can map this information in subsequent modules in the scenario.

When you are configuring this module, the following fields display.

Connection
For instructions about connecting your Dropbox account to Workfront Fusion, see Create a connection to Dropbox in this article.
Way of selecting files
Select whether you want to map the file path or select the file manually.
File Path / File

File Path

Enter or map the target path to the file.

File

Select the file from the menu.

Limit
Enter or map the maximum number of records you want the module to list during each scenario execution cycle.

Modules for creating and editing Dropbox files and folders

Upload a File

This action module uploads a file to a folder.

You specify information such as the location for the file, the file you want to upload, and an optional new name for the file.

The module returns the ID of the file and any associated fields, along with any custom fields and values that the connection accesses. You can map this information in subsequent modules in the scenario.

When you are configuring this module, the following fields display.

Connection
For instructions about connecting your Dropbox account to Workfront Fusion, see Create a connection to Dropbox in this article.
Folder
Select the folder of your Dropbox you want to upload the file to.
Source File

Enter or map the file you want to add to the Dropbox folder selected above.

File name

Enter or map the file name, including the file extension.

File data

Enter or map the file data (from previous module such as Google Drive >Get a File).

Note: The maximum size of the uploaded file is 150 MB.

Overwrite an existing file
Enable this option to replace the existing file with the new file. If this option is left disabled, the uploaded file is renamed.

Create a Folder

This action module creates a new folder.

You specify the path and a name for the folder.

The module returns the ID of the folder and any associated fields, along with any custom fields and values that the connection accesses. You can map this information in subsequent modules in the scenario.

When you are configuring this module, the following fields display.

Connection
For instructions about connecting your Dropbox account to Workfront Fusion, see Create a connection to Dropbox in this article.
Folder Name
Enter the name for the new folder.
Folder

Enter or map the path where you want to create a new folder.

Note:

If you are using a Dropbox Business account (with team spaces), you must remove the slash /, or do not click Click here to choose folder to create a team folder in the root.

If the slash is not removed an error [409] path/malformed_path/.. is returned.

Auto rename
Enable this option to rename the new folder, if a folder with the same name already exists in the target location.

Create/Overwrite a Text File

This action module creates a DOC file or overwrites the content of an existing one.

You specify the source file and the folder.

The module returns the ID of the folder and any associated fields, along with any custom fields and values that the connection accesses. You can map this information in subsequent modules in the scenario.

When you are configuring this module, the following fields display.

Connection
For instructions about connecting your Dropbox account to Workfront Fusion, see Create a connection to Dropbox in this article.
Select to
Select whether you want to create or overwrite a DOC file.
Folder
Select the target location where you want to create a file.
Source File

Enter or map the file you want to add to the Dropbox folder.

File name

Enter the file name for the new DOC file (without an extension).

File Content

Enter the text content of the DOC file.

This action module creates a public link to a file.

You specify the file and information about the link.

The module returns the ID of the link and any associated fields, along with any custom fields and values that the connection accesses. You can map this information in subsequent modules in the scenario.

When you are configuring this module, the following fields display.

Connection
For instructions about connecting your Dropbox account to Workfront Fusion, see Create a connection to Dropbox in this article.
Way of selecting files
Select whether you want to map or enter the file path, or select the file manually.
File Path / File

File Path

Enter or map the target path to the file.

File

Select the file from the menu.

Requested Visibility

Select whether the link is public, for team, or password restricted.

Note: Team only and Access with password options are only available to users who have Dropbox Pro or higher version.

Link's Expiration Date

Enter the date and time when the link will expire and will be no longer accessible. If this field is left empty, the link will not expire. For a list of supported date and time formats, see Type coercion in Adobe Workfront Fusion.

Note: Team only and Access with password options are only available to users who have Dropbox Pro or higher versions.

Link's Access Level

Set the permission for the link recipient.

Viewer Users who use the link can view and comment on the content.

Editor Users who use the link can edit, view, and comment on the content.

Max Users who use the link receive the maximum access level you can set the link to.

Restore a File

This action module restores a previous version of a file.

You specify the file and the number of the revision you want.

The module returns the ID of the version and any associated fields, along with any custom fields and values that the connection accesses. You can map this information in subsequent modules in the scenario.

When you are configuring this module, the following fields display.

Connection
For instructions about connecting your Dropbox account to Workfront Fusion, see Create a connection to Dropbox in this article.
Way of selecting files
Select whether you want to map or enter the file path, or select the file manually.
File Path / File

File Path

Enter or map the target path to the file.

File

Select the file from the menu.

Revision
Enter or map the revision number of the revision you want to restore.

Move a File/Folder

This action module moves a file or folder to a different location.

You specify the file or folder and how and where you ant to move it.

The module returns the ID of the file or folder and any associated fields, along with any custom fields and values that the connection accesses. You can map this information in subsequent modules in the scenario.

When you are configuring this module, the following fields display.

Connection
For instructions about connecting your Dropbox account to Workfront Fusion, see Create a connection to Dropbox in this article.
Way of selecting files
Select whether you want to map or enter the file path, or select the file manually.
File/Folder Path / File/Folder

File/Folder Path

Enter or map the target path to the file or folder.

File/Folder

Select the file or folder from the menu.

To Folder
Enter or map the target location for the file or folder.
New Name
Enter the new name for the file or folder in the new location.
Auto Rename
Enable this option to ensure that if a file or folder with the same name exists, the module renames the new file or folder by adding (NUMBER) after the file or folder name. Otherwise the file or folder in the target location is overwritten.
Allow ownership transfer
Enable this option to allow moves by owner, even if it would result in an ownership transfer for the content being moved.

Rename a File/Folder

This action module renames a file or folder.

You specify the file or folder and the new name.

The module returns the ID of the file or folder and any associated fields, along with any custom fields and values that the connection accesses. You can map this information in subsequent modules in the scenario.

When you are configuring this module, the following fields display.

Connection
For instructions about connecting your Dropbox account to Workfront Fusion, see Create a connection to Dropbox in this article.
Way of selecting files
Select whether you want to map or enter the file path, or select the file manually.
File/Folder Path / File/Folder

File/Folder Path

Enter or map the target path to the file or folder.

File/Folder

Select the file or folder from the menu.

Rename
Enter the target name for the file, including the file extension.

Delete a File/Folder

This action module deletes a file or folder.

You specify the file or folder.

The module returns the ID of the record and any associated fields, along with any custom fields and values that the connection accesses. You can map this information in subsequent modules in the scenario.

When you are configuring this module, the following fields display.

Connection
For instructions about connecting your Dropbox account to Workfront Fusion, see Create a connection to Dropbox in this article.
Way of selecting files
Select whether you want to map or enter the file path, or select the file manually.
File Path / File

File Path

Enter or map the target path to the file.

File

Select the file from the menu.

Other modules

Make an API Call

This action module lets you make a custom authenticated call to the Dropbox API. This way, you can create a data flow automation that can’t be accomplished by the other Dropbox modules.

When you are configuring this module, the following fields display.

Connection
For instructions about connecting your Dropbox account to Workfront Fusion, see Create a connection to Dropbox in this article.
URL

Enter a path relative to Enter a path relative to https://api.dropboxapi.com. For example, /2/files/list_folder

Note: For the list of available endpoints, see the Dropbox API v2 Documentation.

Method
Select the HTTP request method you need to configure the API call. For more information, see HTTP request methods in Adobe Workfront Fusion.
Headers
Enter the desired request headers. Workfront Fusion adds authorization headers automatically.
Query String
Enter the request query string.
Body

Add the body content for the API call in the form of a standard JSON object.

Note:

When using conditional statements such as if in your JSON, put the quotation marks outside of the conditional statement.

INFO
Example: The following API call returns the first 10 files from the /Text files folder in your Dropbox account:
URL: /2/files/list_folder
Body:
{
"path": "/Text files",
"limit": 10,
"recursive": false,
"include_deleted": false
}
Matches of the search can be found in the module’s Output under Bundle > Body > entries.
In our example, 10 tickets were returned:

Common problems

Unable to upload or update a file

There are several situations when uploading or updating a file fails:

  • The uploaded file is too big and exceeds the maximum file size allowed for your Dropbox plan, or you have used all of your Dropbox account’s storage quota. You must delete existing files from your Dropbox account or upgrade your plan.
  • The previously selected folder, to which the file is being uploaded to, no longer exists. The scenario stops and you must select the target folder again.

The URL returned by the Dropbox >Create a shared link does not link directly to an image, but to a Dropbox page. To force the image to download, replace the trailing ?dl=0 with ?dl=1. To force the image to render (for example, in a Web browser or in Facebook Messenger), append &raw=1 to the URL.

If you need to get the direct or raw link of your image for your website or for other Workfront Fusion modules, you must modify the initial shared URL in the following way:

Original URL:

https://www.dropbox.com/s/ia8qtvs20f3a5ux/Screen%20Shot%202018-10-15%20at%204.21.11%20PM.png?dl=0

  1. Replace www with dl.
  2. Remove ?dl=0.

Final URL:

https://dl.dropbox.com/s/ia8qtvs20f3a5ux/Screen%20Shot%202018-10-15%20at%204.21.11%20PM.png

To automatically modify the URL, you can use the replace() function twice:

  • Replace www with dl

  • And to remove ?dl=0

To do it in one step, combine these functions:

You can also copy it and paste it into the field. Replace 1.url with the URL.

{{replace(replace(1.url; "?dl=0"; ""); "www"; "dl")}}
recommendation-more-help
5f00cc6b-2202-40d6-bcd0-3ee0c2316b43