December 11, 2020 Release (5.0.858.1)
This section provides build 5.0.858.1 download links for all supported versions of Sitecore. Download and install the Coveo for Sitecore package that matches your version of Sitecore (see Install Coveo for Sitecore in a Sitecore On-Premise Environment ).
If you are using SXA and want to be able to insert Coveo components in your SXA pages, download and install both the Coveo for Sitecore package and the SXA UI Components package (see Install Coveo for Sitecore SXA Components).
If you want to upgrade your version of Coveo for Sitecore 5 to this release, follow the upgrade procedure (see Upgrade Steps).
For the simultaneous deployment of Sitecore 9.1 and Coveo for Sitecore on Azure, download the
Sitecore 9.1 (WDP) package and the
coveoforsitecore-module.json file (see Install Coveo for Sitecore Alongside Sitecore in Azure PaaS).
This section summarizes the new features and fixed support cases introduced in the Coveo for Sitecore December 11, 2020 release (5.0.858.1).
|SC-4306||Added the possibility to create Test Organizations directly from Coveo for Sitecore.|
|SC-4592||Added support for the new virtual hosted-style Push API files endpoint (see Validate Routes And Ports).|
|SC-4608||Added option to disable the creation of Sitecore sources when activating Coveo for Sitecore.|
|SC-4678||Added the possibility to select the data residency region when creating a trial organization.|
|Identifier||Case||Fixed Support Case|
|SC-4643||00063772||Applied a wait-and-retry strategy on HTTP calls when pushing documents and permissions.|
|SC-4658||00063825||Reduced load on the content database by eliminating fast queries when using Sitecore dictionaries.|
|SC-4671||00063947||Fixed issue with the
|SC-4693||Fixed issue with Sitecore 10.0 CDs throwing an error when Coveo for Sitecore is not yet activated.|
This section describes how to upgrade Coveo for Sitecore from October 30, 2020 (5.0.822.2) to December 11, 2020 (5.0.858.1).
For the best Coveo for Sitecore experience, always follow the Leading Practices When Upgrading Coveo for Sitecore.
Step 1: Upgrade Coveo for Sitecore
Make sure 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).
- Upload and install the Coveo for Sitecore 5.0.858.1 package built for the specific version of Sitecore you’re running (e.g., Sitecore 9.0). You can find it in Downloads.
- 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: Update Firewall Exceptions
Firewall exception rules for
s3.<REGION>.amazonaws.com are no longer of any use because the endpoint URL has changed to the
<BUCKET_NAME>.s3.<REGION>.amazonaws.com format. Update your firewall exceptions accordingly.
The Command Center Coveo Cloud Organization section now displays the list of platform endpoints your Sitecore instance is using.
Step 3: Manually Update the Coveo Configuration Files
The Coveo configuration files are located in the
App_Config\Include\Coveo folder. When upgrading, you must compare the changes to the
.example files from your current Coveo for Sitecore version with the ones in the build you’re upgrading to. Then, you can merge these changes into your current configuration files. This method let’s you keep your customization intact, while still benefiting from the latest enhancements brought in the product. You can use a merge tool such as WinMerge to accomplish this.
In further detail, here are the modifications that you must perform to the configuration files resulting from the feature changes between the previous and current Coveo for Sitecore releases:
<renderContentEditor> element has been added as the first child of the
<renderContentEditor> <!-- The HideContentEditorFields processor hides sections and fields in the Content Editor. --> <processor patch:before="*[@type='Sitecore.Shell.Applications.ContentEditor.Pipelines.RenderContentEditor.RenderSkinedContentEditor, Sitecore.Client']" type="Coveo.SearchProvider.Processors.ContentEditor.HideContentEditorFields, Coveo.SearchProviderBase" /> </renderContentEditor>
Apply this change in your configuration.
Step 4: Publish Your Site
In the Sitecore Content Editor, perform a publish site action. This ensures any changes related to Coveo components in the upgrade are published to the