June 11, 2024 release (5.0.1368.1)

This is for:

In this article

Downloads
Release notes
Upgrade steps

This release includes the 2.10116.0 version of the JavaScript Search Framework (see April 2024 release (v2.10116.0)).

When using a CDN with the Coveo Hive framework, this release includes the latest 2.10116 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.1368.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.4 / (WDP) 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.4 / (WDP) 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]

Coveo for Sitecore

SXA UI components

Sitecore 10.4 / (WDP)
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.4 / (WDP)
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 June 11, 2024 release (5.0.1368.1).

Coveo has ended support for Sitecore 9.0 releases. Sitecore’s extended support end date for these versions was December 31, 2023.

New features and enhancements

Issue number	Description
WEB-5554	Updated user interface labels to reflect Coveo Platform terminology.
WEB-6817	Added support for Coveo JavaScript Search Framework version 2.10116.
WEB-6894	Added support for Sitecore 10.4 initial release.

Issue number

Description

WEB-5554

Updated user interface labels to reflect Coveo Platform terminology.

WEB-6817

Added support for Coveo JavaScript Search Framework version 2.10116.

WEB-6894

Added support for Sitecore 10.4 initial release.

Bug fixes

Issue number Description

Issue number	Description
WEB-6620	Changed settings on some special fields (that is, `source` and `permanentid` now have `IsFacet`, `language` now has `IsMultiValue`).
WEB-6622	Improved the efficiency of the security provider creation process.
WEB-6647	Fixed Resources & Support links in the Control Panel.
WEB-6685	Fixed vulnerabilities.
WEB-6836	Fixed the content structure of the Coveo Page View Analytics request payload.
WEB-6922	Removed no longer required usage reporting.
WEB-6937	Fixed the analytics endpoint being used when you bypass the Coveo for Sitecore proxy.
WEB-6954	Simplified the way the Usage Analytics endpoint is composed, depending on the context.

WEB-6620

Changed settings on some special fields (that is, source and permanentid now have IsFacet, language now has IsMultiValue).

WEB-6622

Improved the efficiency of the security provider creation process.

WEB-6647

Fixed Resources & Support links in the Control Panel.

WEB-6685

Fixed vulnerabilities.

WEB-6836

Fixed the content structure of the Coveo Page View Analytics request payload.

WEB-6922

Removed no longer required usage reporting.

WEB-6937

Fixed the analytics endpoint being used when you bypass the Coveo for Sitecore proxy.

WEB-6954

Simplified the way the Usage Analytics endpoint is composed, depending on the context.

Maintenance cases

Issue number Case Description

Issue number	Case	Description
WEB-6562	00104719	Ensured all responses for search queries go through the `coveoProcessParsedRestResponse` pipeline.
WEB-6574	00105544	Fixed issue with wrong language arguments in media item clickable URIs.
WEB-6864	00111719	Stopped logging `'p_Tracker' must not be null'` errors when the Sitecore Tracker is unavailable (for example, when using Sitecore XM).
WEB-6881	00111817, 00112119	Added handling of Sitecore URL rewrites in the recomputation of clickable URIs at query time.

WEB-6562

00104719

Ensured all responses for search queries go through the coveoProcessParsedRestResponse pipeline.

WEB-6574

00105544

Fixed issue with wrong language arguments in media item clickable URIs.

WEB-6864

00111719

Stopped logging 'p_Tracker' must not be null' errors when the Sitecore Tracker is unavailable (for example, when using Sitecore XM).

WEB-6881

00111817, 00112119

Added handling of Sitecore URL rewrites in the recomputation of clickable URIs at query time.

Upgrade steps

This section describes how to upgrade Coveo for Sitecore from October 23, 2023 (5.0.1277.4) to June 11, 2024 (5.0.1368.1). If you’re upgrading over multiple versions, Coveo has a procedure to streamline the process.

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

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.1368.1 package built for the specific version of Sitecore you’re running (e.g., Sitecore 10.2). 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 Coveo configuration files

Coveo for Sitecore packages contain some .config.example files. When you activated Coveo for Sitecore, the .config.example configuration files copied to your Sitecore instance were renamed (the .example was removed) making them enabled .config files. The name change also prevents the resulting .config files from being overwritten by .config.example files during a Coveo for Sitecore upgrade. In a nutshell, Coveo uses .config.example files for upgrade configuration changes that must be merged manually. Otherwise, Coveo uses standard .config files that get overwritten during step 1 of the upgrade process.

You can use a tool like WinMerge to compare the new Coveo..config.example files with your existing Coveo..config files.

The October 23, 2023, release of Coveo for Sitecore introduced changes that can cause a 500 - Internal Server Error when trying to access pages such as /coveo/rest in this release. See Internal Server Error when accessing package pages for the resolution.

Here are the modifications to the .config.example files between the previous and current Coveo for Sitecore releases:

Coveo.SearchProvider.config

The following element has been added as a child of the <fieldNames> element:

<fieldType fieldName="permanentid" isFacet="true" settingType="Coveo.Framework.Configuration.FieldConfiguration, Coveo.Framework" />

Apply this change to your configuration.

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.

〈 Previous version upgrade steps