THIS IS ARCHIVED DOCUMENTATION

Upgrading from April 2017 to June 2017

This is for:

Developer System Administrator

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

This section describes how to upgrade Coveo for Sitecore 4.0 from the April 2017 to the June 2017 release.

Step 1: Upgrade Coveo Services

  1. Ensure that you have installed the March 2017 release of Coveo Enterprise Search (CES 7.0.8996). For more details, see Upgrading CES.

  2. Ensure that you have installed the March 2017 release of the Coveo Search API (8.0.1134).

Step 2: Upgrade Coveo for Sitecore

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

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

In the Coveo.SearchProvider.config file, make sure that the AdminServiceUri value uses the same host name as the one specified in the certificate. If you’re using a different host name, 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. Install the Coveo for Sitecore .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. 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 3: Manually Update the Coveo Search Provider Configuration File

Step 1: Upgrade Coveo for Sitecore

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

  1. Log into the Sitecore Desktop.

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

  3. Install the Coveo for Sitecore .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. 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: Manually Update the Coveo Search Provider Configuration File

Manually Modify the Search Renderings Files

If you duplicated any of the search components (CoveoSearch.ascx for Web Forms or SearchView.cshtml for MVC), you need to manually merge file modifications into your current rendering 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.

Adding Distance Resources to CoveoSearch.ascx Duplicates (Web Forms)

  1. Open the CoveoSearch.ascx duplicate file in a text editor.

  2. Locate the line <div class="coveo-main-section"> and insert the following code block on the next line:

     <div class="coveo-distance-resources-section">
     <sc:placeholder key="coveo-distance-resources" runat="server"></sc:placeholder>
 </div>

  3. Save and close the file.

  4. Repeat procedure for any CoveoSearch.ascx duplicate.

Adding Distance Resources to SearchView.cshtml Duplicates (MVC)

  1. Open the SearchView.cshtml duplicate file in a text editor.

  2. Locate the line <div class="coveo-main-section"> and insert the following code block on the next line:

     <div class="coveo-distance-resources-section">
     @Html.Sitecore().Placeholder("coveo-distance-resources-mvc")
 </div>

  3. Save and close the file.

  4. Repeat the procedure for any SearchView.cshtml duplicate.