Skip to content
Merged
Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
19 commits
Select commit Hold shift + click to select a range
6df0151
Fixed vale errors and added missing descriptions
eshanrnh Nov 14, 2024
5e1bb6d
Added descriptions and fixed vale errors
eshanrnh Nov 15, 2024
6014ff6
Merge branch 'main' of https://github.com/umbraco/UmbracoDocs into en…
eshanrnh Nov 15, 2024
197f7f8
Removed exclamation icon
eshanrnh Nov 15, 2024
1713262
Removed icon
eshanrnh Nov 15, 2024
4b1740e
Update 13/umbraco-engage/developers/personalization/implement-your-ow…
eshanrnh Nov 18, 2024
33284c5
Update 13/umbraco-engage/getting-started/for-marketers-and-editors/co…
eshanrnh Nov 18, 2024
8b94067
Update 13/umbraco-engage/installation/licensing.md
eshanrnh Nov 18, 2024
bdb177c
Update 13/umbraco-engage/marketers-and-editors/ab-testing/what-is-ab-…
eshanrnh Nov 18, 2024
3fb3f7e
Update 13/umbraco-engage/marketers-and-editors/analytics/campaigns.md
eshanrnh Nov 18, 2024
7f20626
Update 13/umbraco-engage/marketers-and-editors/ab-testing/what-is-ab-…
eshanrnh Nov 18, 2024
efad58c
Update 13/umbraco-engage/marketers-and-editors/analytics/campaigns.md
eshanrnh Nov 18, 2024
1b21cf9
Update 13/umbraco-engage/marketers-and-editors/analytics/types-of-cli…
eshanrnh Nov 18, 2024
7a6fdec
Update 13/umbraco-engage/marketers-and-editors/personalization/implic…
eshanrnh Nov 18, 2024
b0788ed
Update 13/umbraco-engage/security-and-privacy/gdpr/README.md
eshanrnh Nov 18, 2024
91c960c
Update 13/umbraco-engage/security-and-privacy/how-it-works.md
eshanrnh Nov 18, 2024
4f17ee8
Merge branch 'main' of https://github.com/umbraco/UmbracoDocs into en…
eshanrnh Nov 18, 2024
618a8ad
Incorporated comments
eshanrnh Nov 18, 2024
e1e5340
Removed hyphen from rethink to fix vale warning
eshanrnh Nov 18, 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
1 change: 1 addition & 0 deletions .github/styles/UmbracoDocs/Acronyms.yml
Original file line number Diff line number Diff line change
Expand Up @@ -87,3 +87,4 @@ exceptions:
- JPG
- JPEG
- BCC
- SSD
1 change: 0 additions & 1 deletion 13/umbraco-engage/developers/ab-testing/README.md
Original file line number Diff line number Diff line change
@@ -1,5 +1,4 @@
---
icon: square-exclamation
description: Umbraco Engage offers multiple ways for performaing A/B tests on your website.
---

Expand Down
2 changes: 1 addition & 1 deletion 13/umbraco-engage/developers/ab-testing/csharp-api.md
Original file line number Diff line number Diff line change
Expand Up @@ -4,7 +4,7 @@ description: >-
Umbraco Engage C# API.
---

# Retrieving A/B test variants in C\#
# Retrieving A/B test variants in C#

## Retrieving Active A/B test variants

Expand Down
Original file line number Diff line number Diff line change
@@ -1,5 +1,4 @@
---
icon: square-exclamation
description: >-
Learn about what scripts can be used to connect with other data-gathering
tools.
Expand Down
Original file line number Diff line number Diff line change
@@ -1,5 +1,4 @@
---
icon: square-exclamation
description: Learn how to bridge Google Analytics with the data in Umbraco Engage.
---

Expand Down
Original file line number Diff line number Diff line change
@@ -1,5 +1,4 @@
---
icon: square-exclamation
description: Learn how to bridge data between Google Tag Manager and Umbraco Engage.
---

Expand Down
Original file line number Diff line number Diff line change
@@ -1,5 +1,4 @@
---
icon: square-exclamation
description: Learn how to create and add custom events to Umbraco Engage.
---

Expand Down
Original file line number Diff line number Diff line change
@@ -1,5 +1,4 @@
---
icon: square-exclamation
description: Learn how Umbraco Engage handles visitors who use blocker detection.
---

Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -4,7 +4,7 @@ description: >-
Engage to the Google Tag Manager (GTM) data layer in Razor templates.
---

# Sending data to the GTM Datalayer
# Sending data to the Google Tag Manager (GTM) Datalayer

Umbraco Engage provides a partial view that pushes variables related to A/B testing and personalization to the Google Tag Manager (GTM) data layer.

Expand Down
1 change: 0 additions & 1 deletion 13/umbraco-engage/developers/analytics/forms.md
Original file line number Diff line number Diff line change
@@ -1,5 +1,4 @@
---
icon: square-exclamation
description: Learn how data from Umbraco Forms is tracked with Umbraco Engage.
---

Expand Down
1 change: 0 additions & 1 deletion 13/umbraco-engage/developers/analytics/location.md
Original file line number Diff line number Diff line change
@@ -1,5 +1,4 @@
---
icon: square-exclamation
description: Learn how to implement an IP to location provider.
---

Expand Down
1 change: 0 additions & 1 deletion 13/umbraco-engage/developers/analytics/scroll-heatmap.md
Original file line number Diff line number Diff line change
@@ -1,5 +1,4 @@
---
icon: square-exclamation
description: >-
Learn how you can use the Scroll Heatmap in Umbraco Engage to gather data on
the behavior of your visitors.
Expand Down
1 change: 0 additions & 1 deletion 13/umbraco-engage/developers/analytics/types-of-clients.md
Original file line number Diff line number Diff line change
@@ -1,5 +1,4 @@
---
icon: square-exclamation
description: >-
Learn more about how Umbraco Engage distinguishes between bots and real
visitors.
Expand Down
1 change: 0 additions & 1 deletion 13/umbraco-engage/developers/analytics/videos.md
Original file line number Diff line number Diff line change
@@ -1,5 +1,4 @@
---
icon: square-exclamation
description: This article describes what data is tracked from videos on your website.
---

Expand Down
Original file line number Diff line number Diff line change
@@ -1,5 +1,4 @@
---
icon: square-exclamation
description: Learn what Umbraco Engage tracks before any additional configuration is added.
---

Expand Down
Original file line number Diff line number Diff line change
@@ -1,5 +1,4 @@
---
icon: square-exclamation
description: >-
Learn how the Umbraco Engage cookie works and how the functionality can be
tested.
Expand Down
1 change: 0 additions & 1 deletion 13/umbraco-engage/developers/personalization/README.md
Original file line number Diff line number Diff line change
@@ -1,5 +1,4 @@
---
icon: square-exclamation
description: >-
The personalization provided by Umbraco Umbraco Engage is built so users can
personalize the content or layout of any page without programming skills from
Expand Down
Original file line number Diff line number Diff line change
@@ -1,5 +1,4 @@
---
icon: square-exclamation
description: >-
The main two pillars of personalization that the Umbraco Engage offers are
personas and customer journeys.
Expand All @@ -20,9 +19,11 @@ To implement our example above, we will be using the `ICustomerJourneyService`.
To resolve the required services, we will use Dependency Injection:

{% code overflow="wrap" %}

```csharp
ICustomerJourneyGroupRepository _customerJourneyGroupRepository;ICustomerJourneyService _customerJourneyService;public MyController(ICustomerJourneyGroupRepository customerJourneyGroupRepository, ICustomerJourneyService customerJourneyService){ _customerJourneyGroupRepository = customerJourneyGroupRepository; _customerJourneyService = customerJourneyService;}
```

{% endcode %}

We will now request Umbraco Engage to provide the customer journey step "**Do**" from the group "**Customer Journey**".
Expand All @@ -32,10 +33,12 @@ This is the default name for the customer journey upon installation.
{% endhint %}

{% code overflow="wrap" %}

```csharp
var customerJourneyGroup = _customerJourneyGroupRepository.GetAll().FirstOrDefault(group => group.Title == "Customer Journey");
var stepDo = customerJourneyGroup.Steps.FirstOrDefault(step => step.Title == "Do");
```

{% endcode %}

We can now inspect the step **Do** variable and find its `ID`. To score the step, we provide the `ID` and the score to the `CustomerJourneyService`:
Expand Down
Original file line number Diff line number Diff line change
@@ -1,5 +1,4 @@
---
icon: square-exclamation
description: >-
Umbraco Engage has different built-in segment parameters to build segments,
such as "Customer Journey" and "Time of Day".
Expand Down Expand Up @@ -77,15 +76,17 @@ public class DayOfWeekSegmentRuleFactory : ISegmentRuleFactory
}
```

We are using the class `DayOfWeekSegmentRuleConfig` as a representation of the configuration of the rule, which is not strictly necessary but makes it easier. The configuration is stored as a string in the database but in code, we like to have IntelliSense so we parse the stored configuration to this class:
We are using the class `DayOfWeekSegmentRuleConfig` as a representation of the configuration of the rule, which is not strictly necessary but makes it easier. The configuration is stored as a string in the database or IntelliSense support in code. The stored configuration is parsed into this class:

{% code overflow="wrap" %}

```csharp
public class DayOfWeekSegmentRuleConfig
{
public DayOfWeek DayOfWeek { get; set; }
}
```

{% endcode %}

The segment rule factory needs to be registered so Umbraco Engage can use it.\
Expand Down Expand Up @@ -247,7 +248,7 @@ We want to display the picked day to the user:
</span>
```

We store the chosen day of the week as an integer 0-6 ($ctrl.config.dayOfWeek) but in the display component, we want to show the actual day (e.g. `Monday`). Our rule definition defines the mapping in its `data.days` property so we convert it using that and display the name of the day.
The chosen day of the week is stored as an integer (0-6) in `$ctrl.config.dayOfWeek`, but in the display component shows the actual day (for example. `Monday`). Our rule definition defines the mapping in its `data.days` property so we convert it using that and display the name of the day.

* `segment-rule-day-of-week-display.js`

Expand Down
Original file line number Diff line number Diff line change
@@ -1,5 +1,4 @@
---
icon: square-exclamation
description: >-
Sometimes you need more fine-grained personalization for your website. For
this purpose the Umbraco Engage exposes a service called the
Expand Down
Original file line number Diff line number Diff line change
@@ -1,5 +1,4 @@
---
icon: square-exclamation
description: >-
Umbraco Engage does not provide a built-in way to add additional data to a
profile. You can store the data in any format and in any way.
Expand Down
1 change: 0 additions & 1 deletion 13/umbraco-engage/developers/reporting.md
Original file line number Diff line number Diff line change
@@ -1,5 +1,4 @@
---
icon: square-exclamation
description: >-
It is recommended to continuously monitor the personalization on your website.
This can be done from the Reporting dashboard.
Expand Down
4 changes: 2 additions & 2 deletions 13/umbraco-engage/developers/settings/custom-goals-scoring.md
Original file line number Diff line number Diff line change
Expand Up @@ -18,7 +18,7 @@

![goal id](../../.gitbook/assets/engage-custom-goal-ID.png)

## Trigger goal in C\#
## Trigger goal in C#

To trigger the goal, execute C# code during the visitor's pageview. Inject `Umbraco.Engage.Business.Analytics.Goals.IGoalService`, which has a `TriggerGoal(long goalId, int value)` method. An implementation looks like:

Expand All @@ -45,7 +45,7 @@

To trigger a goal outside of an HTTP request, use the overload of **TriggerGoal** that takes the GUID of the pageview.

Retrieve this pageview GUID during the original request using the **Umbraco.Engage.Business.Analytics.Common.IPageviewGuidManager**. You will need to store this pageview GUID for later use when invoking:
Retrieve the pageview GUID in the original request using **Umbraco.Engage.Business.Analytics.Common.IPageviewGuidManager**. You will need to store this pageview GUID for later use when invoking:

Check warning on line 48 in 13/umbraco-engage/developers/settings/custom-goals-scoring.md

View workflow job for this annotation

GitHub Actions / runner / vale

[vale] reported by reviewdog 🐶 [UmbracoDocs.SentenceLength] Write shorter sentences (less than 25 words). Raw Output: {"message": "[UmbracoDocs.SentenceLength] Write shorter sentences (less than 25 words).", "location": {"path": "13/umbraco-engage/developers/settings/custom-goals-scoring.md", "range": {"start": {"line": 48, "column": 1}}}, "severity": "WARNING"}

```cs
_goalService.TriggerGoal(pageviewGuid, goalId, value);
Expand Down
2 changes: 1 addition & 1 deletion 13/umbraco-engage/getting-started/for-developers/README.md
Original file line number Diff line number Diff line change
Expand Up @@ -16,7 +16,7 @@ Get insights on sizing your infrastructure to meet your project's demands.

Discover best practices for setting up load balancing and managing continuous integration and deployment environments.

## [Content Delivery Network Recommendations](content-delivery-network-recommendations.md)
## [Content Delivery Network (CDN) Recommendations](content-delivery-network-recommendations.md)

Explore recommended CDN options to improve content delivery speeds.

Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -11,25 +11,17 @@ The cockpit lets you check out all the stored data when browsing the website. It

You should see the Umbraco Engage Cockpit on the left or right side of the screen:

<div align="center">

<figure><img src="../../.gitbook/assets/engage-cockpit-3.png" alt="Cockpit"><figcaption><p>Cockpit</p></figcaption></figure>

</div>
![Cockpit](../../.gitbook/assets/engage-cockpit-3.png)

Click **Open** to see all the features of the Cockpit:

<div align="center">

<figure><img src="../../.gitbook/assets/engage-cockpit-overview.png" alt="Cockpit features"><figcaption><p>Cockpit features</p></figcaption></figure>

</div>
![Cockpit features](../../.gitbook/assets/engage-cockpit-overview.png)

## Access to the cockpit

When the Umbraco Engage code has been added to the page you can see it when you are logged in to Umbraco. Visitors to your website do not have access to the Cockpit.

If you do not see the Cockpit while the Umbraco back-office runs on a different domain please contact the technical team and refer to the [load balancing / CM / CD environments](../for-developers/loadbalancing-and-cm-cd-environments.md) section.
If the Cockpit is missing while the Umbraco backoffice runs on a different domain, contact the technical team. You can also refer to the [Load Balancing and CM/CD Environments](../for-developers/loadbalancing-and-cm-cd-environments.md) article.

### Data reporting client-side

Expand All @@ -43,11 +35,7 @@ The following information is tracked:
* All [fired events](../../developers/analytics/client-side-events-and-additional-javascript-files/create-your-own-events.md) are tracked.
* Every out-click to other domains, a pdf file or excel file is measured by default.

<div align="left">

<figure><img src="../../.gitbook/assets/engage-cockpit-analytics.png" alt="Cockpit Analytics."><figcaption><p>Cockpit Analytics.</p></figcaption></figure>

</div>
![Cockpit Analytics](../../.gitbook/assets/engage-cockpit-analytics.png)

### Data reporting server-side

Expand All @@ -61,18 +49,10 @@ In this section you can see all the data that is captured on the server side:

Also, you have the option to delete your Umbraco Engage cookie

<div align="left">

<figure><img src="../../.gitbook/assets/engage-cockpit-analytics-2.png" alt="Delete Umbraco Engage cookies."><figcaption><p>Delete Umbraco Engage cookies.</p></figcaption></figure>

</div>
![Delete Umbraco Engage cookies](../../.gitbook/assets/engage-cockpit-analytics-2.png)

### Segments

In the segments section, you can see which segments are configured and which are applied to the current visitor.

<div align="left">

<figure><img src="../../.gitbook/assets/engage-cockpit-personalization.png" alt="Segments"><figcaption><p>Segments</p></figcaption></figure>

</div>
![Segments](../../.gitbook/assets/engage-cockpit-personalization.png)
Original file line number Diff line number Diff line change
@@ -1,5 +1,4 @@
---
icon: square-exclamation
description: >-
Add extra Umbraco Engage functionality to your website using the templates
detailed in this section.
Expand Down
2 changes: 1 addition & 1 deletion 13/umbraco-engage/installation/licensing.md
Original file line number Diff line number Diff line change
Expand Up @@ -44,7 +44,7 @@ There are a few differences as to what the licenses cover:
* Each individual subdomain has to be specified as part of the license (e.g. `subdomain.mysite.com`), wildcard subdomains are not allowed.

{% hint style="info" %}
If you have multiple backoffice domains pointing at the same installation, you have the option to purchase and [add **additional domains**](the-licensing-model.md#add-additional-domains) to your license.
If multiple backoffice domains share the same installation, you have to purchase and add [**additional domains**](the-licensing-model.md#add-additional-domains) to your license.

This is an add-on domain for existing licenses. Refunds will not be given for this product.
{% endhint %}
Expand Down
Original file line number Diff line number Diff line change
@@ -1,5 +1,4 @@
---
icon: square-exclamation
description: >-
Umbraco Engage offers multiple ways for performaing A/B tests on your website.
Learn more about each option and how to configure them in this section.
Expand Down
Original file line number Diff line number Diff line change
@@ -1,5 +1,4 @@
---
icon: square-exclamation
description: >-
Umbraco Engage distributes visitors randomly across the different variants of
your A/B tests.
Expand Down
Original file line number Diff line number Diff line change
@@ -1,5 +1,4 @@
---
icon: square-exclamation
description: >-
When the A/B test has enough data for a statistically complete picture,
Umbraco Engage will notify you. You can also end the test at any time.
Expand Down
Original file line number Diff line number Diff line change
@@ -1,5 +1,4 @@
---
icon: square-exclamation
description: >-
Umbraco Engage takes care of applying the correct styles to the pages part of
your A/B tests.
Expand Down
Original file line number Diff line number Diff line change
@@ -1,5 +1,4 @@
---
icon: square-exclamation
description: >-
Umbraco Engage provides the ability to continuously monitor the A/B tests you
are running on your website. It is recommended to disable tests that perform
Expand Down
Original file line number Diff line number Diff line change
@@ -1,5 +1,4 @@
---
icon: square-exclamation
description: >-
When running A/B tests using Umbraco Engage it recommended to preview the test
before running it. Learn how this is done.
Expand Down
Original file line number Diff line number Diff line change
@@ -1,5 +1,4 @@
---
icon: square-exclamation
description: >-
To set up an A/B test in Umbraco Engage you need to go through a series of
steps. Learn more about the required configuration is required for initating a
Expand Down
Original file line number Diff line number Diff line change
@@ -1,5 +1,4 @@
---
icon: square-exclamation
description: >-
Get an overview of the available types of A/B tests you can run with Umbraco
Engage.
Expand Down
Original file line number Diff line number Diff line change
@@ -1,5 +1,4 @@
---
icon: square-exclamation
description: >-
Umbraco Engage enables running A/B tests on pages using a specified Document
Type. This article covers how and when to use this type of test.
Expand Down
Original file line number Diff line number Diff line change
@@ -1,5 +1,4 @@
---
icon: square-exclamation
description: >-
Umbraco Engage provides the option to run A/B tests across multiple pages.
This article covers how and when to use this type of test.
Expand Down
Original file line number Diff line number Diff line change
@@ -1,5 +1,4 @@
---
icon: square-exclamation
description: >-
Umbraco Engage provides the option to set up A/B testing on individual pages.
This article covers how and when to use this type of test.
Expand Down
Loading
Loading