GITBOOK-44: Developer, Settings

Author: eshanrnh

13/umbraco-ums/SUMMARY.md

@@ -26,8 +26,6 @@
   * [Infrastructure sizing](getting-started/for-developers/infrastructure-sizing.md)
   * [Load Balancing and CM/CD Environments](getting-started/for-developers/loadbalancing-and-cm-cd-environments.md)
   * [Content Delivery Network recommendations](getting-started/for-developers/content-delivery-network-recommendations.md)
-  * [Configuration options 1.x](getting-started/for-developers/configuration-options-1-x.md)
-  * [Configuration options 2.x](getting-started/for-developers/configuration-options-2-x.md)
   * [Cockpit](getting-started/for-developers/cockpit.md)
 
 ## Marketers and Editors
@@ -141,10 +139,10 @@
   * [External Profile Data](developers/profiling/external-profile-data.md)
 * [Reporting](developers/reporting.md)
 * [Settings](developers/settings/README.md)
-  * [Custom Goals Scoring](developers/settings/custom-goals-scoring.md)
+  * [The Configuration file](developers/settings/configuration-options-2-x.md)
   * [IP filtering](developers/settings/ip-filtering.md)
   * [Set up Goals](developers/settings/setup-goals.md)
-  * [The Configuration File](developers/settings/the-configuration-file.md)
+  * [Custom Goals Scoring](developers/settings/custom-goals-scoring.md)
   * [Permissions](developers/settings/permissions.md)
 * [Headless](developers/headless/README.md)
   * [Using the Marketing API](developers/headless/using-the-marketing-api.md)

13/umbraco-ums/developers/introduction/dataflow-pipeline/data-storage.md

@@ -17,7 +17,7 @@ Two thresholds can be set and reached which will trigger the storage of data. If
 * The second threshold is the **FlushIntervalInSeconds**. 
   * After this number of seconds, the data will be sent to the database. If you set it to 30 seconds, for example, every 30 seconds the data will be sent to the database. No matter how many records there are in memory.
 
-Both settings can be set in the [configuration](../../../getting-started/for-developers/configuration-options-2-x.md) file of the Umbraco uMS.
+Both settings can be set in the [configuration](../../settings/configuration-options-2-x.md) file of the Umbraco uMS.
 
 The higher the value set for these thresholds, the more memory Umbraco uMS uses on your web server(s) and less of your database connection. Please be aware the memory impact is low because there is not a lot of complex data stored. It also means that it will take a bit longer for data to appear in the backoffice (because the data is not yet stored and processed).
 
@@ -41,7 +41,7 @@ If no new records appear in this table three things can have happened:
 
 * There is no traffic on the website. 
   * You can try to click through the website. Ensure [your IP is not filtered](../../../../../installing-umarketingsuite/settings-section/ip-filtering/). Filtered IPs are never stored in the raw tables.
-* You have a high threshold for '**FlushRateInRecords**' and '**FlushIntervalInSeconds**' in the [configuration file](../../../getting-started/for-developers/configuration-options-2-x.md). 
+* You have a high threshold for '**FlushRateInRecords**' and '**FlushIntervalInSeconds**' in the [configuration file](../../settings/configuration-options-2-x.md). 
   * This means that the data is flushed only at certain intervals and it could be that these intervals have not been passed yet. Setting both values to 1 will fix this.
 * The website URL is not listed in your license or you have reached the threshold of your pageviews. 
   * If the URL is not listed in your license the data is not stored in the raw-table. The same is true when you have exceeded the number of page views. No more data will be stored at that point. The implication is that upgrading your license later does not mean you will see data in the past that was not tracked again.

13/umbraco-ums/developers/introduction/dataflow-pipeline/reporting.md

@@ -15,4 +15,4 @@ The data is visualized in two parts in Umbraco:
 
 All reports query the data of the normalized tables that are filled in the [data parsing step](../../../../../the-umarketingsuite-broad-overview/dataflow-pipeline/data-parsing/). The data of the raw data tables is not used anymore.
 
-By following the steps of collection, storing, and parsing, it probably makes sense that you can determine how real-time your data is. The lower the thresholds in the [configuration file](../../../getting-started/for-developers/configuration-options-2-x.md) the faster the data is displayed and the more real-time your data is.
+By following the steps of collection, storing, and parsing, it probably makes sense that you can determine how real-time your data is. The lower the thresholds in the [configuration file](../../settings/configuration-options-2-x.md) the faster the data is displayed and the more real-time your data is.

13/umbraco-ums/developers/introduction/performance.md

@@ -98,4 +98,4 @@ You can also optimize your server infrastructure to tweak the performance. There
 
 * You could set up more web servers in [a load-balanced setup](https://docs.umbraco.com/umbraco-cms/13.latest-lts/fundamentals/setup/server-setup/load-balancing). Each web server will collect data from the visitor, but you can specify which web server is responsible for parsing the data in the configuration. 
 * You can also set up one specific server only to parse the data. In that case, the other web servers will have almost no impact on their performance. To set this up you need to set the parameter '`IsProcessingServer`' to '`false`' in [your configuration file](../../../../installing-umarketingsuite/settings-section/the-configuration-file/) for all servers that do not need to process the data and set it to '`true`' on the server(s) that is responsible for parsing. If there is no server with this setting set to '`true`' the raw data of the Umbraco uMS will take place, but the data will never be processed.
-* By default, the Umbraco uMS stores its data in the same database as Umbraco. It uses the default connection string of Umbraco (named '`umbracoDbDSN`'). It is possible to specify a separate database for all Umbraco uMS data. This could be another database on the same server or also another database server. To do this you need to specify a new connection string in your application and give that connection string a name. In [the configuration file](../../getting-started/for-developers/configuration-options-2-x.md), you can now specify this name in the field '`DatabaseConnectionStringName`'.
+* By default, the Umbraco uMS stores its data in the same database as Umbraco. It uses the default connection string of Umbraco (named '`umbracoDbDSN`'). It is possible to specify a separate database for all Umbraco uMS data. This could be another database on the same server or also another database server. To do this you need to specify a new connection string in your application and give that connection string a name. In [the configuration file](../settings/configuration-options-2-x.md), you can now specify this name in the field '`DatabaseConnectionStringName`'.

13/umbraco-ums/developers/introduction/the-umarketingsuite-cookie/README.md

@@ -1,13 +1,13 @@
 ---
-description: Learn how the uMS cookie works and how the functionality can be tested.
 icon: square-exclamation
+description: Learn how the uMS cookie works and how the functionality can be tested.
 ---
 
 # The uMS Cookie
 
 When visiting a website with Umbraco uMS installed you will get a unique cookie. This cookie allows for relating different page visits or sessions to the same visitor. It will also continuously serve the same variant of an A/B test.
 
-By default the uMS cookie has the name `uMarketingSuiteAnalyticsVisitorId`. You can change the name in the [configuration file](../../../getting-started/for-developers/configuration-options-2-x.md).
+By default the uMS cookie has the name `uMarketingSuiteAnalyticsVisitorId`. You can change the name in the [configuration file](../../settings/configuration-options-2-x.md).
 
 The Umbraco uMS cookie:
 

13/umbraco-ums/developers/settings/README.md

@@ -1,6 +1,30 @@
 ---
 icon: arrow-right-long
+description: >-
+  When setting up uMS on your Umbraco project it is important to get the
+  configuration right. Learn more about the different options in this section.
 ---
 
 # Settings
 
+In this section, you can find information about configuring different parts of uMS.
+
+## [**Goals Configuration**](setup-goals.md)
+
+Users can set goals to track important actions or A/B test results. These goals help monitor performance and effectiveness.
+
+You can also find an article on [setting up custom Goal Scoring](custom-goals-scoring.md).
+
+## [**IP Filtering**](ip-filtering.md)
+
+This allows users to filter out internal traffic or specific IP addresses from being a part of the analytics data, ensuring more accurate reporting. For example, you could filter out any traffic from your workplace IP.
+
+## [**The Configuration file**](./#the-configuration-file)
+
+While most configurations and settings will be visible in the Umbraco backoffice, they can only be changed in the `appSettings.json` configuration file. The Configuration file article provides an overview of the available settings.
+
+## [**Permissions**](permissions.md)
+
+Administrators can assign different permissions to control access to marketing and content apps, based on user roles or Document Types.
+
+These settings allow users to manage and fine-tune their marketing efforts, ensuring data accuracy and access control.

13/umbraco-ums/getting-started/for-developers/configuration-options-2-x.md renamed to 13/umbraco-ums/developers/settings/configuration-options-2-x.md

@@ -2,9 +2,9 @@
 description: Get an overview of the configurations options in uMS.
 ---
 
-# Configuration options 2.x
+# The Configuration file
 
-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 configuration options no longer require the application to restart to take effect. This comes with a few exceptions.
+Most of the uMS configuration options are stored in the configuration file. uMS uses the standard for .NET Core applications, in which we make use of the `appsettings.json` (and environment variable support). Because of this new standard, most configuration options no longer require the application to restart to take effect. This comes with a few exceptions.
 
 uMS 2.x ships with an `appsettings-schema.json` file, allowing Visual Studio or Jetbrains Rider to auto-complete the configuration options. It comes with information about default values and a description of what each configuration option does.
 
@@ -87,7 +87,7 @@ The default configuration will look like this:
 
 All these settings are also visualized in the uMS. This overview can be found in the section 'Marketing' -> Settings -> Configuration.
 
-![]()
+![](../../getting-started/for-developers)
 
 {% 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.

13/umbraco-ums/developers/settings/custom-goals-scoring.md

@@ -1,27 +1,28 @@
 ---
 description: >-
-  Discover how to set up and trigger custom goals in uMarketingSuite using C# code.
+  Discover how to set up and trigger custom goals in uMarketingSuite using C#
+  code.
 ---
 
-# Custom Goal Scoring
+# Custom Goals Scoring
 
-Before uMarketingSuite 1.10.0, goals could only be triggered through pageviews and page events. With the release of 1.10.0, custom goals can now be triggered through code.
+Before uMarketingSuite 1.10.0, goals could only be triggered through page views and page events. With the release of 1.10.0, custom goals can now be triggered through code.
 
 ## Setting Up Custom Goals
 
-To setup custom goals:
+To set custom goals:
 
 1. Navigate to **Settings** > **Goals** in the uMarketingSuite section.
 2. Set the goal type to **Custom**.
 3. Execute C# code to trigger the goal.
 
-Creating the goal is similar to creating a pageview or page event goal. Note the **goal id** displayed in the code snippet after saving, as it's needed to trigger the goal from code.
+Creating the goal is similar to creating a page view or page event goal. The **goal ID** displayed in the code snippet after saving, as it's needed to trigger the goal from the code.
 
 ![goal id]()
 
-## Trigger goal in C#
+## Trigger goal in C\#
 
-To trigger the goal, execute C# code during the visitor's pageview. Inject **uMarketingSuite.Business.Analytics.Goals.IGoalService**, which has a **TriggerGoal(long goalId, int value)** method. An implementation looks like:
+To trigger the goal, execute C# code during the visitor's pageview. Inject `uMarketingSuite.Business.Analytics.Goals.IGoalService`, which has a `TriggerGoal(long goalId, int value)` method. An implementation looks like:
 
 ```cs
 using uMarketingSuite.Business.Analytics.Goals;
@@ -42,7 +43,7 @@ public class YourService
 
 ### Triggering Outside of HttpContext
 
-The method automatically determines the current pageview, linking the goal to a session and visitor. This means the **HttpContext** should be available.
+The method automatically determines the current page view, linking the goal to a session and visitor. This means the **HttpContext** should be available.
 
 To trigger a goal outside of an HTTP request, use the overload of **TriggerGoal** that takes the GUID of the pageview.
 

13/umbraco-ums/developers/settings/permissions.md

@@ -1,11 +1,11 @@
 ---
-description: Manage content apps and access on Document Types.
 icon: square-exclamation
+description: Manage content apps and access on Document Types.
 ---
 
 # Permissions
 
-You can manage which document types the content apps are shown, and which Umbraco user groups have access to in the Marketing section settings. They can be managed per Document Type and user group
+You can manage which Document Types the Content Apps are shown on, and which Umbraco user groups can access the Marketing section settings. They can be managed per Document Type and user group.
 
 ![](../../../../media/gbypb1w1/document-type-permissions.png)
 

13/umbraco-ums/developers/settings/setup-goals.md

@@ -1,15 +1,15 @@
 ---
-description: >-
-  Goals are the most important part of the Umbraco uMS. Without goals
-  personalization, a/b testing & tracking analytics does not make any sense.
 icon: square-exclamation
+description: >-
+  Goals are the most important part of uMS. Without goals, personalization, A/B
+  testing, and tracking analytics make no sense.
 ---
 
-# Set up goals
+# Set up Goals
 
 Personalization is never the goal; the goal is to increase your goals which can be achieved by personalization or A/B testing.
 
-In the Goals menu, you can set up goals and specify their value.
+You can set up goals in the Goals menu and specify their value.
 
 You have a complete overview of all of the goals that are currently set:
 
@@ -21,9 +21,9 @@ From this page, you can edit existing goals or set up new goals.
 
 When you click on **Create new goal** you can set up a new goal. You have to give it a name and an optional goal value.
 
-You can specify whether it is a micro or macro goal. 
+You can specify whether it is a micro or macro goal.
 
-* A macro goal should be used for the "bigger things" in your website like a purchase or filling in a contact form. 
+* A macro goal should be used for the "bigger things" in your website like a purchase or filling in a contact form.
 * Micro goals are smaller / less important things like "_Reaching the contact page_" or "_Clicking open a FAQ_". These micro goals should eventually contribute to macro goals.
 
 In the Umbraco uMS, we always keep track of the macro goals, for example during A/B tests. Perhaps your micro goal is increased, but it hurts your macro goal. In that case, Umbraco uMS will give you a warning.