Upgrading from June 2016 to July 2016

Upgrading from June 2016 to July 2016

This is for:

Developer System Administrator

This section describes how to upgrade Coveo for Sitecore 4.0 from the June 2016 to the July 2016 release.

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

Manually Modify the Layout Files

The CoveoForSitecore.js file has been rewritten to TypeScript. The legacy JavaScript file is still available in the installation package but won’t be improved anymore. You can either:

• Keep the legacy file, or

• Update to the new file

Keep the Legacy File

• In every copy of the resources files: CoveoSearchResources.ascx, SearchViewResources.cshtml, etc, replace the CoveoForSitecore.js dependency with CoveoForSitecoreLegacy.js.

    <script type="text/javascript" src="/Coveo/js/CoveoForSitecoreLegacy.js"></script>
  

Update to the New File

• In every copy of the resources files: CoveoSearchResources.ascx, SearchViewResources.cshtml, etc, replace the CoveoForSitecore.js dependency with CoveoForSitecore.min.js.

    <script type="text/javascript" src="/Coveo/js/CoveoForSitecore.min.js"></script>
  

• In every copy of the layout files: CoveoOmniboxResultList.ascx and OmniboxResultListView.cshtml, replace the initialization call with the JS component:

  CoveoOmniboxResultList.ascx

    <span class="CoveoForSitecoreOmniboxResultList"
          data-header-title='<%= Model.HeaderTitle %>'
          data-query-expression='<%= Model.AdditionalExpression %>'
          data-number-of-results='<%= Model.NumberOfResults %>'
          data-result-template-id='<%= Model.Id %>'>
    </span>
  

  OmniboxResultListView.cshtml

    <span class="CoveoForSitecoreOmniboxResultList"
          data-header-title='@(Html.Raw(Model.HeaderTitle))'
          data-query-expression='@(Html.Raw(Model.AdditionalExpression))'
          data-number-of-results='@Model.NumberOfResults'
          data-result-template-id='@Model.Id'>
    </span>
  

Manually Modify the Search Renderings Files

To support adding many Coveo Search components on the same search page, Search component were given an ID. This ID is generated automatically by Coveo and can be edited to be more friendly in the properties of search components. 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.

Changes to look for:

• The term search has been replaced according to the following table:

  June 2016 release	July 2016 release (Web Forms)	July 2016 release (MVC)
  <div id="search" . . . >	<div id="<%= Model.Id %>" . . . >	<div id="@Model.Id" . . . >
  Coveo.$('#search')	Coveo.$('#<%= Model.Id %>')	Coveo.$('#@Model.Id')

• New properties were added to the searchbox.

Manually Modify the Configuration Files

The following modifications detail what has changed between the June 2016 and July 2016 releases in the .example files.

Coveo.SearchProvider.config

Directly under the coveo node, at the beginning of the section, add the following:

<caches>
  <fieldsCache type="Coveo.Framework.Caching.FieldsCache, Coveo.Framework" singleInstance="true" />
</caches>

Under the coveo/defaultIndexConfiguration node, set the activeDirectorySecurityProvider element to the following, if empty:

<activeDirectorySecurityProviderName>Coveo for Sitecore Active Directory</activeDirectorySecurityProviderName>

Sitecore 8.0

Under the coveo/defaultIndexConfiguration node, before the <exclude hint="list:ExcludeField"> node, add the following:

<exclude hint="list:ExcludeTemplate">
 <mediaFolder>{FE5DD826-48C6-436D-B87A-7C4210C7413B}</mediaFolder>
 <bucketFolder>{ADB6CA4F-03EF-4F47-B9AC-9CE2BA53FF97}</bucketFolder>
</exclude>

For every crawler, in every Coveo index, add the name attribute in the crawler node. There are two crawlers in every index by default; one is named ContentCrawler, and the second one is named MediaLibraryCrawler. This is what the crawlers in the Coveo_master_index node look like after the modification:

<crawler name="ContentCrawler" type="Coveo.SearchProvider.CoveoItemCrawler, Coveo.SearchProviderBase">
  <database>master</database>
  <root>/sitecore/content</root>
  <stopOnError>true</stopOnError>
</crawler>
<crawler name="MediaLibraryCrawler" type="Coveo.SearchProvider.CoveoItemCrawler, Coveo.SearchProviderBase">
  <database>master</database>
  <root>/sitecore/media library/files</root>
  <stopOnError>true</stopOnError>
</crawler>

Sitecore 8.1

Under the coveo/defaultIndexConfiguration node, before the <exclude hint="list:AddExcludedField"> node, add the following:

<exclude hint="list:AddExcludedTemplate">
 <mediaFolder>{FE5DD826-48C6-436D-B87A-7C4210C7413B}</mediaFolder>
 <bucketFolder>{ADB6CA4F-03EF-4F47-B9AC-9CE2BA53FF97}</bucketFolder>
</exclude>

For every crawler, in every Coveo index, add the name attribute in the crawler node. There are two crawlers in every index by default; one is named ContentCrawler, and the second one is named MediaLibraryCrawler. This is what the crawlers in the Coveo_master_index node look like after the modification:

<crawler name="ContentCrawler" type="Sitecore.ContentSearch.SitecoreItemCrawler, Sitecore.ContentSearch">
  <database>master</database>
  <root>/sitecore/content</root>
  <stopOnError>true</stopOnError>
</crawler>
<crawler name="MediaLibraryCrawler" type="Sitecore.ContentSearch.SitecoreItemCrawler, Sitecore.ContentSearch">
  <database>master</database>
  <root>/sitecore/media library/files</root>
  <stopOnError>true</stopOnError>
</crawler>

SwitchMasterToWeb.Coveo.config

Under the sitecore/scheduling node, add the following:

<agent name="CoveoCleanUpAfterRebuild">
  <patch:delete />
</agent>