Upgrading from Coveo for Sitecore 4.1 September 2017 to October 2017

THIS IS ARCHIVED DOCUMENTATION

Upgrading from Coveo for Sitecore 4.1 September 2017 to October 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.1 from the September 2017 to the October 2017 release.

Step 1: Upgrade Coveo Services

Ensure that you have installed the September 2017 release of Coveo Enterprise Search (CES 7.0.7.0.9093). For more details, see Upgrading CES.
Ensure that you have installed the August 2017 release of the Coveo Search API (8.0.1168).

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'.]

Log into the Sitecore Desktop.
Access the Installation Wizard (Sitecore Start Menu > Development Tools > Installation Wizard).
Install the Coveo for Sitecore .zip package.
When prompted to overwrite files, click Yes to all.
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.
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

Merging Your Modifications into the Configuration Files

Since upgrading Coveo for Sitecore modifies the Coveo Search Provider configuration files (Coveo.SearchProvider.config.example and Coveo.SearchProvider.Custom.config.example) with the latest fixes and enhancements, you need to manually merge these modifications into your current configuration files (Coveo.SearchProvider.config and Coveo.SearchProvider.Custom.config). 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.

Step 1: Upgrade Coveo for Sitecore

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

Log into the Sitecore Desktop.
Access the Installation Wizard (Sitecore Start Menu > Development Tools > Installation Wizard).
Install the Coveo for Sitecore .zip package.
When prompted to overwrite files, click Yes to all.
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.
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

Merging Your Modifications into the Configuration Files

`Coveo.SearchProvider.config`

Inside the externalFields element, add the following elements:

<field fieldName="sysattachmentparentid" />
<field fieldName="sysclickableuri" />
<field fieldName="sysindexeddate" />
<field fieldName="sysisattachment" />
<field fieldName="syslanguage" />
<field fieldName="sysprintableuri" />
<field fieldName="sysattachmentparentid" />
<field fieldName="syssize" />
<field fieldName="systitle" />
<field fieldName="systopparent" />
<field fieldName="systopparentid" />
<field fieldName="systransactionid" />
<field fieldName="sysuri" />
<field fieldName="sysurihash" />

In the new Coveo.SearchProvider.config.example file for Sitecore 8.1, those lines are missing. You still need to add them to your Coveo.SearchProvider.config file.

At the end of the retryGroups element, add the following elements:

<serverError type="Coveo.Framework.Utils.Rest.HttpWaitAndRetryGroup, Coveo.Framework">
  <retryStrategy type="Coveo.Framework.Utils.Rest.ConstantIntervalRetryStrategy">
    <numberOfRetry>10</numberOfRetry>
    <interval>00:00:03</interval>
  </retryStrategy>
  <conditions hint="raw:AddCondition">
    <condition statusCodes="500" />
  </conditions>
</serverError>

Step 3: Fixing the FilterExpressionRules Issue

This release of Coveo for Sitecore doesn’t display FilterExpressionRule in the parameters for the Search View, but only BoostExpressionRules. This bug was caused by a small problem in our packaging process.

To fix this issue, follow these steps:

Log into the Content Editor of your Coveo for Sitecore instance.
In the Sitecore/Templates/CoveoModule/Search folder, locate both Coveo Search Parameters > Results scope and Coveo Search Base Parameters > Results scope.
Move the FilterExpressionRules item from Coveo Search Parameters > Results scope to Coveo Search Base Parameters > Results scope.
Delete the Coveo Search Parameters > Results scope folder (the one with the Folder icon), as it’s no longer needed.

Note that this is only for the October 2017 release of Coveo for Sitecore 4.1.