Configuring and Indexing a Liferay Source

A source defines a set of configuration parameters for a specific Liferay portal.

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

To configure and index a Liferay 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: Liferay Portal

      Source Type

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

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

      Addresses

      Enter the root address of the Liferay portal in the format:

      http://[serverName]:[port]/

      where you replace [serverName]:[port] by the host name and port of your Liferay portal. The default port is 8080. The port is optional when equal to 80.

      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: Incremental refresh does not catch changes to security and file attachment elements. Only a refresh does.

      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

      If you defined custom field sets, ensure to select the most appropriate for this source (see What Are Field Sets?).

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

   

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

      Mapping File

      Leave this field empty to use the default mapping file (see About the Liferay Connector Mapping File). When you create a custom mapping file, enter the absolute full path pointing to your file (see Customizing the Liferay Connector Mapping File).

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

      Index Blogs

      Whether blog entries, including their comments, should be indexed.

      Index Calendars

      Whether calendar events, including their comments, should be indexed.

      Index Document Libraries

      Whether document library files, including their comments, should be indexed.

      Index Message Boards

      Whether message board messages, including their attachments, should be indexed.

      Index Users

      Whether user profiles should be indexed.

      Index Web Content

      Whether web content, previously known as journals, should be indexed.

      Index Wikis

      Whether Wiki pages, including their attachments and comments, should be indexed.

      Authentication

      Select the user identity that you created previously for the Liferay portal.

      Parameters

      Click Add Parameter when you want to show advanced source parameters (see Modifying Hidden Liferay Source Parameters).

      CES 7.0.8047+ (December 2015) When you crawl a Liferay 6.1 instance, you must add the PluginUrl hidden parameter:

      Parameter name	Parameter value example
      PluginUrl	[LiferayServer:Port]/CESLiferayConnector-portlet/api/axis/Plugin_CES_LiferayConnectorService

      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 Security Provider drop-down list, select the security provider that you created for this source (see Configuring a Liferay Security Provider).

   2. In the Authentication drop-down list, select the user identity that you created for the Liferay Portal.

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