Skip to content

Commit 3e6104d

Browse files
committed
Update Magento_Analytics ReadMe
1 parent 099c639 commit 3e6104d

File tree

1 file changed

+26
-16
lines changed

1 file changed

+26
-16
lines changed

app/code/Magento/Analytics/README.md

Lines changed: 26 additions & 16 deletions
Original file line numberDiff line numberDiff line change
@@ -1,18 +1,28 @@
1-
# Magento_Analytics Module
1+
# Magento_Analytics module
22

33
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.
44

55
The module implements the following functionality:
66

7-
* enabling subscription to the MBI and automatic re-subscription
8-
* changing the base URL with the same MBI account remained
9-
* declaring the configuration schemas for report data collection
10-
* collecting the Magento instance data as reports for the MBI
11-
* introducing API that provides the collected data
12-
* extending Magento configuration with the module parameters:
13-
* subscription status (enabled/disabled)
14-
* industry (a business area in which the instance website works)
15-
* time of data collection (time of the day when the module collects data)
7+
- Enabling subscription to the MBI and automatic re-subscription
8+
- Changing the base URL with the same MBI account remained
9+
- Declaring the configuration schemas for report data collection
10+
- Collecting the Magento instance data as reports for the MBI
11+
- Introducing API that provides the collected data
12+
- Extending Magento configuration with the module parameters:
13+
- Subscription status (enabled/disabled)
14+
- Industry (a business area in which the instance website works)
15+
- Time of data collection (time of the day when the module collects data)
16+
17+
## Installation details
18+
19+
Before disabling or uninstalling this module, note that the following modules depends on this module:
20+
- Magento_CatalogAnalytics
21+
- Magento_CustomerAnalytics
22+
- Magento_QuoteAnalytics
23+
- Magento_ReviewAnalytics
24+
- Magento_SalesAnalytics
25+
- Magento_WishlistAnalytics
1626

1727
## Structure
1828

@@ -29,12 +39,12 @@ The subscription to the MBI service is enabled during the installation process o
2939
Configuration settings for the Analytics module can be modified in the Admin Panel on the Stores > Configuration page under the General > Advanced Reporting tab.
3040

3141
The following options can be adjusted:
32-
* Advanced Reporting Service (Enabled/Disabled)
33-
* Alters the status of the Advanced Reporting subscription
34-
* Time of day to send data (Hour/Minute/Second in the store's time zone)
35-
* Defines when the data collection process for the Advanced Reporting service occurs
36-
* Industry
37-
* Defines the industry of the store in order to create a personalized Advanced Reporting experience
42+
- Advanced Reporting Service (Enabled/Disabled)
43+
- Alters the status of the Advanced Reporting subscription
44+
- Time of day to send data (Hour/Minute/Second in the store's time zone)
45+
- Defines when the data collection process for the Advanced Reporting service occurs
46+
- Industry
47+
- Defines the industry of the store in order to create a personalized Advanced Reporting experience
3848

3949
## Extensibility
4050

0 commit comments

Comments
 (0)