May 28, 2021 Release (5.0.971.3)

This is for:

This release includes the 2.10083.4 version of the JavaScript Search Framework (see February 2021 Release (v2.10083)).

When using a CDN with the Coveo Hive framework, this release includes the latest 2.10083 version of the JavaScript Search Framework (see Understanding How the Coveo JavaScript Files are Loaded (CDN)).

Downloads

This section provides build 5.0.971.3 download links for all supported versions of Sitecore. Download and install the Coveo for Sitecore package that matches your version of Sitecore (see Install ).

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

For the simultaneous deployment of Sitecore 9.1/10.0/10.1 and Coveo for Sitecore on Azure, download the corresponding WDP package and the coveoforsitecore-module.json file (see Install Alongside Sitecore in Azure PaaS).

Coveo for Sitecore		SXA UI components
Sitecore 10.1 Sitecore 10.0 Sitecore 9.3 Sitecore 9.2 Sitecore 9.1 Sitecore 9.0 Sitecore 8.2 Sitecore 8.1 Sitecore 8.0 Sitecore 7.5 Sitecore 7.2 [Supported Sitecore Versions]	Sitecore 10.1 (WDP) Sitecore 10.0 (WDP) Sitecore 9.1 (WDP)	SXA 10.1 SXA 10.0 SXA 9.3 SXA 1.9 SXA 1.8 SXA 1.7 SXA 1.6 [SXA Compatibility Tables]

Release Notes

This section summarizes the new features and fixed support cases introduced in the Coveo for Sitecore May 28, 2021 release (5.0.971.3).

Coveo Hive search interfaces now perform front-end calls through the Coveo REST endpoint proxy to generate search tokens. Caching /coveo/rest endpoint responses may cause issues.

Identifier	Case	Fixed support case
WEB-4921	00065381, 00065717	Improved Hive initialization events to better support custom scripts.
WEB-4990	00067854	Changed the `Default Frame.cshtml`, `Modular Frame - 3 columns.cshtml`, and `Modular Frame.cshtml` files to fix issue with the Coveo Searchbox not being displayed when `allowQueriesWithoutKeywords` is enabled.

Identifier	Bug fix
WEB-4947	Fixed an inaccurate Rebuild and Refresh button tooltip message in the Command Center.
WEB-4970	Fixed issue with the publishing of the Coveo for Sitecore 10.1 WDP package.
WEB-4977	Fixed issue with custom field mappings in Coveo being wiped out after indexing.

Upgrade Steps

This section describes how to upgrade Coveo for Sitecore from March 26, 2021 (5.0.943.3) to May 28, 2021 (5.0.971.3). If you're upgrading over multiple versions, Coveo has a procedure to streamline the process.

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

Note

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: 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 web database.

〈 Previous version upgrade steps Next version upgrade steps 〉