|
1 | 1 | # Magento_Analytics module
|
2 | 2 |
|
3 |
| -The Magento_Analytics module integrates your instance with the [Magento Business Intelligence](https://magento.com/products/business-intelligence) to use [Advanced Reporting](http://devdocs.magento.com/guides/v2.2/advanced-reporting/modules.html) functionality. |
| 3 | +The Magento_Analytics module integrates your Magento instance with the [Magento Business Intelligence (MBI)](https://magento.com/products/business-intelligence) to use [Advanced Reporting](http://devdocs.magento.com/guides/v2.2/advanced-reporting/modules.html) functionality. |
4 | 4 |
|
5 | 5 | The module implements the following functionality:
|
6 | 6 |
|
7 |
| -* Provides a subscription and restores subscription procedures |
8 |
| -* Declares the configuration of data collected for reporting |
9 |
| -* Processes the data collection |
10 |
| -* Provides an Access Control List (ACL) |
11 |
| -* Implements a Configuration page |
| 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) |
12 | 16 |
|
13 | 17 | ## Structure
|
14 | 18 |
|
15 |
| -The module contains a directory `ReportXml`. |
| 19 | +Beyond the [usual module file structure](http://devdocs.magento.com/guides/v2.2/architecture/archi_perspectives/components/modules/mod_intro.html) the module contains a directory `ReportXml`. |
16 | 20 | [Report XML](http://devdocs.magento.com/guides/v2.2/advanced-reporting/report-xml.html) is a markup language used to build reports for Advanced Reporting.
|
17 | 21 | The language declares SQL queries using XML declaration.
|
18 | 22 |
|
19 | 23 | ## Extensibility
|
20 | 24 |
|
21 |
| -The module doesn't expect to be extended. |
22 |
| -It uses a specific API for transferring the collected data to the Magento Business Intelligence service but the API cannot be used for needs other than data transfer to MBI. |
| 25 | +We do not recommend to extend the Magento_Analytics module. It introduces an API that is purposed to transfer the collected data. Note that the API cannot be used for other needs. |
0 commit comments