Coveo for Sitecore 4 to 5 upgrade procedure

This is for:

Developer System Administrator

This article describes how to upgrade from Coveo for Sitecore 4 to Coveo for Sitecore 5 based on the scenario that matches your current environment. It assumes that you’re ready to choose an upgrade path before completing the scenario-specific upgrade articles referenced throughout this procedure.

Tip
Leading practice

Upgrade to the latest release of Coveo for Sitecore 5.

Prerequisites

Before you start, make sure that you:

Identify your upgrade scenario

The recommended upgrade steps to perform depend on the Coveo for Sitecore version and environment you currently have. Select one of the following upgrade scenarios:

Scenario 1: From Coveo for Sitecore 4.0 or Coveo for Sitecore 4.1 using legacy UI components

Incrementally upgrading to Coveo for Sitecore 5 would be ineffective and time-consuming. Instead, you should proceed as follows:

  1. Back up your current Coveo-related files.

  2. Delete all Coveo files and folders from your Sitecore instance.

  3. Download the latest version of Coveo for Sitecore 5.

  4. Install, configure, and activate Coveo for Sitecore 5 in your preferred Sitecore deployment scenario.

  5. Follow the instructions specific to your Sitecore deployment scenario to scale Coveo for Sitecore 5 out to the other instances of your Sitecore environment.

  6. Index your Sitecore content. The Coveo Command Center simplifies this process.

  7. Build your new search solution.

Scenario 2: From a pre-October 2018 release of Coveo for Sitecore 4.1 using Coveo Hive renderings

Important

To upgrade from one Coveo for Sitecore release to the next, you must perform upgrade steps. You can access these upgrade steps through Downloads in Coveo for Sitecore 4.1 and Releases and Downloads in Coveo for Sitecore 5. Upgrade steps almost always contain a Manually Update the Coveo Configuration Files section.

In the following instructions, updating the configuration means performing the Manually Update the Coveo Configuration Files instructions and latter steps from the upgrade steps of a given release, without actually installing the Coveo for Sitecore package itself. You will only install one Coveo for Sitecore package, the latest release of Coveo for Sitecore 5, at the end of the Coveo for Sitecore 4 to Coveo for Sitecore 5 upgrade procedure. You will install the latest release of Coveo for Sitecore 5 normally (that is, install the package and perform release upgrade steps).

To upgrade to the latest release of Coveo for Sitecore 5

  1. If not already done, switch from On-Premises to Cloud indexes.

  2. If not already done, remove any LINQ code querying the Coveo indexes.

  3. Incrementally update your Coveo for Sitecore configuration from your current version of Coveo for Sitecore 4.1 to the October 2018 release of Coveo for Sitecore 4.1 (see Releases).

  4. Update your configuration to the Coveo for Sitecore 5 initial release.

  5. Incrementally update your configuration from the initial release of Coveo for Sitecore 5 to the second to latest release (see Releases and Downloads).

  6. Install the latest release normally.

  7. Perform the post-upgrade steps.

  8. (Recommended) Migrate your search interfaces to a more modern Coveo-powered library.

    Warning
    Legacy feature

    The Coveo Hive Framework is now in maintenance mode and is no longer recommended for new implementations.

    To build new search experiences, use one of Coveo’s more modern, lightweight, and responsive libraries. To get started, see the Build search article.

Scenario 3: From the October 2018 release or post-October 2018 release of Coveo for Sitecore 4.1 using Coveo Hive renderings

Important

To upgrade from one Coveo for Sitecore release to the next, you must perform upgrade steps. You can access these upgrade steps through Downloads in Coveo for Sitecore 4.1 and Releases and Downloads in Coveo for Sitecore 5. Upgrade steps almost always contain a Manually Update the Coveo Configuration Files section.

In the following instructions, updating the configuration means performing the Manually Update the Coveo Configuration Files instructions and latter steps from the upgrade steps of a given release, without actually installing the Coveo for Sitecore package itself. You will only install one Coveo for Sitecore package, the latest release of Coveo for Sitecore 5, at the end of the Coveo for Sitecore 4 to Coveo for Sitecore 5 upgrade procedure. You will install the latest release of Coveo for Sitecore 5 normally (that is, install the package and perform release upgrade steps).

To upgrade to the latest release of Coveo for Sitecore 5

  1. If not already done, switch from On-Premises to Cloud indexes.

  2. If not already done, remove any LINQ code querying the Coveo indexes.

  3. Update your configuration to the Coveo for Sitecore 5 initial release.

  4. Incrementally update your configuration from the initial release of Coveo for Sitecore 5 to the second to latest release (see Releases and Downloads).

  5. Install the latest release normally.

  6. Perform the post-upgrade steps.

  7. (Recommended) Migrate your search interfaces to a more modern Coveo-powered library.

    Warning
    Legacy feature

    The Coveo Hive Framework is now in maintenance mode and is no longer recommended for new implementations.

    To build new search experiences, use one of Coveo’s more modern, lightweight, and responsive libraries. To get started, see the Build search article.

What’s next

After completing the scenario that matches your environment: