Configuring and Indexing a Basecamp Source

A source defines a set of configuration parameters for a specific Basecamp account.

To configure and index a Basecamp source

1. On the Coveo server, access the Administration Tool (see Opening the Administration Tool).

2. Select Index > Sources and Collections.

3. In the Collections section:

   1. Select an existing collection in which you want to add the new source.

      OR

   2. Click Add to create a new collection (see Adding a Collection).

4. In the Sources section, click Add.

   The Add Source page that appears is organized in three sections.

5. In the General Settings section of the Add Source page:

   

   1. Enter the appropriate value for the following required parameters:

      Name

      Enter a descriptive name of your choice for the connector source.

      Example: Basecamp

      Source Type

      Select the connector used by this source. In this case, select Basecamp.

      Note: If you do not see Basecamp, your environment does not meet the requirements (see Basecamp Connector Requirements).

      Addresses

      This parameter does not apply to this source, but cannot be left empty.

      Example: https://www.basecamp.com

      Fields

      Select the field set that you created earlier (see Basecamp Connector Deployment Overview).

      Refresh Schedule

      Time interval at which the index is automatically refreshed to keep the index content up-to-date. By default, the Every day option instructs CES to refresh the source everyday at 12 AM.

   2. Review the value for the following parameters that often do not need to be modified:

      Rating

      Change this value only when you want to globally change the rating associated with all items in this source relative to the rating to other sources (see Understanding Search Results Ranking).

      Example: When a source replaces a legacy system, you may want to set this parameter to High, so that in the search interface, results from this source appear earlier in the list compared to those from legacy system sources.

      Document Types

      If you defined a custom document type set for this source, select it (see What Are Document Type Sets?).

      Active Languages

      If you defined custom active language sets, ensure to select the most appropriate for this source (see Adding and Configuring a Language Set).

6. In the Specific Connector Parameters & Options section of the Add Source page:

   

   1. Using the following parameters, authorize the Coveo crawler to access the content of your Basecamp account:

      Account ID

      Enter your Basecamp account ID.

      Note: After you login to Basecamp, the account ID can be found in the browser address bar after https://basecamp.com/.

      Example: https://basecamp.com/3027985/

      Client ID

      (For OAuth 2.0 only) Enter the client identifier to use that you previously obtained (see Authorizing the Coveo Connector to Access Your Basecamp Content).

      Client Secret

      (For OAuth 2.0 only) Enter the client secret to use that you previously obtained (see Authorizing the Coveo Connector to Access Your Basecamp Content).

      Refresh Token

      (For OAuth 2.0 only) Enter the refresh token to use that you previously obtained (see Authorizing the Coveo Connector to Access Your Basecamp Content).

   2. In the Mapping File box, the path to the default mapping file that defines how the connector handles metadata often does not need to be changed.

   3. The following options must be selected for more content in Basecamp to be indexed.

      Index Project Drafts

      Whether the project drafts should be indexed. By default, archived projects are indexed.

      Index Archived Projects

      Whether the archived projects should be indexed. By default, archived projects are indexed.

   4. (Optional) Click Add Parameter when you want to show and change the value of advanced source parameters (see Modifying Hidden Basecamp Source Parameters).

   5. The Option check boxes generally do not need to be changed:

      Index Subfolders

      This parameter is not taken into account for this connector.

      Index the document's metadata

      When selected, CES indexes all the document metadata, even metadata that are not associated with a field. The orphan metadata are added to the body of the document so that they can be searched using free text queries.

      When cleared (default), only the values of system and custom fields that have the Free Text Queries attribute selected will be searchable without using a field query (see Adding a Field to Search On and What Are Field Queries and Free Text Queries?).

      Example: A document has two metadata:

      • LastEditedBy containing the value Hector Smith

      • Department containing the value RH

      In CES, the custom field CorpDepartment is bound to the metadata Department and its Free Text Queries attribute is selected.

      When the Index the document's metadata option is cleared, searching for RH returns the document because a field is indexing this value. Searching for hector does not return the document because no field is indexing this value.

      When the Index the document's metadata option is selected, searching for hector also returns the document because CES indexed orphan metadata.

      Document's addresses are case-sensitive

      Leave the check box cleared. This parameter needs to be checked only in rare cases for systems in which distinct documents may have the same name but different casing.

      Generate a cached HTML version of indexed documents

      When you select this check box (recommended), at indexing time, CES creates HTML versions of indexed documents. In the search interfaces, users can then more rapidly review the content by clicking the Quick View link rather than opening the original document with the original application. Consider clearing this check box only when you do not want to use Quick View links or to save resources when building the source.

      Open results with cached version

      Leave this check box cleared (recommended) so that in the search interfaces, the main search result link opens the original document with the original application. Consider selecting this check box only when you do not want users to be able to open the original document but only see the HTML version of the document as a Quick View. In this case, you must also select Generate a cached HTML version of indexed documents.

7. In the Security section of the Add Source page:

   

   Important: The connector does not yet support Basecamp permissions. It is thus strongly recommenced to only index Basecamp account with public content.

   Note: A workaround is to manually define permissions on the source (see Permissions).

   1. In the Authentication drop-down list, depending on your setup:

      • When you grant the connector access to your Basecamp content using OAuth, select (none).

      • When you want to grant the connector access to your Basecamp content using Basic authentication, select the user identity you previously created (see Basecamp Connector Deployment Overview).

8. Click Save to save the source configuration.

9. When your Basecamp content is all public:

   Important: The connector does not yet support Basecamp permissions. This means that, in the Coveo search interface, a user searching Basecamp content could see content to which he has normally no access in Basecamp.

   Note: When your Basecamp content is not public, a workaround is to enter the name of user(s) or group(s) you want to allow or deny access to your organization content in the Allowed Users and Deny Users boxes.

   1. In the navigation panel on the left, click Permissions.

   2. In the Permissions page, select Specify the security permissions to index.

   3. In the Allowed Users and Denied Users boxes, enter the users and groups that you respectively want to allow or deny to see search results from this source. The default is to allow everyone \S-1-1-0\ (Active Directory Group).

   4. Click Apply Changes.

10. When you are ready to start indexing the Basecamp source, click Rebuild.

11. Validate that the source building process is executed without errors:

    • In the navigation panel on the left, click Status, and then validate that the indexing proceeds without errors.

      OR

    • Open the CES Console to monitor the source building activities (see Using the CES Console).