---
title: April 15, 2020 release (5.0.655.1)
slug: '3229'
canonical_url: https://docs.coveo.com/en/3229/
collection: coveo-for-sitecore-v5
source_format: adoc
---
# April 15, 2020 release (5.0.655.1)

> **Important**
>
> Per the Coveo [Version Support Lifecycle policy](https://docs.coveo.com/en/1485.md), this Coveo for Sitecore 5 release has reached end of support.
> See [available Coveo for Sitecore releases](https://docs.coveo.com/en/2274.md).
> 
> Even if this release is no longer supported, you must still perform some of its [upgrade steps](#upgrade-steps) to [upgrade to a more recent version](https://docs.coveo.com/en/2155.md#multi-release-upgrade) of Coveo for Sitecore.

This release includes the 2.7968.10 version of the JavaScript Search Framework (see [January 2020 Release (v2.7968)](https://docs.coveo.com/en/3163/)).

When using a CDN with the Coveo Hive Framework, this release includes the latest 2.7968 version of the JavaScript Search Framework (see [Choosing between local and CDN Coveo JavaScript resource files](https://docs.coveo.com/en/2629.md)).

<h2 id="release-notes">Release Notes</h2>

This section summarizes the new features and fixed support cases introduced in the Coveo for Sitecore April 15, 2020 release (5.0.655.1).

<div class="table-wrap table-header-nowrap">
  
| Identifier | Enhancement |
|---|---|
| SC-4252 | Added rendering to support the Coveo JavaScript Search Framework **QuerySuggestPreview** component. |
| SC-4261 | Added data source options to support recently introduced Coveo JavaScript Search Framework **Searchbox**, **ResultList**, and **CategoryFacet** component options. |
| SC-4319 | Added support for SXA 9.3. |

</div>
<div class="table-wrap table-header-nowrap">
  
| Identifier | Case | Fixed Support Case |
|---|---|---|
| SC-4350 | 00059817 | Changed the `AnalyticsEvent` class `CustomMetadatas` property type to an IDictionary&lt;string, object&gt;. This is a breaking change (see [Upgrade Steps](#upgrade-steps)). |
| SC-4361 | 00059860 | Renamed the **Coveo Conditional Renderings** personalization rule condition. |

</div>
<h2 id="upgrade-steps">Upgrade Steps</h2>

> **Important**
>
> Per the Coveo [Version Support Lifecycle policy](https://docs.coveo.com/en/1485.md), this Coveo for Sitecore 5 release has reached end of support.
> See [available Coveo for Sitecore releases](https://docs.coveo.com/en/2274.md).
> 
> Even if this release is no longer supported, you must still perform some of its upgrade steps to [upgrade to a more recent version](https://docs.coveo.com/en/2155.md#multi-release-upgrade) of Coveo for Sitecore.

This section describes how to upgrade Coveo for Sitecore from April 1, 2020 (5.0.642.2) to April 15, 2020 (5.0.655.1). If you're upgrading over multiple versions, Coveo has a [procedure](https://docs.coveo.com/en/2155.md#multi-release-upgrade) to streamline the process.

> **WARNING**
>
> In the `Coveo.Analytics` assembly, the `AnalyticsEvent` class `CustomMetadatas` property has changed type from IDictionary<string, string> to IDictionary<string, object> in order to support other types than Strings.
> This should have been the implementation from the start since these metadata can be objects of any type.
> 
> To ease this breaking change, we added a `TryGetValue` extension method to IDictionary<string, object> which allows to pass in an already typed out value.
> If used, this extension will simply require you add the `Coveo.Framework.Collections` namespace in your using statements.
> **Important**
>
> For the best Coveo for Sitecore experience, always follow the [upgrading leading practices](https://docs.coveo.com/en/2155.md).

<h3 id="step-1-upgrade-coveo-for-sitecore">Step 1: Upgrade Coveo for Sitecore</h3>

> **Important**
>
> Make sure the Microsoft MVC security update [MS14-059](https://docs.microsoft.com/en-us/security-updates/SecurityBulletins/2014/ms14-059) is installed on every Sitecore host in your environment.

  - Log into the Sitecore Desktop.
  - Access the Installation Wizard (**Sitecore Start Menu** &gt; **Development Tools** &gt; **Installation Wizard**).
  - Upload and install the `Coveo for Sitecore XX 5.0.655.1` 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.

<h3 id="step-2-optional-configure-new-data-source-options-on-existing-renderings">Step 2: (Optional) Configure New Data Source Options on Existing Renderings</h3>

In this release, Coveo for Sitecore fronts recently added Coveo JavaScript Search Framework component options in its data sources. Though none of the renderings default behavior have changed, you may want to leverage some of these new data source options in your existing renderings.

Here are the rendering data source options that have been added:

**Coveo Searchbox** rendering:

  - The [Height](https://coveo.github.io/search-ui/components/searchbox.html#options.height) option has been added.
  - The [Query suggest character threshold](https://coveo.github.io/search-ui/components/omnibox.html#options.querysuggestcharacterthreshold) option has been added.
  - The [Clear filters on new query](https://coveo.github.io/search-ui/components/omnibox.html#options.clearfiltersonnewquery) option has been added.

**Coveo Category Facet** rendering:

  - The [Depends on](https://coveo.github.io/search-ui/components/categoryfacet.html#options.dependson) option has been added.

**Coveo Results List** rendering:

  - The [Enable scroll to top](https://coveo.github.io/search-ui/components/resultlist.html#options.enablescrolltotop) option has been added.

<h3 id="step-3-publish-your-site">Step 3: Publish your site</h3>

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.

---
[&#9001;{nbsp}{nbsp}Previous version upgrade steps,role="float-start btn home-outline-btn d-inline-flex px-150 mt-100"](https://docs.coveo.com/en/3204.md#step-2-rename-fields-containing-the-zd23x-pattern)
[Next version upgrade steps{nbsp}{nbsp}&#9002;,role="float-end btn home-outline-btn d-inline-flex px-150 mt-100"](https://docs.coveo.com/en/3235.md#step-2-remove-no-longer-used-json-file)

{nbsp}  
{nbsp}  
{nbsp}