Release Notes
Feb 2021 – released Sitecore Experience Platform 10.1.0
This a feature release. Sitecore recommends that you upgrade to this release if it includes features that meet the specific needs of your organization. This release contains significant new feature functionality, and we encourage you to evaluate it.
Highlights
Sitecore Experience Platform 10.1.0 includes:
- You can now use the content hierarchy to assign a behavior profile to multiple items.
- You can now use content tags to assign a behavior profile to multiple items.
- The Collection database now supports scalable reads.
- You can now use the new Data Purge CLI tool to remove unwanted contact data from the Experience Database.
- Sitecore Fast Query has been deprecated.
- Email Experience Manager - Mutli-Language Management - Marketers can now create HTML emails in any language, regardless of the context language. You can also activate Email campaigns without the need for an English language variant regardless of the language being used.
- Email Experience Manager - We have introduced a configurable retry mechanism that allows users to configure how many times they would like the system to retry if an error or failure occurs when you send out a campaign.
- Email Experience Manager - You can now use the following new email templates:
- Two Column
- 2 Column 1 CTA
- 3 Column Long
- 3 Column Short
- The upgrade process has been simplified and streamlined. You can upgrade from Sitecore XP 8.1.0 or later directly to Sitecore XP 10.1.0 in one straightforward procedure.
The Upgrade Guide has been updated and simplified to reflect these changes. - Experience Analytics - The Reporting and CM server roles have been combined to run on the same server role, thereby reducing hosting costs for containers, PaaS and On-Prem solutions.
- SXA and Horizon
You can now create:
- Extensions in the Selection Details area.
- Extensions that edit the properties of a selected rendering.
- Extensions that can initialize the parameters of a rendering or perform additional actions when a rendering is added to a page
- The majority of the Microsoft/System libraries that we use in Sitecore XP have been updated.
- The
IAsyncEnumerable<T>andIAsyncEnumerator<T>interfaces as well as theAsyncEnumeratorclass from theSystem.InteractiveAsyncassembly have been replaced with their respective counterparts from theMicrosoft.Bcl.AsyncInterfaceslibrary. We have therefore updated the signature of every method that receives or returns an object of these types and every class that implements these interfaces.
To minimize the amount of changes required in the customer’s code, we have implemented a set of extensions in theSitecore.Async.Extensions.Legacyassembly. This is a temporary assembly and will be removed in the next version of Sitecore. - The new Async Redis Session State Provider and the updated Stack Exchange Redis Driver give us a faster and more stable tracker.
- Sitecore.UpdateApp 1.1.0 - This is the initial release of the Sitecore.UpdateApp tool.
New features/improvements
| Context | Description | Customer ticket ID (or other) | TFS no. |
|---|---|---|---|
| Email Experience Manager | Marketers can now create HTML emails in any language, regardless of the context language. You can also activate Email campaigns without the need for an English language variant regardless of the language being used. | ||
| Email Experience Manager | We have introduced a configurable retry mechanism that allows users to configure how many times they would like the system to retry if an error or failure occurs when you send out a campaign. | ||
| Email Experience Manager | We have introduced the following new email templates:
|
||
| Experience Analytics | The Reporting and CM server roles have been combined to run on the same server role. | 410785 | |
| Experience Optimization | We have optimized the amount of storage space used by the FACT_PAGEVIEWS table in the Reporting database. | 407722 | |
| Horizon | Droplink fields display items as a drop-down list. An author can only select one item from the drop-down list. | 419375 | |
| Installation | SIA 1.2.2 supports Sitecore XP 10.1.0. | 454343 | |
| Marketing Foundation | If xConnect fails to add the referenced device profile, it still adds an interaction. | 152105 | |
| Marketing Foundation | In the XDB Upgrade Tool an infinite loop can occur because the percentile limit is hardcoded to <1E-7. | CS0197377 | 445585 |
| Marketing Foundation | The XDB Update Tool does not notify users about any problems that occur during execution and fails silently. | 443205 | |
| Marketing Foundation | The new Data Purge CLI tool lets you remove unwanted contact data from the Experience Database. | 402358 | |
| Marketing Foundation | The new Async Redis Session State Provider and the updated Stack Exchange Redis Driver give us a faster and more stable tracker. | 436550 | |
| Marketing Foundation | The Collection database now supports scalable reads. | 378577 | |
| Marketing Foundation | You can now use content tags to assign a behavior profile to multiple items. | 411105 | |
| Marketing Foundation | You can now use the content hierarchy to assign a behavior profile to multiple items. | 411108 | |
| Miscellaneous | Each database tnow contains it's own links table. | 402711 | |
| Miscellaneous | We have disabled the TaskDatabaseAgent on every Sitecore instances except the content manager. | 346543 | |
| Miscellaneous | The IContentSearchQueryable interface is now public. | 323667 | |
| Miscellaneous | The majority of the Microsoft/System libraries that we use in Sitecore XP have been updated. | 427029 | |
| Miscellaneous | You can now cancel a cortex Distributed Task. | 442392 | |
| Miscellaneous | The name of the task status item has been updated. | 443715 | |
| Miscellaneous | The Reporting role has been removed from the XP1 topology. | 431017 | |
| Miscellaneous | The HtmlCacheClearer agent has been introduced to partially clear HTML caches. | 92709 | |
| Sitecore Containers | The Sitecore Upgrade container supports upgrading from Sitecore XP 10.0.x to Sitecore XP 10.1.0. | 444388 | |
| Sitecore Containers | The Sitecore Docker Tools have been updated for Sitecore XP 10.1.0 with new features. For more information, see https://github.com/Sitecore/docker-tools. | 444563 | |
| Sitecore.ContentSearch | We have added some popular Content Search features to Sitecore that allow the handling Solr exceptions in custom code, and have added circuit breaker/retry logic. | 367264 | |
| Sitecore.ContentSearch | The HtmlCacheClearer agent partially clears HTML caches. |
92709 | |
| Sitecore.ContentSearch | The logic used to suppress exceptions during search has been improved. | 95498 | |
| Sitecore Forms | Sitecore can now use a form without an additional MVCOuterLayout.cshtml layout. | 196722 | |
| Sitecore Forms | Sitecore Forms are now able to load the scripts at the bottom of the page and this improves performance. | 367668 | |
| Sitecore.UpdateApp 1.1.0 | The Sitecore.UpdateApp tool updates databases to Sitecore 10.1.0. | 447041 | |
| Sitecore.UpdateApp 1.1.0 | This is the initial release of the Sitecore.UpdateApp tool. | 455244 | |
| Solr | We have introduce retry logic into the IndexingStateSwitcher. | 409536 | |
| Solr | You can now determine whether Solr is available when searching from the API. | 137660 | |
| Solr | A field type in the Sitecore Solr config file is now mapped to the lowercase Solr field type. | 94968 | |
| SXA and Horizon | In Horizon, only editable rendering parameters are diaplyed in the RHS panel. | 447823 | |
| SXA and Horizon | You can now create extensions that initialize the parameters of a rendering or perform additional actions when a rendering is added to a page. You can create extensions that edit the properties of a selected rendering. |
||
| SXA and Horizon | Multi-line rendering parameter fields are now editable in the Horizon RHS panel. | 435044 | |
| SXA and Horizon | Single line rendering parameter fields are now editable in the Horizon RHS panel. | 435055 | |
| SXA and Horizon | Dropdown/Selector rendering parameter fields are now editable in the Horizon RHS panel. | 435058 | |
| SXA and Horizon | SXA now supports local data sources in Horizon. | 444865 | |
| SXA and Horizon | In Horizon, you can now open Meta Partial Designs and you have access to some rudimentary editing capabilities. | 446768 |
Deprecated/Removed
| Context | Description | Customer ticket ID (or other) | TFS no. |
|---|---|---|---|
| Marketing Foundation | The MongoDB Collection Provider has been removed. | 437928 | |
| Marketing Foundation | The MongoDb Session State Provider has been removed. | 437926 | |
| Marketing Foundation | In the Sitecore.Processing.Cursors.Abstractions.ICursorDataProvider interface, the Task<bool> AreAllCursorsCompletedAsync(); has been deprecated and is no longer supported. |
438624 | |
| Marketing Foundation | The /sitecore/templates/System/Analytics/Profile Card - Persona template is now marked as obsolete. You should use the /sitecore/templates/System/Analytics/Profile Card template instead. |
458660 | |
| Marketing Foundation | The following items were removed:
|
||
| Marketing Foundation | The following items were deprecated and marked as obsolete:
|
||
| Miscellaneous | Sitecore Fast Query has been deprecated. | 96945 | |
| Miscellaneous |
The obsolete Sitecore.Rules.Conditions.DateTimeConditions.DayOfWeekCondition class has been removed.The obsolete \master\sitecore\system\Settings\Rules\Definitions\Obsolete\Common\Conditions\Date\Day of Week item has been removed.
|
213815 | |
| Miscellaneous | The \master\sitecore\system\Settings\Rules\Definitions\Elements\Date\Day of Week |
213815 | |
| Miscellaneous | The Sitecore.Rules.Conditions.DateTimeConditions.DayOfWeekCondition class is now marked as Obsolete. |
213815 | |
| Miscellaneous | The Sitecore.Nexus library has made obsolete, all the code has been merged into Sitecore.Kernel. |
Breaking changes
| Context | Description | Customer ticket ID (or other) | TFS no. |
|---|---|---|---|
| Marketing Foundation | In the Sitecore.Processing.Tasks.Abstractions assembly, the Sitecore.Processing.Tasks.Abstractions.ITaskDataProvider interface has been extended with the new Task<IProcessingTaskData> RefreshTaskStatus(Guid) method. |
438624 | |
| Marketing Foundation | In the Sitecore.Processing.Tasks.Abstractions assembly, the Sitecore.Processing.Tasks.Abstractions.ITaskDataProvider interface has been extended with the new Task<
| ||
| Marketing Foundation | XConnect contact data extraction has been extended to return contacts that do not interact with the brand for a specific amount of time. XConnect CollectionRoutes has been updated to accept the nullable cutoffDate parameter in the GetCreateContactCursorUri. This parameter accepts the nullable date-time value for contact data extraction filtering. |
412111 | |
| Marketing Foundation | In xConnect, we have introduced the Scalable Reads feature to support read operations from secondary instances of the xDB collection database to unload the primary database. The ReadPreference parameter can be specified for most of the read operations including data extraction. The IRepository and IDataProvider interfaces have been extended with create cursor and split cursor methods that accept the new InteractionCursorOptions, ContactCursorOptions, InteractionCursorSplitOptions, and ContactCursorSplitOptions operations with the ReadPreference parameter. |
405346 | |
| Miscellaneous | Items are now stored as resource data and are no longer stored in the database. | 441838 | |
| Miscellaneous | The IAsyncEnumerable<T> and IAsyncEnumerator<T> interfaces as well as the AsyncEnumerator class from the System.InteractiveAsync assembly have been replaced with their respective counterparts from the Microsoft.Bcl.AsyncInterfaces library. We have therefore updated the signature of every method that receives or returns an object of these types and every class that implements these interfaces.
To minimize the amount of changes required in the customer’s code, we have implemented a set of extensions in the Sitecore.Async.Extensions.Legacy assembly. This is a temporary assembly and will be removed in the next version of Sitecore.
|
427029 | |
| Platform | The dictionary items are stored in the \App_Data\localization\*.xml files and are no longer stored in the core database. These XML files have a priority over the dictionary API. |
441837 |
Resolved issues
The following issues have been fixed:
| Context | Description | Customer ticket ID (or other) | TFS no. |
|---|---|---|---|
| Caching | When the StandardValuesCache is populated during a background task, it does not contain the Language Fallback values for items with Standard Values. | 343322 | |
| Caching | The FilteredItemsCache is not cleared when the CacheKeyIndexing setting is set to true. | 424654 | |
| Email Experience Manager | When you rebuild the core link database, if an EXM item contains the ":" value in the Final Renderings field, it generates XML errors. | 210892 | |
| Email Experience Manager | You cannot create an email in a language other than the context language. | 58589 | |
| Email Experience Manager | If the Sender header value is not set correctly, it generates a broken header in the message. | 328606 | |
| Email Experience Manager | If the value of the pageSize parameter is set to less than the current number of contact lists, a user who has been assigned restrictions on contact list items is shown incorrect recipients lists. | 359727 | |
| Email Experience Manager | xConnectRetry does not handle xConnect conflicts correctly and this causes related clicks and open statistics to not be registered. | 434414 | |
| Email Experience Manager | If you click an EXM page link when the enableTracking value is set to false, a System.NullReferenceException is thrown. |
442594 | |
| Email Experience Manager | The item name of an email is overwritten by the display name when the email is saved or activated. | 398255 | |
| Email Experience Manager | The ExmKeyBehaviorCache members are not serializable and this throws an exception. | 411097 | |
| Email Experience Manager | If the current contact is identified as a robot and you try to unsubscribe it, a System.NullReferenceException is thrown. |
435520 | |
| Email Experience Manager | When you are editing an email or a campaign, to exit the editing window, you must click Cancel twice. | 391682 | |
| Email Experience Manager | If the subject of an email contains special characters, they are displayed as encoded text in the UI. | 401984 | |
| Email Experience Manager | Custom SMTP bounces counters are not updated when new bounces are collected. | 410168 | |
| Email Experience Manager | A user can create a language version of a campaign even when the user has not have write permission for that language. | 416354 | |
| Experience Analytics | The following error occurs: Exception when executing agent pathAnalyzer/mapRebuildStatusCheckerAgent when a processing task with the specified unique identifier does not exist. | CS0141107, CS0148766, CS0149264, CS0154560, CS0157278, CS0161069, CS0164366, CS0174859, CS0185346, CS0185583, CS0190709 | 421119 |
| Experience Analytics | If the site name contains "/", the Experience Analytics reports do not resolve correctly. | CS0189972 | 426581 |
| Experience Analytics | If you use the ExperienceAnalytics.aspx page to synchronizing Experience Analytics, the units processed value remains empty when the process is completed. | CS0194073 | 434357 |
| Experience Editor | If you select a component that contains a long text, in the background, the page scrolls to the top. | 163934 | |
| Experience Editor | If you create a non-english version of a campaign, it causes an internal error. | 196557 | |
| Experience Editor | The value in a Single line text field can be modified with hot keys. | 447828 | |
| Experience Editor | The image on a rendering disappears after you edit the rendering parameters. | 431714 | |
| Experience Editor | If you switch from the Experience Explorer to the Experience Editor, the language version is reset. | 426780 | |
| Experience Editor | In the Experience Editor, if you edit a General Link field that contains text and some additional parameters, it is rendered incorrectly. | 426644 | |
| Experience Editor | If the Languages.AlwaysStripLanguage setting is set to false, switching language does not work correctly in the Experience Editor. |
420740 | |
| Experience Editor | If you use the Chrome browser, you cannot paste text from the Experience Editor. | 418798 | |
| Experience Editor | In the Experience Editor, you cannot insert an item with its default name. | 415604 | |
| Experience Editor | If you click inside or outside a component, the field value changes to [No text in field]. | 305756 | |
| Experience Editor | In the Experience Editor, if there are no shell#lang cookies, the labels on the rendering buttons are not displayed. | 402418 | |
| Experience Editor | If there are no shell#lang cookies, the No text in field label is not displayed. | 388571 | |
| Experience Editor | The Experience Explorer does not resolve the correct pattern card. | 369262 | |
| Experience Editor | If you use a Submit button that has comma in its label to go to the next page of a form, a NullReferenceException occurs. | 401410 | |
| Experience Editor | The Field Editor loses the scLanguage context. | 409303 | |
| Experience Editor | If you click the Save button, extra <br> tags are added to RTE fields in the Experience Editor. This is caused by Hotfix 396633/415404. | 413366 | |
| Experience Editor | Sitecore.BeginField() adds paragraph tags in a Single-Line Text field. |
409828 | |
| Experience Editor | If you use the Before and After attributes, a Cannot read property 'toLowerCase' of undefined error occurs. | 299554 | |
| Experience Editor | If you edit an empty Multi-Line Text field, it adds <p> tags when you save it. | 398289 | |
| Experience Editor | In the Experience Editor, if you configure the Custom Experience button for a File field and then click Open file, the Value cannot be null. Parameter name: name error occurs. | 400101 | |
| Experience Editor | If you change the name of a form field, an exception is thrown during form aggregation. | 120569 | |
| Experience Optimization | A full rebuild of the sitecore_suggested_test_index is triggered too often. | 336911 | |
| Experience Optimization | In Experience Optimization, the Active Tests tab opens items in Experience Editor without the sc_site parameter in the URL. |
CS0183207 | 405796 |
| Experience Optimization | If you repeatedly edit an RTE field or add a rendering as a non-administrator, the concurrent insertions into the current item cause a NullReferenceExcepion. | 221156 | |
| Experience Optimization | In the Personalize the component dialog, if a rule name is empty, the The name cannot be blank message appears continuously in Safari and Chrome. | 257477 | |
| Experience Optimization | In Content Testing, the context site for the Generate Screenshot functionality is not resolved correctly. | 194113 | |
| Experience Optimization | In the Content Editor if you cancel the creation of a resuable test, the Content Editor displays the notification for the draft resuable test. | 447990 | |
| Experience Profile | If a contact makes several simultaneous visits to a site, the Experience Profile hangs. | CS0147941 | 291232 |
| Experience Profile | If the profile type is set to Average, the Radar chart is empty. | CS01155246 | 316235 |
| Links | Cross-site links contain sitecore/content/. |
422970 | |
| Login | When you login after trying to access a sitecore/path, you are not redirected to the Launchpad. |
380821 | |
| Login | You cannot log in to the Sitecore client if one of the databases in not accessible. | 411647 | |
| Marketing Foundation | If Marketing Automation changes a profile during an active session, the profiles are lost after the session is submitted. | 407652 | |
| Marketing Foundation | The performance of tracking fields with a large number of profile mapping rules is poor. | 410594 | |
| Marketing Foundation | The ItemEventHandler's isMarketingDefinition check fails on item:create. This causes issues when you create media items that have special characters in their names. |
CS0191872, CS0203313, CS0205684, CS0217531 | 427368 |
| Miscellaneous | Access to an item is denied if the Enforce Version Presence setting is enabled and the items' parent has no version in the current language. | 435442 | |
| Miscellaneous | The GetPublishedVersionOfItem method is not thread-safe. |
346937 | |
| Miscellaneous | A number of classes in the Sitecore Kernel are dependent on Fast Query. | 137916 | |
| Miscellaneous | The Save changes dialog does not refresh the Content Editor. | 126958 | |
| Miscellaneous | The Enabled clones feature decreases field-read performance for non-cloned items. | 227274 | |
| Miscellaneous | Dictionary translation does not work for language fallback items that are updated remotely or through publishing. | 156715 | |
| Miscellaneous | The current implementation of the 'RestrictedControllerProvider' is not optimal. | 188887 | |
| Miscellaneous | LinkManager.GetItemUrl does not resolve sites correctly when alwaysIncludeServerUrl is set to false. |
391005 | |
| Miscellaneous | Editing an item that has several delegated items can throw an error. | 369243 | |
| Miscellaneous | If you use the Revert command, item serialization creates an extra version of the edited item. | 193263 | |
| Miscellaneous | The LinkProvider.ResolveTargetSite(Item item) method does not resolves the site. |
299874 | |
| Miscellaneous | ContetxtItemId is not set inside the GetRenderingDatasourceArgs class. |
415979 | |
| Miscellaneous | The Select Rendering functionality does not respect the language of the current item. | 88236 | |
| Miscellaneous | Validation ignores changes that have been made to fields that inherit from Standard Values. | 415683 | |
| Miscellaneous | If lambda methods are present in the stacktrace, the LocationInfo constructor throws a NullReferenceException. | 437603 | |
| Miscellaneous | If the parent of an item is unpublished, data sources are not rendered on the item. | 437895 | |
| Miscellaneous | A JS file does not contain the logic required to pass the context language to a dialog box. | 441767 | |
| Miscellaneous | It takes too long to load LanguageMapping. | 442879 | |
| Miscellaneous | The General Link dialog box displays the Media Preview icon in EN language and not in the current language. | 446587 | |
| Miscellaneous | The General Link dialog box displays the content tree in EN language and not in the current language. | 434464 | |
| Miscellaneous | The cumulative hotfix for Sitecore XP 9.2.0 breaks the SSL offloading feature for media links. | 426276 | |
| Miscellaneous | When you log in through Azure AD, URLs that contain non-ASCII characters are not encoded correctly on Azure. | 428679 | |
| Miscellaneous | The Suppress Validation Rule functionality does not work on the component field type. | 419674 | |
| Miscellaneous | The Sitecore.zip functionality has been deprecated, and it will be completely removed in a later version. | ||
| Miscellaneous | The Select Media dialog does not respect the current content language. | 184883 | |
| Miscellaneous | The Select Media dialog duplicates the la= language query string parameter for versioned media items. |
405280 | |
| Miscellaneous | When hotfix 402039-1 is installed, the UserRoleCondition does not work for virtual users. | 442097 | |
| Miscellaneous | If you remove a version of an item that contains several links, it is removed very slowly. | 411100 | |
| Miscellaneous | The translation cache reloads very slowly. | 406777 | |
| Miscellaneous | The Redis Session Provider performs poorly in high-stress situations. | 436550 | |
| MVC | If you use a controller rendering, the data source does not contain a value. | 300536 | |
| Path Analyser | The Path Analyzer contains some outdated 3rd party JavaScript libraries. | CS0162399, CS0162401 | 341306 |
| Platform | ItemInformation.ChildIDs has been optimized to improve handling of concurrent requests. |
439228 | |
| Platform | The Sitecore.ExperienceEditor.Pipelines.RenderField.EncodeTextFieldValue processor has been added to the renderField pipeline. It prevents scripts from being executed in simple text fields and ensures that HTML contents in simple text fields are encoded in edit mode but rendered in preview or normal mode. |
319982, 410513, 482842 | |
| Platform | The unversioned Phrase field in en language is still present even if there is no English(region) version of the dictionary item. |
406889 | |
| Platform | It is now possible to configure personalized content while simultaneously setting the caching option for rendering. | ||
| Publishing | During publication the LoadInitialItemDefinitions method does not respect the configuration of retryers. |
443201 | |
| Rich Text Editor | In the Rich Text Editor, when you click Insert Sitecore Link, the default en version of the item Display Name is always inserted as the link text. | 318519 | |
| Rich Text Editor | You cannot paste formatted text from Word into the Rich Text Editor. | 362810 | |
| Serialization | Non-existent FallBack langauge versions of items are serialized with YAML serialization. | 418685 | |
| Sitecore.ContentSearch | The SearchContentSearchIndex class does not support search by criteria. |
94749 | |
| Sitecore.ContentSearch | The SLOP parameter is ignored. | 94796 | |
| Sitecore.ContentSearch | Proximity search does not work with hyphenated words. | 413873 | |
| Sitecore.ContentSearch | Language fallback items are not deleted from the web index. | 220361 | |
| Sitecore.ContentSearch | Media items with language versions can cause UI labels to not be displayed. | 404553 | |
| Sitecore.ContentSearch | The CurrentLanguage token does not work in a search query. | 398616 | |
| Sitecore.ContentSearch | In a patch file, the files specified in the <loadOrder> section are not excluded from the resulting configuration when the mode setting is set to Off. |
391721 | |
| Sitecore.ContentSearch | Use IndexCustodian for index operations (Update, Refresh, Delete, Rebuild) instead of ISearchIndex. | 346932 | |
| Sitecore Forms | If you create a new form based on a template, an error is displayed. | 401422 | |
| Sitecore Forms | You cannot add two actions of the same type to a form. | 398965 | |
| Sitecore Forms | If more than one RegularExpressionValidation is defined in a field, an InvalidOperationException occurs. | 409302 | |
| Sitecore Forms | When unexpected behavior is detected in multi-page forms, no alert message is displayed. | 431196, 446817 | |
| Sitecore Forms | A /fieldtracking/register call returns non valid json. | 421156 | |
| Sitecore Forms | If you use a GET request, the An item with the same key has already been added error occurs. | 400109 | |
| Sitecore security | In the User Manager, a request to unlock a user times out if the user making the request is not an admin. | 416025 | |
| Solr | Searching by the _templatename field is case-sensitive for Solr. | 307597 | |
| Solr | If a value of the index id field contains uppercase letters, searching does not return any results. | 140821 | |
| Solr | Queries that contain spaces do not work correctly. | 177874 | |
| Solr | Queries that use the Contains method do not work correctly. | 206650 | |
| Solr | Search terms that are used in the Contains, StartsWith, EndsWith methods are wrapped in quotation marks and the queries do not work correctly. | 233988 | |
| SPEAK | The Select Media dialog caches image thumbnails. | 436697 | |
| Workbox | In the Workbox, when you submit an item based on the Standard Comment Template, the item is moved to the next workflow state even when a Fatal Validation error is thrown. | 196255 |