March 18, 2022 Release (5.0.1110.1)

This is for:

Developer System Administrator

This release includes the 2.10089.4 version of the JavaScript Search Framework (see August 2021 Release (v2.10089)).

When using a CDN with the Coveo Hive framework, this release includes the latest 2.10089 version of the JavaScript Search Framework (see Understand How Coveo for Sitecore Loads the Coveo JavaScript Files (CDN)).

Downloads

This section provides build 5.0.1110.1 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+ 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.2 / (WDP)
Sitecore 10.1 / (WDP)
Sitecore 10.0 / (WDP)
Sitecore 9.3
Sitecore 9.2
Sitecore 9.1 / (WDP)
Sitecore 9.0
Sitecore 8.2
Sitecore 8.1
Sitecore 8.0
Sitecore 7.5
Sitecore 7.2

[Supported Sitecore Versions]

SXA 10.2 / (WDP)
SXA 10.1 / (WDP)
SXA 10.0 / (WDP)
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 March 18, 2022 release (5.0.1110.1).

Important

  • Though the architecture of the Coveo for Sitecore package DLLs has not changed (that is, the DLLs used to be for x64 architecture and they still are), the architecture description has changed. The DLLs used to be improperly tagged as AnyCPU.

    This change may cause warnings if you’re referencing the Coveo DLLs in your own project files.

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

New Features and Enhancements

Issue number Description

WEB-5325

Added support for Sitecore 10.0 Update-2, 10.0 Update-3, and 10.1 Update-2.

WEB-5327

Added support for Sitecore 10.2 initial release.

WEB-5524

Added logging on the Coveo for Sitecore item URI computation process.

Bug Fixes

Issue number Description

WEB-5328

Improved the handling of invalid certificate errors in the Diagnostic Page.

WEB-5400

Fixed issue with Coveo field MergeWithLexicon, Stemming, Ranking, and IncludeInResults properties being repeatedly updated.

WEB-5476

Fixed inability to initialize multiple Coveo Hosted Search Page components in the same Sitecore page.

WEB-5504

Fixed vulnerabilities.

Maintenance Cases

Issue number Case Description

WEB-5444

00075540

Fixed Promise usage in the Coveo Search Interface initialization code.

WEB-5458

00075299

Fixed issue with Coveo Hosted Search Page rendering not using the Coveo organization region Usage Analytics endpoint.

Upgrade Steps

This section describes how to upgrade Coveo for Sitecore from November 19, 2021 (5.0.1039.1) to March 18, 2022 (5.0.1110.1). If you’re upgrading over multiple versions, Coveo has a procedure to streamline the process.

Important

For the best Coveo for Sitecore experience, always follow the Leading Practices When Upgrading Coveo for Sitecore.

Step 1: Upgrade Coveo for Sitecore

Important

Make sure the Microsoft MVC security update MS14-059 is installed on every Sitecore host in your environment.

  1. Log into the Sitecore Desktop.

  2. Access the Installation Wizard (Sitecore Start Menu > Development Tools > Installation Wizard).

  3. Upload and install the Coveo for Sitecore 5.0.1110.1 package built for the specific version of Sitecore you’re running (for example, Sitecore 10.2). You can find it in Downloads.

  4. When prompted to overwrite files, click Yes to all.

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

  6. Once the installation is completed, make sure that you restart both the Sitecore client and server.

    Restart Server and Client dialog | Coveo for Sitecore 5
Important

Though the architecture of the Coveo for Sitecore package DLLs has not changed (that is, the DLLs used to be for x64 architecture and they still are), the architecture description has changed. The DLLs used to be improperly tagged as AnyCPU.

This change may cause warnings if you’re referencing the Coveo DLLs in your own project files.

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  〉