--- title: October 23, 2023 release (5.0.1277.4) slug: n5jd0437 canonical_url: https://docs.coveo.com/en/n5jd0437/ collection: coveo-for-sitecore-v5 source_format: adoc --- # October 23, 2023 release (5.0.1277.4) :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.10110.0 version of the JavaScript Search Framework (see [June 2023 release (v2.10110.0)](https://docs.coveo.com/en/n14g0321#june-2023-release-v2101100)). When using a CDN with the Coveo Hive framework, this release includes the latest 2.10110 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 October 23, 2023 release (5.0.1277.4). ### New features and enhancements [cols="15,85",options="header"] |=== | Issue number | Description | WEB-6130 | Changed the default configuration to use Coveo organization endpoints during activation. | WEB-6303 | Deprecated the `ProviderIndexUserIdentityHelper` class. | WEB-6446 | Added support for Sitecore 10.3 Update 1. |=== ### Bug fixes [cols="15,85",options="header"] |=== | Issue number | Description | WEB-6253 | Fixed vulnerabilities. | WEB-6339 | Fixed issue with date facet ranges not returning results. | WEB-6453 | Fixed vulnerabilities. |=== ### Maintenance cases [cols="15,15,70",options="header"] |=== | Issue number | Case | Description | WEB-6337 | 00100218 | Removed fast queries. | WEB-6502 | 00102838 | Fixed issue with analytics calls failing when a custom `Coveo REST endpoint` is used. | WEB-6546 | 00105208 | Fixed issue with the clickable URI not being computed correctly when `UseServerUrlFromConfiguration` is used. |=== ### Services created or updated |=== | Issue number | Description | WEB-6130 | Added the `organizations/organizationendpoints` service. |=== ## 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 May 9, 2023 (5.0.1227) to October 23, 2023 (5.0.1277.4). 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/2606/) 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.1277.4 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. > **Important** > > The October 23, 2023, release of Coveo for Sitecore introduced changes that can cause a `500 - Internal Server Error` when trying to access pages such as `/coveo/rest`. > See [Internal Server Error when accessing package pages](https://docs.coveo.com/en/oaa90229/) for the resolution. Here are the modifications to the `.config.example` files between the previous and current Coveo for Sitecore releases: #### Coveo.SearchProvider.config The following element has been removed: ```xml true ``` Apply this change to your configuration. #### Coveo.SearchProvider.Rest.config The `` element value has been changed to `+https://analytics.cloud.coveo.com+`. Apply this change to your configuration. ### 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. ### Step 4: Stop use of `ProviderIndexUserIdentityHelper` and `SkipSitecoreCredentialsUpdate` Coveo for Sitecore stopped using the `ProviderIndexUserIdentityHelper` class to update user identities some time ago. This class would check the `SkipSitecoreCredentialsUpdate` value to determine whether to perform the update or not. The `ProviderIndexUserIdentityHelper` class has now been deprecated and `SkipSitecoreCredentialsUpdate` can be omitted (see [Coveo.SearchProvider.config](#coveo-searchprovider-config)). ### Step 5: (Recommended) Enable organization endpoints This version of Coveo for Sitecore simplifies switching to organization endpoints. To enable organization endpoints, follow the instructions in [Migrate to organization endpoints](https://docs.coveo.com/en/o1ud0002#migrate-to-organization-endpoints). > **Note** > > These steps will change settings in the following configuration files on your main CM server: > > * `\App_Config\Include\Coveo\Coveo.SearchProvider.Rest.Custom.config` > > * `\App_Config\Include\Coveo\Coveo.CloudPlatformClient.Custom.config` ### ⚠️Step 6: Configure the `Coveo analytics endpoint` on search pages > **Important** > > This step is only required if you've set up a custom [Coveo for Sitecore REST endpoint](https://docs.coveo.com/en/2160/). A new `Coveo analytics endpoint` option has been added to the [**Coveo Search Resources**](https://docs.coveo.com/en/3033#data-source-options) rendering data source options. The introduction of this option fixes [an issue](#maintenance-cases) where analytics calls would fail when a custom Coveo REST endpoint was used. If you've set up a custom [Coveo for Sitecore REST endpoint](https://docs.coveo.com/en/2160/), you need to set the `Coveo analytics endpoint` value on all your search pages as well. To set the `Coveo analytics endpoint` value on a search page . Open the search page in the **Experience Editor**. . Select the **Coveo Search Resources** rendering. It's typically at the bottom of the page. . In the floating toolbar, select **Edit the rendering's data source**. It should be the leftmost option in the toolbar. . Set the `Coveo analytics endpoint` value. The value must be harmonized with the custom Coveo REST endpoint value. For example, the following combination of values in a **Coveo Search Resources** data source is valid: * `Coveo REST endpoint`: `/coveo/customendpoint` * `Coveo analytics endpoint`: `/coveo/customendpoint/ua` . Save and publish your changes. --- [〈{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/n3ne0564#step-2-manually-update-coveo-configuration-files) [Next version upgrade steps{nbsp}{nbsp}〉,role="float-end btn home-outline-btn d-inline-flex px-150 mt-100"](https://docs.coveo.com/en/o4te0333#step-2-manually-update-coveo-configuration-files) {nbsp} {nbsp} {nbsp}