THIS IS ARCHIVED DOCUMENTATION
2018 Coveo for Sitecore 4.1 Releases
2018 Coveo for Sitecore 4.1 Releases
This page summarizes the new features and bug fixes introduced throughout 2018.
Release Notes for November 2018
This release includes the 1.2537.57 and 2.4609.8 versions of the JavaScript Search Framework (see May 2018 maintenance release (1.2537.57) and August 2018 maintenance release (v2.4609.8)).
This section summarizes the new features and fixed support cases introduced in the Coveo for Sitecore November 2018 release.
For the upgrade procedure, see Upgrading from October 2018 to November 2018.
| Issue number | Enhancement |
|---|---|
| SC-3237 | Discontinue support for LINQ queries. |
| SC-3238 | Mark Legacy UI Search Framework as deprecated. |
| Issue number | Bug fix |
|---|---|
| SC-3222 | Improved accessibility by adding lang="en" in the Basic Search Interface Layout.cshtml layout file <html> tag. |
| SC-3294 | [Diagnostic Page] Fixed issue with inaccurate field count. |
| SC-3326 | Fixed issue where many FieldReaderCache were created at a very fast rate. |
| SC-3331 | [Command Center] Fixed issue with template fields not being selectable in Internet Explorer 11. |
| SC-3334 | [Command Center] Fixed issue with fields not sorted alphabetically. |
| SC-3336 | [Command Center] Fixed issue with organization selection/creation section not appearing on page load in Internet Explorer 11. |
| SC-3355 | Fixed issue with the handling of Sitecore field names beginning with a number. |
Release Notes for October 2018
This release includes the 1.2537.57 and 2.4609.8 versions of the JavaScript Search Framework (see May 2018 maintenance release (1.2537.57) and August 2018 maintenance release (v2.4609.8)).
This section summarizes the new features and fixed support cases introduced in the Coveo for Sitecore October 2018 release.
For the upgrade procedure, see Upgrading from September 2018 to October 2018.
| Issue number | Enhancement |
|---|---|
| SC-2714 | Enable the FetchPageContent HTML processor by default instead of the HtmlContentInBodyWithRequestsProcessor. |
| SC-2997 | [Command Center] Group the fields by template. |
| SC-2998 | [Command Center] Allow the inclusion and exclusion of fields in the Indexing Manager. |
| SC-3102 | [Command Center] Format numbers based on user locale information. |
| SC-3104 | [Command Center] Improve readability through the standardization of fonts and button colors. |
| SC-3105 | [Command Center] Move the security part of the configuration to the Security section of the Command Center. |
| SC-3108 | [Command Center] Change the color scheme to avoid confusion with the Coveo Cloud Administration Console. |
| SC-3121 | Support Coveo JavaScript Search Framework version 2.4609. |
| SC-3166 | Reduce the document payload sent to Coveo Cloud to reflect only the included fields (see Field Is No Longer Indexed in the Sitecore Items). |
| Issue number | Service created or updated |
|---|---|
| SC-3118 | Update the GET fields/bytemplate service to indicate whether a field is mandatory or not. |
| SC-3130 | Add a PATCH fields service to add or remove fields from the <include> field list. |
| Issue number | Case | Fixed support case |
|---|---|---|
| SC-3181 | SC-3184 | [Hive] Fixed issue with many search interfaces always resolving to first index defined for the site. |
| Issue number | Bug fix |
|---|---|
| SC-3157 |
[SXA] Fixed issue with Unexpected token < error in Sitecore Experience Editor. |
| SC-3182 |
[Command Center] Fixed issue with fields wrongly tagged as Coveo Special Fields. |
| SC-3185 | Fixed issue with fields removed from the <include> field list not being removed in Coveo Cloud when IsSourceSpecific is set to false. |
| SC-3195 | [Command Center] Improved rebuild progress details when permissions indexing is disabled. |
| SC-3199 | [Command Center] Sorted organizations in alphabetical order in organization selection dropdown list. |
| SC-3200 |
[Command Center] Fixed issue with Analytics fields not being indexed when fields are included, even though IndexAnalyticsFields is set to true. |
| SC-3201 | [Command Center] Added Coveo Analytics Fields in the template fields table when they're enabled. |
| SC-3205 |
[Hive] Fixed issue with the Coveo Results List data source DOM Unique Id not being outputted in the HTML. |
| SC-3217 | [Command Center] Improved the handling of critical errors. |
| SC-3221 | [Command Center] Corrected indexed fields count. |
Release Notes for September 2018
This release includes the 1.2537.57 and 2.4382.10 versions of the JavaScript Search Framework (see May 2018 maintenance release (1.2537.57) and July 2018 Release (v2.4382.10)).
This section summarizes the new features and fixed support cases introduced in the Coveo for Sitecore September 2018 release.
For the upgrade procedure, see Upgrading from August 2018 to September 2018.
| Issue number | Enhancement |
|---|---|
| SC-2453 |
isSourceSpecific attribute introduced for improved management of field hashing. |
| SC-2892 |
Facet, Sort and Multi-Value Facet field attributes revert to true unless changed both in field configuration and Coveo Cloud Administration Console. |
| Issue number | Service created |
|---|---|
| SC-3021 | Create a service to return a list of fields grouped by template. |
| SC-3039 | Create a service to add fields with the specified field names to the list of indexed fields. |
| SC-3081 | In the service that returns the list of fields grouped by template, show which fields are included in the configuration. |
| Issue number | Case | Fixed support case |
|---|---|---|
| SC-3083 | SC-3079 | Fixed issue with Coveo-powered search page results showing items not consistent with Sitecore permissions. |
| Issue number | Bug fix |
|---|---|
| SC-2610 | Fixed issue with the Coveo for Sitecore Analytics component overriding the Search Hub value with the page name in originLevel1. |
| SC-3058 | [Command Center] Fixed erroneous pop-up messages. |
| SC-3076 | [Command Center] Fixed issue while visiting fields section (on-premises instance only). |
| SC-3080 | Fixed confusing property name when configuring Placeholder extender in Coveo for Sitecore Hive. |
| SC-3087 | Fixed issue on accessibility caused by duplicated IDs. |
| SC-3091 |
[Command Center] Fixed issue with template fields showing as having both the Facet and Multi-Value Facet attributes. |
| SC-3093 | Fixed issue with unhandled exception occurring upon Coveo Hive component initialization when the Sitecore user is locked out. |
| SC-3109 | [Command Center] Fixed issue with on-premises organizations showing in organization selection dropdown menu. |
| SC-3113 | Fixed issue with critical errors in Coveo Hive components not rendering an error message on the public site. |
| SC-3114 | Fixed issue with prebinding operations not being applied on certain searchbox container components. |
| SC-3123 | Improved performance when editing an External Components Section. |
| SC-3126 | Improved the handling of Date and numeric field configurations with attribute mismatches. |
| SC-3128 | [SXA] Qualify SXA 1.7.1. |
| SC-3146 |
[SXA] Fixed issue when inserting the Coveo User Context component into an SXA page. |
| SC-3177 | SC-3177 Fixed issue with site name not being properly resolved in clickable uri of search results. |
Release Notes for August 2018
This release includes the 1.2537.57 and 2.4382.10 versions of the JavaScript Search Framework (see May 2018 maintenance release (1.2537.57) and July 2018 Release (v2.4382.10)).
This section summarizes the new features and fixed support cases introduced in the Coveo for Sitecore August 2018 release.
For the upgrade procedure, see Upgrading from July 2018 to August 2018.
| Issue number | Enhancement |
|---|---|
| SC-1943 | Improve security identity transfers to Coveo Cloud for HIPAA compliance. |
| SC-2708 | [Command Center] Expose Coveo Cloud search and relevance features. |
| SC-2739 | [Command Center] Allow users to update Coveo for Sitecore configurations. |
| SC-2798 | [Command Center] Add Security section in Indexing Manager (see Understanding the Indexing Manager). |
| SC-2942 | [Command Center] Display the field usage summary in the Fields section. |
| SC-2961 | Add a browser tab icon for the Command Center and the Coveo Diagnostic Page. |
| SC-2989 | [Command Center] User Interface improvements. |
| SC-3009 | [Command Center] When the cloud organization has been paused, display a dialog box to allow its reactivation. |
| Issue number | Service created |
|---|---|
| SC-2855 | Create services to update/synchronize users, roles, and deactivated identities. |
| SC-2856 | Create a service to synchronize Coveo Cloud sources, fields, and security providers based on Sitecore configurations. |
| SC-2974 | Create a service to update the Coveo for Sitecore license with the Coveo Cloud license information. |
| SC-3031 | Create services to get whether an organization is paused and to resume a paused organization. |
| Issue number | Bug fix |
|---|---|
| SC-2962 | [Command Center] Fixed issue with erroneous index document counts due to long cache clearing intervals. |
| SC-2966 | Strengthened security associated with certain API calls. |
| SC-2982 | Fixed document size value when Quick view couldn't be generated. |
| SC-3015 | [Command Center] Removed the Name column from the Strategies section of the index details. |
| SC-3024 | [Diagnostic Page] Fixed issue with inaccurate Sitecore version Compatibility Status since Sitecore 9. |
| SC-3043 | [Command Center] Improved rebuild status reporting when the organization is paused. |
| SC-3047 | Improved the Coveo Cloud license retrieval process. |
| SC-3051 | Fixed issue with Empty strings aren't allowed exception occurring when specifying Creator-Owner permissions on an item. |
| SC-3057 | Fixed issue with identities recently created or updated in Sitecore showing in error in Coveo Cloud. |
| SC-3068 | Fixed issue with identities that were not correctly sent after a synchronization of the security identities. |
| SC-3069 | [Command Center] Fixed redirection to the Activation page when user is logged out of Sitecore. |
Release Notes for July 2018
This release includes the 1.2537.57 and 2.4094.8 versions of the JavaScript Search Framework (see May 2018 maintenance release (v1.2537.57) and May 2018 Release (v2.4094.8)).
This section summarizes the new features and fixed support cases introduced in the Coveo for Sitecore July 2018 release.
For the upgrade procedure, see Upgrading from May 2018 to July 2018.
| Issue number | Enhancement |
|---|---|
| SC-1445 | Reduce the load on the platform through better scheduling of call retries. |
| SC-1743 | Tag searches performed in Sitecore with originContext value WebsiteSearch for analytics purposes. |
| SC-2343 | Implement permanentids for Machine Learning (see About the permanentid Field). |
| SC-2347 | Associate API keys to API key templates rather than on individual privileges. |
| SC-2631 | Minimize number of calls to the Cloud Platform when updating a user or a role. |
| SC-2756 | [Command Center] Allow Coveo for Sitecore configuration and activation through the Command Center (see Understanding the Command Center). |
| SC-2784 | [Command Center] Upon attempt to access a Command Center page when not logged in, prompt user for Sitecore credentials and then redirect user to requested page. |
| SC-2797 | [Command Center] Allow the removal of unused fields. |
| SC-2814 | [Command Center] Provide a user interface to display the list of fields (Template, External, and Computed). |
| SC-2817 |
[Command Center] Add a filter box in the Fields section of the Command Center to allow for searches on Field Name and Translated Name. |
| SC-2839 | Support SXA 1.7. |
| SC-2846 | Support Sitecore version 8.2 update 7. |
| SC-2861 |
[Index Service] Cache responses from GET calls to /indexes service. |
| SC-2864 | Record Coveo events in the Experience Profile. |
| SC-2874 | [Command Center] Provide user interface to create or select an organization in Coveo Cloud. |
| SC-2910 | [Command Center] Display the current state of Coveo for Sitecore in Configuration section. |
| SC-2926 | [Command Center] Streamline the Coveo organization provisioning process. |
| SC-2932 | [Command Center] User interface improvements. |
| SC-2967 | Support Sitecore version 9.0 update 2. |
| Issue number | Service created |
|---|---|
| SC-2785 | Provide a service to list computed fields. |
| SC-2813 | Provide a service to expose the IndexPermissions configuration. |
| SC-2815 | Provide a service to expose field limit information. |
| SC-2853 | Provide a service allowing the creation of a Coveo organization. |
| SC-2854 | Create a service to generate API keys. |
| SC-2873 | Create a service to list the available organizations in Coveo Cloud. |
| SC-2933 | Create a service to get Coveo for Sitecore activation state. |
| SC-2934 | Create a service to get Coveo for Sitecore configuration information. |
| Issue number | Case | Fixed support case |
|---|---|---|
| SC-2943 | 00041306 | Fixed issue with IndexOutOfRangeException thrown during rebuild. |
| Issue number | Bug fix |
|---|---|
| SC-985 | Moved DateSelector.xml file to the Website\sitecore modules\Shell\Coveo\CustomFields folder. |
| SC-2763 | Strengthened security in storage mechanism for certain data. |
| SC-2881 | [Command Center] Clarified the Last rebuild information. |
| SC-2888 | Fixed issue with External Content placeholder label not appearing when the external source was empty. |
| SC-2889 | Fixed issue with clickable URI of search result items not being properly set. |
| SC-2898 | Fixed issue with Coveo Hive Page View component not outputting correct contentIdKey value. |
| SC-2900 | Fixed issue with log message referencing the <SiteName> configuration element rather than <siteName> (incorrect casing). |
| SC-2901 | Fixed issue with SXA reference JSON files being included in release packages. |
| SC-2944 | [Command Center] Fixed issue with exceptions thrown during an index rebuild not being displayed in interface. |
| SC-2959 | Fixed issue with document indexing producing duplicate metadata for some fields. |
| SC-2999 | Fixed issue with Session is not Initialized exception occurring mainly on Sitecore 8.0 Coveo Platform authentication and on Coveo Diagnostic Page. |
Release Notes for May 2018
This release includes the 1.2537.57 and 2.3826.13 version of the JavaScript Search Framework (see May 2018 maintenance release (v1.2537.57) and February 2018 Release (v2.3826.13)).
This section summarizes the new features and fixed support cases introduced in the Coveo for Sitecore May 2018 release.
For the upgrade procedure, see Upgrading from April 2018 to May 2018.
| Issue number | Enhancement |
|---|---|
| SC-1956 | Ensure all Usage Analytics events respect the strict field validation feature. |
| SC-2506 | Prevent the InvalidateRequirementsDelay option from being set too low. The recommended value is 60; the lowest recommended value is now 10. |
| SC-2585 | Implement the Indexing Manager for the Coveo Command Center (see Understanding the Indexing Manager). |
| Issue number | Case | Fixed support case |
|---|---|---|
| SC-2768 | 00041490 | [On-Premises] Fixed issue causing license errors to occur when adding a NLB between CES and RabbitMQ. |
| SC-2792 | 00042394 | Fixed issue preventing administrators from changing their Coveo organization when a comment was added to the scheduling node of the Coveo.SearchProvider.Custom.config file. |
| SC-2808 | 00042451 | [On-Premises] Fixed issue where certain RabbitMQ connections were opened but never closed. |
| SC-2835 | 00042763 | Fixed issues caused by a manual change in the Coveo Cloud license. |
| SC-2838 | 00042906 |
[Sitecore 9.0+] Fixed issue causing the Item Template Is or Inherits from rule not to work. |
| SC-2845 | 00042608 | [Sitecore 9.0+] Fixed issue where some custom processors would prevent the Experience Profile from working (see Error in the Experience Profile After Installing Coveo for Sitecore). |
| Issue number | Bug fix |
|---|---|
| SC-2741 | Added missing Website metadata to search events. |
| SC-2742 | [On-Premises] Fixed issue that caused Usage Analytics events not to be sent when using the Coveo Hive framework with the Free edition. |
| SC-2753 | Fixed issue where the link to an item was not resolved properly when using IIS custom bindings. |
| SC-2774 | [Silent Installation] Prevented a configuration update when some mandatory values were empty. |
| SC-2800 | Improved performance of the ExcludeCoveoDataSourceItems inbound filter. |
| SC-2804 | Fixed issue where pressing the Enter key in the OmniboxResultList didn't access the selected result page. |
| SC-2830 | [Installation Wizard] Ensured the body indexing option text fits the selected option. |
Release Notes for April 2018
This release includes the 1.2537.52 and 2.3826.13 version of the JavaScript Search Framework, which is a hotfix of the 2.3826.10 release (see February 2018 maintenance release (v1.2537.52) and February 2018 Release (v2.3826.13)).
This section summarizes the new features and fixed support cases introduced in the Coveo for Sitecore April 2018 release.
For the upgrade procedure, see Upgrading from March 2018 to April 2018.
| Issue number | Enhancement |
|---|---|
| SC-2068 | Allow administrators to silently activate Coveo for Sitecore (see Silently Activating Coveo for Sitecore). |
| SC-2576 | Changed the security entity structure to support larger groups. |
| SC-2608 | Support SXA with the Coveo for Sitecore SXA package (see Installing Coveo for Sitecore SXA Components). |
| SC-2618 | Qualify Sitecore 9.0 update 1. |
| Issue number | Bug fix |
|---|---|
| SC-2541 | Fixed issue where non-existent security groups were applied to items when indexing. |
| SC-2564 | Fixed issue where numerical fields wouldn't be suggested for the Facet Slider and Facet Range components. |
| SC-2591 | Ensured the documentation link of the Distance component pointed to the right page. |
| SC-2602 | Fixed issue causing wrong events to be logged to the xDB when accessing Coveo admin pages. This issue still persists when using Sitecore 7.5. |
| SC-2619 | [Coveo Hive] Display an error when an invalid boosting or filtering rule is entered in a search page. |
| SC-2628 | [Sitecore 9.0] Fixed issue causing the indexing to fail when setting the indexAnalyticsFields option to true. |
| SC-2630 | Sanitized the content of the diagnostic package. |
| SC-2659 | [Coveo Hive] Fixed issue causing the More section of the Tabs to not show all of the extra tabs. |
| SC-2664 | Fixed issue causing the Diagnostic Page to fail when the Coveo for Sitecore package is installed but not activated. |
| SC-2676 | [Legacy UI] Fixed issue where inserting an Omnibox Result List in Web Forms caused the page to fail. |
| SC-2678 | [Legacy UI] Fixed issue where the Omnibox result list couldn't be added to an MVC page. |
| SC-2704 | Fixed issue where multi-value fields were not listed in the auto-complete dialog when selecting a facet field. |
| SC-2727 | [Coveo Hive] Fixed issue preventing the addition of many languages to a same search page. |
| SC-2732 | [Coveo Hive] Fixed issue where a search page would fail to load when part of a sub-folder. |
| SC-2759 | [Coveo Cloud] Removed error when hitting the platform throttling limit. Instead, a warning is logged. |
| SC-2764 | [Coveo Cloud] Optimized the indexing process to avoid hitting the throttling limit too quickly. |
| Issue number | Case | Fixed support case |
|---|---|---|
| SC-2690 | 00041762 | [Sitecore Analytics] Fixed issue where keywords logged in Sitecore Analytics were not properly registered. |
Release Notes for March 2018
This release includes the 1.2537.43 and 2.3826.10 version of the JavaScript Search Framework (see January 2018 maintenance release (v1.2537.43) and February 2018 Release (v2.3826.10)).
When using a CDN with the Coveo for Sitecore Hive framework, this release includes the latest 2.3836 version of the JavaScript Search Framework (see Using the CDN in Coveo for Sitecore Hive Framework).
This section summarizes the new features and fixed support cases introduced in the Coveo for Sitecore March 2018 release.
For the upgrade procedure, see Upgrading from January 2018 to March 2018.
| Issue number | Bug fix |
|---|---|
| SC-2110 | Removed unnecessary warning about missing analytics component when using the Free version. |
| SC-2464 | Fixed issue where Global Folder were not shown when selecting the data source of an external component. |
| SC-2518 | [Coveo Hive] Fixed issue preventing xDB boosting rules conditions from working. |
| SC-2519 | [Coveo Hive] Fixed issue preventing facet personalization from working inside the Experience Editor. |
| SC-2535 | Improved speed of the GetCompleteFieldConfigs validation in SortModel. |
| SC-2565 | Fixed issue causing search pages to show an ASPX error page when there's a server-side error. |
| SC-2569 | [Experience Editor] Fixed issue where automatic boosting was using the web source fields instead of the master. |
| SC-2588 | Fixed issue causing a search page to fail when using a faulty boosting rule. |
| SC-2590 | Added missing comments in the configuration files. |
| SC-2601 | Separated resource path specification for JavaScript Search Framework and Coveo for Sitecore (see Using the CDN in Coveo for Sitecore Hive Framework). |
| Issue number | Case | Fixed support case |
|---|---|---|
| SC-2589 | 00040886 | Fixed issue causing search page to display an error when applying a Sitecore hotfix on Sitecore 8.2. |
Release Notes for January 2018
This version of Coveo for Sitecore automatically uses the Content Delivery Network (CDN) to load the Coveo JavaScript Search Framework files (see Using the CDN in Coveo for Sitecore Hive Framework).
This release includes the v1.2537.35 and v2.3477.9 version of the JavaScript Search Framework (see July 2017 maintenance release (v1.2537.35) and November 2017 Release (v2.3477.9).
When using the CDN to load these files, you will get the v2.3477.X version of the Coveo JavaScript Search Framework.
When using local files to load them, you will get the v2.3477.9 version of the Coveo JavaScript Search Framework.
This section summarizes the new features and fixed support cases introduced in the Coveo for Sitecore January 2018 release
For the upgrade procedure, see Upgrade Procedures for Coveo for Sitecore 4.1 Previous Releases.
| Issue number | Enhancement | |
|---|---|---|
| SC-2281 | If new processor |
Understanding the coveoIndexingGetFields and coveoIndexingGetTemplates Pipelines |
| SC-2332 | If query syntax is enabled on the search box, search by field name is possible with no hashing or prefixes (human-friendly). | |
| SC-2435 | Coveo search UI files now loaded via CDN. Datasource on the local component can be used to load local files. | Using the CDN in Coveo for Sitecore Hive Framework |
| SC-2469 | Sitecore 8.2 update 6 now qualified. | |
| SC-2189 | Initial release of Sitecore 9.0 now qualified. | |
| SC-2485 |
@source used instead of @syssource when querying for Cloud indexes during rebuild. |
|
| SC-2502 | Only disabled entities get counted when re-enabling them. |
| Issue number | Bug fix |
|---|---|
| SC-1109 | Ensured only string fields can be used with the includeForFreeTextSearch attribute. |
| SC-1752 | Fixed issue where ConversionHelper would be lost if GetSecurityProvider failed. |
| SC-2309 | [Experience Editor] Fixed issue causing the Add Here buttons to stop working in the Experience Editor when adding the search box resources. |
| SC-2410 | [Diagnostic Page] Ensured the Expanded Permissions Provider section isn't shown when using Coveo for Sitecore on-premises. |
| SC-2450 | Fixed issue where isAnonymous was not properly set with anonymous users. |
| SC-2468 | [Hive] Added missing Enable Query Syntax item in template. |
| SC-2472 | Fixed issue causing the installation wizard to fail when a user doesn't have the right access. |
| SC-2490 | [Facet Sort] Fixed issue preventing some Facet Sort components from working with the default parameters. |
| SC-2503 | [Hive] Fixed issue where Has Data Source validation was no longer working. |
| SC-2504 | Fixed issue where sort components error reports were hidden. |
| SC-2514 | Fixed issue where fields counts were not accurate on the diagnostic page. |
| SC-2517 | Coveo Hive search page visited from Experience Editor doesn't log Coveo Usage Analytics Events anymore. |
| SC-2524 | Fixed issue where documents would get lost in index after error 502 during rebuild. |
| SC-2528 | Removed Analytics Top Query Suggestions option from version 4.1 on the Legacy UI. |