From 3e6104de227981da9631986aacb60a249fa063bc Mon Sep 17 00:00:00 2001 From: Raul E Watson Date: Sun, 25 Aug 2019 07:04:18 +0100 Subject: [PATCH 1/3] Update Magento_Analytics ReadMe --- app/code/Magento/Analytics/README.md | 42 +++++++++++++++++----------- 1 file changed, 26 insertions(+), 16 deletions(-) diff --git a/app/code/Magento/Analytics/README.md b/app/code/Magento/Analytics/README.md index aa424182e2ebd..cb78a27dae8e0 100644 --- a/app/code/Magento/Analytics/README.md +++ b/app/code/Magento/Analytics/README.md @@ -1,18 +1,28 @@ -# Magento_Analytics Module +# Magento_Analytics module The Magento_Analytics module integrates your Magento instance with the [Magento Business Intelligence (MBI)](https://magento.com/products/business-intelligence) to use [Advanced Reporting](https://devdocs.magento.com/guides/v2.3/advanced-reporting/modules.html) functionality. The module implements the following functionality: -* enabling subscription to the MBI and automatic re-subscription -* changing the base URL with the same MBI account remained -* declaring the configuration schemas for report data collection -* collecting the Magento instance data as reports for the MBI -* introducing API that provides the collected data -* extending Magento configuration with the module parameters: - * subscription status (enabled/disabled) - * industry (a business area in which the instance website works) - * time of data collection (time of the day when the module collects data) +- Enabling subscription to the MBI and automatic re-subscription +- Changing the base URL with the same MBI account remained +- Declaring the configuration schemas for report data collection +- Collecting the Magento instance data as reports for the MBI +- Introducing API that provides the collected data +- Extending Magento configuration with the module parameters: + - Subscription status (enabled/disabled) + - Industry (a business area in which the instance website works) + - Time of data collection (time of the day when the module collects data) + +## Installation details + +Before disabling or uninstalling this module, note that the following modules depends on this module: +- Magento_CatalogAnalytics +- Magento_CustomerAnalytics +- Magento_QuoteAnalytics +- Magento_ReviewAnalytics +- Magento_SalesAnalytics +- Magento_WishlistAnalytics ## Structure @@ -29,12 +39,12 @@ The subscription to the MBI service is enabled during the installation process o Configuration settings for the Analytics module can be modified in the Admin Panel on the Stores > Configuration page under the General > Advanced Reporting tab. The following options can be adjusted: -* Advanced Reporting Service (Enabled/Disabled) - * Alters the status of the Advanced Reporting subscription -* Time of day to send data (Hour/Minute/Second in the store's time zone) - * Defines when the data collection process for the Advanced Reporting service occurs -* Industry - * Defines the industry of the store in order to create a personalized Advanced Reporting experience +- Advanced Reporting Service (Enabled/Disabled) + - Alters the status of the Advanced Reporting subscription +- Time of day to send data (Hour/Minute/Second in the store's time zone) + - Defines when the data collection process for the Advanced Reporting service occurs +- Industry + - Defines the industry of the store in order to create a personalized Advanced Reporting experience ## Extensibility From 52cdae7e754ab4a12b06e9bf2df05127cb5a7a53 Mon Sep 17 00:00:00 2001 From: Raul E Watson Date: Tue, 27 Aug 2019 00:35:46 +0100 Subject: [PATCH 2/3] Add changes requested during CR --- app/code/Magento/Analytics/README.md | 4 ++-- 1 file changed, 2 insertions(+), 2 deletions(-) diff --git a/app/code/Magento/Analytics/README.md b/app/code/Magento/Analytics/README.md index cb78a27dae8e0..e0f1c818c7a94 100644 --- a/app/code/Magento/Analytics/README.md +++ b/app/code/Magento/Analytics/README.md @@ -4,10 +4,10 @@ The Magento_Analytics module integrates your Magento instance with the [Magento The module implements the following functionality: -- Enabling subscription to the MBI and automatic re-subscription +- Enabling subscription to Magento Business Intelligence (MBI) and automatic re-subscription - Changing the base URL with the same MBI account remained - Declaring the configuration schemas for report data collection -- Collecting the Magento instance data as reports for the MBI +- Collecting the Magento instance data as reports for MBI - Introducing API that provides the collected data - Extending Magento configuration with the module parameters: - Subscription status (enabled/disabled) From 0c45902eeeddb660ecdeaeabda2d0a06e514c316 Mon Sep 17 00:00:00 2001 From: Raul E Watson Date: Sun, 15 Sep 2019 22:49:37 +0100 Subject: [PATCH 3/3] remove confusing lines from Magento_Analytics ReadMe --- app/code/Magento/Analytics/README.md | 1 - 1 file changed, 1 deletion(-) diff --git a/app/code/Magento/Analytics/README.md b/app/code/Magento/Analytics/README.md index e0f1c818c7a94..7ec30c6dd484b 100644 --- a/app/code/Magento/Analytics/README.md +++ b/app/code/Magento/Analytics/README.md @@ -5,7 +5,6 @@ The Magento_Analytics module integrates your Magento instance with the [Magento The module implements the following functionality: - Enabling subscription to Magento Business Intelligence (MBI) and automatic re-subscription -- Changing the base URL with the same MBI account remained - Declaring the configuration schemas for report data collection - Collecting the Magento instance data as reports for MBI - Introducing API that provides the collected data