September 18, 2020 Release (5.0.788.5)
This section provides build 5.0.788.5 download links for all supported versions of Sitecore. Download and install the Coveo for Sitecore package that matches your version of Sitecore (see Install Coveo for Sitecore in a Sitecore On-Premise Environment).
If you’re using SXA and want to be able to insert Coveo components in your SXA pages, download and install both the Coveo for Sitecore package and the SXA UI Components package (see Install Coveo for Sitecore SXA Components).
If you want to upgrade your version of Coveo for Sitecore 5 to this release, follow the upgrade procedure (see Upgrade Steps).
This section summarizes the new features and fixed support cases introduced in the Coveo for Sitecore September 18, 2020 release (5.0.788.5).
|SC-4509||Added support for new usage analytics endpoint.|
|SC-4543||Provided ability to connect a Sitecore instance to Coveo organizations across all available data residency regions.|
|SC-4544||Added support for SXA 10.0.|
|SC-4554||Added support for Sitecore 10.0.|
|Identifier||Case||Fixed Support Case|
|SC-4551||00062150||Fixed issue with Sitecore returning 127.0.0.1 as the server URL on Azure.|
|SC-4542||Enable license parameters
This section describes how to upgrade Coveo for Sitecore from August 10, 2020 (5.0.761.5) to September 18, 2020 (5.0.788.5).
For the best Coveo for Sitecore experience, always follow the Best Practices When Upgrading Coveo for Sitecore.
Step 1: Upgrade Coveo for Sitecore
Make sure the Microsoft MVC security update MS14-059 is installed on every Sitecore host in your environment.
- Log into the Sitecore Desktop.
- Access the Installation Wizard (Sitecore Start Menu > Development Tools > Installation Wizard).
- Upload and install the Coveo for Sitecore 5.0.788.5 package built for the specific version of Sitecore you’re running (e.g., Sitecore 9.0). You can find it in Downloads.
- When prompted to overwrite files, click Yes to all.
When prompted to overwrite items, select Overwrite, then click Apply to all.
You might be prompted twice with this question. Select the Overwrite option and click Apply to all both times.
Once the installation is completed, make sure that you restart both the Sitecore client and server.
Step 2: Manually Update the Coveo Configuration Files
The Coveo configuration files are located in the
App_Config\Include\Coveo folder. When upgrading, you must compare the changes to the
.example files from your current Coveo for Sitecore version with the ones in the build you’re upgrading to. Then, you can merge these changes into your current configuration files. This method let’s you keep your customization intact, while still benefiting from the latest enhancements brought in the product. You can use a merge tool such as WinMerge to do this.
In further detail, here are the modifications that you must perform to the configuration files resulting from the feature changes between the previous and current Coveo for Sitecore releases:
<analyticsUri> element text node has changed. The new value is
https://platform.cloud.coveo.com/rest/ua. Update this setting, both in
Coveo.SearchProvider.Rest.config and in the
Coveo.SearchProvider.Rest.Custom.config patch file, to ensure the final configuration uses the new endpoint.
Coveo.Service.Api.IndexService.config and Coveo.Service.Api.ConfigService.config
Setting a cache expiration for storing organizations using the
<fetchOrganizations> element has been moved from the
Coveo.Service.Api.IndexService.config file to the
If you had manually changed the
<fetchOrganizations> element value in
Coveo.Service.Api.IndexService.config, ensure you set
Coveo.Service.Api.ConfigService.config to the same value.
Step 3: (Optional) Use queryQuotaPerOrgLimit Instead of queryRateLimit to Configure the Query Rate Limit
If you added the
queryRateLimit parameter to your
Coveo.SearchProvider.Rest.Custom.config file to configure the query rate limit, you should replace it with
Step 4: End Use of
MediaUrlOptions Properties in Custom Code
MediaUrlOptions properties of the
Coveo.Framework.Links.IMediaUrlOptions classes respectively have been marked as obsolete. Adjust your custom code if necessary.
Step 5: Publish Your Site
In the Sitecore Content Editor, perform a publish site action. This ensures any changes related to Coveo components in the upgrade are published to the