Skip to content
This repository was archived by the owner on Apr 29, 2019. It is now read-only.

Commit 0e0b76a

Browse files
author
olysenko
committed
Merge remote-tracking branch 'origin/MAGETWO-70201' into bugfixes
2 parents 5698c6f + bfc8608 commit 0e0b76a

File tree

1 file changed

+12
-9
lines changed

1 file changed

+12
-9
lines changed

app/code/Magento/Analytics/README.md

Lines changed: 12 additions & 9 deletions
Original file line numberDiff line numberDiff line change
@@ -1,22 +1,25 @@
11
# Magento_Analytics module
22

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

55
The module implements the following functionality:
66

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)
1216

1317
## Structure
1418

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`.
1620
[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.
1721
The language declares SQL queries using XML declaration.
1822

1923
## Extensibility
2024

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

Comments
 (0)