February 26, 2019 Release (5.0.239.2)

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.5395.6 version of the JavaScript Search Framework (see January 2019 Release (v.2.5395.6)).

When using a CDN with the Coveo Hive framework, this release includes the latest 2.5395 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 26, 2019 release (5.0.239.2).

Identifier Enhancement
SC-1766 Add component data source field to support additional Coveo JavaScript Search Framework component options.
SC-2052 Make the process of associating Sitecore item templates to search result templates more user-friendly.
SC-2235 [Hive] Add field to Coveo Search Interface data source to reference initialization script (see Use a Custom Search Interface Initialization Script).
SC-2533 [Hive] Add a warning when no SearchPageUri value is defined in a Global Searchbox data source.
SC-3008 [Hive] Add the CoveoTriggers JavaScript Framework component to the Coveo Search Interface.
SC-3122 [Hive] Make the Enable Cancel Last Action, Enable No Results Found Message, and No Results Found Message JavaScript Framework component options available in Coveo Query Summary data sources.
SC-3453 Support Sitecore 9.1.
SC-3491 Support Coveo JavaScript Search Framework version 2.5395.
SC-3517 [Hive] Allow users to create category facets.
SC-3545 [Command Center] Make the Coveo for Sitecore version number selectable.
Identifier Case Fixed support case
SC-3519 00047806 Fixed An item with the same key has already been added. error when executing the coveoIndexingGetTemplates pipeline.
SC-3548 00048390 Improved performance of security identities rebuild.
SC-3562 00048513 Fixed issue with broken search pages when MongoDB is unavailable.
Identifier Bug fix
SC-3122 [Hive] Fixed issue with the Coveo Query Summary Enable search tips and Only display search tips settings not working.
SC-3485 Added setting to disallow forwarding cookies along with search queries.
SC-3516 Fixed the Select field button not showing field suggestions.
SC-3518 [SXA] Fixed issue where RenderingViewPath was not taken into account when using Coveo SXA controllers.
SC-3535 Fixed issue with ItemWithUniqueIdEventHandler unnecessarily updating newly created items.
SC-3536 Fixed issue when pushing Coveo analytics data into xConnect in Sitecore 9.
SC-3546 Fixed issue with the Related Query component Main Search Interface field value not being properly handled.
SC-3551 [Command Center] Added redirection to the Indexes section following an Apply and Restart in the Configuration and Security sections.
SC-3563 Improved rebuild validation when Cloud index replicas are out of sync.
SC-3567 Added validation on Coveo File Result Template component File template name field.

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 1, 2019 (5.0.177.21) to February 26, 2019 (5.0.239.2). 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 Best 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 in to the Sitecore Desktop.

  2. Access the Installation Wizard (Sitecore Start Menu > Development Tools > Installation Wizard).

  3. Upload and install the Coveo for Sitecore XX 5.0.239.2 package.

  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: Delete Two Configuration Files From the \Modules\Coveo Folder

Sitecore 9

The following configuration files have been moved from the <SITECORE_INSTANCE_ROOT>\App_Config\Modules\Coveo folder to the new <SITECORE_INSTANCE_ROOT>\App_Config\Modules\Coveo\Analytics folder:

  • Coveo.Analytics.XConnect.config.disabled

  • Coveo.Analytics.xDB.config

When upgrading, these two files you already had in the <SITECORE_INSTANCE_ROOT>\App_Config\Modules\Coveo folder won't be deleted automatically. You must therefore delete the Coveo.Analytics.XConnect.config.disabled and Coveo.Analytics.xDB.config files located in the <SITECORE_INSTANCE_ROOT>\App_Config\Modules\Coveo folder so that only the ones in the new <SITECORE_INSTANCE_ROOT>\App_Config\Modules\Coveo\Analytics folder remain.

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 to the web database.

〈  Previous version upgrade steps Next version upgrade steps  〉