Configure and Activate Using the User Interface

After installing Coveo for Sitecore, it must be configured and activated. The following steps let you link your Sitecore instance to a Coveo organization and to perform indexing configurations.

In some circumstances, for example in many server setups, you may prefer activating Coveo for Sitecore programmatically (see Configuration and Activation Options).

To configure and activate Coveo for Sitecore using the Command Center

  1. Sitecore 7.2

    For Sitecore 7.2 instances only, perform the activation prerequisites that apply to that version of Sitecore (see Prerequisites For Sitecore 7.2 Instances Only).

  2. In the Coveo for Sitecore Configuration dialog, click Activate Coveo for Sitecore Package.

    You can reach the Coveo for Sitecore Activation page at http://[INSTANCE_NAME]/coveo/command-center/index.html, where [INSTANCE_NAME] is replaced by your Sitecore instance name­.

    Command Center Activation

  3. Click Log In.
  4. Follow the instructions shown on screen to log in to the Coveo Platform using your preferred identity provider.

    • If you already have access to one or several Coveo organizations, a screen with the Select your organization section similar to the following will appear:

      Activating Existing Organization

    • If you don’t have access to a Coveo organization, a screen with the Select your organization section similar to the following will appear:

      Activating New Organization

  5. Select or create your Coveo organization.

    • If you already have access to one or several Coveo organizations, you may either want to select an existing organization or create a new one.
      1. To select an existing organization, in the Select your organization section, under the Existing tab, select the appropriate organization name from the drop-down menu.

        Coveo for Sitecore (September 18, 2020)

        The flag next to the organization name indicates the region the organization data is hosted in. The flag tooltip provides further details on the organization data residency location.

        Image of Select Organization dropdown with region flags

      2. To create a new organization, select the Create New tab and proceed as indicated in step b) below.

    • If you don’t already have access to a Coveo organization, you must now create one.
      1. In the Select your organization section, in the Create New tab, type the name you want for your Coveo organization name.

        • While you can always change your organization display name later in the Coveo Administration Console under Settings > Organization > Profile, be aware that the original name value you specify when creating an organization will forever be part of the unique and permanent ID of that organization.

        • Organizations created through Coveo for Sitecore are hosted in the us-east-1 region.

        Coveo for Sitecore (September 18, 2020)

        • Coveo for Sitecore now lets you connect to Coveo organizations in regions other than us-east-1. For more information on your data residency options, see Multi-Region Deployments.
      2. Select the Trial type that matches your needs (see Entitlement Comparison (Coveo for Sitecore)).

  6. In the Configure options section, specify your configuration options.

    Further details for each option are provided below.

    • Security: Allows to select whether to index Sitecore permissions on the documents. When permissions aren’t indexed, all indexed documents are available to anonymous users. If your site contains secure content, we recommend that you index the permissions.
    • Body indexing: Allows to select whether the rendered HTML should be indexed.
    • Farm configuration: Allows to specify a farm name in order to refer to resources such as sources and security providers with coherent names.
    • Sitecore credentials: Allows to specify the Sitecore account (domain\username) responsible for crawling the items and expanding permissions (see Sitecore Credential Usage in Coveo for Sitecore).

      Create a dedicated Sitecore admin user for Coveo and use it in the activation steps. Assigning a dedicated user to Coveo for Sitecore will prevent lock-down issues.

      • Coveo for Sitecore 5 (April 2019) If you don’t specify a domain in the User name field, Coveo for Sitecore assumes the user is a member of the sitecore domain.

      • The password entered on this screen is encrypted and saved in the Coveo.SearchProvider.Custom.config.example file.

        Coveo for Sitecore (May 2019) An encryption key is automatically created in the core database of your Sitecore instance.

        Coveo for Sitecore (May 2019) An encryption key is automatically created in the core database (for Sitecore versions up to 9.0 inclusively) or the web database (for Sitecore versions 9.1 onwards) of your Sitecore instance.

  7. Click Activate.

    Allow 15 to 30 minutes for your Coveo organization to be provisioned.

    At activation, the .config.example files below are renamed.

    • Coveo.CloudPlatformClient.Custom.config.example to Coveo.CloudPlatformClient.Custom.config

    • Coveo.SearchProvider.config.example to Coveo.SearchProvider.config

    • Coveo.SearchProvider.Custom.config.example to Coveo.SearchProvider.Custom.config

    • Coveo.SearchProvider.Rest.config.example to Coveo.SearchProvider.Rest.config

    • Coveo.SearchProvider.Rest.Custom.config.example to Coveo.SearchProvider.Rest.Custom.config

    • Coveo.UI.Controls.config.example to Coveo.UI.Controls.config

    • Coveo.UI.Components.ExperienceEditor.config.example to Coveo.UI.Components.ExperienceEditor.config

    For Sitecore 7 and 8 versions, these configuration files are located under [Your Sitecore Instance]\Website\App_Config\Include\Coveo.

    For Sitecore 9 and 10 versions, these configuration files are located under [Your Sitecore Instance]\App_Config\Modules\Coveo, except the *.Custom.config files which are located under [Your Sitecore Instance]\App_Config\Include\Coveo.

    When a Coveo Cloud trial organization has been idle for some time, it’s paused automatically. If you have selected an existing organization that has been idle for a while, the following dialog box will be displayed:

    You can click Reactivate in the dialog box to resume using your organization.

    You can also reactivate your organization through the Coveo Administration Console, in the left panel, in the Status section.

  8. Depending on your Sitecore revision, there may be some lines that you want to uncomment in the Coveo.SearchProvider.Custom.config file. Scan the file for any relevant section. For example, you may want to uncomment the <field fieldName="culture"> element.

    It’s important that you only modify the .Custom.config files. Modifying the .config files may lead to unexpected bugs during updates.

  9. Sitecore 9 and 10

    For Sitecore 9 and 10 instances only, changes to your Web.config file are required to ensure that requests targeting the REST endpoint can handle special characters (see Ajax Error 500 When Using Special Characters in a Query - Workaround).

  10. Restart the Sitecore client.

  11. If you’re using the web database, publish the master database, as items created by Coveo for Sitecore need to be replicated to the web database as well.


Sitecore on Azure

Azure’s Web Application Firewall (WAF) may block Coveo query network calls that trigger OWASP rules. You might need to disable or customize Azure WAF rules to allow Coveo for Sitecore network calls (see Azure Web Application Firewall triggered rules block Coveo for Sitecore’s communication on Content Delivery servers).

What’s Next?

When installing Coveo for Sitecore in a Sitecore configuration with several Content Management (CM) and Content Delivery (CD) hosts, see the Coveo for Sitecore Scaling Guide.

Otherwise you can return to the Coveo for Sitecore Deployment Guide.

Recommended Articles