Coveo for Sitecore 5 is now available!

Installing Coveo for Sitecore 4.0

  • Coveo recommends that you upgrade at least to the March 2016 (3.0.1266) release of Coveo for Sitecore 3.0 before migrating to the April 2016 (4.0.171) release of Coveo for Sitecore 4.0.
  • The Leading Practices When Upgrading Coveo for Sitecore also apply to a migration to Coveo for Sitecore 4.0.

Upgrade Coveo Services

If you upgrade to Coveo for Sitecore On-Premises, you will need to upgrade Coveo Enterprise Search (CES) and the Coveo Search API.

First upgrade your Coveo for Sitecore 3.0 to the version that uses the same CES and Search API version as the Coveo for Sitecore 4.0 release that you plan to install.

  1. Upgrade Coveo Enterprise Search (CES). For more details, see Upgrading CES.
  2. Upgrade Coveo Search API. Follow the normal steps of the installation wizard.

Prepare your Sitecore Instance

  1. Disable all the Coveo for Sitecore configuration files.
    1. In the App_Config/Include folder, add .disabled at the end of the following .config files.
      1. Coveo.SearchProvider.config
      2. Coveo.SearchProvider.Rest.config
      3. Coveo.UI.Controls.config
    2. Sitecore 7.5 In the App_Config/Include/Coveo folder, add .disabled at the end of the Coveo.Analytics.xDB.config file.
    3. Sitecore 7.5 In the App_Config/Include/ExperienceProfileCoveo folder, add .disabled at the end of the Coveo.ExperienceProfile.config file.
  2. If you use Coveo for Sitecore 7.2, or if your Coveo indexes replace Lucene indexes, re-enable Lucene. Go to the App_Config/Include folder, and remove .disabled from the Sitecore.ContentSearch.Lucene.*.config and Sitecore.Social.*.config files.

    Do not remove the .example from the Sitecore.ContentSearch.Lucene.*.config.example files.

Upgrade Coveo for Sitecore

If you are using the Coveo Admin Service in secure mode, please read this notice before installing the package.

In the Coveo.SearchProvider.config file, make sure that the adminServiceUri value uses the same hostname as the one specified in the certificate. If you are using a different hostname, such as localhost, you might get the error below when installing the package.

The remote certificate is invalid according to the validation procedure.
...
[WebException: The underlying connection was closed: Could not establish trust relationship for the SSL/TLS secure channel.]
...
[SecurityNegotiationException: Could not establish trust relationship for the SSL/TLS secure channel with authority 'localhost'.]
  1. Log into the Sitecore Desktop.

  2. Access the Installation Wizard (Sitecore Start Menu > Development Tools > Installation Wizard).
  3. Upload and install the Coveo for Sitecore XX 4.0 (YYY).zip package.
  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. Simply select the Overwrite option and click Apply to all both times.

  6. You may get the following message. Simply select Continue Always.

     Role 'sitecore\Coveo Admin' will not be installed since it already exists.
    
  7. Follow the instructions of the Post Installation Wizard. This will configure certain mandatory settings in the configuration files. For more information, see Installing Coveo for Sitecore.

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

Rebuild your Indexes

Once your client and server are up and running, you should rebuild your indexes (see Coveo for Sitecore Indexing Guide).

Failure to do so will result in the duplication of your index items.

Change the Encryption Key Name

In Coveo for Sitecore 3.0, the name of the encryption key was RijndaelEncryptionKey. However, in Coveo for Sitecore 4.0, it is IndexingEncryptionKey.

To ensure that your encryption key remains valid, rename your encryption key to IndexingEncryptionKey. It is usually located under Data\Coveo\ConfigurationEncryptionKeys.

Configure Your Sources

The Coveo for Sitecore Cloud edition does not use CES anymore, instead relying on the Coveo Cloud platform.

If you had indexed non-Sitecore sources in your previous installation, you need to reconfigure them in the Cloud Platform.

For more information on how to do this, see Adding Content to Your Coveo Organization.

Connecting to Cloud

Coveo for Sitecore 4.0 needs to connect to an organization in the Coveo Cloud platform, whether you are using the Cloud or On-Premises version of Coveo for Sitecore.

In an On-Premises installation, this organization is used to store your CES license. The organization is also used to store your Coveo for Sitecore license. It is thus important that you allow your instances to communicate with the Cloud Platform. To know which IPs the Coveo Cloud platform uses, see Adding and Managing API Keys.

Because a Coveo for Sitecore Cloud installation does not use CES anymore, many services have been moved to the Coveo Cloud platform, including securities and permissions.

For Cloud editions of Coveo for Sitecore, Top Results has moved to the Cloud Platform as part of the Query Pipeline feature, and has been renamed Featured Results. For more information, see Adding and Managing Query Pipeline Featured Results.

Merging Your Modifications into the Configuration Files

Since upgrading Coveo for Sitecore updates the Coveo configuration files with the latest fixes and enhancements, you need to manually merge these modifications 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 do that.

To see the list of modifications that you should perform, see Upgrading Configuration Files from Coveo for Sitecore 3.0 to Coveo for Sitecore 4.0.

Recommended Articles