Coveo for Sitecore 5 is now available!

Upgrading from October 2016 (4.0.704) to December 2016 (4.0.780)

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 October 2016 to the December 2016 release.

Step 1 - Upgrade Coveo Services

  1. Ensure you have installed the December 2016 release of Coveo Enterprise Search (CES 7.0.8691). For more details, see Upgrading CES.

  2. Ensure you have installed the May 2016 release of the Coveo Search API (8.0.1130).

Step 2 - Upgrade Coveo for Sitecore

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

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 (780).zip 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. Simply 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

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

Please, 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. Upload and install the Coveo for Sitecore XX 4.0 (780).zip 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. Simply 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

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.

Coveo.SearchProvider.config

In the events timingLevel="custom" node, before the event name="item:deleting" node, add the following snippet:

<event name="item:created">
  <handler type="Coveo.SearchProvider.Processors.Indexing.Templates.TemplateInUseEventHandler, Coveo.SearchProviderBase" method="OnItemCreated" />
</event>
<event name="item:templateChanged">
  <handler type="Coveo.SearchProvider.Processors.Indexing.Templates.TemplateInUseEventHandler, Coveo.SearchProviderBase" method="OnItemTemplateChanged" />
</event>

After the event name="item:deleting" node, add the following node:

<event name="item:moved">
  <handler type="Coveo.SearchProvider.Processors.Indexing.Templates.TemplateInUseEventHandler, Coveo.SearchProviderBase" method="OnItemMoved" />
</event>

In the event name="item:saved" node, add the following handler:

<handler type="Coveo.SearchProvider.Processors.Indexing.Templates.TemplateInUseEventHandler, Coveo.SearchProviderBase" method="OnItemSaved" />

In the coveoIndexingGetTemplates node, change the type="Coveo.AbstractLayer.Processors.Indexing.Templates.AddAllTemplatesProcessor processor as such:

<processor type="Coveo.SearchProvider.Processors.Indexing.Templates.AddTemplatesForIndexedItems, Coveo.SearchProviderBase">
  <ApplyInboundFilter>true</ApplyInboundFilter>
</processor>

After this processor, add the following processor:

<!-- The IncludeBaseTemplates processor ensures that all necessary base templates are added for the templates included so far. -->
<processor type="Coveo.SearchProvider.Processors.Indexing.Templates.IncludeBaseTemplates, Coveo.SearchProviderBase" />

After the adminServiceConfiguration node, add the following configuration:

<!-- Coveo security configuration -->
<securityConfiguration type="Coveo.Framework.Configuration.SecurityConfiguration, Coveo.Framework" />

In the fieldNames hint="raw:AddFieldByFieldName" node, the fieldType fieldName="_id" node should read:

<fieldType fieldName="_id" includeForFreeTextSearch="true" settingType="Coveo.Framework.Configuration.FieldConfiguration, Coveo.Framework" type="Sitecore.Data.ID, Sitecore.Kernel" returnType="System.String" />

Sitecore 8.1 

For Sitecore 8.1+, at the end of your index nodes, after the <propertyStore ref="contentSearch/indexConfigurations/databasePropertyStore" param1="$(id)"/> node, add the following settings. Do this for every index.

By default, you should only have the Coveo_master_index and Coveo_web_index.

<enableItemLanguageFallback>false</enableItemLanguageFallback>
<enableFieldLanguageFallback>false</enableFieldLanguageFallback>

Coveo.SearchProvider.Rest.config

At the end of the getSearchUserIdentities, add the following processor:

<!-- This processor modifies the identity list only when the said list is empty.
     In such case, it adds the global Everyone role to the list of identities. -->
<processor type="Coveo.SearchProvider.Rest.Processors.GetSearchUserIdentities.AddEveryoneRoleWhenNoIdentities, Coveo.SearchProvider.Rest" />