February 15, 2023 release (5.0.1202.1)

This is for:

Developer System Administrator

This release includes the 2.10099.2 version of the JavaScript Search Framework (see JavaScript Search Framework Release Notes).

When using a CDN with the Coveo Hive framework, this release includes the latest 2.10099 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.1202.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).

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.3 / (WDP)
Sitecore 10.2 / (WDP)
Sitecore 10.1 / (WDP)
Sitecore 10.0 / (WDP)
Sitecore 9.3 / (WDP)
Sitecore 9.2 / (WDP)
Sitecore 9.1 / (WDP)

[Supported Sitecore Versions]

SXA 10.3 / (WDP)
SXA 10.2 / (WDP)
SXA 10.1 / (WDP)
SXA 10.0 / (WDP)
SXA 9.3
SXA 1.9
SXA 1.8

[SXA compatibility tables]

Release notes

This section summarizes the new features and fixed support cases introduced in the Coveo for Sitecore February 15, 2023 release (5.0.1202.1).

Important

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

Coveo has ended support for Sitecore 8 versions. Sitecore’s extended support end date for these versions was December 31, 2022.

New features and enhancements

Issue number Description

WEB-6076

Added support for Sitecore 10.3 initial release.

Bug fixes

Issue number Description

WEB-5892

Removed Experience Editor and log warnings when a custom dictionary overrides an out-of-the-box dictionary entry.

WEB-5896

Fixed issue with HideDependentCheckbox which caused Could not find constructor in ReflectionUtil.CreateObject warnings.

WEB-5916

Changed the facet data source Facet name option to Facet ID.

WEB-6030

Fixed issue where a Sitecore source would always display as Rebuilding when the Sitecore instance shuts down or restarts.

Maintenance cases

Issue number Case Description

WEB-5876

00089140

Updated all references of System.Web.WebPages.Razor to 3.0.0.0 and System.Web.Mvc to 5.0.0.0.

WEB-5900

00089647

Optimized use of the cached version of the Coveo license when users are created or updated in Sitecore.

WEB-6024

00090944

Fixed Command Center field inclusion issue in Sitecore 10.1 and higher instances.

WEB-6081

00093476

Fixed issue with searches for @ causing search pages to load forever.

Upgrade steps

This section describes how to upgrade Coveo for Sitecore from August 15, 2022 (5.0.1153.1) to February 15, 2023 (5.0.1202.1). If you’re upgrading over multiple versions, Coveo has a procedure to streamline the process.

Important

See Leading practices when upgrading Coveo for Sitecore and Upgrade Sitecore with Coveo for Sitecore to ensure successful upgrades.

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

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.

⚠️Step 3: Adjust uses of Coveo for Sitecore codebase methods

Note the following changes that were made in the Coveo for Sitecore codebase:

  • Coveo.CloudPlatformClientBase.CloudPlatformClient.IsSecurityProviderCreationAllowed

    This method was removed from the codebase.

  • Coveo.AbstractLayer.Security.PermissionsProviderFactory.CreateProvider

    The signature of this method was changed. It now only accepts one argument of type SecurityConfiguration.

If you’re using these methods in your code, make the necessary adjustments.

〈  Previous version upgrade steps Next version upgrade steps  〉