--- title: August 15, 2022 release (5.0.1153.1) slug: m3gf4364 canonical_url: https://docs.coveo.com/en/m3gf4364/ collection: coveo-for-sitecore-v5 source_format: adoc --- # August 15, 2022 release (5.0.1153.1) > **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.10099.2 version of the JavaScript Search Framework (see [August 2022 Release (v2.10099)](https://docs.coveo.com/en/328/)). When using a CDN with the Coveo Hive framework, this release includes the latest 2.10099 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 August 15, 2022 release (5.0.1153.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. > **Notes** > > * Coveo has ended support for Sitecore 7.2 and 7.5. > Sitecore's [extended support end date](https://support.sitecore.com/kb?id=kb_article_view&sysparm_article=KB0641167#SupportPhasesForSpecificProducts) for these versions was December 31, 2020. > > As a result, the no-longer relevant `Coveo.Framework.Compatibility.ISitecoreFeaturesResolver.HasControlPanelInsideShell()` and `Coveo.Framework.Compatibility.SitecoreFeaturesResolver.HasControlPanelInsideShell()` interface and class methods have been removed from the Coveo for Sitecore solution. > > * Many `Coveo.AbstractLayer.FieldManagement.MetadataNames` class properties have also been deprecated. ### New features and enhancements [cols="15,85",options="header"] |=== | Issue number | Description | WEB-5273 | Enabled the `AddSecurityOnItemsWithDatabase` processor by default when `Index Sitecore permissions` is selected. | WEB-5626 | Added support for Coveo JavaScript Search Framework version 2.10099. |=== ### Bug fixes [cols="15,85",options="header"] |=== | Issue number | Description | WEB-5560 | Improved Command Center handling of Sitecore credentials not being set. | WEB-5688 | Fixed vulnerability. | WEB-5755 | Fixed issue with Sitecore Date and Datetime fields not being added to the Quick view when indexing with the `BasicHtmlContentInBodyProcessor`. | WEB-5765 | Updated links to the new Coveo Administration Console URLs. | WEB-5776 | Stopped taking into account the site definition `ContentStartItem` attribute when resolving item clickable URIs. |=== ### Maintenance cases [cols="15,15,70",options="header"] |=== | Issue number | Case | Description | WEB-5571 | 00077235 | Fixed issue with media items not being attributed the proper host name. | WEB-5668 | 00077563 | Fixed the `BasicHtmlContentInBodyProcessor` template name filtering issue. | WEB-5698 | 00079960 | Ensured the Coveo JavaScript Search Framework takes into account local minified culture files. | WEB-5772 | 00079979 | Added caching of organization status GET request responses to reduce load on Coveo. | WEB-5784 | 00086225 | Ensured search token are not cached to prevent them from expiring. |=== ## 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 March 18, 2022 (5.0.1110.1) to August 15, 2022 (5.0.1153.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** > > For the best Coveo for Sitecore experience, always follow the [upgrading leading practices](https://docs.coveo.com/en/2155/). ### 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.1153.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 | Coveo for Sitecore 5](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.Custom.config The following comment block was removed: ```xml ``` > **Important** > > If you had uncommented this processor in your `Coveo.SearchProvider.Custom.config` to enable it, no action on your part is required. > > If the above comment block appears as is in your `Coveo.SearchProvider.Custom.config` (that is, the processor is commented out), you can now remove this code block from your configuration. > > This change is associated with the fact Coveo for Sitecore now automatically enables the `AddSecurityOnItemsWithDatabase` processor when you [select to index Sitecore permissions](#step-4-activate-the-addsecurityonitemswithdatabase-processor). ### Step 3: Account for `ContentStartItem` no longer being considered The Coveo for Sitecore `ResolveItemSiteProcessor` processor used to give precedence to the site definition `ContentStartItem` attribute over the `StartItem` attribute when [resolving clickable URIs at indexing time](https://docs.coveo.com/en/2930#how-the-site-is-resolved-at-indexing-time). Coveo for Sitecore now disregards the `ContentStartItem`. If you have `ContentStartItem` attribute values in your site definitions, the changes in this release might affect the clickable URIs of your items in the index. ### Step 4: Activate the `AddSecurityOnItemsWithDatabase` Processor To enable this processor in past versions of Coveo for Sitecore, you needed to uncomment its configuration in the `Coveo.SearchProvider.Custom.config` file. If the processor is already enabled in your `Coveo.SearchProvider.Custom.config` file, no action is required on your part and the processor will continue to run on your items as it did before. If you're indexing Sitecore permissions and the processor isn't enabled, you should enable it now. > **Note** > > See [Deny Anonymous Users Access to the Master Database](https://docs.coveo.com/en/2716/) for more details on what this processor does. To enable the `AddSecurityOnItemsWithDatabase` processor . Open the Command Center **Security** page. It's accessible at `\http:///coveo/command-center/index.html#security/`. . Un-select the `Index Sitecore permissions` option. . Re-select the `Index Sitecore permissions` option. . Click **Apply and Restart**. ### 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 to the `web` database. ### Step 6: Eliminate use of deprecated `Coveo.AbstractLayer.FieldManagement.MetadataNames` class properties Many `Coveo.AbstractLayer.FieldManagement.MetadataNames` class properties have been deprecated. Eliminate any references you may have to these properties in you project. --- [〈{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/lbic3150#step-2-publish-your-site) [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/m9ta0384#step-2-publish-your-site) {nbsp} {nbsp} {nbsp}