March 25, 2019 release (5.0.301.4)

This is for:

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.5549.2 version of the JavaScript Search Framework (see February 2019 Release (v2.5549)).

When using a CDN with the Coveo Hive framework, this release includes the latest 2.5549 version of the JavaScript Search Framework (see Understanding How the Coveo JavaScript Files are Loaded (CDN)).

WARNING

There’s an issue with the Coveo Facet Value Suggestions component when using regular Coveo Hive search pages and Coveo for Sitecore SXA search interfaces simultaneously. If you’re using the Coveo Facet Value Suggestions component, see SXA Coveo Facet Value Suggestions Rendering Item Overwriting Hive Item at Installation.

Release Notes

This section summarizes the new features and fixed support cases introduced in the Coveo for Sitecore March 25, 2019 release (5.0.301.4).

Identifier	Enhancement
SC-2532	[Hive] Display an error in Experience Editor if the External Components Section `Search Interface` field is empty.
SC-2810	[Command Center] Prompt users for confirmation on the index Rebuild All action.
SC-2840	[Hive] Allow users to add facet value suggestions (see Add Facet Value Suggestions to Query Suggestions).
SC-2840	[Hive] Embed the Coveo HiddenQuery Coveo JavaScript Search Framework component markup in the `Coveo Search Interface.cshtml` file to support facet value suggestions.
SC-3071	[Command Center] Prompt users for confirmation on actions that restart the Sitecore instance.
SC-3169	[Hive] Display a warning in the web browser developer tools if a Coveo for Sitecore Analytics component is present in the page to indicate that analytics are only logged in a published page.
SC-3189	[Command Center] Allow users to select and unselect all fields in a template (see Understanding the Indexing Manager).
SC-3202	[Command Center] Filtered out Coveo component data source fields from the Template fields table.
SC-3353	Removed hyphens in Coveo for Sitecore item names to avoid potential invalid character issues.
SC-3401	Ensure that the Coveo system fields are created on the Coveo organization upon synchronization.
SC-3553	Support Coveo JavaScript Search Framework version 2.5549.
SC-3564	[SXA] Support the SXA grid rendering parameters.
SC-3577	[Hive] Allow users to change the Coveo Global Searchbox initialization script (see Use Custom Initialization Scripts).
SC-3593	The debug logging in the indexing process now shows added and removed document IDs along with their batch ID.

Identifier	Service created or updated
SC-3605	Added parameter in `fields/bytemplate` service to return only fields included for indexing.
SC-3618	Added a service to refresh an index from a specific item path in Sitecore.
SC-3619	Modified the `refresh` POST service to monitor a crawler `RefreshState`.

Identifier	Case	Fixed support case
SC-3580	00048627	Log Coveo `Bad Request` 400 errors response content into Sitecore logs.
SC-3600	00048962	Properly handle retries when HTTP calls are being throttled by Coveo.
SC-3614	00048550	Fixed a concurrency issue when fetching license details.

Identifier	Bug fix
SC-3581	Added `permanentid` to the Coveo Special Fields.
SC-3598	[Hive] Improved the Coveo Search Interface `Initialization File Name` field value validation.

Upgrade Steps

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 26, 2019 (5.0.239.2) to March 25, 2019 (5.0.301.4). If you're upgrading over multiple versions, Coveo has a procedure to streamline the process.

For the best Coveo for Sitecore experience, always follow the Best Practices When Upgrading Coveo for Sitecore.

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 in to the Sitecore Desktop.
Access the Installation Wizard (Sitecore Start Menu > Development Tools > Installation Wizard).
Upload and install the Coveo for Sitecore XX 5.0.301.4 package.
When prompted to overwrite files, click Yes to all.
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.
Once the installation is completed, make sure that you restart both the Sitecore client and server.

Step 2: 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 〉