Product DocsMenu

Dropbox for Business Connector Deployment Overview

The following procedure outlines the steps needed to deploy the Dropbox for Business connector. The steps indicate the order in which you must perform configuration tasks on both the Dropbox and Coveo servers.

To deploy the Dropbox for Business connector

  1. Validate that your environment meets the requirements (see Dropbox for Business Connector Requirements).

  2. On the Dropbox server, authorize the Coveo connector to access the Dropbox of your team members (see Authorizing the Coveo Connector to Access the Dropbox of Your Team Members).

  3. On the Coveo server, in the Coveo Administration Tool:

    1. CES 7.0.8047+ (December 2015) Create a user identity

      The connector needs to know the access token that you just obtained performing the OAuth 2.0 protocol to connect to your team members Dropbox. You thus need to create a user identity that you will later associate to your Dropbox for Business source (see Adding a User Identity):

      1. In the User box, enter a value of your choice (i.e., Dropbox for Business).

        Note: The User parameter is not used, but cannot be left empty.

      2. In the Password box, enter the OAuth 2.0 access token you previously obtained (see Authorizing the Coveo Connector to Access the Dropbox of Your Team Members).

        Note: The access token grants the connector access to your team members Dropbox without exposing the administrator’s real credentials.

    2. Optionally create security providers

      When you want to index Dropbox for Business permissions, you must create two security providers to get Dropbox item permissions and resolve and expand groups.

      In Dropbox for Business, users are identified by their email addresses. Consequently, permissions returned by the Dropbox for Business security provider for each document are email addresses. The Dropbox for Business security provider then requires another security provider to uniquely identify users from their email addresses.

      1. Start by selecting or creating a security provider that the Dropbox for Business security provider will use to resolve and expand groups. The security provider type to use depends on how users are authenticated when they access the search interface:

        Note: You may require to also use a REGEX Transform Member Name security provider in between the two following security providers to map member types. Contact Coveo Support for assistance.

        • When authenticated with their email address, use an Email security provider (see Configuring an Email Security Provider).

        • When authenticated with an Active Directory account, use an LDAP Lookup security provider that maps LDAP identities to Active Directory ones. Contact Coveo Support for assistance.

          Note: This chain of security providers is required since the Dropbox security provider does not directly support to be chained with an Active Directory security provider.

      2. Then create a Dropbox for Business security provider that the connector uses to resolve indexed permissions (see Configuring a Dropbox for Business Security Provider).

    3. Create a Dropbox field set to take advantage of the available Dropbox metadata.

      1. It is recommended to start by importing the default Dropbox field set file ([CES_Path]\Bin\Coveo.CES.CustomCrawlers.Dropbox.FieldSet.xml) to create fields for all the metadata available by default from Dropbox documents (see Exporting and Importing a Field Set).

        Note: CES 7.0.8996+ (June 2017) Due to a Dropbox API change, the following fields are removed or filled with a different metadata:

        Field Name

        Status

        Comment
        dbtimetaken Added  
        dbdisplaysize Removed

        Metadata no longer available

        Note: The same information is available in the bytes metadata.

        dbfilelatestrevision Removed Always empty since the connector no longer indexes file revisions.
        dbfilename Removed

        Metadata no longer available

        Note: The same information is available in the Title field.

        dbfoldingchild Removed Always empty since the connector no longer indexes file revisions.
        dbicon Removed Metadata no longer available
        dbimagetimetaken Removed Now merged in dbtimetaken since both fields are based on the same metadata name.
        dbmimetype Removed Metadata no longer available
        dbmodifiername Removed The item display name is no longer available
        dbvideotimetaken Removed Now merged in dbtimetaken since both fields are based on the same metadata name.
        dbfilerevision Unchanged No longer available on folders
        dbfilebytes Updated Now populated with the size metadata and no longer available on folders
        dbfoldingcollection Updated Field values are based on the item URI. Since the URI now uses a different account id, the values of these fields change.
        dbfoldingparent Updated
        dblastmodificationdate Updated Date format changed at the API level, but does not affect the field values. No longer available on folders.

        If you have an existing Dropbox for Business source, you must update the field set used by the source, and then rebuild the source to take account of these changes.

      2. When you created custom metadata for your Dropbox documents, add corresponding fields to the field set (see Adding or Modifying Custom Fields).

    4. Configure and index a Dropbox for Business source.

      The connector must know details about the authorized access to the Dropboxes of your team members to index their content (see Configuring and Indexing a Dropbox for Business Source).

    5. If you encounter issues, verify if modifying the default value of hidden source parameters can help resolve the problems (see Modifying Hidden Dropbox for Business Source Parameters).

People who viewed this topic also viewed