March 26, 2021 release (5.0.943.3)

This is for:

Developer System Administrator
Important

Per the Coveo Version Support Lifecycle policy, this Coveo for Sitecore 5 release has been retired. See available Coveo for Sitecore releases.

Even if this release is retired, you must still perform some of its upgrade steps to upgrade to a more recent version of Coveo for Sitecore.

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

Release Notes

This section summarizes the new features and fixed support cases introduced in the Coveo for Sitecore March 26, 2021 release (5.0.943.3).

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.
Identifier Enhancement
SC-4052 Added a Coveo for Sitecore Rebuild Process search hub to requests that poll documents after a rebuild.
SC-4107 Removed warnings in the logs when the Coveo indexes were already initialized and when the first entry of the excludedFieldsFactory list wasn't found.
SC-4764 Added support for Sitecore 10.0.1.
WEB-4811 Added support for Sitecore 10.1 and SXA 10.1.
WEB-4824 Added support for Coveo JavaScript Search Framework version 2.10083.
WEB-4824 Added support for Coveo JavaScript Search Framework dynamic facet CustomSort and CustomSortDelimitingCharacter options.
Identifier Case Fixed Support Case
WEB-4795 00065927 Fixed issue with improper Coveo media library item field type preventing generation of valid WDP packages.
WEB-4907 00066467, 00065997, 00066604 Deprecated the CleanHtmlWithSimpleSelectors processor.
Identifier Bug Fix
SC-4777 Fixed email anonymous identity being logged in the Usage Analytics service.
SC-4778 Fixed issue where duplicate Additional Data Attributes prevented the Coveo Search Resources component to initialize properly.
WEB-4796 Fixed issue with errors thrown upon accessing the Content Editor when Coveo for Sitecore is not activated.
WEB-4806 Fixed Invalid token issue when trying to synchronize or switch organization in the Command Center.
WEB-4828 Fixed issue with the Command Center endlessly loading upon login when there is an error getting the list of organizations.

Upgrade Steps

Important

Per the Coveo Version Support Lifecycle policy, this Coveo for Sitecore 5 release has been retired. See available Coveo for Sitecore releases.

Even if this release is retired, you must still perform some of its upgrade steps to upgrade to a more recent version of Coveo for Sitecore.

This section describes how to upgrade Coveo for Sitecore from February 12, 2020 (5.0.900.5) to March 26, 2021 (5.0.943.3). 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.943.3 package built for the specific version of Sitecore you're running (for example, Sitecore 9.0).
  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: Manually Update the Coveo Configuration Files

The Coveo configuration files are located in the App_Config\Include\Coveo folder. When upgrading, you must compare the changes to the .example files from your current Coveo for Sitecore version with the ones in the build you're upgrading to. Then, you can merge these changes into your current configuration files. This method lets you keep your customization intact, while still benefiting from the latest enhancements brought in the product. You can use a merge tool such as WinMerge to accomplish this.

In further detail, here are the modifications that you must perform to the configuration files resulting from the feature changes between the previous and current Coveo for Sitecore releases:

Coveo.SearchProvider.config

The following <processor> element (and its leading comment) has been added as the last child of the <renderContentEditor> element. Until now, this processor definition was located in the Coveo.SearchProvider.Licensing.config file, from which it has been removed.

<!-- The CoveoRenderContentEditor processor hides sections in the Content Editor based on available features. -->
<processor patch:before="*[@type='Sitecore.Shell.Applications.ContentEditor.Pipelines.RenderContentEditor.RenderSkinedContentEditor, Sitecore.Client']" type="Coveo.SearchProvider.Licensing.Processors.CoveoRenderContentEditor, Coveo.SearchProvider.Licensing" />

Apply these changes in your configuration.

(Optional) Coveo.SearchProvider.Custom.config

An empty <settings> element has been added as a child of the <sitecore> element, to streamline the process of patching elements in the <settings> section of the Coveo.SearchProvider.config file.

You can apply this change in your Coveo.SearchProvider.Custom.config file.

Step 3: Enable the CleanHtml Processor

The CleanHtmlWithSimpleSelectors processor added in the February 12, 2021 release of Coveo for Sitecore had to be deprecated in this release. It will no longer be maintained and supported. The instructions below will allow you to revert to the CleanHtml processor.

Tip
An alternative to processors in Sitecore for removing HTML content is using Coveo indexing pipeline extensions (IPEs). After re-enabling the CleanHtml processor, we recommend you refer to the Remove HTML Sections From Indexed Sitecore Items article for instructions and a code sample on how to achieve this.

To re-enable the CleanHtml processor

  1. Open the Command Center Indexing Options accessible at https://<INSTANCE_HOSTNAME>/coveo/command-center/index.html#indexing-options/.

  2. If the Index rendered HTML option is selected

    1. Select Only index Sitecore item data.

    2. Click Apply and Restart.

  3. In the Command Center left menu, select Indexing Options to return to the indexing options screen.

  4. Select the Index rendered HTML option.

  5. Click Apply and Restart.

Step 4: (Optional) Leverage the New Dynamic Facet and Dynamic Hierarchical Facet Data Source Options

This version of Coveo for Sitecore adds support for the recently added Coveo JavaScript Search Framework CustomSort and CustomSortDelimitingCharacter options. The CustomSort option has been added in both the Coveo Dynamic Facet and the Coveo Dynamic Hierarchical Facet data source. The CustomSortDelimitingCharacter option has been added in the Coveo Dynamic Hierarchical Facet data source. For more details on these options and how to leverage them, see Coveo Dynamic Facet - Data Source Options and Coveo Dynamic Hierarchical Facet - Data Source Options.

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.

〈  Previous version upgrade steps Next version upgrade steps  〉