February 12, 2021 Release (5.0.900.5)
This section provides build 5.0.900.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 are 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).
For the simultaneous deployment of Sitecore 9.1 and Coveo for Sitecore on Azure, download the
Sitecore 9.1 (WDP) package and the
coveoforsitecore-module.json file (see Install Coveo for Sitecore Alongside Sitecore in Azure PaaS).
This section summarizes the new features and fixed support cases introduced in the Coveo for Sitecore February 12, 2021 release (5.0.900.5).
|SC-3654||Added a new processor to clean the content of an HTML page before sending it to the index, based on CSS simple selectors.|
|SC-3899||Improved the performance of the Coveo Cloud organization selection drop-down using paginated calls.|
|SC-4751||Rebranded the Command Center, Control Panel and Diagnostic Package to reflect the new Coveo visual identity.|
|Identifier||Case||Fixed Support Case|
|SC-4721||00064528||Fixed the failing calls when trying to send
|SC-4717||Fixed issue with the Australian flag not being displayed in Command Center drop-downs.|
|SC-4719||Fixed issue with errors being logged when source creation is disabled and Sitecore user credentials are empty.|
|SC-4728||Fixed issue where the
|SC-4771||Fixed issue where endpoint attributes were not visible in Swagger on the
This section describes how to upgrade Coveo for Sitecore from December 11, 2020 (5.0.858.1) to February 12, 2021 (5.0.900.5).
For the best Coveo for Sitecore experience, always follow the Leading 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.900.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 lets 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 accomplish 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:
</coveo> tag location has changed. It’s now located immediately before the opening
<contentSearch> tag, as shown below.
Apply these changes in your configuration.
⚠️Step 3: (Optional) Leverage the new CleanHtmlWithSimpleSelectors processor
CleanHtmlWithSimpleSelectors processor had to be deprecated in the March 26, 2021 release of Coveo for Sitecore. Don’t perform the steps below which would activate the
Instead, should you want to remove HTML sections from Sitecore items using CSS selectors, refer to our new article on indexing pipeline extensions (IPE) which contains a Python script sample you can easily adjust for your specific needs (see Remove HTML Sections From Indexed Sitecore Items).
CleanHtml processor configuration will be kept if existing. However, we strongly recommend to move to the new
CleanHtmlWithSimpleSelectors, which offers an easier way to clean HTML content by using simple CSS selectors.
You can move to the new processor by changing your indexing options in the Command Center. Disable and enable again the Index rendered HTML option. The new processor will then be activated.
The new processor comes with the default selector
.coveo-no-index. It’s also possible to customize the list of selectors that the processor uses to clean HTML content.
Step 4: (Optional) Leverage the New Category Facet Data Source Options
This version of Coveo for Sitecore adds support for the recently added
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