You signed in with another tab or window. Reload to refresh your session.You signed out in another tab or window. Reload to refresh your session.You switched accounts on another tab or window. Reload to refresh your session.Dismiss alert
Copy file name to clipboardExpand all lines: 13/umbraco-ums/installation/installation.md
+13-11Lines changed: 13 additions & 11 deletions
Display the source diff
Display the rich diff
Original file line number
Diff line number
Diff line change
@@ -1,21 +1,23 @@
1
1
---
2
-
description: Learn about the different ways available for installing Umbraco uMS on your project.
2
+
description: >-
3
+
Learn about the different ways available for installing Umbraco uMS on your
4
+
project.
3
5
---
4
6
5
7
# Installation
6
8
7
-
This article covers two ways for installing Umbraco uMS:
9
+
This article covers two ways to install Umbraco uMS:
8
10
9
-
*[Via NuGet](#installation-via-nuget), or
10
-
*[Via a terminal](#installing-using-the-terminal).
11
+
*[Via NuGet](installation.md#installation-via-nuget), or
12
+
*[Via a terminal](installation.md#installing-using-the-terminal).
11
13
12
14
{% hint style="info" %}
13
15
Check [the requirements](../getting-started/for-developers/system-requirements.md) before you start installing Umbraco uMS.
14
16
{% endhint %}
15
17
16
18
## Installation via NuGet
17
19
18
-
Install Umbraco uMS via Nuget in your IDE such as Visual Studio, Jetbrains Rider or VSCode (With [C# DevKit](https://marketplace.visualstudio.com/items?itemName=ms-dotnettools.csdevkit)).
20
+
Install Umbraco uMS via Nuget in your IDE such as Visual Studio, JetBrains Rider, or VSCode (With [C# DevKit](https://marketplace.visualstudio.com/items?itemName=ms-dotnettools.csdevkit)).
19
21
20
22
The example shown below uses the Nuget Package Manager in Visual Studio.
21
23
@@ -62,11 +64,11 @@ If you have any trouble, please go to [Troubleshooting installs](../../../instal
62
64
63
65
![]()
64
66
65
-
When you have installed the Umbraco uMS, build or restart your website and the **Marketing** section will appear in the backoffice, as shown above.
67
+
When you have installed the Umbraco uMS, build or restart your website, and the **Marketing** section will appear in the backoffice, as shown above.
66
68
67
-
The next step is to [configure a license](../../../installing-umarketingsuite/licensing/) and you are ready to go.
69
+
The next step is to [configure a license](../../../installing-umarketingsuite/licensing/).
68
70
69
-
To get the best out of Umbraco uMS it is recommended to consider the information detailed in the sections below.
71
+
It is recommended to consider the information detailed in the section below, to get the best out of Umbraco uMS.
70
72
71
73
### Umbraco Forms
72
74
@@ -120,12 +122,12 @@ Here are some optional extras you can do to improve your experience with uMS.
120
122
121
123
### Cookie consent
122
124
123
-
If you would like to influence the default [uMS cookie](../../../the-umarketingsuite-broad-overview/the-umarketingsuite-cookie/) behaviour please go [here](../../../security-privacy/gdpr/). Or go to an example [implementation using Cookiebot](../../../security-privacy/gdpr/how-to-become-gdpr-compliant-using-cookiebot/) which can be used as an example for other cookie consent providers.\
125
+
If you need to influence the default [uMS cookie](../../../the-umarketingsuite-broad-overview/the-umarketingsuite-cookie/) behaviour please go [here](../../../security-privacy/gdpr/). Or go to an example [implementation using Cookiebot](../../../security-privacy/gdpr/how-to-become-gdpr-compliant-using-cookiebot/) which can be used as an example for other cookie consent providers.\\
124
126
125
127
{% hint style="warning" %}
126
128
If you [change the default cookie behaviour](../../../the-umarketingsuite-broad-overview/the-umarketingsuite-cookie/module-permissions/) make sure to perform a **client side reload of the initial page after cookie consent**. If this is not done, visitor referrer and/or campaigns will not be tracked.
127
129
{% endhint %}
128
130
129
-
### Loadbalancing and CM / CD environments
131
+
### Load balancing and CM / CD environments
130
132
131
-
Using a loadbalanced setup and/or separate CM and CD environments? Please check our documentation about this topic [here](/installing-umarketingsuite/loadbalancing-and-cm-cd-environment).
133
+
Are you using a load-balanced setup or separate CM and CD environments? Please check our documentation about this topic [here](../../../installing-umarketingsuite/loadbalancing-and-cm-cd-environment/).
description: Use the checklist in this article to verify your uMS installation.
3
+
---
2
4
3
-
At the moment we are not aware of any problems when installing the uMarketingSuite.
5
+
# Troubleshooting Installs
4
6
5
-
If you have one please let us know by [submitting an issue on GitHub](https://github.com/uMarketingSolutions/uMarketingSuite/issues/new/choose) or by getting in touch with us.
7
+
{% hint style="info" %}
8
+
If you have one please let us know by [submitting an issue on GitHub](https://github.com/uMarketingSolutions/uMarketingSuite/issues/new/choose) or using our support channels.
6
9
7
10
[Please check out our known-issue section for possible issues after installing.](../../../support/known-issues-and-work-arounds/)
11
+
{% endhint %}
8
12
9
13
## The uMS Checklist
10
14
11
-
If you are having problems or unsure you have uMS setup and configured, then this checklist is for you. Verify you installed the Nuget package **uMarketingSuite** into your Umbraco website
15
+
If you have problems with the uMS setup or configuration, this checklist is for you. Verify you installed the Nuget package **uMarketingSuite** into your Umbraco website
12
16
13
17
### 1. The Marketing section
14
18
15
-
After logging in into Umbraco you are able to see the Marketing section along with the other main sections in the Umbraco backoffice.
19
+
After logging in to Umbraco you can see the Marketing section next to the other main sections in the Umbraco backoffice.
16
20
17
-
If you cannot see this, please check if your Umbraco user and or user group has access to the Marketing section.
21
+
If you cannot see this, please check if your Umbraco user or user group has access to the Marketing section.
18
22
19
23
![]()
20
24
@@ -24,71 +28,70 @@ When editing a page within Umbraco you should be able to see the following Conte
24
28
25
29
![]()
26
30
27
-
If you cannot see this, please check if your Umbraco user and or user group has access to the Marketing section.
31
+
If you cannot see this, please check if your Umbraco user or user group has access to the Marketing section.
28
32
29
33
### 3. Cockpit
30
34
31
-
Is the **uMS Cockpit tool** visible on frontend of your site **after logging into Umbraco**?
35
+
Is the **uMS Cockpit tool** visible on the front end of your site **after logging into Umbraco**?
32
36
33
37
No? Ensure you added the [Cockpit Partial view](../../../installing-umarketingsuite/cockpit/) in your main template.
34
38
35
39
![]()
36
40
37
41
### 4. Cockpit Client Side Data
38
42
39
-
Can you see client-side data such as **scroll depth** & **total time** on pages in analytics or the cockpit?
43
+
Can you see client-side data such as **scroll depth** & **total time** on pages in analytics or the cockpit?
40
44
41
-
No? Ensure you have [added the client side tracking script](../../../analytics/clientside-events-and-additional-javascript-files/additional-measurements-with-our-ums-analytics-scripts/) in your main template.
42
-
![]()
45
+
No? Ensure you have [added the client-side tracking script](../../../analytics/clientside-events-and-additional-javascript-files/additional-measurements-with-our-ums-analytics-scripts/) in your main template. ![]()
43
46
44
47
### 5. Umbraco Forms
45
48
46
-
Go to a Form and add a new question to a form. Do you see this option?
49
+
Go to a form and add a new question. Do you see this option?
47
50
48
51
![]()
49
52
50
53
Go to Marketing -> Settings -> Create a new goal. Do you see the following option called **Umbraco Forms Submission**?
51
54
52
55
![]()
53
56
54
-
If you see both options, this has been configured correctly. If not, ensure that your development team have installed the additional [uMarketingSuite.UmbracoForms nuget package](https://www.nuget.org/packages/uMarketingSuite.UmbracoForms).
57
+
If you see both options, this has been configured correctly. If not, ensure that your development team has installed the additional [uMarketingSuite.UmbracoForms NuGet package](https://www.nuget.org/packages/uMarketingSuite.UmbracoForms).
55
58
56
59
### 6. Analytics
57
60
58
-
Edit a page and go to the Content App marked **Analytics** or alternatively go to **Marketing** -> **Analytics** from the top navigation.
61
+
Edit a page and go to the Content App marked **Analytics** or **Marketing** -> **Analytics** from the top navigation.
59
62
60
-
Are you able to see analytical data? If not then you **need to wait 24 hours for todays analytics** to be collected and reported.
63
+
Are you able to see analytical data? If not then you **need to wait 24 hours for today's analytics** to be collected and reported.
61
64
62
65
### 7. Locations for Analytics
63
66
64
67
Do you see the following message when browsing Analytics for Locations?
65
68
66
69
![]()
67
70
68
-
This means that some configuration is needed by your development team. They need to do a bit of[work to set up and track visitor locations by country and city](../../../analytics/extending-analytics/implement-an-ip-to-location-provider/).
71
+
This means that additional configuration is required. Get in touch with a developer, as they need to[work to set up and track visitor locations by country and city](../../../analytics/extending-analytics/implement-an-ip-to-location-provider/).
69
72
70
73
Once set up, you will see analytics for countries like this below:
71
74
72
75
![]()
73
76
74
77
### 8. Setup IP Filters
75
78
76
-
Confirm that your own IP of your company/office building has been set to be excluded from uMS. This is done to ensure it is excluded from tracking and reporting, along with anyone else who is a content editor of the website.
79
+
Confirm that the IP of your company/office building has been set to be excluded from uMS. This is done to ensure it is excluded from tracking and reporting, along with anyone else who is a content editor of the website.
77
80
78
-
You can check what your IP is by [Googling for What is My IP](https://www.google.com/search?q=what+is+my+IP). Ensure it is in the list of IPs by navigating to **Marketing** -> **Settings** -> **IP Filters**.
81
+
You can check your IP by [Googling for What is My IP](https://www.google.com/search?q=what+is+my+IP). Ensure it is in the list of IPs by navigating to **Marketing** -> **Settings** -> **IP Filters**.
79
82
80
83
![]()
81
84
82
85
### 9. Reload after Cookie consent
83
86
84
-
To ensure that uMS can interact with the visitor from the first page on, reloaded the page as soon as the Cookie consent is approved. This enables showing personalized variant on the landing page which you need to have consent for doing. More info on how to this can be found at the bottom of the [tracking a visitors initial pageview](../../../security-privacy/gdpr/how-to-become-gdpr-compliant-using-cookiebot/) article.
87
+
To ensure that uMS can interact with the visitor from the first page, reload the page as soon as the Cookie consent is approved. This enables showing personalized variants on the landing page which requires consent. More info on how to do this can be found at the bottom of the [tracking a visitors initial pageview](../../../security-privacy/gdpr/how-to-become-gdpr-compliant-using-cookiebot/) article.
85
88
86
89
### Still missing analytical data?
87
90
88
-
If you have performed all the steps and do not see Analytics data within uMS there are a handful of additional steps to take. Please work with a developer to check the following steps, as they are more technical.
91
+
If you have performed all the steps and do not see Analytics data within uMS there are a handful of additional steps to take. Please work with a developer to check the following technical steps.
89
92
90
93
* Open your website in a browser with the browser developer tools open.
91
-
* Refresh the page with the developer tools open.
94
+
* Refresh the page while the developer tools are open.
92
95
* Look for a POST request being made to `umbraco/umarketingsuite/pagedata/ping` in the Network Tab of requests.
0 commit comments