---
title: October 30, 2020 release (5.0.822.2)
slug: '3360'
canonical_url: https://docs.coveo.com/en/3360/
collection: coveo-for-sitecore-v5
source_format: adoc
---
# October 30, 2020 release (5.0.822.2)
> **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.
> 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 release includes the 2.9159.8 version of the JavaScript Search Framework (see [June 2020 Release (v2.9159)]({{ site.baseurl }}/3273/)).


When using a CDN with the Coveo Hive Framework, this release includes the latest 2.9159 version of the JavaScript Search Framework (see [Choosing between local and CDN Coveo JavaScript resource files]({{ site.baseurl }}/2629/)).

<h2 id="downloads">Downloads</h2>

> **Important**
>
> An [important issue](https://docs.coveo.com/en/3424.md) with this release was discovered and has been fixed in the December 2020 release.
> Coveo recommends you refrain from upgrading to this release and upgrade to the December 2020 release instead.
> 
> However, as usual, the [upgrade steps](#upgrade-steps) in this release need to be performed prior to upgrading to the December 2020 release (see [General leading practices](https://docs.coveo.com/en/2155.md#general-leading-practices)).


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

This section summarizes the new features and fixed support cases introduced in the Coveo for Sitecore October 30, 2020 release (5.0.822.2).

<div class="table-wrap table-header-nowrap">
  
| Identifier | Enhancement |
|---|---|
| SC-4470 | Enabled Coveo Hive resources to be loaded from the CDN. |
| SC-4570 | Added the possibility to bypass the Coveo for Sitecore reverse proxy (see [Disable the reverse proxy]({{ site.baseurl }}/3401/)).[1](#footnote1) |
| SC-4586 | Added the possibility to disable automatic filtering on Sitecore sources. |
| SC-4587 | Added the possibility to disable Sitecore source creation. |
| SC-4598 | Exposed the **BypassCoveoForSitecoreProxy** setting in the **Command Center**. |

</div>
<div id="footnote1" class="footnote"><sup>1</sup> Front end search token generation was introduced. Caching of the `/coveo/rest` endpoint in general should be avoided.</div>

<div class="table-wrap table-header-nowrap">
  
| Identifier | Case | Fixed Support Case |
|---|---|---|
| SC-4576 | 00062734 | Added support for unhandled UA events in the **Coveo Send Analytics to Sitecore** rendering. |
| SC-4582 | 00063047 | Fixed `Could not resolve the search interface element` console error message when using **Coveo Recommendations** rendering as standalone. |
| SC-4601 | 00063155 | Fixed issue with Coveo for Sitecore reverse proxy adding load balancer/proxy IP to the `X-Forwarded-For` Usage Analytics call header. |
| SC-4609 | 00062822 | Fixed issue with old versions of items not being deleted in the master index of Sitecore 9.1+ instances. |

</div>
<div class="table-wrap table-header-nowrap">
  
| Identifier | Bug Fix |
|---|---|
| SC-4617 | Made `QuerySummaryNoResultsFoundMessage` a versioned field­ for multi-language support. |

</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](#upgrade-steps) to [upgrade to a more recent version](https://docs.coveo.com/en/2155.md#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.md#multi-release-upgrade) of Coveo for Sitecore.



This section describes how to upgrade Coveo for Sitecore from September 18, 2020 (5.0.788.5) to October 30, 2020 (5.0.822.2). If you're upgrading over multiple versions, Coveo has a [procedure]({{ site.baseurl }}/2155#multi-release-upgrade) to streamline the process.

<div class="admonitionblock important">
|  | For the best Coveo for Sitecore experience, always follow the [Leading Practices When Upgrading Coveo for Sitecore]({{ site.baseurl }}/2155/). |
|---|---|
</div>
<h3 id="step-1-upgrade-coveo-for-sitecore">Step 1: Upgrade Coveo for Sitecore</h3>
<div class="admonitionblock 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.. |
|---|---|
</div>

  - 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 5.0.822.2 package built for the specific version of Sitecore you're running.
  - When prompted to overwrite files, click **Yes to all**.
  - When prompted to overwrite items, select **Overwrite**, then click **Apply to all**.

    
|  | NoteYou 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 let's you keep your 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>

The following element has been added.

<div class="language-xml highlighter-rouge"><div class="highlight">
`<span class="nt">&lt;bypassCoveoForSitecoreProxy&gt;</span>false<span class="nt">&lt;/bypassCoveoForSitecoreProxy&gt;</span>
`</pre></div></div>
<p>Apply this change in your configuration.


Having `&lt;bypassCoveoForSitecoreProxy&gt;` set to `false` does not alter the behavior of your instance. Should you wish to have Coveo for Sitecore perform search and analytics calls directly to Coveo, you should patch this setting to `true` in your `Coveo.SearchProvider.Rest.Custom.config` file (see [New Coveo for Sitecore features]({{ site.baseurl }}/3254#bypassing-the-reverse-proxy)).

<h4 id="coveouicontrolsconfig">Coveo.UI.Controls.config</h4>

The `&lt;fieldTypes&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;fieldTypes&gt;</span>
  <span class="nt">&lt;fieldType</span> <span class="na">name=</span><span class="s">"HideDependentCheckbox"</span> <span class="na">type=</span><span class="s">"Coveo.UI.Controls.Controls.HideDependentCheckbox, Coveo.UI.Controls"</span> <span class="nt">/&gt;</span>
<span class="nt">&lt;/fieldTypes&gt;</span>
`</pre></div></div>
<p>The `&lt;renderContentEditor&gt;` element below has been added as a child of the `&lt;pipelines&gt;` element.

<div class="language-xml highlighter-rouge"><div class="highlight">
`<span class="nt">&lt;renderContentEditor&gt;</span>
  <span class="c">&lt;!-- This processor injects custom JavaScript and CSS file link into the Content editor. --&gt;</span>
  <span class="nt">&lt;processor</span> <span class="na">patch:before=</span><span class="s">"*[1]"</span> <span class="na">type=</span><span class="s">"Coveo.UI.Controls.Pipelines.InjectScripts, Coveo.UI.Controls"</span><span class="nt">&gt;</span>
    <span class="nt">&lt;CustomContentEditorJavascript&gt;</span>/sitecore modules/Shell/Coveo/CustomFields/DependentFields.js<span class="nt">&lt;/CustomContentEditorJavascript&gt;</span>
    <span class="nt">&lt;CustomContentEditorStylesheets&gt;&lt;/CustomContentEditorStylesheets&gt;</span>
  <span class="nt">&lt;/processor&gt;</span>
<span class="nt">&lt;/renderContentEditor&gt;</span>
`</pre></div></div>
<p>Apply these changes in your configuration.

<h3 id="step-3-update-your-custom-initialization-and-view-files">Step 3: Update Your Custom Initialization and View Files</h3>

A line has changed in the following files:


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


  - `&lt;SITECORE_INSTANCE_ROOT&gt;\Website\Coveo\Hive\init\init.cshtml`
  - `&lt;SITECORE_INSTANCE_ROOT&gt;\Website\Coveo\Hive\search box init\init.cshtml`
  - `&lt;SITECORE_INSTANCE_ROOT&gt;\Website\Views\Coveo Hive\Initialization\Initialize Recommendations.cshtml`
  - `&lt;SITECORE_INSTANCE_ROOT&gt;\Website\Views\Coveo Hive\Sections\External Components Section.cshtml`
  - `&lt;SITECORE_INSTANCE_ROOT&gt;\Website\Views\Coveo Hive\Validations\Validate Resources Are Included.cshtml`


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


  - `&lt;SITECORE_INSTANCE_ROOT&gt;\Coveo\Hive\init\init.cshtml`
  - `&lt;SITECORE_INSTANCE_ROOT&gt;\Coveo\Hive\search box init\init.cshtml`
  - `&lt;SITECORE_INSTANCE_ROOT&gt;\Views\Coveo Hive\Initialization\Initialize Recommendations.cshtml`
  - `&lt;SITECORE_INSTANCE_ROOT&gt;\Views\Coveo Hive\Sections\External Components Section.cshtml`
  - `&lt;SITECORE_INSTANCE_ROOT&gt;\Views\Coveo Hive\Validations\Validate Resources Are Included.cshtml`


The line used to read as follows:

<div class="language-javascript highlighter-rouge"><div class="highlight">
`<span class="nb">document</span><span class="p">.</span><span class="nx">addEventListener</span><span class="p">(</span><span class="dl">"</span><span class="s2">DOMContentLoaded</span><span class="dl">"</span><span class="p">,</span> <span class="kd">function</span><span class="p">()</span> <span class="p">{</span>
`</pre></div></div>
<p>The line now reads as follows:

<div class="language-javascript highlighter-rouge"><div class="highlight">
`<span class="nb">document</span><span class="p">.</span><span class="nx">addEventListener</span><span class="p">(</span><span class="dl">"</span><span class="s2">CoveoSearchEndpointInitialized</span><span class="dl">"</span><span class="p">,</span> <span class="kd">function</span><span class="p">()</span> <span class="p">{</span>
`</pre></div></div>
<p>If you've created [custom initialization scripts]({{ site.baseurl }}/2788/) or custom view files based on the aforementioned files, ensure you adjust your scripts to listen for the `CoveoSearchEndpointInitialized` event from now on.

<h3 id="step-4-update-custom-view-files-based-on-coveo-page-view-analyticscshtml">Step 4: Update Custom View Files Based on `Coveo Page View Analytics.cshtml`</h3>

The <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> `&lt;SITECORE_INSTANCE_ROOT&gt;\Website\Views\Coveo Hive\Analytics\Coveo Page View Analytics.cshtml` file or <span class="tag applies-to" aria-label="Applies to Sitecore 9 and 10 instances" data-balloon-pos="up" data-balloon-length="medium">Sitecore 9 and 10</span> `&lt;SITECORE_INSTANCE_ROOT&gt;\Views\Coveo Hive\Analytics\Coveo Page View Analytics.cshtml` file has changed substantially.


Ensure you replicate the changes made by Coveo in any custom `.cshtml` files you may have created off of the `Coveo Page View Analytics.cshtml` file.

<h3 id="step-5-update-custom-code-associated-with-filter-on-sitecore-context-database">Step 5: Update Custom Code Associated With Filter on Sitecore Context Database</h3>

If you have custom code associated with the automatic filtering of results based on the current Sitecore context database, this release of Coveo for Sitecore includes a new data source option which controls whether the `source==&lt;SITECORE_SOURCE_NAME&gt;` filter is to be applied (see [Remove Filtering on the Current Sitecore Context Database]({{ site.baseurl }}/3392/)). If the purpose of your custom code was to avoid having this filter added on your search results and recommendations, we recommend that you eliminate your custom code and use the new option instead.


Here are the most significant changes Coveo for Sitecore has made regarding filtering on the current Sitecore context database:


  - the `source==&lt;SITECORE_SOURCE_NAME&gt;` filter is now added to the [constant query expression (cq)]({{ site.baseurl }}/179/)(it used to be added to the [advanced query expression (aq)]({{ site.baseurl }}/175/)).
  - Coveo for Sitecore now adds the `source==&lt;SITECORE_SOURCE_NAME&gt;` filter on the `onBuildingLocalSitecoreInstanceExpression` event (it used to be added on the `onBuildingQuery` event).

<h3 id="step-6-publish-your-site">Step 6: 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/3314.md#step-2-manually-update-the-coveo-configuration-files)
[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/3408.md#step-2-update-firewall-exceptions)

{nbsp}  
{nbsp}  
{nbsp}