Coveo for Sitecore 5 is now available!

2017 Coveo for Sitecore 4.0 Releases

This page summarizes the new features and bug fixes introduced throughout 2017.

Release Notes for December 2017: Minor Release 4.0.1606.9

The initial December 2017 release was 4.0.1606.8. However, due to an issue with the Legacy UI, it had to be hotfixed to 4.0.1606.9.

The official December 2017 release is 4.0.1606.9.

This release includes the v1.2537.35 version of the JavaScript Search Framework (see July 2017 Maintenance Release (v1.2537.35)).

This page summarizes the bug fix introduced in the Coveo for Sitecore December 2017 release (4.0.1606.9).

To download the December 2017 release, see Downloads.

Issue number Bug fix
SC-2536 Fixed issue where already translated fields were being double translated, thus breaking the field sort component in the Experience Editor.

Release Notes for December 2017: 4.0.1606.8

The initial December 2017 release was 4.0.1606.8. However, due to an issue with the Legacy UI, it had to be hotfixed to 4.0.1606.9.

The official December 2017 release is 4.0.1606.9 (see Release Notes for December 2017: Minor Release 4.0.1606.9).

This release includes the v1.2537.35 version of the JavaScript Search Framework (see July 2017 Maintenance Release (v1.2537.35)).

This section summarizes the new features and fixed support cases introduced in the Coveo for Sitecore December 2017 release (4.0.1606.8).

To download the December 2017 release, see Downloads.

For the upgrade procedure, see Upgrading from September 2017 (4.0.1536.8) to December 2017 (4.0.1606.8).

Issue number New features
SC-2182 HTMLContentInBodyWithRequestProcessor is now customizable.
SC-2199 Validated Sitecore 8.2 update 5.
SC-2254 Coveo for Sitecore is now FIPS compliant.
SC-2413 Date and Time were added to the Diagnostic Package file name.
SC-2421 SSO pre-authenticator was implemented for FetchPageContent.
Issue number Bug fixes
SC-359

[UI] Removed Renderings and Sublayouts items related to the Coveo Sort.

SC-565 [Wizard] Fixed issue where wizard would throw unhandled exceptions when Coveo Cloud Platform was unavailable.
SC-925 Fixed issue where handle entity didn't exist for SecurityProvider.
SC-1134 [Search Box] Fixed broken component preview for secured target search page.
SC-1194 Fixed issue where SearchIndexName parameter was only used by IndexSourceName property.
SC-1437 Fixed issue where External Content Collections were present in Cloud .
SC-1544 Fixed issue where encryption key was written in the wrong data folder.
SC-1559 Removed obsolete Analytics Top Query Suggestions for all editions.This doesn't affect ML suggestions.
SC-1571 Fixed issue where tab component in the Experience Editor couldn't be added by clicking on the placeholder.
SC-1583 [Security Provider] Fixed issue where first rebuild didn't end because of errors in security identities.
SC-1615 Fixed issue where too many calls were sent to the Cloud Platform during the post-installation wizard.
SC-1670 Validated API key to prevent many denied calls to the platform.
SC-1687 Fixed issue where search page components were not editable if the query returned no result.
SC-1750 Fixed issue where cleaning up unused resources would call the platform twice.
SC-1782 Renamed Cloud admin UI to Cloud Administration Console.
SC-1793 Fixed issue where indexCommunicationFactory element was multiplicated in Coveo.SearchProvider.Custom.config file.
SC-1856 Fixed issue where adding a new user in Sitecore triggered many calls instead of only one.
SC-1869 Fixed issue where CreateAuthorizationStateCookie would use EncryptionKeys file when connecting to the Cloud.
SC-1870 Removed deprecated Enable collapse button from Javascript UI for range facets.
SC-1877 Fixed issue where push of permissions were duplicated.
SC-1915 Fixed issue where recommendation column would'nt disappear on mobile devices screens.
SC-1986 Updated help links for component properties.
SC-1991 [UA] Fixed issue where link was unavailable in visit browser for Coveo for Sitecore result clicks.
SC-2057 Fixed issue where console logging couldn't be disabled.
SC-2081 Fixed issue where user-friendly error message for UI components didn't work.
SC-2105 Fixed issue where sort component would disappear if wrong value field was entered.
SC-2131 Added missing searchHub querystring attribute to query suggest requests in the Experience Editor.
SC-2132 Fixed issue where Standalone searchbox Coveo Machine Learning query suggestions would'nt be on the same page.
SC-2141 Changed title of page Disable Security Permissions on Documents so its has the right title.
SC-2159 Fixed issue where ResolveItemSiteProcessor didn't take site language into account.
SC-2167 Fixed issue where URI had to be logged when its format could be determined.
SC-2173 Added relevant error message in the UI for some actions in the Control Panel .
SC-2240 Fixed issue preventing simultaneous rebuild of Coveo_master and Coveo_web indexes.
SC-2241 Fixed issue where first rebuild after upgrade failed.
SC-2242 Fixed issue where alphabetical sort options would'nt display in the facet option.
SC-2251 Updated deprecated JavaScript Search Framework property in default result template.
SC-2252 Fix issue where Language Integrated Query with Boolean parameters would fail when using equality.
SC-2293 Fixed issue where relevance and date sort components would'nt show when editing the Search Page.
SC-2305 Fixed issue where roles containing a non-existing user were still sent to the expanded provider.
SC-2311 Fixed issue where profiles with manys profile cards were not indexed completely.
SC-2315 Displayed more friendly error message in case of API key creation failure.
SC-2318 Improved diagnostic page error message about the security provider not existing.
SC-2319 Fixed issue where message Item already exists was displayed when installing a package on a new instance.
SC-2323 Fixed issue where supposedly disabled search indexes still appeared in the Sitecore configuration.
SC-2324 Fixed issue where legacy sort components didn't recognize certain fields.
SC-2329 Fixed issue where Sitecore would send many deletion calls for items that were not indexed.
SC-2369 Fixed link Indexing Documents with HTML Content Processor in the installation wizard.
SC-2374 Added error message in the for Update User or Role actions in the UI.
SC-2408 Fixed issue where xDB profiles with different names for their items and keys were not mapped in documents.
SC-2417 Fixed issue where generating a diagnostic package interrupted Sitecore activities.
SC-2427 Added missing external fields to Coveo.SearchProvider.config for Sitecore 8.1.
SC-2429 Fixed issue where mappings were overridden when updating Sitecore source.
SC-2430 Fixed issue where deleted items still appeared in diagnostic page.
SC-2486 Fixed issue where the rebuild process tried to get security provider entities even when the IndexPermissions setting was disabled.
Issue number Case Fixed support cases
SC-2284 00038311 Fixed issue where a client’s analytics interrupted after upgrading from Sitecore 8.0 to 8.2 and from Coveo for Sitecore 4.0 April 2016 to January 2017.

Release Notes for September 2017 Minor Release - 4.0.1536.8

The initial September 2017 release was 4.0.1536.6. However, due to an issue concerning misconfigured CORS (Cross Origin Resource Sharing) headers when using cookies for authentication for Cloud users, it had to be hotfixed to 4.0.1536.8.

The official September 2017 release is 4.0.1536.8.

If you're currently using CORS on your website, you need to manually add your CORS headers before applying this fix.

This release includes the 1.2537.28 version of the JavaScript Search Framework, which is a hotfix version of the July 2017 Minor Release (see July 2017 Minor Release (v1.2537.24)).

This section summarizes the new features and fixed support cases introduced in the Coveo for Sitecore September 2017 release (4.0.1536.6).

To download the September 2017 minor release, see Downloads.

Issue number Bug fixes
SC-2456 Fixed misconfigured CORS headers when using cookies for authentication

Release Notes for September 2017: 4.0.1536.6

The initial September 2017 release was 4.0.1536.6. However, due to an issue concerning misconfigured CORS (Cross Origin Resource Sharing) headers when using cookies for authentication for Cloud users, it had to be hotfixed to 4.0.1536.8.

The official September 2017 release is 4.0.1536.8 (see Release Notes for September 2017 Minor Release - 4.0.1536.8).

If you're currently using CORS on your website, you need to manually add your CORS headers before applying this fix.

This release includes the 1.2537.28 version of the JavaScript Search Framework, which is a hotfix version of the July 2017 Minor Release (see July 2017 Minor Release (v1.2537.24)).

This section summarizes the new features and fixed support cases introduced in the Coveo for Sitecore September 2017 release (4.0.1536.6).

To download the September 2017 release, see Downloads.

For the upgrade procedure, see Upgrading from July 2017 (4.0.1547) to September 2017 (4.0.1536.8).

Issue number Bug fixes
SC-1147 Fixed Certificate Thumbprint validation issue
SC-1382 Added better error messaging in Diagnostic Tool on 400 Bad Request errors
SC-1572 Allow sending analytics when a site uses different content and database databases
SC-1605 Fixed installation issue when the wizard is closed before completing the process
SC-1683 Added better error when accessing a search page with a non-existent Coveo organization
SC-1778 Fixed facet alphabetical sort issue
SC-1798 Fixed issue when adding a field name that already exists on the Coveo Cloud Platform
SC-1983 Fixed issue with deleted custom ranges
SC-2003 Added domain validation when synchronizing permissions
SC-2048 Improved suggested field options in the Coveo.SearchProvider.config file
SC-2103 Ensure that the current language is taken into account with the Related Query component
SC-2137 Fixed missing identities issue after consecutive rebuild or security cache updates
SC-2174 Send pipeline and maximumAge with the Search Box component
SC-2226 Fixed coveoOnPublishEndAsync issue caused by the SwitchMasterToWeb.config file
Issue number Case Fixed support cases
SC-2075 00037497 Redirect to custom 404 page breaks the Coveo component it contains
SC-2136 00037927 Ajax error on every browser but Chrome

Release Notes for July 2017 Minor Release - 4.0.1547

This release includes the 1.2537.28 version of the JavaScript Search Framework, which is a hotfix version of the July 2017 Minor Release (see July 2017 Minor Release (v1.2537.24)).

This page summarizes the fixed support case introduced in the Coveo for Sitecore July 2017 minor release (4.0.1547).

Issue number Case Fixed support cases
SC-2237 00038310 Date Facet disappears when clicking any other facet

Release Notes for July 2017 Minor Release - 4.0.1526

This release includes the 1.2537.24 version of the JavaScript Search Framework (see July 2017 Minor Release (v1.2537.24)).

The initial July 2017 release was 4.0.1520. However, due to a performance issue, it had to be hotfixed to 4.0.1526.

Due to a display issue with the JavaScript Search Framework, the 4.0.1526 release was hotfixed (see Release Notes for July 2017 Minor Release - 4.0.1547). The official July 2017 release is 4.0.1547.

This page summarizes the bug fix introduced in the Coveo for Sitecore July 2017 minor release (4.0.1526).

Issue number Bug fixes
SC-2130 Fixed issue causing specific entities to be disabled upon rebuild

Release Notes for July 2017: 4.0.1520

This release includes the 1.2537.24 version of the JavaScript Search Framework (see July 2017 Minor Release (v1.2537.24)).

The initial July 2017 release was 4.0.1520. However, due to a performance issue, it had to be hotfixed to 4.0.1526 (see Release Notes for July 2017 Minor Release - 4.0.1526).

Due to a display issue with the JavaScript Search Framework, the 4.0.1526 release was hotfixed (see Release Notes for July 2017 Minor Release - 4.0.1547). The official July 2017 release is 4.0.1547.

This section summarizes the new features and fixed support cases introduced in the Coveo for Sitecore July 2017 release (4.0.1520).

To download the July 2017 release, see Downloads.

For the upgrade procedure, see Upgrading from June 2017 (4.0.1461) to July 2017 (4.0.1547).

Issue number New features
SC-1684 Use OrderingId instead of deprecated OperationId when calling the Push API
SC-1822 Use S3 for all push calls to Coveo Cloud
SC-1958 Avoid making unnecessary calls to the Cloud Platform when getting the TOO_MANY_FIELDS exception
SC-2054 Qualify Sitecore 8.2 update 4 for compatibility with Coveo for Sitecore 4.0
SC-2088 Update the JavaScript Search Framework to the July Minor Release (v1.2537.24)
Issue number Bug fixes
SC-1309 Fixed an issue in Microsoft Edge where a user would'nt be redirected after authenticating on Coveo Cloud
SC-1685 Fixed infinite loading when removing the field of a field sort component
SC-1719 Added the Organization ID in the license details and Diagnostic page
SC-1748 Added error message when a source was just added and can't yet be returned by the service
SC-1795 Fixed field usage reset after diagnostic package download
SC-1830 Using another indexing provider than Lucene won't produce an error anymore
SC-1953 Fixed generation of the ClickUri to use resolved site for media items
SC-1979 Localize validation message for the sort by distance component
SC-1999 Correctly set the file type on small-sized file with no binaries
SC-2000 Fixed bug that prevented the search page from working with empty cookie
SC-2017 Fixed Text With Tokens control error when context isn't available
SC-2018
SC-2019
Added error logging when using PermissionSetsBuilder
SC-2023 Fixed potential rendering issue when indexing search page item
SC-2028 Fix potential vulnerabilities in CoveoSearchWebCrawler
SC-2037 Remove error message when rebuilding a source that was just created
SC-2039 User can now edit search interfaces without context item in the Experience Editor
SC-2049 Prevent errors when logging Sitecore Analytics event when user has no access to the event item
Issue number Case Fixed support cases
SC-1970 00037192 App pool for Sitecore instance crashed after unhandled exception

Release Notes for June 2017: 4.0.1461

This release includes the 1.2537.19 version of the JavaScript Search Framework (see May 2017 Minor Release (v1.2537.19)).

This section summarizes the new features and fixed support cases introduced in the Coveo for Sitecore June 2017 release (4.0.1461).

To download the June 2017 release, see Downloads.

For the upgrade procedure, see Upgrading from April 2017 (4.0.1329) to June 2017 (4.0.1461).

Issue number New features Documentation
SC-1510 Changed the label for the Synchronize action Synchronize Coveo for Sitecore Configuration
SC-1770
SC-1723
SC-1729
SC-1734
SC-1757
SC-1767
Added distance components, rules and resources to support the use of geolocalized search.

Facet Distance Slider Component Properties

Facet Distance Range Component Properties

Distance Sort Component Properties

Rule Set Editor Boosting and Filtering Rules Reference

Coveo Distance Resources Component Properties

SC-1861 Qualified Sitecore 8.2 update 3 for compatibility with Coveo for Sitecore 4.0 Supported Sitecore Versions and Dependencies
SC-1876 Added a new option to allow disabling of security permissions on items. Installing Coveo for Sitecore
Issue number Bug fixes
SC-1588 Fixed the help link for “Display the recommendations section”.
SC-1689 Fixed the infinite rebuild issue caused by very small files.
SC-1690 Optimized the calls to fetch the fields when rebuilding indexes from the Content Editor.
SC-1747 User names without a domain returned by a security provider will correctly synchronize with Coveo for Sitecore.
SC-1818 Fixed the failed rebuild bug caused by the “__Everyone” entity being considered invalid.
SC-1851 Admin users are now assigned the coveo_sitecoreAdministrators group.
SC-1872 Force call to resolve identity if the security cache returns a NULL value for a security provider instead of failing.
SC-1902 Removed member variable causing an error on some items processed with HtmlContentInBodyWithRequestsProcessor.
SC-1936 Fixed a ”SecurityProviderConversionHelper not found for index” error.
SC-1940 Removed error on IndexPermissions being logged before it was even created by the wizard.

Release Notes for April 2017: 4.0.1329

This release includes the 1.2359.7 version of the JavaScript Search Framework (see March 2017 Release (v1.2359.7)).

The initial April 2017 release was 4.0.1258. However, due to a performance issue, it had to be hotfixed. The official April 2017 release is 4.0.1329.

Due to the JavaScript Search Framework introduced in this version, there's a rendering issue for the Sort components in existing MVC-based search pages (see Upgrading from March 2017 (4.0.1088) to April 2017 (4.0.1329)).

This section summarizes the new features and fixed support cases introduced in the Coveo for Sitecore April 2017 release (4.0.1258).

To download the April 2017 release, see Downloads.

For the upgrade procedure, see Upgrading from March 2017 (4.0.1088) to April 2017 (4.0.1329).

Issue number New features Documentation
SC-458 Add a link to the Release Notes in the Developer Resources configuration panel. Embedded Developer and Support Resources
SC-812 Encrypt the value of the Admin Service password in the configuration file.
SC-1208 Add an installation wizard page to help the user find the relevant installation or upgrade documentation. Installing Coveo for Sitecore
SC-1243 Display the product name in the organization selection drop-down to help identify Sitecore organizations.
SC-1671 Add a configuration panel to configure the Admin Service.
SC-1694 Rename the AnalyticsUri configuration setting to analyticsUri. Upgrading from March 2017 (4.0.1088) to April 2017 (4.0.1329)
SC-1809 Update the JavaScript Search Framework to the March 2017 release. March 2017 Release (v1.2359.7)
Issue number Bug fixes
SC-1599 Ensure sourceName is set before sending an Event to the Usage Analytics.
SC-1679 Avoid initialization deadlock when Coveo for Sitecore is installed alongside WFFM.
SC-1728 Prevent delete older than execution if push calls fail.
SC-1739 Force deletion of obsolete latestVersion of an item when a new version is created regardless of the ForceDeleteExcludedItems setting.
SC-1742 Added jQuery to CoveoJsSearch.Dependencies.js.
SC-1803 Updated the computed field obsolete message so it's more meaningful.
SC-1837 Fixed identity deletion PushAPI call.
SC-1871 Prevent modification of a batch when many parallel calls add or delete documents.
SC-1883 Removed a useless error logging in browser console with default settings of the Coveo Search Box component.

Release Notes for March 2017: 4.0.1088

This release includes the 1.1865.18 version of the JavaScript Search Framework (see January 2017 Maintenance Release (v1.1865.18)).

This release of the JavaScript Search Framework made the JQueryStatic and the global jQuery instance unavailable.

When using TypeScript in your integration and relying on jQuery, you now need to implement the following changes:

  • JQueryEventObject should be replaced with Event.
  • Reference jquery.d.ts in your TypeScript project.

This section summarizes the new features and fixed support cases introduced in the Coveo for Sitecore March 2017 release (4.0.1088).

To download the March 2017 release, see Downloads.

For the upgrade procedure, see Upgrading from January 2017 (4.0.895) to March 2017 (4.0.1088).

Issue number New features Documentation
SC-849 Make MaximumAge dynamic after a publish or rebuild
SC-903 Add option to remove unused resources in Coveo Cloud Cleaning Up Unused Field Resources
SC-919 Validate source endpoint in the Diagnostic Page Troubleshooting Problems Using the Coveo Diagnostic Page
SC-1077 Compress expanded permission security identities
SC-1306 Add new rules to the Rule Editor Rule Set Editor Boosting and Filtering Rules Reference
SC-1347 Add coveoanalytics comment in Coveo.SearchProvider.config file Upgrading from January 2017 (4.0.895) to March 2017 (4.0.1088)
SC-1363 Update post-installation wizard Installing Coveo for Sitecore
SC-1387 Ensure new search tokens aren't requested too often
SC-1409 Add the main Sitecore.config to the Diagnostic Package with Sitecore 8.1+
SC-1532 Remove the QUERY_PIPELINE_EDITOR privilege from the API Key
SC-1541 Validate and update disabled identities in the security cache
SC-1546 Add warning listing the organization unused fields in the logs
SC-1568 Update EULA Coveo Terms & Agreements
SC-1654 Prevent many query calls from logging in the query count
SC-1703 Allow the specification of the injection depths for facets in LINQ Understanding the Coveo Search Provider’s Configuration File
Issue number Bug fixes
SC-1522 Ensure users not related to a domain have their permissions pushed
SC-1526 Allow entities absent from Sitecore to be updated in the security cache
SC-1561 Fixed bug where identities were updated when the indexPermissions setting was set to false
SC-1597 Automatically replace invalid characters in user context keys
SC-1610 Fixed bug where Coveo On-Premises organizations were sometimes seen as Coveo Cloud organizations
SC-1630 Fixed bug when reactivating role that isn't in a Sitecore domain
SC-1638 Fixed bug where some fields were sometimes not created or created as the wrong type
Issue number Case Fixed support cases
SC-1547 00034970

Index was outside the bounds of the array on LINQ query solved by IIS Reset

The issue was solved by fixing a race condition while initializing an internal cache.

Release Notes for January 2017: 4.0.895

This release includes the 1.1550.11 version of the JavaScript Search Framework (see October 2016 Maintenance Release (v1.1550.11)).

This section summarizes the new features and fixed support cases introduced in the Coveo for Sitecore January 2017 release (4.0.895).

To download the January 2017 release, see Downloads.

For the upgrade procedure, see Upgrading from December 2016 (4.0.780) to January 2017 (4.0.895).

Issue number New features Documentation
SC-806 Support setting originLevel3 when redirected from a searchbox
SC-1005 Implement batching for Cloud item indexing
SC-1007 Prevent permissions from being pushed when AnonymousPermissionsProvider is set
SC-1273 Add the icon for Coveo Fields Resources
SC-1339 Leverage user context for Coveo™ Machine Learning Recommendations Inserting and Customizing a User Context Component
SC-1365 Add identity verification when indexing item securities
SC-1377 Refactoring of HtmlContentInBodyWithRequestsProcessor
SC-1383 Change name of ActiveDirectorySecurityProvider to CascadingSecurityProvider
SC-1413 Block queries coming from the quickview indexing process Performing Search Queries when Indexing Page Content
SC-1414 Add warning when a query comes from a computed field
SC-1415 Compile PageEditorDeferRefresh using TypeScript
SC-1448 Add sysfiletype to default config
SC-1466 Adapt the warning message in the Diagnostic Page when the field limit is reached
SC-1488 Replace the DeleteDocumentAndChildren with the batch call
SC-1490 Add LINQ extensions to use the Advanced and Constant expressions Coveo LINQ Extensions
SC-1492 Qualify Sitecore 8.2 update 1 Supported Sitecore Versions and Dependencies
SC-1497 Add Sitecore credentials validation during installation phase
SC-1503 Prevent duplicates in indexing batches
SC-1536 Qualify Sitecore 8.2 update 2 Supported Sitecore Versions and Dependencies
Issue number Bug fixes
SC-975 Removed warning when using LINQ GetCoveoQueryResults
SC-1009 Fixed rebuild issue with non-facetable numeric fields
SC-1052 Fixed search-as-you-type issue with Coveo Search Box component
SC-1224 Track Recomendations events in Sitecore Analytics
SC-1244 Fixed search box UI glitch involving x button in the default Coveo-powered search page
SC-1267 Ensure Recommendations component still appears when pipeline is inexistant
SC-1373 Fixed CoveoFieldsHandler escaping issue
SC-1408 Fixed valueCaption issue with facet slider
SC-1444 Removed faulty error logging with HtmlContentInBodyWithRequestsProcessor
SC-1454 Fixed throttling issue in On-Premises setups
SC-1455 Fixed bug when using fields containing special characters in the Default Sort Option
SC-1456 Fixed bug when removing existing Default Sort Option
SC-1462 Fixed Analytics custom data transfer issue
SC-1467 Handle duplicated items in processors
SC-1469 Fixed bug where coveo-sorts placeholder disappeared
SC-1476 Fixed error when an excluded component in a tab isn't on the page
SC-1480 Ensure user security updates also updates roles
SC-1482 Fixed LINQ issue where DefaultNumberOfFacetValues was ignored
SC-1484 Improved error message when proxying call
SC-1495 Fixed Security Provider name when changing username or password
SC-1509 Fixed setting used for the DeletedDocumentPoller
Issue number Case Fixed support cases
SC-1494 00034901 Content Browser Doesn't Show Any Data
Recommended Articles