April 15, 2020 Release (5.0.655.1)
This section provides build 5.0.655.1 download links for all supported versions of Sitecore. Download and install the Coveo for Sitecore package that matches your version of Sitecore (see Installing Coveo for Sitecore).
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 Installing 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 April 15, 2020 release (5.0.655.1).
|SC-4319||Added support for SXA 9.3.|
|Identifier||Case||Fixed Support Case|
|SC-4361||00059860||Renamed the Coveo Conditional Renderings personalization rule condition.|
This section describes how to upgrade Coveo for Sitecore from April 1, 2020 (5.0.642.2) to April 15, 2020 (5.0.655.1).
Coveo.Analytics assembly, the
CustomMetadatas property has changed type from IDictionary<string, string> to IDictionary<string, object> in order to support other types than Strings. This should have been the implementation from the start since these metadata can be objects of any type.
To ease this breaking change, we added a
TryGetValue extension method to IDictionary<string, object> which allows to pass in an already typed out value. If used, this extension will simply require you add the
Coveo.Framework.Collections namespace in your using statements.
For the best Coveo for Sitecore experience, always follow the Best Practices When Upgrading Coveo for Sitecore.
Step 1: Upgrade Coveo for Sitecore
Please, ensure that 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 XX 5.0.655.1package. 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. Simply 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: (Optional) Configure New Data Source Options on Existing Renderings
Here are the rendering data source options that have been added:
Coveo Searchbox rendering:
The Height option has been added.
The Query suggest character threshold option has been added.
The Clear filters on new query option has been added.
Coveo Category Facet rendering:
- The Depends on option has been added.
Coveo Results List rendering:
- The Enable scroll to top option has been added.
Step 3: 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