Skip to content

Update migrate-from-umarketingsuite.md #6633

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Merged
merged 6 commits into from
Nov 13, 2024
Merged

Update migrate-from-umarketingsuite.md #6633

Changes from all commits
Commits
Show all changes
6 commits
Select commit Hold shift + click to select a range
1a7b12d
Update migrate-from-umarketingsuite.md
Jette94 Nov 7, 2024
3778524
Update 13/umbraco-engage/upgrading/migrate-from-umarketingsuite.md
Jette94 Nov 7, 2024
ccd1955
Fix the ordered list
sofietoft Nov 8, 2024
178c40e
Update migrate-from-umarketingsuite.md
Jette94 Nov 8, 2024
6b22204
Update 13/umbraco-engage/upgrading/migrate-from-umarketingsuite.md
Jette94 Nov 8, 2024
81f8969
Update migrate-from-umarketingsuite.md
Jette94 Nov 13, 2024
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
22 changes: 15 additions & 7 deletions 13/umbraco-engage/upgrading/migrate-from-umarketingsuite.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -48,6 +48,10 @@
2. Verify that uMarketingSuite & uMarketingSuite addon version checks return the expected results.
3. Verify that the uMarketingSuite table integrity check returns the expected results.

{% hint style="info" %}
If any of these checks return a failure, please resolve the issue before proceeding with the migration.
{% endhint %}

The result should look like this:

```
Expand Down Expand Up @@ -123,11 +127,11 @@

Please find below an overview of the changes to the default scripts in a uMarketingSuite installation:

* All scripts & Asset Paths containing the `uMarketingSuite` keyword are renamed to:
* Rename scripts & Asset Paths containing the `uMarketingSuite` keyword to:
* `Assets/Umbraco.Engage/Scripts/umbracoEngage.analytics.js`
* `Assets/Umbraco.Engage/Scripts/umbracoEngage.ga4-bridge.js`
* `Assets/Umbraco.Engage/Scripts/umbracoEngage.blockerdetection.js`
* The Cockpit Partial View has been moved to:
* The Cockpit partial view has been moved, and any references should be changed to:
*  `Partials/Umbraco.Engage/Cockpit`
* If you are tracking custom events please make sure to update the calls to the send event method:
* `ums("send", "event", "<Category name>", "<Action>", "<Label>")`
Expand Down Expand Up @@ -256,8 +260,8 @@
1. Delete any `obj`/`bin` folders in your projects to ensure a clean build.
2. Recompile all projects and ensure all dependencies are restored correctly.
3. Contact Umbraco Support for a license key.
1. Look for the speech bubble in the bottom right corner of your screen at [umbraco.com](https://umbraco.com).
2. Click it, and you can open a new support request.
* Look for the speech bubble in the bottom right corner of your screen at [umbraco.com](https://umbraco.com).

Check warning on line 263 in 13/umbraco-engage/upgrading/migrate-from-umarketingsuite.md

View workflow job for this annotation

GitHub Actions / runner / vale 

[vale] reported by reviewdog 🐶
[UmbracoDocs.UmbracoTerms] We prefer 'Umbraco' over 'umbraco.'

Raw Output:
{"message": "[UmbracoDocs.UmbracoTerms] We prefer 'Umbraco' over 'umbraco.'", "location": {"path": "13/umbraco-engage/upgrading/migrate-from-umarketingsuite.md", "range": {"start": {"line": 263, "column": 79}}}, "severity": "WARNING"}
* Click it, and you can open a new support request.
4. Add your new Umbraco Engage [license](../installation/licensing.md) key to the `appSettings.json` file:

```json
Expand All @@ -268,7 +272,7 @@
}
```

4. Configure Umbraco Engage to use the legacy segment naming scheme:
5. Configure Umbraco Engage to use the legacy segment naming scheme:

```json
"Engage": {
Expand All @@ -284,7 +288,7 @@
It is required to enable the `UseLegacySegmentNames` setting on all environments to maintain compatibility with existing segments. Without it, any personalization or A/B test created using uMarketingSuite will fail to work and become inaccessible and incompatible with the new naming scheme.
{% endhint %}

5. \[Optional] Set the `Engage:Analytics:VisitorCookie:LegacyCookieName` configuration if uMarketingSuite was using a different visitor cookie name setting than the default `uMarketingSuiteAnalyticsVisitorId`:
6. \[Optional] Set the `Engage:Analytics:VisitorCookie:LegacyCookieName` configuration if uMarketingSuite was using a different visitor cookie name setting than the default `uMarketingSuiteAnalyticsVisitorId`:

```json
"Engage": {
Expand All @@ -300,7 +304,7 @@
Umbraco Engage will automatically convert cookies previously set by uMarketingSuite to the new cookie name. This setting is only required if you have a custom cookie name set in uMarketingSuite. It will ensure a smooth transition in tracking existing visitors.
{% endhint %}

6. Run the project.
7. Run the project.

## **Step 7: Validate the migration**

Expand Down Expand Up @@ -330,6 +334,10 @@
* Go to Engage -> Settings -> Configuration in the backoffice and click the Regenerate button. Depending on the number of page views in the database this could take a while.
9. Use the [Troubleshooting Installs](../installation/troubleshooting-installs.md) guide to verify that everything works as expected.

{% hint style="info" %}
If the site is hosted on Umbraco Cloud, stopping and starting the site is not necessary.
{% endhint %}

### **Custom firewall changes**

If the `/umbraco/umarketingsuite/` path was previously allowed, this needs to change to `/umbraco/engage/`.
Expand Down
Loading