---
title: May 17, 2019 release (5.0.387.10)
slug: '2875'
canonical_url: https://docs.coveo.com/en/2875/
collection: coveo-for-sitecore-v5
source_format: adoc
---
# May 17, 2019 release (5.0.387.10)
> **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.5926.10 version of the JavaScript Search Framework (see [April 2019 Release (v2.5926.10)]({{ site.baseurl }}/3277#april-2019-release-v25926)).


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


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

This section summarizes the new features and fixed support cases introduced in the Coveo for Sitecore May 17, 2019 release (5.0.387.10).

<div class="table-wrap table-header-nowrap">
  
| Identifier | Enhancement |
|---|---|
| SC-3683 | **[SXA]** Added context item children to the suggested data source locations (see [Coveo Rendering Data Source Locations]({{ site.baseurl }}/2878/)). |
| SC-3683 | **[Hive][SXA]** Added context item children **Coveo Local Parameters Folders** component type folder to the suggested data source locations (see [Coveo Rendering Data Source Locations]({{ site.baseurl }}/2878/)). |
| SC-3743 | **[Command Center]** Improved display of index crawler multi-value attributes. |
| SC-3767 | **[Command Center]** Improved handling of invalid Sitecore credentials at activation. |
| SC-3789 | Support Coveo JavaScript Search Framework version 2.5926. |
| SC-3811 | Support Sitecore 9.1.1. |

</div>
<div class="table-wrap table-header-nowrap">
  
| Identifier | Case | Fixed support case |
|---|---|---|
| SC-3803 | 00050372 | Fixed issues to support Sitecore 9.1 content delivery servers without the `Core` database. |

</div>
<div class="table-wrap table-header-nowrap">
  
| Identifier | Bug fix |
|---|---|
| SC-3766 | **[Command Center]** Fixed table rendering issue in Microsoft Edge. |
| SC-3791 | **[Hive] [SXA]** Fixed issue with Hive and SXA **Coveo Facet Value Suggestion** rendering item IDs being identical. |
| SC-3831 | Fixed index initialization issue on Sitecore 9 `ContentDelivery` servers. |
| SC-3836 | **[Hive]** Fixed issue with `Basic Search Interface Layout.cshtml` throwing an exception on XM Sitecore topology. |
| SC-3838 | Fixed indexing issue on Sitecore XM topology. |
| SC-3863 | Fixed issue with **Coveo Send Analytics to Sitecore** events not being recorded in the Sitecore xDB Interactions table. |

</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 April 18, 2019 (5.0.362.4) to May 17, 2019 (5.0.387.10). If you're upgrading over multiple versions, Coveo has a [procedure]({{ site.baseurl }}/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.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.387.10` 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 `Website\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="coveoauthenticationconfig">Coveo.Authentication.config</h4>

The modification below only pertains to Sitecore 9.1 instances.


The following line:

<div class="language-xml highlighter-rouge"><div class="highlight">
`<span class="nt">&lt;site</span> <span class="na">patch:before=</span><span class="s">"*[1]"</span> <span class="na">name=</span><span class="s">"coveoapi"</span> <span class="na">virtualFolder=</span><span class="s">"/coveo"</span> <span class="na">physicalFolder=</span><span class="s">"/coveo"</span> <span class="na">enableTracking=</span><span class="s">"false"</span> <span class="na">content=</span><span class="s">"master"</span> <span class="na">domain=</span><span class="s">"sitecore"</span> <span class="na">set:loginPage=</span><span class="s">"$(loginPath)shell/SitecoreIdentityServer"</span> <span class="nt">/&gt;</span>
`</pre></div></div>
<p>has been changed to:

<div class="language-xml highlighter-rouge"><div class="highlight">
`<span class="nt">&lt;site</span> <span class="na">patch:before=</span><span class="s">"*[1]"</span> <span class="na">name=</span><span class="s">"coveoapi"</span> <span class="na">virtualFolder=</span><span class="s">"/coveo"</span> <span class="na">physicalFolder=</span><span class="s">"/coveo"</span> <span class="na">enableTracking=</span><span class="s">"false"</span> <span class="na">content=</span><span class="s">"master"</span> <span class="na">domain=</span><span class="s">"sitecore"</span> <span class="na">set:loginPage=</span><span class="s">"$(loginPath)shell/SitecoreIdentityServer"</span><span class="nt">&gt;</span>
  <span class="nt">&lt;patch:attribute</span> <span class="na">role:require=</span><span class="s">"ContentDelivery"</span> <span class="na">name=</span><span class="s">"content"</span><span class="nt">&gt;</span>web<span class="nt">&lt;/patch:attribute&gt;</span>
<span class="nt">&lt;/site&gt;</span>
`</pre></div></div>
<p>The modification below only pertains to Sitecore 9.1 instances.


The `&lt;site name="coveoapi"` element has been moved to become the first child of the `&lt;sites&gt;` element. Comments regarding the `&lt;site name="coveoapi"` and `&lt;site name="coveorest"` elements have been changed accordingly.


When combined, the result of the two Sitecore 9.1 changes above on the `&lt;sites&gt;` element is the following:

<div class="language-xml highlighter-rouge"><div class="highlight">
`<span class="nt">&lt;sites&gt;</span>
  <span class="c">&lt;!-- The site coveoapi needs to be inserted as the first element, or before any other sites that have the coveoapi site as a child (for example, sites defined with virtualpath="/coveo*"). --&gt;</span>
  <span class="nt">&lt;site</span> <span class="na">patch:before=</span><span class="s">"*[1]"</span> <span class="na">name=</span><span class="s">"coveoapi"</span> <span class="na">virtualFolder=</span><span class="s">"/coveo"</span> <span class="na">physicalFolder=</span><span class="s">"/coveo"</span> <span class="na">enableTracking=</span><span class="s">"false"</span> <span class="na">content=</span><span class="s">"master"</span> <span class="na">domain=</span><span class="s">"sitecore"</span> <span class="na">set:loginPage=</span><span class="s">"$(loginPath)shell/SitecoreIdentityServer"</span><span class="nt">&gt;</span>
    <span class="nt">&lt;patch:attribute</span> <span class="na">role:require=</span><span class="s">"ContentDelivery"</span> <span class="na">name=</span><span class="s">"content"</span><span class="nt">&gt;</span>web<span class="nt">&lt;/patch:attribute&gt;</span>
  <span class="nt">&lt;/site&gt;</span>
  <span class="c">&lt;!-- The site coveorest needs to be inserted before any other sites that have the coveorest site as a child (for example, sites defined with virtualpath="/coveo/rest*"). --&gt;</span>
  <span class="nt">&lt;site</span> <span class="na">patch:before=</span><span class="s">"*[1]"</span> <span class="na">name=</span><span class="s">"coveorest"</span> <span class="na">virtualFolder=</span><span class="s">"/coveo/rest"</span> <span class="na">physicalFolder=</span><span class="s">"/coveo/rest"</span> <span class="na">enableTracking=</span><span class="s">"false"</span> <span class="na">database=</span><span class="s">"web"</span> <span class="na">domain=</span><span class="s">"extranet"</span> <span class="nt">/&gt;</span>
  <span class="c">&lt;!-- The site coveoanalytics needs to be inserted before coveorest, as it requires analytics to be enabled. --&gt;</span>
  <span class="c">&lt;!-- The coveoanalytics website database attribute value should match the published website database attribute value to allow Coveo Usage Analytics logging. --&gt;</span>
  <span class="nt">&lt;site</span> <span class="na">patch:before=</span><span class="s">"*[1]"</span> <span class="na">name=</span><span class="s">"coveoanalytics"</span> <span class="na">virtualFolder=</span><span class="s">"/coveo/rest/v6/analytics"</span> <span class="na">enableTracking=</span><span class="s">"true"</span> <span class="na">database=</span><span class="s">"web"</span> <span class="na">domain=</span><span class="s">"extranet"</span> <span class="nt">/&gt;</span>
  <span class="nt">&lt;site</span> <span class="na">patch:before=</span><span class="s">"*[1]"</span> <span class="na">name=</span><span class="s">"coveo_website"</span> <span class="na">virtualFolder=</span><span class="s">"/sitecore modules/Web/Coveo"</span> <span class="na">physicalFolder=</span><span class="s">"/sitecore modules/Web/Coveo"</span> <span class="na">rootPath=</span><span class="s">"/sitecore/content"</span> <span class="na">startItem=</span><span class="s">"/home"</span> <span class="na">language=</span><span class="s">"en"</span> <span class="na">content=</span><span class="s">"web"</span> <span class="na">domain=</span><span class="s">"sitecore"</span> <span class="na">loginPage=</span><span class="s">"/identity/login/admin/SitecoreIdentityServer"</span> <span class="nt">/&gt;</span>
<span class="nt">&lt;/sites&gt;</span>
`</pre></div></div>
<p>The modification below only pertains to Sitecore 9.1 instances.


The following block has been added inside the `&lt;sitecore&gt;` element.

<div class="language-xml highlighter-rouge"><div class="highlight">
`<span class="nt">&lt;settings&gt;</span>
  <span class="nt">&lt;setting</span> <span class="na">name=</span><span class="s">"Coveo.Framework.DatabasePropertyName"</span> <span class="na">value=</span><span class="s">"web"</span> <span class="nt">/&gt;</span>
<span class="nt">&lt;/settings&gt;</span>
`</pre></div></div>
<p>The modification below pertains to all Sitecore versions except Sitecore 9.1.


The comment line regarding the `&lt;site name="coveorest"` element has been changed from:

<div class="language-xml highlighter-rouge"><div class="highlight">
`<span class="c">&lt;!-- The site coveorest needs to be inserted as the first element, or before any other sites that have the coveorest site as a child (for example, sites defined with virtualpath="/"). --&gt;</span>
`</pre></div></div>
<p>to:

<div class="language-xml highlighter-rouge"><div class="highlight">
`<span class="c">&lt;!-- The site coveorest needs to be inserted as the first element, or before any other sites that have the coveorest site as a child (for example, sites defined with virtualpath="/coveo/rest*"). --&gt;</span>
`</pre></div></div>
<h4 id="coveosearchproviderconfig">Coveo.SearchProvider.config</h4>
<p>The modification below only pertains to Sitecore 9.1 instances.


The `databasePropertyStore/Database` element has been changed from

<div class="language-xml highlighter-rouge"><div class="highlight">
`<span class="nt">&lt;Database&gt;</span>core<span class="nt">&lt;/Database&gt;</span>
`</pre></div></div>
<p>to

<div class="language-xml highlighter-rouge"><div class="highlight">
`<span class="nt">&lt;Database&gt;</span>web<span class="nt">&lt;/Database&gt;</span>
`</pre></div></div>
<h4 id="coveosearchprovidercustomconfig">Coveo.SearchProvider.Custom.config</h4>
<p>If you have Sitecore 9, the `&lt;configuration&gt;` element has been changed from

<div class="language-xml highlighter-rouge"><div class="highlight">
`<span class="nt">&lt;configuration</span> <span class="na">xmlns:patch=</span><span class="s">"http://www.sitecore.net/xmlconfig/"</span> <span class="na">xmlns:coveo=</span><span class="s">"http://www.sitecore.net/xmlconfig/coveo/"</span><span class="nt">&gt;</span>
`</pre></div></div>
<p>to

<div class="language-xml highlighter-rouge"><div class="highlight">
`<span class="nt">&lt;configuration</span> <span class="na">xmlns:patch=</span><span class="s">"http://www.sitecore.net/xmlconfig/"</span> <span class="na">xmlns:role=</span><span class="s">"http://www.sitecore.net/xmlconfig/role/"</span> <span class="na">xmlns:coveo=</span><span class="s">"http://www.sitecore.net/xmlconfig/coveo/"</span><span class="nt">&gt;</span>
`</pre></div></div>
<p>If you have Sitecore 9, the `&lt;index id="Coveo_master_index"&gt;` element has been changed to

<div class="language-xml highlighter-rouge"><div class="highlight">
`<span class="nt">&lt;index</span> <span class="na">role:require=</span><span class="s">"!ContentDelivery"</span> <span class="na">id=</span><span class="s">"Coveo_master_index"</span><span class="nt">&gt;</span>
`</pre></div></div>
<h3 id="step-3-regenerate-and-save-your-encryption-key">Step 3: Regenerate and Save your Encryption Key</h3>
<p><span class="tag applies-to" aria-label="Applies to Sitecore 9.1 instances" data-balloon-pos="up" data-balloon-length="medium">Sitecore 9.1</span>


For Sitecore 9.1 instances only, you must regenerate and save your encryption key in the `web` database and subsequently copy your new configurations across your instances.


  - On your **CM**, regenerate your API keys by using the **Command Center** (see [Modifying Your Coveo Organization]({{ site.baseurl }}/2572#modifying-your-coveo-organization)). Select the same organization than previously configured.
  - Regenerate your Sitecore Credentials using the `Security` panel of the **Command Center** (see [Understanding the Indexing Manager - Security]({{ site.baseurl }}/2566#security)). Re-enter the credentials, and click `Apply and Restart`.
  - Copy the configuration files (see [Deploy Coveo for Sitecore on the Content Delivery Servers - Copying the Configuration Files]({{ site.baseurl }}/2264#step-3-copying-the-configuration-files)).

<h3 id="step-4-publish-your-site">Step 4: 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/2847.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/2904.md#step-2-delete-coveo-for-sitecore-legacy-ui-items)

{nbsp}  
{nbsp}  
{nbsp}