---
title: November 22, 2019 (5.0.515.1)
slug: '2970'
canonical_url: https://docs.coveo.com/en/2970/
collection: coveo-for-sitecore-v5
source_format: adoc
---
# November 22, 2019 (5.0.515.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.7219.11 version of the JavaScript Search Framework (see [October 2019 Release (v2.7219)](https://docs.coveo.com/en/3277.md#october-2019-release-v27219)).

When using a CDN with the Coveo Hive Framework, this release includes the latest 2.7219 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 November 22, 2019 release (5.0.515.1).

<div class="table-wrap table-header-nowrap">
  
| Identifier | Enhancement |
|---|---|
| SC-4149 | Added support for Coveo JavaScript Search Framework version 2.7219. |

</div>
<div class="table-wrap table-header-nowrap">
  
| Identifier | Case | Fixed support case |
|---|---|---|
| SC-4013 | 00053860 | Fixed the creation of an Example Search Page using the Insert Options feature. |
| SC-4103 | 00055766 | Added handling of malformed `&lt;!-- BEGIN NOINDEX --&gt;` - `&lt;!-- END NOINDEX --&gt;` HTML indexing exclusion tag sequence. |
| SC-4124 | 00056409 | Fixed issue with the `DocumentsValidation` rebuild step failing on custom-named databases. |
| SC-4126 | 00056260 | Fixed erroneous logging of warnings for conflicting Coveo dictionary entry keys. |
| SC-4146 | 00056719 | Fixed issue with the handling of `Sitecore.Jobs` objects in Sitecore 9.2. |
| SC-4153 | 00056369 | Fixed issue with the Coveo for Sitecore reverse proxy forwarding the `Proxy-Connection` header. |

</div>
<div class="table-wrap table-header-nowrap">
  
| Identifier | Bug fix |
|---|---|
| SC-4006 | Fixed improper reporting of invalid usage of Coveo strategies. |
| SC-4022 | Removed the 'Focus on searchbox after initialization' option as it has been removed from the JavaScript Search Framework. |
| SC-4076 | Fixed issue with special characters in queries locking up search pages in Sitecore 7 and 8 instances (see [Ajax Error 500 When Using Special Characters in a Query](https://docs.coveo.com/en/3077.md)). |
| SC-4095 | Fixed issue causing the clickableUri of media items to be indexed with a relative path. |

</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 August 8, 2019 (5.0.461.9) to November 22, 2019 (5.0.515.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.

+

> **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 in to 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.515.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-manually-update-the-coveo-configuration-files">Step 2: Manually Update the Coveo Configuration Files</h3>

The Coveo configuration files are located in the `App_Config\Include\Coveo` folder. When upgrading, you must compare the changes to the `.example` files from your current Coveo for Sitecore version with the ones in the build you're upgrading to. Then, you can merge these changes into your current configuration files. This method allows you to keep your own customization intact, while still benefiting from the latest enhancements brought in the product. You can use a merge tool such as [WinMerge](http://winmerge.org/) to accomplish this.

In further detail, here are the modifications that you must perform to the configuration files resulting from the feature changes between the previous and current Coveo for Sitecore releases:

<h4 id="coveosearchproviderrestconfig">Coveo.SearchProvider.Rest.config</h4>

<span class="tag applies-to" aria-label="Applies to Sitecore 7 and 8 instances" data-balloon-pos="up" data-balloon-length="medium">Sitecore 7 and 8</span>

The `&lt;preprocessRequest&gt;` element below has been added as a child of the `&lt;pipelines&gt;` element to ensure that requests targeting the REST endpoint can handle special characters.

<div class="language-xml highlighter-rouge"><div class="highlight">
`<span class="nt">&lt;preprocessRequest&gt;</span>
  <span class="c">&lt;!-- This processor is required to ensure that requests targeting the REST endpoint can handle special characters. --&gt;</span>
  <span class="nt">&lt;processor</span> <span class="na">patch:instead=</span><span class="s">"processor[@type = 'Sitecore.Pipelines.PreprocessRequest.SuppressFormValidation, Sitecore.Kernel']"</span> <span class="na">type=</span><span class="s">"Coveo.SearchProvider.Rest.Processors.PreprocessRequest.SuppressFormValidation, Coveo.SearchProvider.Rest"</span> <span class="nt">&gt;</span>
    <span class="nt">&lt;urlPaths</span> <span class="na">hint=</span><span class="s">"list:AddUrlPath"</span><span class="nt">&gt;</span>
      <span class="nt">&lt;urlPath&gt;</span>/coveo/rest/<span class="nt">&lt;/urlPath&gt;</span>
      <span class="nt">&lt;urlPath&gt;</span>/sitecore/admin/<span class="nt">&lt;/urlPath&gt;</span>
      <span class="nt">&lt;urlPath&gt;</span>/sitecore/shell/<span class="nt">&lt;/urlPath&gt;</span>
      <span class="nt">&lt;urlPath&gt;</span>/-/speak/request/<span class="nt">&lt;/urlPath&gt;</span>
    <span class="nt">&lt;/urlPaths&gt;</span>
  <span class="nt">&lt;/processor&gt;</span>
<span class="nt">&lt;/preprocessRequest&gt;</span>
`</pre></div></div>
<h4 id="coveouicontrolsspecificconfig">Coveo.UI.Controls.Specific.config</h4>
<p><span class="tag applies-to" aria-label="Applies to Sitecore 8 and 9 instances" data-balloon-pos="up" data-balloon-length="medium">Sitecore 8 and 9</span>

The `&lt;pipelines&gt;` element below has been added as a child of the `&lt;sitecore&gt;` element.

<div class="language-xml highlighter-rouge"><div class="highlight">
`<span class="nt">&lt;pipelines&gt;</span>
  <span class="nt">&lt;group</span> <span class="na">name=</span><span class="s">"itemProvider"</span> <span class="na">groupName=</span><span class="s">"itemProvider"</span><span class="nt">&gt;</span>
    <span class="nt">&lt;pipelines&gt;</span>
      <span class="nt">&lt;addFromTemplate&gt;</span>
        <span class="nt">&lt;processor</span> <span class="na">type=</span><span class="s">"Coveo.SearchProvider.Processors.UIResolveBranchRenderingDataSourcesProcessor, Coveo.SearchProvider"</span> <span class="nt">&gt;</span>
          <span class="nt">&lt;TemplatesToExpand</span> <span class="na">hint=</span><span class="s">"list"</span><span class="nt">&gt;</span>
            <span class="nt">&lt;coveoExampleSearchPage&gt;</span>{0555887D-AB12-46E6-8EA8-93D2E6ED3CB4}<span class="nt">&lt;/coveoExampleSearchPage&gt;</span>
          <span class="nt">&lt;/TemplatesToExpand&gt;</span>
        <span class="nt">&lt;/processor&gt;</span>
      <span class="nt">&lt;/addFromTemplate&gt;</span>
    <span class="nt">&lt;/pipelines&gt;</span>
  <span class="nt">&lt;/group&gt;</span>
<span class="nt">&lt;/pipelines&gt;</span>
`</pre></div></div>
<p>This addition tells Sitecore to call the new `UIResolveBranchRenderingDataSourcesProcessor` processor so that the creation of a new **Example Search Page** using the Insert Options feature works correctly.

<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/2950.md#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/3162.md#step-2-update-to-the-coveo-settings-button-view-file)

{nbsp}  
{nbsp}  
{nbsp}