Product DocsMenu

Box Connector Deployment Overview

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

To deploy the Box connector

  1. Validate that your environment meets the requirements (see Box Connector Requirements).

  2. On the Box server, authorize the Coveo connector to access the content of your managed users (see Authorizing the Coveo Connector to Access the Box of Your Managed Users).

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

    1. CES 7.0.8850+ (March 2017) Optionally create security providers

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

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

      1. Select or create an Email or an Active Directory security provider that the Box 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:

        • 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 Active Directory security provider (see Configuring an Active Directory Security Provider).


          • CES comes with an Active Directory security provider that you can configure to connect to the default domain. When your environment contains more than one domain, you can select an Active Directory security provider that you created for other domains.

          • An Active Directory security provider is appropriate only when the User Principal Name (UPN) matches the email address for all users.

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

      2. Create a Box security provider that the connector uses to resolve indexed permissions (see Configuring a Box Security Provider).

    2. Create a Box field set to take advantage of the available Box metadata.

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

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

    3. Configure and index a Box source.

      The connector must know details to access and index the Box content of your managed users (see Configuring and Indexing a Box Source).

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

People who viewed this topic also viewed