February 12, 2021 Release (5.0.900.5)

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.10081.5 version of the JavaScript Search Framework (see October 2020 Release (v2.10081)).

When using a CDN with the Coveo Hive framework, this release includes the latest 2.10081 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 February 12, 2021 release (5.0.900.5).

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-3654 Added a new processor to clean the content of an HTML page before sending it to the index, based on CSS simple selectors.
SC-3899 Improved the performance of the Coveo organization selection dropdown menu using paginated calls.
SC-4722 Added support for Coveo JavaScript Search Framework version 2.10081.
SC-4722 Made the displaySearchOnTop and displaySearchButton JavaScript Framework component options available in the Coveo Category Facet rendering data source.
SC-4751 Rebranded the Command Center, Control Panel and Diagnostic Package to reflect the new Coveo visual identity.
Identifier Case Fixed Support Case
SC-4721 00064528 Fixed the failing calls when trying to send pagerNumber events to Sitecore analytics.
Identifier Bug Fix
SC-4717 Fixed issue with the Australian flag not being displayed in Command Center dropdown menus.
SC-4719 Fixed issue with errors being logged when source creation is disabled and Sitecore user credentials are empty.
SC-4720 Fixed </coveo> location issue in Sitecore 8.1 Coveo.SearchProvider.Custom.config file.
SC-4728 Fixed issue where the ClientSessionWrapper is reusing the same instance of IHttpClient.
SC-4771 Fixed issue where endpoint attributes were not visible in Swagger on the configure call of the API.

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 December 11, 2020 (5.0.858.1) to February 12, 2021 (5.0.900.5). 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.900.5 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.

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.Custom.config

Sitecore 8.1

The closing </coveo> tag location has changed. It's now located immediately before the opening <contentSearch> tag, as shown below.

    </coveo>
    <contentSearch>

Apply these changes in your configuration.

⚠️Step 3: (Optional) Leverage the new CleanHtmlWithSimpleSelectors processor

Warning
WARNING

The CleanHtmlWithSimpleSelectors processor had to be deprecated in the March 26, 2021 release of Coveo for Sitecore. Don’t perform the steps below which would activate the CleanHtmlWithSimpleSelectors processor.

Instead, should you want to remove HTML sections from Sitecore items using CSS selectors, refer to our new article on indexing pipeline extensions (IPEs) which contains a Python script sample you can easily adjust for your specific needs (see Remove HTML Sections From Indexed Sitecore Items).

The CleanHtml processor configuration will be kept if existing. However, we strongly recommend to move to the new CleanHtmlWithSimpleSelectors, which offers an easier way to clean HTML content by using simple CSS selectors.

You can move to the new processor by changing your indexing options in the Command Center. Disable and enable again the Index rendered HTML option. The new processor will then be activated.

The new processor comes with the default selector .coveo-no-index. It's also possible to customize the list of selectors that the processor uses to clean HTML content.

Step 4: (Optional) Leverage the New Category Facet Data Source Options

This version of Coveo for Sitecore adds support for the recently added displaySearchOnTop and displaySearchButton Coveo JavaScript Search Framework component options. For more details on these options and how to leverage them, see Coveo Category 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  〉