Google Drive for Work Connector Deployment Overview

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

To deploy the Google Drive for Work connector

1. Validate that your environment meets the requirements (see Google Drive for Work Connector Requirements).

2. On the Google server:

   1. Create a Google API Console project to authorize the Coveo connector to access the Google Drive of your users (see Authorizing the Coveo Connector to Access Your Google Drive).

   2. Modify security parameters in your Google Apps account to grant the connector access to your Google Apps for Work (see Authorizing the Coveo Connector to Access Your Google Apps for Work).

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

   1. Set up the crawling account

      The Coveo connector needs an account that can list the various drives and users of the domain. This is typically the administrator of the Google Apps domain. There are two methods available to get the permissions from the crawling account depending on your CES version:

      • CES 7.0.7433+ (February 2015) The method, that only requires your admin account email, uses the service account email and its PCKS12 private key file, both obtained in step 2a, to impersonate the admin account without having to create a user identity.

      • CES 7.0.7338– (January 2015) Create a CES user identity that contains the credentials (username and password) of your domain administrator (see Adding a User Identity).

   2. Optionally create security providers

      When you want to index Google Drive permissions, you must create two security providers to get Google Apps for Work item permissions and resolve and expand groups.

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

      1. Start by selecting or creating an Email or an Active Directory security provider that the Google Apps for Work 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).

           Notes:

           • 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. Then create a Google Apps for Work security provider that the connector uses to resolve indexed permissions (see Configuring a Google Drive for Work Security Provider).

   3. CES 7.0.6607+ (April 2014) Create a Google Drive field set to take advantage of the available Google Drive metadata.

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

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

   4. Configure and index a Google Drive for Work source.

      The connector must know details about the authorized access to the Google Drive of your users to index its content (see Configuring and Indexing a Google Drive for Work Source).

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