April 18, 2019 release (5.0.362.4)

This is for:

Developer System Administrator
In this article
Important

Per the Coveo Version Support Lifecycle policy, this Coveo for Sitecore 5 release has been retired. See available Coveo for Sitecore releases.

Even if this release is retired, you must still perform some of its upgrade steps to upgrade to a more recent version of Coveo for Sitecore.

This release includes the 2.5652.7 version of the JavaScript Search Framework (see March 2019 Release (v2.5652)).

When using a CDN with the Coveo Hive framework, this release includes the latest 2.5652 version of the JavaScript Search Framework (see Understanding How the Coveo JavaScript Files are Loaded (CDN)).

Warning

There’s an issue with the Coveo Facet Value Suggestions component when using regular Coveo Hive search pages and Coveo for Sitecore SXA search interfaces simultaneously. If you’re using the Coveo Facet Value Suggestions component, see SXA Coveo Facet Value Suggestions Rendering Item Overwriting Hive Item at Installation.

Release Notes

This section summarizes the new features and fixed support cases introduced in the Coveo for Sitecore April 18, 2019 release (5.0.362.4).

Identifier Enhancement
SC-2904 [Command Center] Allow users to refresh a single crawler (see Refreshing a Crawler).
SC-3186 [Command Center] Allow users to view only included fields in the template fields section.
SC-3316 [Command Center] Avoid having to scroll to use the Apply and Restart button in Fields and Configuration sections.
SC-3344 [Command Center] Display all crawler attributes in a modal window.
SC-3388 Make the current version of the Coveo for Sitecore Search UI project available on NPM.
SC-3425 Allow Coveo for Sitecore JavaScript libraries to be imported as a module.
SC-3573 [Command Center] Provide more details when an organization is paused.
SC-3592 [Command Center] Disable Rebuild and Refresh buttons when a rebuild/refresh on the index is in progress.
SC-3599 [Hive] Make the External Components Section console messages more accurate.
SC-3639 [Command Center] Disable Farm name editing when value in Coveo.SearchProvider.Custom.config is patched.
SC-3684 Support Coveo JavaScript Search Framework version 2.5652.
SC-3694 [Command Center] Eliminate Security and Configuration section console warnings.
Identifier Service created or updated
SC-3658 Handle the modified JSON object returned by Coveo on the currentOrganization/status call.
SC-3670 Add the farm EffectiveName parameter value in the GET configure API call response.
SC-3671 Updated the indexes service to return more information on the crawlers.
Identifier Bug fix
SC-3706 [Command Center] Ensured Sitecore fields with names identical to Coveo system fields are created in the Cloud indexes.
SC-3708 Removed unused files from the Coveo for Sitecore 5 package.
SC-3734 Ensured that users can connect to a new organization even if their previous API key is invalid.
SC-3760 [Command Center] Clarified and standardized the organization status modal windows text contents.
SC-3761 Improved handling of errors during SendingPermissions rebuild phase.
SC-3771 [Hive] Removed unused placeholders in the Global Search Section.

Upgrade steps

Important

Per the Coveo Version Support Lifecycle policy, this Coveo for Sitecore 5 release has been retired. See available Coveo for Sitecore releases.

Even if this release is retired, you must still perform some of its upgrade steps to upgrade to a more recent version of Coveo for Sitecore.

This section describes how to upgrade Coveo for Sitecore from March 25, 2019 (5.0.301.4) to April 18, 2019 (5.0.362.4). If you’re upgrading over multiple versions, Coveo has a procedure to streamline the process.

Important

For the best Coveo for Sitecore experience, always follow the upgrading leading practices.

Step 1: Upgrade Coveo for Sitecore

Important

Make sure the Microsoft MVC security update MS14-059 is installed on every Sitecore host in your environment.

  1. Log in to the Sitecore Desktop.

  2. Access the Installation Wizard (Sitecore Start Menu > Development Tools > Installation Wizard).

  3. Upload and install the Coveo for Sitecore XX 5.0.362.4 package.

  4. When prompted to overwrite files, click Yes to all.

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

  6. Once the installation is completed, make sure that you restart both the Sitecore client and server.

    35455209

Step 2: Manually Update the Coveo Configuration Files

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

Coveo.SearchProvider.Custom.config

A <contentSearch> element below has been added as a child of the <sitecore> element. It’s a blueprint for patching the <root> element of your ContentCrawler crawlers, or to add a new crawler, whether on your master or web database.

The <contentSearch> element contents differ, depending on your version of Sitecore (see the For Sitecore Versions 7.2, 7.5, and 8.0 section, the For Sitecore Versions 8.1 and 8.2 section, or the For Sitecore Versions 9.0 and 9.1 section).

For Sitecore Versions 7.2, 7.5, and 8.0
<contentSearch>
  <configuration>
    <indexes hint="list:AddIndex">
      <index id="Coveo_master_index">
        <locations hint="list:AddCrawler">
          <crawler name="ContentCrawler">
            <!-- Uncomment this node if you want to change the crawling root to a smaller part of your site. -->
            <!--<root>/sitecore/content/YOUR_PATH</root> -->
          </crawler>
          <!-- Uncomment this node if you want to crawl a different section of your site. -->
          <!--
          <crawler name="SubSiteCrawler" type="Coveo.SearchProvider.CoveoItemCrawler, Coveo.SearchProviderBase">
            <database>master</database>
            <root>/sitecore/YOUR_PATH</root>
            <stopOnError>true</stopOnError>
          </crawler>
          -->
        </locations>
      </index>
      <index id="Coveo_web_index">
        <locations hint="list:AddCrawler">
          <crawler name="ContentCrawler">
            <!-- Uncomment this node if you want to change the crawling root to a smaller part of your site. -->
            <!--<root>/sitecore/content/YOUR_PATH</root> -->
          </crawler>
          <!-- Uncomment this node if you want to crawl a different section of your site. -->
          <!--
          <crawler name="SubSiteCrawler" type="Coveo.SearchProvider.CoveoItemCrawler, Coveo.SearchProviderBase">
            <database>web</database>
            <root>/sitecore/YOUR_PATH</root>
            <stopOnError>true</stopOnError>
          </crawler>
          -->
        </locations>
      </index>
    </indexes>
  </configuration>
</contentSearch>
For Sitecore Versions 8.1 and 8.2
<contentSearch>
  <configuration>
    <indexes hint="list:AddIndex">
      <index id="Coveo_master_index">
        <locations hint="list:AddCrawler">
          <crawler name="ContentCrawler">
            <!-- Uncomment this node if you want to change the crawling root to a smaller part of your site. -->
            <!--<root>/sitecore/content/YOUR_PATH</root> -->
          </crawler>
          <!-- Uncomment this node if you want to crawl a different section of your site. -->
          <!--
          <crawler name="SubSiteCrawler" type="Sitecore.ContentSearch.SitecoreItemCrawler, Sitecore.ContentSearch">
            <database>master</database>
            <root>/sitecore/YOUR_PATH</root>
            <stopOnError>true</stopOnError>
          </crawler>
          -->
        </locations>
      </index>
      <index id="Coveo_web_index">
        <locations hint="list:AddCrawler">
          <crawler name="ContentCrawler">
            <!-- Uncomment this node if you want to change the crawling root to a smaller part of your site. -->
            <!--<root>/sitecore/content/YOUR_PATH</root> -->
          </crawler>
          <!-- Uncomment this node if you want to crawl a different section of your site. -->
          <!--
          <crawler name="SubSiteCrawler" type="Sitecore.ContentSearch.SitecoreItemCrawler, Sitecore.ContentSearch">
            <database>web</database>
            <root>/sitecore/YOUR_PATH</root>
            <stopOnError>true</stopOnError>
          </crawler>
          -->
        </locations>
      </index>
    </indexes>
  </configuration>
</contentSearch>
For Sitecore Versions 9.0 and 9.1

In the April 18, 2019 release of Coveo for Sitecore 5, the Coveo.SearchProvider.Custom.config.example file contains the following contentSearch/configuration/indexes/ child element:

<index id="Coveo_master_index">
Important

This is an error and the root cause of a known issue (see Sitecore 9 Content Delivery Instance Crashes at Index Initialization).

Instead, the <index id="Coveo_master_index"> element should include a role:require attribute, as follows:

<index role:require="!ContentDelivery" id="Coveo_master_index">

Hence, the block to add inside the <sitecore> element, in your Coveo.SearchProvider.Custom.config file, is the following.

<contentSearch>
  <configuration>
    <indexes hint="list:AddIndex">
      <index role:require="!ContentDelivery" id="Coveo_master_index">
        <locations hint="list:AddCrawler">
          <crawler name="ContentCrawler">
            <!-- Uncomment this node if you want to change the crawling root to a smaller part of your site. -->
            <!--<root>/sitecore/content/YOUR_PATH</root> -->
          </crawler>
          <!-- Uncomment this node if you want to crawl a different section of your site. -->
          <!--
          <crawler name="SubSiteCrawler" type="Sitecore.ContentSearch.SitecoreItemCrawler, Sitecore.ContentSearch">
            <database>master</database>
            <root>/sitecore/YOUR_PATH</root>
            <stopOnError>true</stopOnError>
          </crawler>
          -->
        </locations>
      </index>
      <index id="Coveo_web_index">
        <locations hint="list:AddCrawler">
          <crawler name="ContentCrawler">
            <!-- Uncomment this node if you want to change the crawling root to a smaller part of your site. -->
            <!--<root>/sitecore/content/YOUR_PATH</root> -->
          </crawler>
          <!-- Uncomment this node if you want to crawl a different section of your site. -->
          <!--
          <crawler name="SubSiteCrawler" type="Sitecore.ContentSearch.SitecoreItemCrawler, Sitecore.ContentSearch">
            <database>web</database>
            <root>/sitecore/YOUR_PATH</root>
            <stopOnError>true</stopOnError>
          </crawler>
          -->
        </locations>
      </index>
    </indexes>
  </configuration>
</contentSearch>

Additionally, in your Coveo.SearchProvider.Custom.config file, change the following line:

<configuration xmlns:patch="http://www.sitecore.net/xmlconfig/" xmlns:coveo="http://www.sitecore.net/xmlconfig/coveo/">

to

<configuration xmlns:patch="http://www.sitecore.net/xmlconfig/" xmlns:role="http://www.sitecore.net/xmlconfig/role/" xmlns:coveo="http://www.sitecore.net/xmlconfig/coveo/">

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 to the web database.

〈  Previous version upgrade steps Next version upgrade steps  〉