---
title: May 9, 2023 release (5.0.1227.1)
slug: n3ne0564
canonical_url: https://docs.coveo.com/en/n3ne0564/
collection: coveo-for-sitecore-v5
source_format: adoc
---
# May 9, 2023 release (5.0.1227.1)
:page-create-version-block-in-assets/version-tags/sitecore-version.adoc: done


> **Important**
>
> Per the Coveo [Version Support Lifecycle policy](https://docs.coveo.com/en/1485/), this Coveo for Sitecore 5 release has reached end of support.
> See [available Coveo for Sitecore releases](https://docs.coveo.com/en/2274/).
> 
> 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#multi-release-upgrade) of Coveo for Sitecore.
> 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#multi-release-upgrade) of Coveo for Sitecore.

This release includes the 2.10107.0 version of the JavaScript Search Framework (see [JavaScript Search Framework release notes](https://docs.coveo.com/en/n14g0321#march-2023-release-v2101070)).

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

## Release notes

This section summarizes the new features and fixed support cases introduced in the Coveo for Sitecore May 9, 2023 release (5.0.1227.1).

> **Important**
>
> Coveo Hive search interfaces now perform front-end calls through the [reverse proxy](https://docs.coveo.com/en/3401/) to generate search tokens, even when you disable the proxy.
> [Caching reverse proxy endpoint responses](https://docs.coveo.com/en/n74a0288/) may cause issues.

### New features and enhancements

[cols="15,85",options="header"]
|===
| Issue number | Description

| WEB-5249
| Eliminated no longer required security cache update calls.

| WEB-5801
| Improved the handling of exceptions during the execution of computed field code.

| WEB-6208
| Updated `coveoua.js` to version 2 in the **Coveo Page View Analytics** rendering.

| WEB-6222
| Added support for Coveo JavaScript Search Framework version 2.10107.
|===

### Bug fixes

[cols="15,85",options="header"]
|===
| Issue number | Description

| WEB-6222
| Fixed vulnerabilities.
|===

### Maintenance cases

[cols="15,15,70",options="header"]
|===
| Issue number | Case | Description

| WEB-6197
| 00095248
| Fixed issue with SXA site non-English items being indexed with English content.

| WEB-6233
| 00095257
| Implemented a document push retry strategy to handle `underlying connection was closed` exceptions.
|===

## Upgrade steps

> **Important**
>
> Per the Coveo [Version Support Lifecycle policy](https://docs.coveo.com/en/1485/), this Coveo for Sitecore 5 release has reached end of support.
> See [available Coveo for Sitecore releases](https://docs.coveo.com/en/2274/).
> 
> 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#multi-release-upgrade) of Coveo for Sitecore.
> 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#multi-release-upgrade) of Coveo for Sitecore.

This section describes how to upgrade Coveo for Sitecore from February 15, 2023 (5.0.1202.1) to May 9, 2023 (5.0.1227.1).
If you're upgrading over multiple versions, Coveo has a [procedure](https://docs.coveo.com/en/2155#multi-release-upgrade) to streamline the process.

> **Important**
>
> See [Leading practices when upgrading Coveo for Sitecore](https://docs.coveo.com/en/2155/) and [Upgrade Sitecore with Coveo for Sitecore](https://docs.coveo.com/en/2155/) to ensure successful upgrades.

### Step 1: Upgrade Coveo for Sitecore

> **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** > **Development Tools** > **Installation Wizard**).
. Upload and install the Coveo for Sitecore 5.0.1227.1 package built for the specific version of Sitecore you're running (for example, Sitecore 10.2).
. 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.

![Restart Server and Client dialog](https://docs.coveo.com/en/assets/images/c4sc-v5/new-install-a-package-image.png)

### Step 2: Manually update Coveo configuration files

Coveo for Sitecore packages contain some `.config.example` files.
When you activated Coveo for Sitecore, the `.config.example` configuration files copied to your Sitecore instance were renamed (the `.example` was removed) making them enabled `.config` files.
The name change also prevents the resulting `.config` files from being overwritten by `.config.example` files during a Coveo for Sitecore upgrade.
In a nutshell, Coveo uses `.config.example` files for upgrade configuration changes that must be merged manually.
Otherwise, Coveo uses standard `.config` files that get overwritten during [step 1](#step-1-upgrade-coveo-for-sitecore) of the upgrade process.

> **Tip**
>
> Use a tool like WinMerge to compare the new `+Coveo.**.config.example+` files with your existing `+Coveo.**.config+` files.

Here are the modifications to the `.config.example` files between the previous and current Coveo for Sitecore releases:

#### Coveo.SearchProvider.config

. All eight `<handler type="Coveo.SearchProvider.Events.EntityEventHandler, ...>` elements were removed from the configuration file.
Apply these changes to your configuration.

. Under the `retryGroups/throttlingAndTimeout/conditions` element, the following element was added:

```xml
<condition responseMatch="The underlying connection was closed" />
```

Apply this change to your configuration.

### ⚠️ Step 3: Choose how to handle computed field exceptions

Prior to this release, Coveo for Sitecore wouldn't index an item if an exception occurred during the execution of computed field code.
This release  [introduces an exception handling option](#new-features-and-enhancements) that lets you decide whether

* To index the item without the computed field (default behavior).

OR

* Not to index the item.

If the new default behavior to index the item without the computed field suits you, no action on your part is required.
If not, you can revert to the old indexing behavior.

To revert to the old indexing behavior and skip the item when a computed field exception occurs

. Open the `<SITECORE_INSTANCE_ROOT>\App_Config\Include\Coveo\Coveo.SearchProvider.Custom.config` file in a text editor.

. Add the `<skipItemOnComputedFieldError>` element below as an immediate child of the `<defaultIndexConfiguration>` element.

```xml
<skipItemOnComputedFieldError>True</skipItemOnComputedFieldError>
```

. Save your changes.

> **Note**
>
> When a computed field exception occurs, Coveo logs the `An error has occurred while evaluating the <COMPUTED_FIELD_NAME> computed field on item <ITEM_UNIQUE_ID>` message in the Sitecore logs.

### Step 4: Update custom renderings based on Coveo Page View Analytics

The [**Coveo Page View Analytics**](https://docs.coveo.com/en/3013/) rendering now uses version 2 of the `coveoua.js` file.

If you've created custom renderings based on the **Coveo Page View Analytics** rendering, make sure you [update the `coveoua.js` version number](https://docs.coveo.com/en/3013/) in your custom rendering `.cshtml` view files.

. Open the `.cshtml` file of your custom **Coveo Page View Analytics** rendering in a text editor.

. Locate the following line:

```html
})(window, document, 'script', 'https://static.cloud.coveo.com/coveo.analytics.js/1.0/coveoua.js');
```

. Replace the version number as follows:

```html
})(window, document, 'script', 'https://static.cloud.coveo.com/coveo.analytics.js/2/coveoua.js');
```

. Save your changes.

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

---
[&#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/m9ta0384#step-2-publish-your-site)

[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/n5jd0437#step-2-manually-update-coveo-configuration-files)

{nbsp}  
{nbsp}  
{nbsp}