Skip to content
Merged
Show file tree
Hide file tree
Changes from all commits
Commits
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
Original file line number Diff line number Diff line change
Expand Up @@ -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:

Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -9,7 +9,7 @@ description: >-
You can add the Umbraco Engage Analytics JavaScript file to your website by placing this code before the closing `</body>` tag of your website.

```html
<script src="/Assets/umbracoEngage/Scripts/umbracoEngage.analytics.js"></script>
<script src="/Assets/Umbraco.Engage/Scripts/umbracoEngage.analytics.js"></script>
```

When this file is included, Umbraco Engage sends the following data to the server before the visitor navigates to another page:
Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -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
<script src="~/Assets/umbracoEngage/Scripts/umbracoEngage.analytics.ga4-bridge.min.js"></script>
<script src="~/Assets/Umbraco.Engage/Scripts/umbracoEngage.analytics.ga4-bridge.min.js"></script>
```

### Excluded events
Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -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
<script src="~/Assets/umbracoEngage/Scripts/umbracoEngage.analytics.ga-bridge.js"></script>
<script src="~/Assets/Umbraco.Engage/Scripts/umbracoEngage.analytics.ga-bridge.js"></script>
```
Original file line number Diff line number Diff line change
Expand Up @@ -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
<script src="/Assets/umbracoEngage/Scripts/umbracoEngage.analytics.blockerdetection.js"></script>
<script src="/Assets/Umbraco.Engage/Scripts/umbracoEngage.analytics.blockerdetection.js"></script>
```

If you include the script one of the following events is sent:
Expand Down
6 changes: 4 additions & 2 deletions 13/umbraco-engage/developers/analytics/location.md
Original file line number Diff line number Diff line change
Expand Up @@ -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; }
Expand All @@ -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)
{
Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -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:

Expand All @@ -65,7 +65,7 @@ You need to load the file at the end of your page to enable these events.

{% code lineNumbers="true" %}
```html
<script src="/Assets/umbracoEngage/Scripts/umbracoEngage.analytics.js"></script>
<script src="/Assets/Umbraco.Engage/Scripts/umbracoEngage.analytics.js"></script>
```
{% endcode %}

Expand Down Expand Up @@ -99,6 +99,6 @@ The only thing you will need to do is include the script _\Assets\umbracoEngage\

{% code lineNumbers="true" %}
```html
<script src="/Assets/umbracoEngage/Scripts/umbracoEngage.analytics.ga-bridge.js"></script>
<script src="/Assets/Umbraco.Engage/Scripts/umbracoEngage.analytics.ga-bridge.js"></script>
```
{% endcode %}
Original file line number Diff line number Diff line change
Expand Up @@ -14,7 +14,34 @@ This interface defines 3 methods that you will have to implement:

{% code overflow="wrap" %}
```csharp
/// <summary>/// 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./// </summary>/// <param name="context">Context of the request</param>/// <returns>True if A/B testing is allowed, otherwise false.</returns>bool AbTestingIsAllowed(HttpContextBase context);/// <summary>/// 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./// </summary>/// <param name="context">Context of the request</param>/// <returns>True if Analytics is allowed, otherwise false.</returns>bool AnalyticsIsAllowed(HttpContextBase context);/// <summary>/// Indicates if Personalization testing is allowed for the given request context./// If false, the visitor will not see any personalized content./// </summary>/// <param name="context">Context of the request</param>/// <returns>True if Personalization is allowed, otherwise false.</returns>bool PersonalizationIsAllowed(HttpContextBase context);
/// <summary>
/// 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.
/// </summary>
/// <param name="context">Context of the request</param>
/// <returns>True if A/B testing is allowed, otherwise false.</returns>
bool AbTestingIsAllowed(HttpContextBase context);

/// <summary>
/// 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.
/// </summary>
/// <param name="context">Context of the request</param>
/// <returns>True if Analytics is allowed, otherwise false.</returns>
bool AnalyticsIsAllowed(HttpContextBase context);

/// <summary>
/// Indicates if Personalization testing is allowed for the given request context.
/// If false, the visitor will not see any personalized content.
/// </summary>
/// <param name="context">Context of the request</param>
/// <returns>True if Personalization is allowed, otherwise false.</returns>
bool PersonalizationIsAllowed(HttpContextBase context);
```
{% endcode %}

Expand All @@ -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<IModulePermissions, YourCustomModulePermissions>(); } }}
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<IModulePermissions, YourCustomModulePermissions>();
}
}
}
```
{% endcode %}

Expand Down
6 changes: 3 additions & 3 deletions 13/umbraco-engage/upgrading/migrate-from-umarketingsuite.md
Original file line number Diff line number Diff line change
Expand Up @@ -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:

```
<script src="~/Assets/umbracoEngage/Scripts/umbracoEngage.analytics.js"></script>
<script src="~/Assets/umbracoEngage/Scripts/umbracoEngage.analytics.ga-bridge.js"></script>
<script src="~/Assets/umbracoEngage/Scripts/umbracoEngage.analytics.blockerdetection.js"></script>
<script src="~/Assets/Umbraco.Engage/Scripts/umbracoEngage.analytics.js"></script>
<script src="~/Assets/Umbraco.Engage/Scripts/umbracoEngage.analytics.ga-bridge.js"></script>
<script src="~/Assets/Umbraco.Engage/Scripts/umbracoEngage.analytics.blockerdetection.js"></script>
```

See the detailed steps and instructions here \<link to guide of Corné below>
Expand Down
Loading