August 15, 2022 Release (5.0.1153.1)

This release includes the 2.10099.2 version of the JavaScript Search Framework (see August 2022 Release (v2.10099)).

When using a CDN with the Coveo for Sitecore 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.1153.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 Coveo for Sitecore in a Sitecore On-Premise Environment).

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 Coveo for Sitecore 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

[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 August 15, 2022 release (5.0.1153.1).

  • Coveo has ended support for Sitecore 7.2 and 7.5. Sitecore’s extended support end date for these versions was December 31, 2020.

    As a result, the no-longer relevant Coveo.Framework.Compatibility.ISitecoreFeaturesResolver.HasControlPanelInsideShell() and Coveo.Framework.Compatibility.SitecoreFeaturesResolver.HasControlPanelInsideShell() interface and class methods have been removed from the Coveo for Sitecore solution.

  • Many Coveo.AbstractLayer.FieldManagement.MetadataNames class properties have also been deprecated.

New Features and Enhancements

Issue number Description

WEB-5273

Enabled the AddSecurityOnItemsWithDatabase processor by default when Index Sitecore permissions is selected.

WEB-5626

Added support for Coveo JavaScript Search Framework version 2.10099.

Bug Fixes

Issue number Description

WEB-5560

Improved Command Center handling of Sitecore credentials not being set.

WEB-5688

Fixed vulnerability.

WEB-5755

Fixed issue with Sitecore Date and Datetime fields not being added to the Quick view when indexing with the BasicHtmlContentInBodyProcessor.

WEB-5765

Updated links to the new Coveo Administration Console URLs.

WEB-5776

Stopped taking into account the site definition ContentStartItem attribute when resolving item clickable URIs.

Maintenance Cases

Issue number Case Description

WEB-5571

00077235

Fixed issue with media items not being attributed the proper host name.

WEB-5668

00077563

Fixed the BasicHtmlContentInBodyProcessor template name filtering issue.

WEB-5698

00079960

Ensured the Coveo JavaScript Search Framework takes into account local minified culture files.

WEB-5772

00079979

Added caching of organization status GET call responses to reduce load on Coveo.

WEB-5784

00086225

Ensured search token are not cached to prevent them from expiring.

Upgrade Steps

This section describes how to upgrade Coveo for Sitecore from March 18, 2022 (5.0.1110.1) to August 15, 2022 (5.0.1153.1).

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.1153.1 package built for the specific version of Sitecore you’re running (e.g., 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.

    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

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.

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

Coveo.SearchProvider.Custom.config

The following comment block was removed:

<!-- Uncomment this processor to deny anonymous users on items from master database. For more information, see: https://docs.coveo.com/en/2716 -->
<!--
<processor type="Coveo.SearchProvider.Processors.AddSecurityOnItemsWithDatabase, Coveo.SearchProviderBase">
 <database>master</database>
</processor>
-->
Important

If you had uncommented this processor in your Coveo.SearchProvider.Custom.config to enable it, no action on your part is required.

If the above comment block appears as is in your Coveo.SearchProvider.Custom.config (i.e., the processor is commented out), you can now remove this code block from your configuration.

This change is associated with the fact Coveo for Sitecore now automatically enables the AddSecurityOnItemsWithDatabase processor when you select to index Sitecore permissions.

⚠️Step 3: Account For ContentStartItem No Longer Being Considered

The Coveo for Sitecore ResolveItemSiteProcessor processor used to give precedence to the site definition ContentStartItem attribute over the StartItem attribute when resolving clickable URIs at indexing time. Coveo for Sitecore now disregards the ContentStartItem. If you have ContentStartItem attribute values in your site definitions, the changes in this release might affect the clickable URIs of your items in the index.

Step 4: Activate the AddSecurityOnItemsWithDatabase Processor

To enable this processor in past versions of Coveo for Sitecore, you needed to uncomment its configuration in the Coveo.SearchProvider.Custom.config file. If the processor is already enabled in your Coveo.SearchProvider.Custom.config file, no action is required on your part and the processor will continue to run on your items as it did before.

If you’re indexing Sitecore permissions and the processor isn’t enabled, you should enable it now.

See Deny Anonymous Users Access to the Master Database for more details on what this processor does.

To enable the AddSecurityOnItemsWithDatabase processor

  1. Open the Command Center Security page. It’s accessible at http://<INSTANCE_HOSTNAME>/coveo/command-center/index.html#security/.

  2. Un-select the Index Sitecore permissions option.

  3. Re-select the Index Sitecore permissions option.

  4. Click Apply and Restart.

Step 5: 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 6: Eliminate Use of Deprecated Coveo.AbstractLayer.FieldManagement.MetadataNames Class Properties

Many Coveo.AbstractLayer.FieldManagement.MetadataNames class properties have been deprecated. Eliminate any references you may have to these properties in you project.