December 21, 2018 Release (


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 its upgrade steps to upgrade to a more recent version of Coveo for Sitecore.

This release includes the 2.4710.8 version of the JavaScript Search Framework (see October 2018 Release (v2.4710.8)).

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

Release Notes

This section summarizes the new features and fixed support cases introduced in the Coveo for Sitecore December 21, 2018 release (

Identifier Enhancement
SC-1564 In a Coveo-powered search page, either published or in the Experience Editor, output the current version of Coveo for Sitecore when CoveoForSitecore.version is typed in browser developer tools console.
SC-2134 Issue a warning in the web browser developer tools when no analytics component is present on the search page.
SC-3231 Change the display name of the Coveo Analytics rendering in the Content Editor and issue a warning in the Experience Editor to indicate this component is deprecated.
Identifier Bug fix
SC-3112 Removed the legacy Security Provider upgrade utilities.
SC-3439 Fixed issue with Send Analytics to Sitecore component calls returning internal server errors.
SC-3447 Fixed issue with various links redirecting to Coveo for Sitecore 4 documentation pages.

Upgrade Steps

This section describes how to upgrade Coveo for Sitecore from November 23, 2018 ( to December 21, 2018 ( If you're upgrading over multiple versions, Coveo has a procedure to streamline the process.


For the best Coveo for Sitecore experience, always follow the Best Practices When Upgrading Coveo for Sitecore.

Step 1: Upgrade Coveo for Sitecore


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 package. You can find it in Downloads.

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

  5. When prompted to overwrite items, select Overwrite, then click Apply to all.


    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.

Step 2: Replace the Coveo Analytics Component With the Coveo for Sitecore Analytics Component

The Coveo Analytics component has been deprecated. If you’re using this component in your Coveo-powered search interface(s), we recommend you use the Coveo for Sitecore Analytics component instead.

Step 3: Update Your onSitecoreContextInitialization Event Handler Code

The arguments passed to the JavaScript onSitecoreContextInitialization event of Coveo Hive now pass the isInExperienceEditor attribute instead of isEditing.

If you have registered handlers on the onSitecoreContextInitialization event, ensure that you use the isInExperienceEditor attribute of the ISitecoreContextInitializationEventArgs object from now on.


You had an event handler such as the following in your code:

Coveo.$$(searchInterfaceElement).on("onSitecoreContextInitialization", function(event, args) {
   if (args.isEditing) {
       // ...

You would need to update it as follows:

Coveo.$$(searchInterfaceElement).on("onSitecoreContextInitialization", function(event, args) {
   if (args.isInExperienceEditor) {
       // ...

Step 4: 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.