|
1 | 1 | ---
|
2 |
| -description: Version-specific documentation for upgrading to new major versions of Umbraco Engage. |
| 2 | +description: >- |
| 3 | + Version-specific documentation for upgrading to new major versions of Umbraco |
| 4 | + Engage. |
3 | 5 | ---
|
4 | 6 |
|
5 |
| -# Version Specific Upgrade Notes |
| 7 | +# Version specific Upgrade Notes |
6 | 8 |
|
7 |
| -This article provides specific upgrade instructions for migrating to major version of Umbraco Engage |
| 9 | +This article provides specific upgrade instructions and breaking changes introduced when migrating from major version 13 of Umbraco Engage to version 16. |
8 | 10 |
|
9 | 11 | {% hint style="info" %}
|
10 | 12 | When upgrading to a new minor or patch version, learn about the changes in the [Release Notes](../release-notes.md) article.
|
11 | 13 | {% endhint %}
|
12 | 14 |
|
13 | 15 | ## Breaking changes
|
14 |
| -#### v13.2.0 (Umbraco Engage) & v13.1.0 (Umbraco Engage Forms) |
15 |
| -Introduced Razor Class Library support to serve static files for Engage, removing physical backoffice, views, and assets files from development projects. |
16 | 16 |
|
17 |
| -While this is not considered a breaking change, it is recommended that such folders be removed from the project to avoid conflicts in the future. |
| 17 | +### v16.0.0 (Umbraco Engage v16 Launch) |
18 | 18 |
|
19 |
| -The following folders should be manually removed from your project upon updating Umbraco Engage: |
| 19 | +With the introduction of Engage version 16, several breaking changes have been introduced to accommodate the transitions between multiple major versions of the core CMS. |
20 | 20 |
|
21 |
| - * `App_Plugins\Umbraco.Engage` |
22 |
| - * `Assets\Umbraco.Engage` |
23 |
| - * `Views\Partials\Umbraco.Engage` |
| 21 | +#### Clientside Analytics |
24 | 22 |
|
25 |
| -The same changes apply to the Forms add-on `Umbraco.Engage.Forms`. |
| 23 | +Engage includes various optional scripts that can be included in the front-end, which interact with various API endpoints. Some of these endpoints have changed. If any firewall rules are in place involving the front-end reaching Umbraco APIs, the following paths need to be allowed through: |
26 | 24 |
|
27 |
| -The following folder should be manually removed from your project upon updating Umbraco Engage Forms: |
| 25 | +``` |
| 26 | +/umbraco/engage/pagedata/collect |
| 27 | +/umbraco/engage/pagedata/collect-event |
| 28 | +/umbraco/engage/pagedata/ping |
| 29 | +``` |
28 | 30 |
|
29 |
| - * `App_Plugins\Umbraco.Engage.Forms` |
| 31 | +#### Umbraco Member Detection & Storage |
30 | 32 |
|
31 |
| -Health checks have been added to verify whether these folders are present in your project. If they are, you will receive a warning in the Health Check dashboard. |
| 33 | +The detection and storage of logged-in Umbraco Members have changed significantly between versions 13 and 16 of Engage. In older versions of v13, any kind of login claim would be detected as a valid member, causing the visitor to be marked as 'Identified' and get linked to any member claim ID. This has changed over various minor versions of v13 to only allow for Umbraco Members to prevent other login methods from interfering with Engage.  |
32 | 34 |
|
33 |
| -#### v13.0.0 (Umbraco Engage Launch) |
| 35 | +Engage v16 will strictly enforce the storage of Umbraco Members only, attempting to update any existing pageview data that detects a logged-in member. This migration includes switching from integer IDs to GUID keys, validating the GUIDs against the existing Umbraco Members, and enforcing the datatype to a unique identifier.  |
34 | 36 |
|
35 |
| -Umbraco Engage contains a number of breaking changes from the previous uMarketingSuite product. |
36 |
| - |
37 |
| -See the [Migrate from uMarketingSuite](migrate-from-umarketingsuite.md) for full details. |
| 37 | +This **will** result in data loss if non-Umbraco members or no longer existing members were stored in the `MembershipProviderKey` column in the `umbracoEngageAnalyticsPageview` table. |
0 commit comments