Configuring and Indexing a Aha! Source

A source defines a set of configuration parameters for indexing the content of a specific Aha! account.

To configure and index an Aha! 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

      A descriptive name of your choice for the connector source.

      Example: My Aha! Content

      Source Type

      The connector used by this source. In this case, select Aha!.

      Addresses

      The URL to access your Aha! content, typically in the form:

      https://[domain].aha.io/

      where you replace [domain] by your Aha! domain.

      Fields

      If you created an Aha! field set, select it(see Aha! Connector Deployment Overview and What Are Field Sets?.

      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.

      Because the Aha! connector does not support incremental refresh, keep this value. Consider using a shorter interval when your Aha! content changes frequently within a day and you need to have a better search result freshness (see What Should Be the Frequency of Source Refresh Schedules?).

      Note: You can create a new or modify an existing source refresh schedule (see Creating or Modifying a Source Schedule).

   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 ranking associated with all items in this source relative to the rating of other sources (see Understanding Search Results Ranking).

      Example: If this source is for a legacy PLM, you may want to set this parameter to Low, so that in the search interface, results from this source appear later in the list compared to those from other sources.

      Document Types

      If you created a custom document type set for this source, select it (see Creating a Document Type Set). Otherwise, leave Default.

      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. In the Access token box, paste the access_token value that you obtained previously (see Granting the Connector Access to Your Aha! Content).

   2. In the Mapping File box, leave the default mapping file name (Coveo.CES.CustomCrawlers.Aha.MappingFile.xml) unless you created a custom mapping file, in which case, enter the full path of your valid mapping file.

   3. In the Option section, the state of check boxes generally does not need to be changed:

      Index Subfolders

      Check to index all subfolders below the specified starting addresses.

      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.

      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 and saves them in the unified index. In the search interfaces, users can then more rapidly review the content by clicking the Quick View link to open the HTML version of the item rather than opening the original document with the original application.

      Consider clearing this check box only if 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. When this option is selected, you must also select the Generate a cached HTML version of indexed documents check box.

   4. Click Save to save the source configuration.

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

   

   1. In the Security Provider drop-down list, select a security provider such as Email that resolves permissions to emails (like the Aha! connector does) so that users authenticated with their email address in a Coveo search interface can see the Aha! content to which they have the read permission.

   2. Click Save and Start to save your source configuration and start indexing.