From 9cb0a7102ab2cba2404307dd0a2196b5e5fabd1d Mon Sep 17 00:00:00 2001 From: sofietoft Date: Tue, 24 Sep 2024 09:53:31 +0200 Subject: [PATCH 1/4] Cockpit article! --- .../for-marketers-and-editors/cockpit.md | 50 +++++++++++-------- 1 file changed, 29 insertions(+), 21 deletions(-) diff --git a/13/umbraco-ums/getting-started/for-marketers-and-editors/cockpit.md b/13/umbraco-ums/getting-started/for-marketers-and-editors/cockpit.md index f5419a40e03..febc2f89930 100644 --- a/13/umbraco-ums/getting-started/for-marketers-and-editors/cockpit.md +++ b/13/umbraco-ums/getting-started/for-marketers-and-editors/cockpit.md @@ -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 ` tag. - @Html.Partial("uMarketingSuite/Cockpit") +```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. ![]() \ No newline at end of file From 311e2be8259e797ed7043b6060d0e48e4c960c54 Mon Sep 17 00:00:00 2001 From: sofietoft Date: Tue, 24 Sep 2024 10:20:38 +0200 Subject: [PATCH 2/4] System requirements --- .../for-developers/system-requirements.md | 25 +++++++++++++------ 1 file changed, 17 insertions(+), 8 deletions(-) diff --git a/13/umbraco-ums/getting-started/for-developers/system-requirements.md b/13/umbraco-ums/getting-started/for-developers/system-requirements.md index d52f146097a..bc170da39f9 100644 --- a/13/umbraco-ums/getting-started/for-developers/system-requirements.md +++ b/13/umbraco-ums/getting-started/for-developers/system-requirements.md @@ -1,14 +1,23 @@ +--- +description: Learn about the system requirements before installing uMS. +--- + # System Requirements -The uMarketingSuite has the following requirements: +The uMS has the following requirements: + +* Umbraco version 8.7+, 9, 10, 11, 12 and 13. +* SQL Server 2014+, LocalDB or Azure SQL. + * **SQL CE & SQLite is not supported.** + +{% hint style="info" %} +It is recommended to upgrade your Umbraco installation to the latest version. +{% endhint %} -* Umbraco version 8.7+, 9, 10, 11, 12 and 13.\ - It is recommended to upgrade your Umbraco installation to the latest version. -* SQL Server 2014+, LocalDB or Azure SQL.\ - **SQL CE & SQLite is not supported.** +See the [Troubleshooting](../../../../installing-umarketingsuite/troubleshooting-installs/)-section if you need to upgrade from SQL CE to SQL Server. -See our [Troubleshooting](../../../../installing-umarketingsuite/troubleshooting-installs/)-section if you need to upgrade from SQL CE to SQL Server +The uMS is compatible with Umbraco Cloud. -The uMarketingSuite is Umbraco Cloud compatible.![]() +![]() -Umbraco Deploy is currently not supported for the uMarketingSuite features. +Umbraco Deploy is currently not supported for the uMS features. From 83211206e31473436fd63d0f357eb52386090bdc Mon Sep 17 00:00:00 2001 From: sofietoft Date: Tue, 24 Sep 2024 13:33:16 +0200 Subject: [PATCH 3/4] loadbalancing --- .../for-developers/infrastructure-sizing.md | 23 +++++---- .../loadbalancing-and-cm-cd-environments.md | 50 ++++++++++++------- 2 files changed, 44 insertions(+), 29 deletions(-) diff --git a/13/umbraco-ums/getting-started/for-developers/infrastructure-sizing.md b/13/umbraco-ums/getting-started/for-developers/infrastructure-sizing.md index f69cef84dc6..475c56ebb5a 100644 --- a/13/umbraco-ums/getting-started/for-developers/infrastructure-sizing.md +++ b/13/umbraco-ums/getting-started/for-developers/infrastructure-sizing.md @@ -1,27 +1,30 @@ -# **Infrastructure sizing** +# Infrastructure sizing -To determine the optimal infrastructure sizing the most important metric is the number of page views you will need to process. Also peak load is an important factor. +To determine the optimal infrastructure sizing the most important metric is the number of page views you need to process. Peak load is also an important factor. -uMarketingSuite recommends the following (database) infrastructure sizes when using the following environments. +The following presents recommendations based on environment as well as the number of expected page views. -**Non-cloud** +## Non-cloud - **100.000 page views per month or less:** Database: CPU 2, 4-8 GB RAM, 50GB disk - **500.000 page views per month or less:** Database: CPU 4, 8-16 GB RAM, 100GB SSD disk - **1.000.000 page views per month or less:** Database: CPU 8, 16-32 GB RAM, 250GB SSD disk - **1.000.000 page views per month or more:** Please [contact our Expert Services](mailto:info@umarketingsuite.com) team to discuss the infrastructure requirements. -**Cloud environments (Microsoft Azure, Amazon AWS)** +## Cloud environments -Because of the rapidly changing naming and sizing of Azure and AWS instances we recommend to use the appropriate supplier tools to determine the exact sizing based on the above non-cloud recommendations. -In general for Azure SQL use at least a S3 instance for production purposes. +Due to the rapidly changing naming and sizing of Azure instances we recommend using the appropriate supplier tools to determine the exact sizing. Base the exact sizing on the non-cloud recommendations above. -**Umbraco Cloud** +In general, for Azure SQL use at least a S3 instance for production purposes. + +## Umbraco Cloud - **100.000 page views per month or less:** Standard / Professional - **500.000 page views per month or less:** Professional - **500.000 page views per month or more:** Professional / Enterprise -Always discuss the exact requirements with your agency and/or the Umbraco Cloud team and if needed discuss Prioritized Cloud Computing, Prioritized Database Performance and/or Dedicated Resources based on the expected load. +Always discuss the exact requirements with your agency or the Umbraco Cloud team. If needed discuss Prioritized Cloud Computing, Prioritized Database Performance and Dedicated Resources based on the expected load. -*Note: above you will find general recommendations which infrastructure parameters to use. While these should work well for most cases, you may need to adjust the infrastructure parameters to suit your page view processing workload. Very large or heavily trafficked websites may have significantly higher requirements. If you expect high page view peaks it is recommended to scale to a tier higher then normally.* \ No newline at end of file +{% hint style="info" %} +Above you will find general recommendations on which infrastructure parameters to use. While these should work well for most cases, you may need to adjust the infrastructure parameters to suit your page view processing workload. Large or heavily trafficked websites may have higher requirements. If you expect high page view peaks it is recommended to scale to a tier higher then normally. +{% endhint %} diff --git a/13/umbraco-ums/getting-started/for-developers/loadbalancing-and-cm-cd-environments.md b/13/umbraco-ums/getting-started/for-developers/loadbalancing-and-cm-cd-environments.md index e88c7c11afc..7bf0589a731 100644 --- a/13/umbraco-ums/getting-started/for-developers/loadbalancing-and-cm-cd-environments.md +++ b/13/umbraco-ums/getting-started/for-developers/loadbalancing-and-cm-cd-environments.md @@ -1,38 +1,50 @@ +--- +description: Recommendations for using uMS within a load-balanced setup. +--- + # Load balancing and CM/CD Environments -## **Umbraco setup** +## Umbraco setup + +Make sure your Umbraco is setup according to best-practices. Please refer to the [Umbraco documentation](https://docs.umbraco.com/umbraco-cms/fundamentals/setup/server-setup/load-balancing) for more details. + +## Cockpit + +For the Cockpit to function properly it is necessary that the cockpit can read the Umbraco login cookie. Umbraco and the site should run on the same domain or sub-domain. -Make sure your Umbraco is setup according to the Umbraco best-practices. Please refer to the [Umbraco documentation](https://docs.umbraco.com/umbraco-cms/fundamentals/setup/server-setup/load-balancing). +For example: -## **Cockpit** +**Umbraco:** `umbraco.domain.com` +**Site:** `domain.com` -**Configuring the AuthCookieDomain cookie**For the cockpit to function properly it is necessary that the cockpit can read the Umbraco login cookie or else the cockpit won't be visible. **Umbraco and the site should run on the same domain / sub-domain**. For example: +Make sure the AuthCookieDomain in your SecuritySettings of your Umbraco config has the following value: -**Umbraco:** umbraco.domain.com -**Site:** domain.com +```json +"AuthCookieDomain": ".domain.com", +``` -Make sure the AuthCookieDomain in your SecuritySettings of your Umbraco config is set to +To learn more, read the documentation about the [SecuritySettings](https://docs.umbraco.com/umbraco-cms/reference/configuration/securitysettings) - "AuthCookieDomain": ".domain.com", +## Machine key and Data Protection -Also see: [https://docs.umbraco.com/umbraco-cms/reference/configuration/securitysettings](https://docs.umbraco.com/umbraco-cms/reference/configuration/securitysettings) +You need to configure machine keys and data protection to **use the same keys on all servers** (content delivery and content-management). -**Machine key / Data Protection** +Without this setup, each server will generate its own key. This will results in the Umbraco authentication cookie being encrypted and decrypted using different keys leaving the Cockpit unusable on the frontend servers. -You need to configure machine keys / data protection to **use the same keys on all servers** (content delivery and content-management). Without this setup, each server will generate its own key, resulting in that the Umbraco authentication cookie is encrypted and decrypted using different keys and the uMarketingSuite cockpit will not be shown on the front-end servers. +To learn more, read the [Load Balancing article](https://docs.umbraco.com/umbraco-cms/fundamentals/setup/server-setup/load-balancing) in the Umbraco CMS documentation. -Also see the Data Protection section at: [https://docs.umbraco.com/umbraco-cms/fundamentals/setup/server-setup/load-balancing](https://docs.umbraco.com/umbraco-cms/fundamentals/setup/server-setup/load-balancing) +## Bot detection (ping) -## **Bot detection (ping)** +uMS will perform a ping (POST) to detect if the [visitor is a visitor or a bot](/analytics/types-of-clients/). The `umbraco/umarketingsuite/pagedata/ping` URL should be accessible from the content delivery and front-end servers. Make sure no firewall or other mechanism is blocking POST requests to `umbraco/umarketingsuite/pagedata/ping`. If this URL is blocked, all visitors will be treated like a bot and no analytics data is collected. -uMarketingSuite will perform a ping (POST) to detect if the [visitor is a visitor or a bot](/analytics/types-of-clients/). The url umbraco/umarketingsuite/pagedata/ping should be accessible from the content delivery / front-end servers so make sure no firewall or other mechanism is blocking POST requests to **umbraco/umarketingsuite/pagedata/ping** or else all visitors will be treated like a bot and no analytics data is collected. +## Configuration -## **Configuration** +Make sure the `IsProcessingServer` is set to `true` on the content management (Umbraco) environment and to `false` on the content delivery or front-end servers. -Make sure the **IsProcessingServer** is set to **True** on the content management (Umbraco) server/environment and to **False** on the content delivery / front-end servers in your **uMarketingSuite.config** ([uMarktingSuite v1.x](/installing-umarketingsuite/configuration-options-1-x/)) or **AppSettings.json** ([uMarketingSuite v2.x](/installing-umarketingsuite/configuration-options-2-x/)) file. +The setting can be found in your `uMarketingSuite.config` ([uMarktingSuite v1.x](/installing-umarketingsuite/configuration-options-1-x/)) or `AppSettings.json` ([uMarketingSuite v2.x](/installing-umarketingsuite/configuration-options-2-x/)) file. -## **Sticky sessions** +## Sticky sessions -Sticky sessions, also known as session affinity, are essential for the proper functioning of uMarketingSuite in a load-balanced environment. Sticky sessions can be enabled using various methods such as cookie-based, IP-based, or URL-based session affinity, depending on the load balancer configuration. By enabling sticky sessions, you can ensure that user sessions remain intact and data consistency is maintained across the uMarketingSuite application so analytics, a/b testing and personalization can work properly. +Sticky sessions, also known as session affinity, are essential for the proper functioning of uMS in a load-balanced environment. Sticky sessions can be enabled using different methods such as cookie-based, IP-based, or URL-based session affinity, depending on the load balancer configuration. By enabling sticky sessions, you can ensure that user sessions remain intact and data consistency is maintained across the uMarketingSuite application. Sticky sessions will ensure that analytics, A/B testing and personalization works properly. -Please refer to the documentation or configuration settings of your load balancer for specific instructions on enabling sticky sessions. \ No newline at end of file +Please refer to the documentation or configuration settings of your load balancer for specific instructions on enabling sticky sessions. From f94e9fa574e168f6b5c2a75216acfb72904ac7c1 Mon Sep 17 00:00:00 2001 From: sofietoft Date: Tue, 24 Sep 2024 13:53:56 +0200 Subject: [PATCH 4/4] The rest of getting started --- .../getting-started/for-developers/cockpit.md | 50 +++++++++++-------- .../configuration-options-1-x.md | 24 ++++----- .../configuration-options-2-x.md | 12 +++-- ...ontent-delivery-network-recommendations.md | 18 ++++--- .../for-developers/infrastructure-sizing.md | 4 ++ 5 files changed, 63 insertions(+), 45 deletions(-) diff --git a/13/umbraco-ums/getting-started/for-developers/cockpit.md b/13/umbraco-ums/getting-started/for-developers/cockpit.md index f5419a40e03..febc2f89930 100644 --- a/13/umbraco-ums/getting-started/for-developers/cockpit.md +++ b/13/umbraco-ums/getting-started/for-developers/cockpit.md @@ -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 ` tag. - @Html.Partial("uMarketingSuite/Cockpit") +```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. ![]() \ No newline at end of file diff --git a/13/umbraco-ums/getting-started/for-developers/configuration-options-1-x.md b/13/umbraco-ums/getting-started/for-developers/configuration-options-1-x.md index 2c9f5ca298b..281e6c75175 100644 --- a/13/umbraco-ums/getting-started/for-developers/configuration-options-1-x.md +++ b/13/umbraco-ums/getting-started/for-developers/configuration-options-1-x.md @@ -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 umbracoDbDSN @@ -73,22 +73,22 @@ The configuration file will look like this: ``` -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** | | ------------------------- | -------------------------------------- | --------------------------- | --------------------------------- | -------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------ | @@ -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) |

Integer
> 0

| 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 | | -------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | -------------------------------------------------------------------------- | ----------------------- | ------------- | ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | ---------------------- | @@ -122,7 +122,7 @@ You cannot change any of the settings over here which is by design. To use the n |



| | | | | | |

None: No data is shared
Minimum: The number of tests and the number of variants is shared
Medium: The number of tests, the number of variants, and screenshots of the variants are shared to inspirate other people in the community.

| This option is not in use at this moment! | | | | | -#### Section 'Profiles' +## Profiles | Key | Label | Type / possible options | Default value | Help text | Additional information | | ------------------------------------------ | ----- | ----------------------- | -------------- | ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------ | ---------------------- | @@ -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** | | --------------------- | ----------------------- | --------------------------- | ----------------- | --------------------------------------------------------------------------------------------------------------- | -------------------------- | diff --git a/13/umbraco-ums/getting-started/for-developers/configuration-options-2-x.md b/13/umbraco-ums/getting-started/for-developers/configuration-options-2-x.md index a8a663302fc..f8067f5cde6 100644 --- a/13/umbraco-ums/getting-started/for-developers/configuration-options-2-x.md +++ b/13/umbraco-ums/getting-started/for-developers/configuration-options-2-x.md @@ -1,12 +1,12 @@ # Configuration options 2.x -There are quite some configuration options within the uMarketingSuite. 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). This means we no longer use the umarketingsuite.config like in version 1.x of uMarketingSuite. Because of this new standard most of these configuration options are hot reloaded, no longer requiring the application to restart in order for them to take effect _(with some exceptions)_. +Most of the uMS configuration options are stored in the configuration file. 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). Because of this new standard most of the configuration options no longer require the application to restart in order for them to take effect. This comes with a few with some exceptions. -uMarketingSuite 2.x also ships with an **appsettings-schema.json** file, allowing editing environments like Visual Studio or Jetbrains Rider to auto-complete the various configuration options together with their default values and a description of what each configuration option does. +uMS 2.x ships with an **appsettings-schema.json** file, allowing Visual Studio or Jetbrains Rider to auto-complete the configuration options. It allows comes with information about default values and a description of what each configuration option does. The default configuration will look like this: -``` +```json { "uMarketingSuite": { "Settings": { @@ -79,8 +79,10 @@ The default configuration will look like this: } ``` -All these settings are also visualized in the uMarketingSuite. This overview can be found in the section 'Marketing' -> Settings -> Configuration +All these settings 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. +{% 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 %} diff --git a/13/umbraco-ums/getting-started/for-developers/content-delivery-network-recommendations.md b/13/umbraco-ums/getting-started/for-developers/content-delivery-network-recommendations.md index 6591eb6a9f1..c58f7fd9633 100644 --- a/13/umbraco-ums/getting-started/for-developers/content-delivery-network-recommendations.md +++ b/13/umbraco-ums/getting-started/for-developers/content-delivery-network-recommendations.md @@ -1,15 +1,19 @@ +--- +description: Learn more about recommendations when working with the Content Delivery Network. +--- + # Content Delivert Network Recommendations -In this section you will find information and best-practices how to use a content delivery network (CDN) in combination with uMarketingSuite in your Umbraco installation. +In this section you will find information and best-practices how to use a Content Delivery Network (CDN) in combination with uMarketingSuite. -### Pages (html) +## Pages (HTML) -You should not cache pages on CDN level. uMarketingSuite is based on serving a unique page to every (returning) visitor. By enabling page caching every visitor will be assigned the same uMarketingSuite ID and Analytics, A/B testing and Personalisation will not work correctly. +You should not cache pages on CDN level. uMS is based on serving a unique page to every (returning) visitor. By enabling page caching every visitor will be assigned the same uMS ID and Analytics, A/B testing and Personalisation will not work correctly. -### Cache static files (CSS and javascript) +### Cache static files (CSS and JavaScript) -It is possible to cache static CSS and javascript files. Please refer to the documentation of the CDN provider for the best-practice setup. +It is possible to cache static CSS and JavaScript files. Please refer to the documentation of the CDN provider for the best-practice setup. -### Media files (Umbraco /media folder, images and pdf's) +### Media files (Umbraco /media folder, images and PDF's) -It is possible to cache /media files. Please refer to the documentation of the CDN provider for best-practice the setup. \ No newline at end of file +It is possible to cache `/media` files. Please refer to the documentation of the CDN provider for best-practice the setup. \ No newline at end of file diff --git a/13/umbraco-ums/getting-started/for-developers/infrastructure-sizing.md b/13/umbraco-ums/getting-started/for-developers/infrastructure-sizing.md index 475c56ebb5a..5d0af568fb0 100644 --- a/13/umbraco-ums/getting-started/for-developers/infrastructure-sizing.md +++ b/13/umbraco-ums/getting-started/for-developers/infrastructure-sizing.md @@ -1,3 +1,7 @@ +--- +description: Learn more about recommendation when is comes to infrastructure and database. +--- + # Infrastructure sizing To determine the optimal infrastructure sizing the most important metric is the number of page views you need to process. Peak load is also an important factor.