Configuring and Indexing an OpenText Content Server Source

A source defines a set of configuration parameters for a specific OpenText Content Server (OTCS).

Note: In an environment with more than one OTCS, you need to define one source for each OTCS that you want to index.

To configure and index an OpenText Content Server 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: OpenText Content Server

      Source Type

      Select the connector used by this source. In this case, select OpenText Content Server.

      Notes: If you do not see OpenText Content Server, your environment does not meet the requirements (see OpenText Content Server Connector Requirements).

      You can also use the OTCS connector to crawl a Livelink version 9.7.1 source. You need to add a hidden parameter to do so (see below).

      Addresses

      Enter the document or folder IDs that you want to index. One ID per line or * to index the whole OTCS content from the Enterprise Workspace root.

      Note: CES 7.0.6830– (July 2014) This parameter is not used for the OpenText Content Server connector, but must not be left empty. Enter NA.

      You can find the ID for a node in OTCS by clicking the Functions icon of an item, selecting Properties > General on the menu, clicking Change next to Nickname, and then read the Item ID value.

      Example: When you want to create an OTCS source only for one project, in the project General property tab, read the Item ID value, like 4094 in the following example.

      

      Note: Using certain item types as the root node will result in an error when retrieving their permissions. All item types receiving their permissions from their parents (such as Task, News, all types under Discussion, and possibly other types) are not supported as the root node.

      Refresh Schedule

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

      Note: You can create new or modify existing source refresh schedules (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 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).

      Fields

      By default, when an OTCS metadata name matches the name of a CES standard or custom field, the metadata value is automatically mapped to the CES field and the field can be used to make the search interface results more relevant. It is a good practice to create a custom field set that and fields with names matching those of your signification OTCS metadata (see What Are Field Sets?).

      If you defined custom field sets, ensure to select the most appropriate for this source.

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

   

   1. Configure the following required parameters: 

      Web Service URL

      Enter the URL of the OpenText Content Server Web Service used to communicate with the server. By default, this value is:

      http://OTCS_Server/les-services/

      where you replace OTCS_Server by the fully qualified domain name of your server.

      Example: http://OTCS.corp.MyCompany.com/les-services/

      Important: CES 7.0.8225+ (March 2016) (For OTCS 10.5+ only) Replace les-services by cws.

      Example: http://OTCS.corp.MyCompany.com/cws/

      Note: This is the same value that you entered for the Web Service Url parameter when you configured the security provider (see Configuring an OpenText Content Server Security Provider).

      Content Server URL

      Enter the URL pointing to the OpenText Content Server necessary to have valid clickable URIs.

      Example: When you access the OTCS, the Content Server URL is the part of the URL before Livelink.exe: 

      

      In the above example: http://OTCS.corp.MyCompany.com/OTCS/

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

      Mapping File

      By default, when an OTCS metadata name matches the name of a CES standard or custom field, the metadata value is automatically mapped to the CES field. When this default behavior is sufficient to leverage OTCS metadata, leave this field empty.

      When you want to control more precisely how to map OTCS metadata to CES fields, create a custom mapping file and enter the absolute full path pointing to your file (see Creating an OpenText Content Server Connector Mapping File).

      Example: C:\CES7\Config\MyOTCSMappingFile.xml

      Number of Refresh Threads

      Enter the number of threads that will be used to retrieve OpenText Content Server content. The default value is 2.

      Parameters

      Click Add Parameter when you want to show and use advanced source parameters (see Modifying Hidden OpenText Content Server Source Parameters).

      Important: CES 7.0.5425+ (May 2013) When you are indexing a Livelink v9.7.1, you must add the OTCSVersion parameter and enter the 9.7.1 value.

   3. In the Option section:

      Index Subfolders

      Keep this check box selected (recommended). By doing so, all subfolders from the specified portal address are indexed.

      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:

   

   1. In the OpenText Content Server Security Provider drop-down list, select the security provider that you created for this source (see Configuring an OpenText Content Server Security Provider).

   2. In the Authentication drop-down list, select the user identity that you created for the OpenText Content Server.

   3. Click Save and Start to save the source configuration and start indexing this source.

8. 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).