From 914930ca1b434d0b480cb381a1212082c3d6ab43 Mon Sep 17 00:00:00 2001 From: =?UTF-8?q?Corn=C3=A9=20Hoskam?= Date: Tue, 22 Oct 2024 10:58:50 +0200 Subject: [PATCH] Asset path changes --- .../README.md | 2 +- ...measurements-with-the-analytics-scripts.md | 2 +- .../bridging-library-for-google-analytics.md | 2 +- ...bridging-library-for-google-tag-manager.md | 2 +- .../google-analytics-blocker-detection.md | 2 +- .../developers/analytics/location.md | 6 ++- .../dataflow-pipeline/data-collection.md | 6 +-- .../module-permissions.md | 46 ++++++++++++++++++- .../upgrading/migrate-from-umarketingsuite.md | 6 +-- 9 files changed, 59 insertions(+), 15 deletions(-) diff --git a/13/umbraco-engage/developers/analytics/client-side-events-and-additional-javascript-files/README.md b/13/umbraco-engage/developers/analytics/client-side-events-and-additional-javascript-files/README.md index c7175627fc7..f24e0d9aa38 100644 --- a/13/umbraco-engage/developers/analytics/client-side-events-and-additional-javascript-files/README.md +++ b/13/umbraco-engage/developers/analytics/client-side-events-and-additional-javascript-files/README.md @@ -9,7 +9,7 @@ description: >- Umbraco Engage helps you with some additional scripts and views. -They are all stored in the `/Assets/umbracoEngage/Scripts/` and the `/Views/Partials/Umbraco.Engage/` folders. +They are all stored in the `/Assets/Umbraco.Engage/Scripts/` and the `/Views/Partials/Umbraco.Engage/` folders. Find more information about the scripts: diff --git a/13/umbraco-engage/developers/analytics/client-side-events-and-additional-javascript-files/additional-measurements-with-the-analytics-scripts.md b/13/umbraco-engage/developers/analytics/client-side-events-and-additional-javascript-files/additional-measurements-with-the-analytics-scripts.md index be5b943e3db..0da9dbccfab 100644 --- a/13/umbraco-engage/developers/analytics/client-side-events-and-additional-javascript-files/additional-measurements-with-the-analytics-scripts.md +++ b/13/umbraco-engage/developers/analytics/client-side-events-and-additional-javascript-files/additional-measurements-with-the-analytics-scripts.md @@ -9,7 +9,7 @@ description: >- You can add the Umbraco Engage Analytics JavaScript file to your website by placing this code before the closing `` tag of your website. ```html - + ``` When this file is included, Umbraco Engage sends the following data to the server before the visitor navigates to another page: diff --git a/13/umbraco-engage/developers/analytics/client-side-events-and-additional-javascript-files/bridging-library-for-google-analytics.md b/13/umbraco-engage/developers/analytics/client-side-events-and-additional-javascript-files/bridging-library-for-google-analytics.md index 2bf5d64d785..83737f7f784 100644 --- a/13/umbraco-engage/developers/analytics/client-side-events-and-additional-javascript-files/bridging-library-for-google-analytics.md +++ b/13/umbraco-engage/developers/analytics/client-side-events-and-additional-javascript-files/bridging-library-for-google-analytics.md @@ -12,7 +12,7 @@ We have included a bridging JavaScript file to "catch" all Google Analytics even Add a reference to `umbracoEngage.analytics.ga4-bridge.min.js`: ```html - + ``` ### Excluded events diff --git a/13/umbraco-engage/developers/analytics/client-side-events-and-additional-javascript-files/bridging-library-for-google-tag-manager.md b/13/umbraco-engage/developers/analytics/client-side-events-and-additional-javascript-files/bridging-library-for-google-tag-manager.md index f7374c7dadd..45d6809b417 100644 --- a/13/umbraco-engage/developers/analytics/client-side-events-and-additional-javascript-files/bridging-library-for-google-tag-manager.md +++ b/13/umbraco-engage/developers/analytics/client-side-events-and-additional-javascript-files/bridging-library-for-google-tag-manager.md @@ -10,5 +10,5 @@ When using Google Tag Manager you can collect all events in Umbraco Engage. This To include the file add the following code before the closing `body` tag in your HTML: ```html - + ``` diff --git a/13/umbraco-engage/developers/analytics/client-side-events-and-additional-javascript-files/google-analytics-blocker-detection.md b/13/umbraco-engage/developers/analytics/client-side-events-and-additional-javascript-files/google-analytics-blocker-detection.md index ca092c6713c..7b96704a09e 100644 --- a/13/umbraco-engage/developers/analytics/client-side-events-and-additional-javascript-files/google-analytics-blocker-detection.md +++ b/13/umbraco-engage/developers/analytics/client-side-events-and-additional-javascript-files/google-analytics-blocker-detection.md @@ -10,7 +10,7 @@ When a visitor runs an Adblocker or cookieblocker the visitor is likely not trac This is made possible by a JavaScript file that you can include before the closing `body`-tag in your HTML: ```js - + ``` If you include the script one of the following events is sent: diff --git a/13/umbraco-engage/developers/analytics/location.md b/13/umbraco-engage/developers/analytics/location.md index 9aebeee3b70..db4319489d9 100644 --- a/13/umbraco-engage/developers/analytics/location.md +++ b/13/umbraco-engage/developers/analytics/location.md @@ -22,7 +22,8 @@ First, define a class that implements **ILocation**, to hold the localization in {% code overflow="wrap" lineNumbers="true" %} ```cs -using Umbraco.Engage.Business.Analytics.Processed;public class GeoIpLocation : ILocation{ +using Umbraco.Engage.Business.Analytics.Processed; +public class GeoIpLocation : ILocation { public string Country { get; set; } public string County { get; set; } public string Province { get; set; } @@ -37,7 +38,8 @@ Next, implement the location extractor to read and validate the incoming IP addr {% code overflow="wrap" lineNumbers="true" %} ```cs -using Umbraco.Engage.Business.Analytics.Processing.Extractors;public class MyCustomLocationExtractor : IRawPageviewLocationExtractor +using Umbraco.Engage.Business.Analytics.Processing.Extractors; +public class MyCustomLocationExtractor : IRawPageviewLocationExtractor { public ILocation Extract(IRawPageview rawPageview) { diff --git a/13/umbraco-engage/developers/introduction/dataflow-pipeline/data-collection.md b/13/umbraco-engage/developers/introduction/dataflow-pipeline/data-collection.md index c000591158f..d4db1e2b31b 100644 --- a/13/umbraco-engage/developers/introduction/dataflow-pipeline/data-collection.md +++ b/13/umbraco-engage/developers/introduction/dataflow-pipeline/data-collection.md @@ -47,7 +47,7 @@ These kinds of requests need to be collected via the client side. To support thi ### umbracoEngage.analytics.js -If you install the package you will find this JavaScript file in the folder /Assets/umbracoEngage/scripts/. +If you install the package you will find this JavaScript file in the folder /Assets/Umbraco.Engage/scripts/. This JavaScript collects the following data for you: @@ -65,7 +65,7 @@ You need to load the file at the end of your page to enable these events. {% code lineNumbers="true" %} ```html - + ``` {% endcode %} @@ -99,6 +99,6 @@ The only thing you will need to do is include the script _\Assets\umbracoEngage\ {% code lineNumbers="true" %} ```html - + ``` {% endcode %} diff --git a/13/umbraco-engage/developers/introduction/the-umbraco-engage-cookie/module-permissions.md b/13/umbraco-engage/developers/introduction/the-umbraco-engage-cookie/module-permissions.md index 29333d6c9bc..331cadf18fb 100644 --- a/13/umbraco-engage/developers/introduction/the-umbraco-engage-cookie/module-permissions.md +++ b/13/umbraco-engage/developers/introduction/the-umbraco-engage-cookie/module-permissions.md @@ -14,7 +14,34 @@ This interface defines 3 methods that you will have to implement: {% code overflow="wrap" %} ```csharp -/// /// Indicates if A/B testing is allowed for the given request context./// If false, the visitor will not be assigned to any A/B tests and will not/// see any active A/B test content./// /// Context of the request/// True if A/B testing is allowed, otherwise false.bool AbTestingIsAllowed(HttpContextBase context);/// /// Indicates if Analytics is allowed for the given request context./// If false, the visitor will be treated as the built-in Anonymous visitor/// and all their activity will be assigned to the Anonymous visitor rather than the specific visitor./// No A/B testing or Personalization will be allowed either if this is false regardless of their/// respective IsAllowed() outcomes./// In addition, no cookie will be sent to the visitor when this is set to false./// /// Context of the request/// True if Analytics is allowed, otherwise false.bool AnalyticsIsAllowed(HttpContextBase context);/// /// Indicates if Personalization testing is allowed for the given request context./// If false, the visitor will not see any personalized content./// /// Context of the request/// True if Personalization is allowed, otherwise false.bool PersonalizationIsAllowed(HttpContextBase context); +/// +/// Indicates if A/B testing is allowed for the given request context. +/// If false, the visitor will not be assigned to any A/B tests and will not +/// see any active A/B test content. +/// +/// Context of the request +/// True if A/B testing is allowed, otherwise false. +bool AbTestingIsAllowed(HttpContextBase context); + +/// +/// Indicates if Analytics is allowed for the given request context. +/// If false, the visitor will be treated as the built-in Anonymous visitor +/// and all their activity will be assigned to the Anonymous visitor rather than the specific visitor. +/// No A/B testing or Personalization will be allowed either if this is false regardless of their +/// respective IsAllowed() outcomes. +/// In addition, no cookie will be sent to the visitor when this is set to false. +/// +/// Context of the request +/// True if Analytics is allowed, otherwise false. +bool AnalyticsIsAllowed(HttpContextBase context); + +/// +/// Indicates if Personalization testing is allowed for the given request context. +/// If false, the visitor will not see any personalized content. +/// +/// Context of the request +/// True if Personalization is allowed, otherwise false. +bool PersonalizationIsAllowed(HttpContextBase context); ``` {% endcode %} @@ -24,7 +51,22 @@ It could look something like this: {% code overflow="wrap" %} ```csharp -using Umbraco.Engage.Business.Permissions.ModulePermissions;using Umbraco.Engage.Common.Composing;using Umbraco.Core;using Umbraco.Core.Composing;namespace YourNamespace { [ComposeAfter(typeof(UmbracoEngageApplicationComposer))] public class YourComposer : IComposer { public void Compose(Composition composition) { composition.RegisterUnique(); } }} +using Umbraco.Engage.Infrastructure.Permissions.ModulePermissions; +using Umbraco.Engage.Common.Composing; +using Umbraco.Core; +using Umbraco.Core.Composing; + +namespace YourNamespace +{ + [ComposeAfter(typeof(UmbracoEngageApplicationComposer))] + public class YourComposer : IComposer + { + public void Compose(Composition composition) + { + composition.RegisterUnique(); + } + } +} ``` {% endcode %} diff --git a/13/umbraco-engage/upgrading/migrate-from-umarketingsuite.md b/13/umbraco-engage/upgrading/migrate-from-umarketingsuite.md index f7a9c538f20..91543a8f0b5 100644 --- a/13/umbraco-engage/upgrading/migrate-from-umarketingsuite.md +++ b/13/umbraco-engage/upgrading/migrate-from-umarketingsuite.md @@ -27,9 +27,9 @@ The final version will be available with the release of Umbraco Engage. Make sure to change the reference to the client side analytics scripts to: ``` - - - + + + ``` See the detailed steps and instructions here \