Update Coveo for Sitecore Settings

The options in the Command Center Configuration Manager let you:

  • Change the Coveo organization your Sitecore instance is linked to.

  • View and copy the list of URLs you should add to your firewall allowed list.

  • Edit your indexing options.

  • Enable or disable the Coveo for Sitecore reverse proxy.

Accessing the Configuration Manager

To access the Configuration Manager as a Sitecore administrator

  1. Open the Coveo Search control panel section.

  2. Select Configuration Manager.

    You can also access the Command Center Configuration Manager using URL http://<INSTANCE_HOSTNAME>/coveo/command-center/index.html#cloud-organization, where <INSTANCE_HOSTNAME> is the name of your Sitecore instance. Non-Sitecore administrators can only access the Command Center by URL (see Give Access to the Command Center).

Modifying Your Coveo Organization

To modify the Coveo organization your instance is linked to

  1. In the Coveo Cloud Organization section, click Log In.

    Command Center login

  2. Follow the instructions shown on screen to log in to the Coveo Platform using your preferred identity provider.

    Command Center change organization section

  3. Select or create your Coveo organization.
    • To select an existing organization, under the Existing tab, select the desired organization from the drop-down menu.

      Image of Select Organization drop-down with region flags

      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.

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

    • To create a new organization

      1. Select the Create New tab.

        Create New organization section

      2. Type the name you want in the Organization Name field.

        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.

      3. Select the Organization Type that matches your needs (see Entitlement Comparison (Coveo for Sitecore)).

        Coveo for Sitecore (December 11, 2020)

        For a local development environment, select the Test organization organization type.

      4. Coveo for Sitecore (December 11, 2020) In the Organization Region drop-down, select the data residency region that best suits your needs.

  4. Click Apply and Restart.

    Your Security and Indexing Options section settings are carried over from your previous Coveo organization to the current one. To make changes to these settings, refer to the Modifying Security Settings and Modifying Your Indexing Options sections below.

    • Allow 15 to 30 minutes for a new Coveo organization to be provisioned.
    • 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, one of the following dialogs is displayed when you reload the page:

      If you click Resume, the organization status then changes to Resuming.

      The dialog automatically closes once the organization has finished resuming and is, once again, fully functional.

      You can also reactivate your organization through the Coveo Administration Console, in the notification center.

Modifying Security Settings

To modify your security settings

  1. In the Security section, specify your new settings.

    Editing the security settings

    Further details for each option are provided below.

    • Sitecore credentials: Lets you specify the Sitecore account (domain\username) responsible for crawling the items and expanding permissions (see Sitecore Credential Usage in Coveo for Sitecore).

    • Index Permissions: This check box lets you set whether Coveo for Sitecore is configured to index permissions on documents.

  2. Click Apply and Restart.

    Since Coveo for Sitecore configuration files are updated, a restart of the Sitecore instance is triggered.

Modifying Your Indexing Options

To modify your indexing options settings

  1. In the Indexing Options section, specify your new settings.

    Further details for each option are provided below.

    • Body indexing: Allows you to select whether the rendered HTML should be indexed.
    • Farm configuration: Allows you to specify a Farm name in order to refer to resources such as sources and security identity providers with coherent names.

      Changing the Farm name in the Command Center updates the <farmName> element text content in Coveo.SearchProvider.Custom.config. Similarly, when you change the text content of the <farmName> element in Coveo.SearchProvider.Custom.config, the Command Center reflects this change as soon as you refresh the page.

      However, if you overwrite the Farm name value using a patch file of your own, the Command Center will detect a difference between the Coveo.SearchProvider.Custom.config Farm name and the one in the Sitecore compiled configuration. When both values are different:

      • The Command Center displays the Farm name field which contains the Coveo.SearchProvider.Custom.config Farm name value.
      • The Command Center displays the Effective farm name field which contains the Farm name value you set in your custom patch file.
      • The Effective farm name is used for indexing.
      • Coveo for Sitecore disables farm name editing in the Command Center.

      Effective Farm Name Overrides Coveo Farm Name

  2. Click Apply and Restart.

    Since Coveo for Sitecore configuration files are updated, a restart of the Sitecore instance is triggered.

Enabling or Disabling the Reverse Proxy

To enable or disable the reverse proxy

  1. In the Reverse Proxy Options section, select or clear Enable Coveo for Sitecore proxy.

  2. Click Apply and Restart.

    Since Coveo for Sitecore configuration files are updated, a restart of the Sitecore instance is triggered.

Recommended Articles