Liferay Connector Deployment Overview

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

1. Validate that your environment meets the requirements (see Liferay Connector Requirements).

2. In Liferay:

   1. Deploy the Coveo Liferay portlet plugin.

      The Coveo connector communicates with this plugin to crawl and index the Liferay content (see About the Coveo Liferay Portlet Plugin Deployment).

   2. Select or create the crawling account.

      The Coveo connector needs a Liferay account with which it can fully crawl the Liferay content (see Setting up a Liferay Crawling Account).

3. In the Coveo Administration Tool:

   1. Configure a user identity.

      The Coveo connector needs to know the Liferay account that you previously selected or created (see Setting up a Liferay Crawling Account). You must create a CES user identity to use this account. Use either the Screen Name or the Email Address of the dedicated Liferay account (see Adding a User Identity). You will later assign this user identity to the security provider and the source used by the connector to crawl the Liferay content.(see Configuring and Indexing a Liferay Source).

   2. CES 7.0.8047+ (December 2015) Optionally create security providers

      When you want to index Liferay permissions, you need at least two security providers to get Liferay item permissions and resolve and expand groups.

      In Liferay, users are identified by their screen names. Consequently, permissions returned by the Liferay security provider for each document are screen names (may be expanded from groups). The Liferay security provider then requires another security provider to uniquely identify users from their screen names.

      1. Start by selecting or creating a security provider that the Liferay 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 Active Directory (AD) user logon name, which match their screen name in Liferay, use the out-of-the-box or create a custom Active Directory security provider (see Configuring an Active Directory Security Provider).

         • When authenticated with their Active Directory (AD) account in the DOMAIN\username format, use a REGEX Transform Member Name security provider chained to an Active Directory security provider to map the two member types (see Configuring an Active Directory Security Provider and Configuring a REGEX Transformation Security Provider).

           Important: A regex rule must be able to transform the Liferay screen name, so that the screen name match the AD username. Contact Coveo Support for assistance.

         • When authenticated with their email address, use a REGEX Transform Member Name security provider chained to an Email security provider to map the two member types (see Configuring an Email Security Provider and Configuring a REGEX Transformation Security Provider).

           Important: A regex rule must be able to transform the Liferay screen name, so that the screen name match the email address. Contact Coveo Support for assistance.

      2. Then create a Liferay security provider chained with the security provider(s) you just created that the connector uses to resolve indexed permissions (see Configuring a Liferay Security Provider).

      Note: CES 7.0.7914– (October 2015) You need to configure a Liferay security provider, and then add the security provider on your .NET search interface since you cannot map Liferay user identities to AD ones (see Configuring a Liferay Security Provider and Adding Security Providers to a .NET Search Interface).

      Important: JavaScript search interfaces cannot contain secured Liferay content.

   3. Configure and index the Liferay source

      The Coveo connector needs to know details about the Liferay portal to be able to index its content (see Configuring and Indexing a Liferay Source).

   4. Optionally, customize the mapping file to fine-tune indexed content

      Consider customizing the connector mapping file to fine-tune the indexed content or to index other entities in your Liferay portal (see About the Liferay Connector Mapping File and Customizing the Liferay Connector Mapping File).

   5. Optionally, modify hidden source parameters

      Once your Liferay source is up and running, if you encounter issues, consider modifying some hidden source parameters to try resolving the issues (see Modifying Hidden Liferay Source Parameters).

4. In the Interface Editor, add the built-in Liferay facets

   CES comes with a built-in Liferay Type facet that you can add to your search interface so that users can more easily refine search results based on file types (see Managing Built-in Facets and Related Results Appearing in a .NET Search Interface).