Configure the Primary Deployment Region or Multi-Region Support in Coveo for Sitecore

Coveo provides its customers with options as to where their data is stored. The physical center of your Coveo organization is referred to as the primary deployment region. Coveo also offers multi-region support, that is to have only the data required for search queries automatically replicated from your primary deployment region to one or multiple satellite regions. This strategy minimizes response times for your international search interface users, because search queries are automatically routed to the closest deployment region.

This article aims at providing existing Coveo for Sitecore customers with instructions should they want to change their primary deployment region or enable multi-region support for their Coveo organization.

Changing the Primary Deployment Region

When activating Coveo for Sitecore, the Command Center gives you the option to connect your Sitecore instance to an existing Coveo organization (in a given primary deployment region) or to create a new organization in the region of your choice. To determine the primary deployment region of the Coveo organization your Sitecore instance is currently connected to, navigate to the Command Center Configuration Manager (accessible at https://<INSTANCE_HOSTNAME>/coveo/command-center/index.html#cloud-organization/).

deployment region shown in Coveo Command Center
The primary deployment region may be seen by hovering over your Coveo organization in the list of existing organizations.

If the Coveo organization you’re currently connected to isn’t located in your preferred deployment region, you may want to migrate your organization data.

To migrate your Coveo organization data from one deployment region to another

  1. Contact Coveo Sales to have the new Coveo organization created and to initiate the related administrative tasks.

    When a Coveo customer requests a primary deployment region data migration, Coveo must first create the new organization in the desired region. The old organization is maintained and available for a given time period only, as determined by Coveo and the customer.

  2. Migrate (or have Coveo Professional Services migrate) your data from the old organization to the new organization.

    Coveo currently has no automated process to migrate organization data.

    Customers can use the Resource Snapshot feature to migrate most resources (but not all[1]) from the old to the new organization themselves, or they may call upon Coveo Professional Services to perform the migration.

    Coveo Professional Services use the Resource Snapshot feature to migrate organization data, as customers would do themselves. However, Coveo can also copy the top 1000 Query Suggestions (QS) from the old organization to the new one, though this option has its limitations.[2] Coveo can’t migrate other Usage Analytics data (e.g., Automatic Relevance Tuning (ART) and Content Recommendations (CR) data) to the new organization.

  3. Upgrade Coveo for Sitecore to the September 18, 2020 Release (5.0.788.5) or higher.

    Ensure you follow the leading practices when upgrading.

  4. Follow the steps in the Modifying Your Coveo Organization section to link your Sitecore instance to your new organization.

    These steps will change settings in the following configuration files on your main CM server:

    Sitecore 7 and 8



    Sitecore 9 and 10



  5. Copy the two configuration files that were updated on your main CM server and paste them to overwrite the same files on all your other CMs and CDs.

  6. Access the Indexes section of the Command Center.

  7. Rebuild your indexes.

Adding Multi-Region Support

  1. Contact Coveo Sales to create the satellite region(s) for your Coveo organization.

    Coveo will provide you with a custom domain name to use in your Search API requests instead of the current region-specific URL.

  2. On your main CM server, in the Coveo.SearchProvider.Rest.config file, replace the <searchApiUri> value with the custom URL provided by Coveo Sales. The Coveo.SearchProvider.Rest.config file is located in the <SITECORE_INSTANCE_ROOT>\Website\App_Config\Include\Coveo folder in Sitecore 7 and 8, and in the <SITECORE_INSTANCE_ROOT>\App_Config\Modules\Coveo folder in Sitecore 9 and 10.

    Ensure you’re not patching the <searchApiUri> value in the Coveo.SearchProvider.Rest.Custom.config file. This file is located in the <SITECORE_INSTANCE_ROOT>\Website\App_Config\Include\Coveo folder in Sitecore 7 and 8, and in the <SITECORE_INSTANCE_ROOT>\App_Config\Include\Coveo folder in Sitecore 9 and 10.

  3. Copy the Coveo.SearchProvider.Rest.config file you updated on your main CM server and overwrite the Coveo.SearchProvider.Rest.config file on all your other CM and CD servers.

1. Usage Analytics can’t be migrated.
2. Only part of the Query Suggestions (QS) data is copied in the process. As a result, customers don’t initially get the same level of QS functionality in the new Coveo organization as they did in the original organization. Having Query Suggestions data migrated ensures adequate query suggestions during the transitory period when analytics data begins accumulating in the new organization.
What's Next for Me?