Skip to content

uMS Getting Started section #6451

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 4 commits into from
Sep 24, 2024
Merged

uMS Getting Started section #6451

Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
4 commits
Select commit Hold shift + click to select a range
9cb0a71
Cockpit article!
sofietoft Sep 24, 2024
311e2be
System requirements
sofietoft Sep 24, 2024
8321120
loadbalancing
sofietoft Sep 24, 2024
f94e9fa
The rest of getting started
sofietoft Sep 24, 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
50 changes: 29 additions & 21 deletions 13/umbraco-ums/getting-started/for-developers/cockpit.md
View file
Open in desktop
Original file line number Diff line number Diff line change
@@ -1,53 +1,61 @@
---
description: The Cockpit is a tool to let you view data directly on the front end of the website.
---

# Cockpit

To enable the uMarketingSuite cockpit add the following partial just above the body end.
The cockpit gives you the option to check out all the stored data when browsing through the website. It is also a good way to verify your personalization setup.

To enable the uMS Cockpit add the following code above the `</body`> tag.

@Html.Partial("uMarketingSuite/Cockpit")</body>
```csharp
@Html.Partial("uMarketingSuite/Cockpit")
```

If you reload the page it will show you the uMarketingSuite Cockpit on the left or right side of the screen:
Once the code is added, reload the page to see the uMS Cockpit on the left or right side of the screen:

![]()

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

![]()

The cockpit gives you the option to check out all the data that is stored on the fly when browsing through the website. It's also a really easy way to verify your personalization setup.

## Access to the cockpit

When the uMarketingSuite cockpit partial has been added to the page you will see it when you are logged in to Umbraco (!). Visitors of your website won't see the cockpit. If you don't see the cockpit and Umbraco is running on a different domain please refer to the [loadbalancing / CM / CD environments](/installing-umarketingsuite/loadbalancing-and-cm-cd-environments/) section.
When the uMS Cockpit code has been added to the page you can see it when you are logged in to Umbraco. Visitors of your website will not see the Cockpit.

If you do not see the Cockpit and Umbraco is running on a different domain please refer to the [load balancing / CM / CD environments](/installing-umarketingsuite/loadbalancing-and-cm-cd-environments/) section.

### Data reporting client side

If you've setup the [additional Analytics-script](/analytics/clientside-events-and-additional-javascript-files/additional-measurements-with-our-ums-analytics-scripts/) of the uMarketingSuite you'll find all tracked data in the cockpit.
If you have setup the [additional Analytics-script](/analytics/clientside-events-and-additional-javascript-files/additional-measurements-with-our-ums-analytics-scripts/) of the uMS you can find all tracked data in the Cockpit.

We will track:
The following is tracked:

- The time on page. This is defined betweened the time the page was loaded and the current time. So if you visit the website at 11:23:12 and it's now 11:25:30 you're time on page is 2 minutes and 18 seconds.
- The engaged time on page. This is a far more important metric because it measures the time you were active on the page. When you scroll, move your mouse, type or select text on the website you're considered "engaged". As soon as you stop one of these actions and have no other interaction in the next five seconds this engaged timer will be stopped. This could happen when you're browsing in another window or tab of your browser or system, when you went to grab a cup of coffee, or when you're talking to a colleague. The time on page is still counting, but you're not engaged at that moment.
- The script tracks the maximum scrolldepth that you have reached. Both in absolute pixels and as a percentage
- We keep track off all [fired events](/analytics/clientside-events-and-additional-javascript-files/create-your-own-events/) within the uMarketingSuite
- And finally we measure every outclick to another domain, a pdf-file or excel-file by default
- The time on page. This is defined betweened the time the page was loaded and the current time. If you visit the website at 11:23:12 and it is now 11:25:30, your time on page is 2 minutes and 18 seconds.
- The engaged time on page. This measures the time you were active on the page. When you scroll, move your mouse, type or select text on the website you are considered "engaged". As soon as you stop one of these actions and have no other interaction in the next five seconds this engaged timer will be stopped. This could happen when you are browsing in another window or tab of your browser or system or when you left your computer. The time on page is still counting, but you are not engaged at that moment.
- The script tracks the maximum scrolldepth that you have reached. This counts in absolute pixels and as a percentage.
- All [fired events](/analytics/clientside-events-and-additional-javascript-files/create-your-own-events/) are tracked.
- Every outclick to other domains, a pdf-file or excel-file is measured by default.

![]()

### Data reporting server side

In this section you'll see all the data that is capture server side:
In this section you can see all the data that is captured on the server side:

- The browser,
- the type of device,
- the IP address (anonymized or not; depending on your [settings](/installing-umarketingsuite/configuration-options-1-x/))
- The total number of pages you've visited in this session
- The total number of sessions you've had with this cookie
- The type of device,
- The IP address (anonymized or not; depending on your [settings](/installing-umarketingsuite/configuration-options-1-x/))
- The total number of pages visited in this session
- The total number of sessions with this cookie

Also you have the option to easily delete your uMarketingSuite cookie
Also you have the option to delete your uMS cookie

![]()

### Segments

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

![]()
24 changes: 12 additions & 12 deletions 13/umbraco-ums/getting-started/for-developers/configuration-options-1-x.md
View file
Open in desktop
Original file line number Diff line number Diff line change
@@ -1,12 +1,12 @@
# Configuration options 1.x

There are quite some configuration options within the uMarketingSuite. Most of these settings are stored in the configuration file of the uMarketingSuite. For uMarketingSuite 1.x, this configuration file can be found in /config/uMarketingSuite/umarketingsuite.config. For uMarketingSuite 2.x we have adopted the new standard for .NET Core applications, in which we make use of the appsettings.json (and environment variable support). See [Configuration options 2.x](../../../../installing-umarketingsuite/configuration-options-2-x/) if you are using uMarketingSuite version 2.
Most of the uMS configuration options are stored in the configuration file. For uMarketingSuite 1.x, the configuration file can be found in `/config/uMarketingSuite/umarketingsuite.config`. For uMS 2.x we have adopted the new standard for .NET Core applications, in which we make use of the `appsettings.json` (and environment variable support). See [Configuration options 2.x](../../../../installing-umarketingsuite/configuration-options-2-x/) if you are using uMS version 2.

If you open this file with your favourite texteditor you've all kinds of options that you can set. If you afterwards save the file you should touch the web.config (which restarts your website!) in order to make sure these new settings are used.
If you open the configuration file with your prefered texteditor, you can see all the options you can configure. If you make changes to the file you should touch the `web.config` in order to make sure these new settings are used. Making changes to the `web.config` file will restart the website.

The configuration file will look like this:

```
```xml
<Configuration>
<Settings>
<DatabaseConnectionStringName>umbracoDbDSN</DatabaseConnectionStringName>
Expand Down Expand Up @@ -73,22 +73,22 @@ The configuration file will look like this:
</Configuration>
```

All these settings are also visualized in the uMarketingSuite. This overview can be found in the section 'Marketing' -> Settings -> Configuration
All the configuration options are also visualized in the uMS. This overview can be found in the section 'Marketing' -> Settings -> Configuration.

![]()

You cannot change any of the settings over here which is by design. To use the new settings the website must be restarted (by touching the web.config) and that is not something that we wanted to make possible via the Umbraco backoffice.

### All settings
{% hint style="warning" %}
You cannot change any of the settings in the backoffice. To use the new settings the website must be restarted and that is not something that we wanted to make possible via the Umbraco backoffice.
{% endhint %}

#### Section 'Settings'
## Settings

| **Key** | **Label** | **Type / possible options** | **Default value** | **Helptext** | **Additional information** |
| ---------------------------- | ------------------------- | --------------------------- | ----------------- | ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------ | ----------------------------------------------------------------------------------------------------------------------------------------------------------- |
| DatabaseConnectionStringName | Database connectionstring | Text | umbracoDbDSN | In this database the data of the uMarketingSuite will be stored. By default this is the same database as Umbraco is stored, but this could be set to another database instance | |
| Enabled | Enabled | True / False | True | If you want to disable the uMarketingSuite you can set this setting to False. Possible options: true and false. | The killswitch of the uMarketingSuite. By setting this property to 'False' the uMarketingSuite will not do anything with regards to storing and processing. |

#### Section 'Analytics'
## Analytics

| **Key** | **Label** | **Type / possible options** | **Default value** | **Helptext** | **Additional information** |
| ------------------------- | -------------------------------------- | --------------------------- | --------------------------------- | -------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------ |
Expand All @@ -111,7 +111,7 @@ You cannot change any of the settings over here which is by design. To use the n
| DeleteDataAfterDays | Delete data after (in days) | <p>Integer<br>> 0</p> | 1460 | After this number of days the data will be deleted from the database | |
| IsProcessingServer | Is a processing server? | True / False | True | Indicates whether this server is the processing server. For performance optimization the processing of the data could be outsourced to another server. Processing is done on the raw data. Possible options: true and false. | _Note: If you are using_ [_Umbraco in a load balanced configuration_](https://docs.umbraco.com/umbraco-cms/fundamentals/setup/server-setup/load-balancing#how-umbraco-load-balancing-works)_, then ensure the front end servers have the configuration setting for **IsProcessingServer** set to false and that the back end (Umbraco backoffice) server should only have this setting enabled._ |

#### Section 'A/B Testing'
## A/B Testing

| Key | Label | Type / possible options | Default value | Help text | Additional information |
| -------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | -------------------------------------------------------------------------- | ----------------------- | ------------- | ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | ---------------------- |
Expand All @@ -122,7 +122,7 @@ You cannot change any of the settings over here which is by design. To use the n
| <p><br><br></p> | | | | | |
| <p>None: No data is shared<br>Minimum: The number of tests and the number of variants is shared<br>Medium: The number of tests, the number of variants, and screenshots of the variants are shared to inspirate other people in the community.</p> | This option is not in use at this moment! | | | | |

#### Section 'Profiles'
## Profiles

| Key | Label | Type / possible options | Default value | Help text | Additional information |
| ------------------------------------------ | ----- | ----------------------- | -------------- | ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------ | ---------------------- |
Expand All @@ -133,7 +133,7 @@ You cannot change any of the settings over here which is by design. To use the n
| Identification/Abbreviation | | Text | \{{name\[0]\}} | Template for the abbreviation of a member in the profile section. This is an AngularJS template expression that can use custom member properties. | |
| Identification/ImagePropertyAlias | | Text | avatar | The property alias of the member property containing an avatar image of the member. | |

#### Section 'Reporting'
## Reporting

| **Key** | **Label** | **Type / possible options** | **Default value** | **Helptext** | **Additional information** |
| --------------------- | ----------------------- | --------------------------- | ----------------- | --------------------------------------------------------------------------------------------------------------- | -------------------------- |
Expand Down
Loading