Advanced Reports
Magento 2 Advanced Reports

Welcome to the Advanced Reports Guide!

Here you will find everything you need to set up and use our Advanced Reports. Whether you're new or an advanced user, you can find some useful information here.

The Advanced Reports extension includes the following modules:

  • Advanced Reports
  • Advanced Dashboard
  • Report Builder First, please find your extension in your account in My Downloadable Products section.

Then, start with the Installation and Quick Start option. It is best to follow our step-by-step guide to configure the best search results.

Go ahead, dive in!

Learn about the initial setup:

Installation

In this article, you will find two possible ways to install our extension.

Installation via composer (preferably)

We recommend this installation method because the composer automatically checks and installs necessary dependencies.

  1. Back up your store's database and web directory.
  2. Log in to your server's SSH console and navigate to the root directory of the Magento 2 store.
  3. Copy the installation instructions from the page My Downloadable Products to the SSH console and press ENTER.

  4. To enable the extension, run commands:
        php -f bin/magento module:enable Mirasvit_Core Mirasvit_Report Mirasvit_Reports Mirasvit_Dashboard Mirasvit_ReportBuilder
        php -f bin/magento setup:upgrade
  5. Clean the cache

        php -f bin/magento cache:clean
  6. Deploy static view files
        rm -rf pub/static/frontend/*
        rm -rf pub/static/backend/* 
        rm -rf var/view_preprocessed/*  
        php -f bin/magento setup:static-content:deploy  

Installation via direct file upload

You can also install the extension via direct files uploading.

  1. Go to My Downloadable Products / View & Download.

  2. Unpack the .zip package and copy the contents to Magento's root directory
  3. Login to your server's SSH console and navigate to the root directory of the Magento 2 store.
  4. To enable the extension, run commands:
        php -f bin/magento module:enable Mirasvit_Core Mirasvit_Report Mirasvit_Reports Mirasvit_Dashboard Mirasvit_ReportBuilder
        php -f bin/magento setup:upgrade
  5. Clean the cache

        php -f bin/magento cache:clean
  6. Deploy static view files
        rm -rf pub/static/frontend/*
        rm -rf pub/static/backend/* 
        rm -rf var/view_preprocessed/*  
        php -f bin/magento setup:static-content:deploy  

Learn about the initial setup:

Quick Start

As you have completed the installation of Advanced Reports, we will guide you through the main steps required to start using our extension efficiently.

  1. Please open and configure your first Advanced Dashboard (Magento Main Menu > Dashboard > Advanced Dashboard)

  2. Please check the Reports (Magento Main Menu > Reports > Advanced Reports)

Reports

The module provides a wide range of reports using various tools in analyzing and improving sales:

Reports Menu

General sales report. It allows you to see the number of orders, the quantity of sold products, net sales, total, discounts, and returns.

The report can contain about 40 columns.

You receive daily / weekly / monthly / quarterly / annual reports.

The report gives full information about store orders.

Hourly sales report. You can detect the number of hours based on whether the personnel of your shop are being utilized to the maximum extent. It will allow you to plan the working hours and perform possible updates necessary for your shop.

Weekly sales report.

A report with details of sales to each customer can be found in your store. This allows you to view the required information about sales to all customers: the number of orders, refunds, and discounts, etc.

Sales by Customer Group refers to the sales report generated from different user groups. Using such a tool, you can determine the extent of work efficiency with different user groups.

The report allows you to gain knowledge regarding which of the coupons are most favorable in terms of sales volume, and which should be elaborated in a better way.

The report shows the rules guiding the use of cart prices.

The report contains information about the distribution of orders based on tax rates.

The report allows you to define the degree of popularity from different payment methods.

The report reflects the sales volumes in different countries achieved during a definite period.

Sales Report by store product categories

The report allows you to compile a comparative analysis of sales by new customers (those who have just placed their first order) juxtaposed against sales by returning customers (those who have already made two or more orders)

Detailed information about each product's sale history: number of orders (%), ordered qty, the total amount of incomes, etc

Sales Report by store product attributes

Sales Report by store product attribute sets

The report contains all general information and statistics about registered customers'.

The report contains statistics on abandoned carts. Information can be grouped at different time intervals (day / week / month / quarter / year).

This report contains a list of abandoned carts with information about their date of the creation, customer, coupon (if applied), and products.

  • Abandoned Products Contains detailed information about abandoned products, letting you identify the most frequently abandoned products.

This module allows you to display composite reports of all websites in addition to separate reports by each store.

You can analyze your product sales on the Chart. Add additional columns to compare the following values:

  • Number of Orders - number of product orders
  • Total Qty Ordered - the total amount of products ordered
  • Qty Refunded - the total amount of products refunded
  • Discount Amount - the number of discounts for a certain product
  • Shipping Amount - the amount of money paid for shipping
  • Shipping Tax Amount
  • Tax Amount - the amount of taxes paid for a certain product
  • Tax Refunded
  • Total Refunded - the amount of money refunded for a given product
  • Subtotal - the order value without shipping costs and taxes
  • Grand Total - the total amount of sales revenue for a selected period
  • Total Invoiced
  • Total Invoiced Cost
  • Gross Margin
  • Grand Total by new customers
  • Grand Total by returning customers
  • Grand Total excl. Tax
  • Gross Profit

The extension shows you reports of the different Store views, their varying report period, and compared attributes and values.

Interface

Consider generic interface using an example on "Sales Overview" report.

Sales Overview

  • 1: –°alendar for the selection of the reporting period;
  • 2: Drop-down with pre-defined time intervals for Calendar (1): Today, Yesterday, This week, Previous week, This month, Previous month, This year, Previous year, Lifetime (minus 10 years from the current moment, plus 10 years to the current moment), Custom (allows you to select a period manually).
  • 3: Currently selected time interval for the report.
  • 4, 5 - Drop-down with the pre-defined comparison periods, and fields for custom comparison period definition.
  • 6: Selects the scope of Report - either for All Stores or only for a particular one.
  • 7: Defines a step size. Report can be dispayed for each Day, Week, Month, Quarter and Year.

  • 8: Filters data table with the filter, and correspondingly changes chart display. With these filters, you can build a report for individual customer groups or consider the selected order statuses.

9: Defines Reports Presets like the Time Interval, Columns, Filters. It allows you to save your Report setup and view it next time with a single click.

10: Add or remove columns to a data table of the Report. It contains only Active columns, so if you wish to add some extended columns - you need to use the Settings button first.

11: Export report in CSV or XML format.

12: It defines which columns are Active (e. g. selectable in Columns for a data table) and available in displaying a Dashboard. It can dramatically reduce the time of report generation by excluding all unnecessary columns.

Settings (12) button brings up an Active Column selection. Where listed, all columns that can be displayed in a current Report (including a synthetic - e. g. that can be calculated on-the-fly - such as the Average Base Discount Amount).

Reports Active Columns

Each row is a column activation definition, and it contains the following:

  • Column Name - a sensible name of the column.
  • Column Type - the type of column, e. g. numeric, money, text, and so on.
  • Aggregator Type - used for synthetic columns and displays, as SQL function is used for calculations.

Each selected column is marked with a green line, and becomes available both in the Columns (11) popup, and in the Dashboard Blocks.

Sales Overview report

General sales report. It allows you to see the number of orders, quantity of sold products, net sales, grand total, discounts, and returns etc. You receive daily / weekly / monthly / quarterly / annual reports.

Sales Overview

Orders report

Orders Report

Sales by Hour report

Sales by Hour

Sales by Day of Week report

Sales by Day of Week

Sales by Customer report

Sales by Customer

Sales by Customer Group report

Sales by Customer Group

Sales by Coupon report

Sales by Coupon report

Sales by Cart Price Rule report

Sales by Cart Price Rule report

Sales by Tax Rates report

Sales by Tax Rates report

Sales by Payment Type report

Sales by Payment Type report

Sales by Geo-data report

Sales by Geo-data

Sales by Category report

Sales by Category report

New vs Returning Customers report

New vs Returning Customers

Product Performance report

The Product performance report (also called Sales by product or bestsellers) shows a breakdown of products' (the total sales products) during a specified time frame but does not include the shipping charges.

Shipping is not included in this report because Magento calculates the shipping cost for a whole order only.

The report displays a list of all purchased products during a specified time frame.

Product Performance report

Sales by Attribute report

Sales by Attribute report

Sales by Attribute Set report

Sales by Attribute Set report

Customers report

Customers report

Note

In contrast, the "Sales by Customer" report also contains registered customers without purchases

Abandoned Carts Overview report

Abandoned Carts Overview report

Abandoned Carts report

Abandoned Carts report

Abandoned Products report

Abandoned Carts report

Custom Reports

This section provides a few common reports built with the Report Builder tool.

You can find out how to exact the configuration reports in our demo.

Low Stock Report

The Magento 2 Low Stock Report contains a list of all products with a stock quantity that is lower than the designated minimum level.

Cost of Goods Sold Report

The Magento 2 COGS Report (Cost of Goods Sold) contains a list of all purchased products, their quantity, and cost.

Stock Value Report

The Magento 2 Stock Value Report contains a list of all products with their stock quantity and each products' cost.

The stock value report is very useful when you need to know the specific quantity of stock you have for specific products and their total value.

Managing Dashboards

Our Advanced Reports extension allows you to have more than one Dashboard, suited for different purposes. They all are located at Dashboard -> Advanced Dashboard section as a part of the menu:

Dashboard Menu

It is divided into three sections:

  • Top section allows you quick access to dashboards, that you had created.
  • Middle section provides you with basic actions, that can be done on currently opened Dashboard: Edit and Delete.
  • Bottom section contains a single action, which allows you to create new Dashboard

Creating New Dashboard

Visit Dashboard -> Advanced Dashboard, open menu and press Add New Board action. You will be brought to the dashboard creation page, which contains the following fields:

  • Title - a sensical name of your Dashboard.
  • Type - type of your new Dashboard. There are two different types:
    • Private Board will be available only for current user.
    • Shared Board will be available for all backend users, defined in System -> Permissions -> All Users.
  • Is Default - whether newly-created Dashboard will be shown immediately after log-in.
  • Enable Mobile Access - whether newly-created Dashboard will be accessible in Mobile mode.

    Note

    This mode is very convenient for accessing dashboard data, but has some warranties:

    • Dashboard widgets editing mode is disabled.
    • Access to the mobile dashboard is granted according to the URL specified on the page and encrypted in the QR code. We recommend that you use any QR-reader on your mobile device to read such an URL.
    • Dashboard URL itself is highly encoded to limit the ability to remember/copy URLs by an unauthorized person.


    Please note that there is no other suitable protection for the mobile dashboard. If you are not sure, do not enable this option.

Press Save to create your new Dashboard.

This will create only a template for a Dashboard. To complete creation, you need to add one or more Blocks to your newly-created Dashboard Panel.

Adding Blocks to Dashboard

After Dashboard is created, you need to add there blocks. Open your newly-created Dashboard, and press View Mode button, which is located in the right end of title ribbon: Dashboard Menu It will bring you to the Blocks Configuration mode, as shown below: Dashboard Edit

To add a block, press Add Block button on the title ribbon. It will create an empty block rectangle, as you can see on screenshot above.

This block has four buttons on its bottom pane:

  • Move - allows you to move block visually on marked zone. You can also resize block, if you wish - just drag and drop its right-botton corner.
  • Settings - allows you to select data, which will be displayed on that block (read more below).
  • Refresh - allows you to preview (or refresh) previewed data in Edit Mode.

    Note

    By default, each block is reloaded once a minute to ensure that the dashboard always contains up-to-date data
  • Delete - removes block.

You can add to the block either statistical data, or tables. Press Settings button (second on the block button pane), and you will see Metrics Edit Panel:

Metrics

As you see above, it contains of the following fields:

  • General Settings

    • Title - a sensical title for a metric. It will be displayed as title of your block.
    • Description - short description of your block.
    • Block Types - defines view, in which data will be presented. There are three possible values:
      • Single Value - in this mode only first selected data field will be displayed.
      • Table - in this mode multiple fields can be displayed.
      • Chart - in this mode a block will be presented as chart
  • Time Range
    • Override Dashboard Time - by enabling this option, you can fix your block on specific period. Otherwise, data on your block will be displayed according to date range, selected for current Dashboard.

      Note

      Blocks with overridden time ranges are marked with special icon at upper-right corner.
    • Range - is a hidden field, which appears only when Override Time mode is used. Allows you to pick up a range, for which block should display data.
    • Compare To - is a hidden field, which appears only when Override Time mode is used. Allows you to pick up a range, which shall be used for comparison.
  • Filter - allows you to filter raw data, used by this block, with one or more filters. Read more about it below.

Depending on Block Type parameter, you can also set additional visualization options.

If Block Type is Single Value, then you will see next options:

  • Metric - select column that should be used for building the block.
  • Spark Line - is the curve line chart, which displays dynamic of selected value by dates. If you had selected Compare To option in
  • Comparison - Allows you to pick up a range, which shall be used for comparison.

If Block Type is Table, then will available the next options:

  • Dimensions - select column that will be used for group the report.
  • Columns - allows you to select, which columns should be displayed
  • Sorting - choose sort order
  • Rows Limit - allows to set limit for rows.

If Block Type is Chart, then will available the next options:

  • Dimension - select column that will be used for group the report.
  • Columns - allows you to select, which columns should be displayed
  • Comparison - Allows you to pick up a range, which shall be used for comparison.

Selecting Metrics Data

Selection of Metrics data is a little tricky. Field Dimensions and Columns in Metrics Edit Pane contains all available fields in selected category. There are the following Categories:

  • Orders - allows you to analyze orders.
  • Order Items - allows you to analyze products, that was bought by customers.
  • Order Payments - completed payments
  • Order Transactions - transactions (e. q. all actions, such as invoicing or shipping), which performed on your orders.
  • Taxes - extracted taxes for all actually paid orders
  • Order Addresses - addresses, that used as billing or shipping in orders.
  • Quotes - quotes, created by customers (includes abandoned).
  • Quote Items - products, that customer placed to the quote.
  • Invoices - invoices, created for your orders.
  • Postcodes - postal codes, used in billing and shipping addresses (used, for example, to determine country ship disperse).
  • Customers - your customers.
  • Customer Addresses - addresses, that customers are using in their accounts.
  • Products - your products.
  • Categories - categories, where at least one product is assigned.

Each of this category contains a number of fields. There are four types of them:

  • Numerical fields - can be used "as is", for example, IDs. There are two additional subtypes of numerical fields:
    • Total [Field] - calculates total value of the entire column.
    • Average [Field] - calculates average value of the entire column.
  • Group of [Field] - non-numerical field, that can be used as filter.

Combine them to create a query, and block will display result, with automatic date clip.

Note

You can combine fields from different categories - but for some reports some fields will return empty data. For example, categories Orders, Customers, Order Items are compatible, while Products and Customers are not.

We recommend to use fields from the same Category - it is enough for most reports.

Properly configured, our dashboards should look, as in our demo:

  • Daily View dashboard

    Daily View dashboard

  • All in One dashboard

    All in One dashboard

Filtering Data

Each block contains a Filter section, available both at creation stage, and on block editing. It is a table, which contains zero or more conditions, applied to general data. selected at Metrics section.

Dashboard Filter

Each condition is represented by row with the following properties:

  • Column - a raw data column, which is used for filtering. It can differ depending on Metrics data, but currently offer only numeric and text columns.
  • Operator - is the comparison type. There are the following comparison operators available:
    • Equal To and Not Equal To
    • Greater Than and Lesser Than
    • Equals of Greater Than and Equals of Lesser Than
    • Is One Of and Is Not One Of
  • Value - is the value, to which eligible raw data should fit. This field is text-based, so if you wish to use Is One of operator, values shall be comma-separated.
  • Action - contains a button for removing condition.

Note

Warning: If you had selected more than one condition, data shall fit them all like they were combined with AND operator.

Note

If you want to set a Magento dashboard as default, please go to Store - Configuration - Advanced - Admin - Startup page and set from drop-down list Dashboard.

=======

Managing Dashboards

Our Advanced Reports extension allows you to have more than one Dashboard, suited for different purposes. They all are located at Dashboard -> Advanced Dashboard section as a part of the menu:

Dashboard Menu

It is divided into three sections:

  • Top section allows you quick access to dashboards, that you had created.
  • Middle section provides you with basic actions, that can be done on currently opened Dashboard: Edit and Delete.
  • Bottom section contains a single action, which allows you to create new Dashboard

Creating New Dashboard

Visit Dashboard -> Advanced Dashboard, open menu and press Add New Board action. You will be brought to the dashboard creation page, which contains the following fields:

  • Title - a sensical name of your Dashboard.
  • Type - type of your new Dashboard. There are two different types:
    • Private Board will be available only for current user.
    • Shared Board will be available for all backend users, defined in System -> Permissions -> All Users.
  • Is Default - whether newly-created Dashboard will be shown immediately after log-in.
  • Enable Mobile Access - whether newly-created Dashboard will be accessible in Mobile mode.

    Note

    This mode is very convenient for accessing dashboard data, but has some warranties:

    • Dashboard widgets editing mode is disabled.
    • Access to the mobile dashboard is granted according to the URL specified on the page and encrypted in the QR code. We recommend that you use any QR-reader on your mobile device to read such an URL.
    • Dashboard URL itself is highly encoded to limit the ability to remember/copy URLs by an unauthorized person.


    Please note that there is no other suitable protection for the mobile dashboard. If you are not sure, do not enable this option.

Press Save to create your new Dashboard.

This will create only a template for a Dashboard. To complete creation, you need to add one or more Blocks to your newly-created Dashboard Panel.

Adding Blocks to Dashboard

After Dashboard is created, you need to add there blocks. Open your newly-created Dashboard, and press View Mode button, which is located in the right end of title ribbon: Dashboard Menu It will bring you to the Blocks Configuration mode, as shown below: Dashboard Edit

To add a block, press Add Block button on the title ribbon. It will create an empty block rectangle, as you can see on screenshot above.

This block has four buttons on its bottom pane:

  • Move - allows you to move block visually on marked zone. You can also resize block, if you wish - just drag and drop its right-botton corner.
  • Settings - allows you to select data, which will be displayed on that block (read more below).
  • Refresh - allows you to preview (or refresh) previewed data in Edit Mode.

    Note

    By default, each block is reloaded once a minute to ensure that the dashboard always contains up-to-date data
  • Delete - removes block.

You can add to the block either statistical data, or tables. Press Settings button (second on the block button pane), and you will see Metrics Edit Panel:

Metrics

As you see above, it contains of the following fields:

  • General Settings

    • Title - a sensical title for a metric. It will be displayed as title of your block.
    • Description - short description of your block.
    • Block Types - defines view, in which data will be presented. There are three possible values:
      • Single Value - in this mode only first selected data field will be displayed.
      • Table - in this mode multiple fields can be displayed.
      • Chart - in this mode a block will be presented as chart
  • Time Range
    • Override Dashboard Time - by enabling this option, you can fix your block on specific period. Otherwise, data on your block will be displayed according to date range, selected for current Dashboard.

      Note

      Blocks with overridden time ranges are marked with special icon at upper-right corner.
    • Range - is a hidden field, which appears only when Override Time mode is used. Allows you to pick up a range, for which block should display data.
    • Compare To - is a hidden field, which appears only when Override Time mode is used. Allows you to pick up a range, which shall be used for comparison.
  • Filter - allows you to filter raw data, used by this block, with one or more filters. Read more about it below.

Depending on Block Type parameter, you can also set additional visualization options.

If Block Type is Single Value, then you will see next options:

  • Metric - select column that should be used for building the block.
  • Spark Line - is the curve line chart, which displays dynamic of selected value by dates. If you had selected Compare To option in
  • Comparison - Allows you to pick up a range, which shall be used for comparison.

If Block Type is Table, then will available the next options:

  • Dimensions - select column that will be used for group the report.
  • Columns - allows you to select, which columns should be displayed
  • Sorting - choose sort order
  • Rows Limit - allows to set limit for rows.

If Block Type is Chart, then will available the next options:

  • Dimension - select column that will be used for group the report.
  • Columns - allows you to select, which columns should be displayed
  • Comparison - Allows you to pick up a range, which shall be used for comparison.

Selecting Metrics Data

Selection of Metrics data is a little tricky. Field Dimensions and Columns in Metrics Edit Pane contains all available fields in selected category. There are the following Categories:

  • Orders - allows you to analyze orders.
  • Order Items - allows you to analyze products, that was bought by customers.
  • Order Payments - completed payments
  • Order Transactions - transactions (e. q. all actions, such as invoicing or shipping), which performed on your orders.
  • Taxes - extracted taxes for all actually paid orders
  • Order Addresses - addresses, that used as billing or shipping in orders.
  • Quotes - quotes, created by customers (includes abandoned).
  • Quote Items - products, that customer placed to the quote.
  • Invoices - invoices, created for your orders.
  • Postcodes - postal codes, used in billing and shipping addresses (used, for example, to determine country ship disperse).
  • Customers - your customers.
  • Customer Addresses - addresses, that customers are using in their accounts.
  • Products - your products.
  • Categories - categories, where at least one product is assigned.

Each of this category contains a number of fields. There are four types of them:

  • Numerical fields - can be used "as is", for example, IDs. There are two additional subtypes of numerical fields:
    • Total [Field] - calculates total value of the entire column.
    • Average [Field] - calculates average value of the entire column.
  • Group of [Field] - non-numerical field, that can be used as filter.

Combine them to create a query, and block will display result, with automatic date clip.

Note

You can combine fields from different categories - but for some reports some fields will return empty data. For example, categories Orders, Customers, Order Items are compatible, while Products and Customers are not.

We recommend to use fields from the same Category - it is enough for most reports.

Properly configured, our dashboards should look, as in our demo:

  • Daily View dashboard

    Daily View dashboard

  • All in One dashboard

    All in One dashboard

Filtering Data

Each block contains a Filter section, available both at creation stage, and on block editing. It is a table, which contains zero or more conditions, applied to general data. selected at Metrics section.

Dashboard Filter

Each condition is represented by row with the following properties:

  • Column - a raw data column, which is used for filtering. It can differ depending on Metrics data, but currently offer only numeric and text columns.
  • Operator - is the comparison type. There are the following comparison operators available:
    • Equal To and Not Equal To
    • Greater Than and Lesser Than
    • Equals of Greater Than and Equals of Lesser Than
    • Is One Of and Is Not One Of
  • Value - is the value, to which eligible raw data should fit. This field is text-based, so if you wish to use Is One of operator, values shall be comma-separated.
  • Action - contains a button for removing condition.

Note

Warning: If you had selected more than one condition, data shall fit them all like they were combined with AND operator.

Note

If you want to set a Magento dashboard as default, please go to Store - Configuration - Advanced - Admin - Startup page and set from drop-down list Dashboard.

=======

Adding Blocks to Dashboard

After a Dashboard is created, you need to add blocks there. Open your newly-created Dashboard, and press the View Mode button, which is located in the right end of title ribbon: Dashboard Menu It will bring you to the Blocks Configuration mode, as shown below: Dashboard Edit

To add a block, press the Add Block button on the title ribbon. It will create an empty block rectangle, as you can see on the screenshot above.

This block has four buttons on its bottom pane:

  • Move - allows you to move a block visually on the marked zone. You can also resize the block if you wish - just drag and drop its right-bottom corner.
  • Settings - allows you to select data, which will be displayed on that block (read more below).
  • Refresh - allows you to preview (or refresh) previewed data in the Edit Mode.

    Note

    By default, each block is reloaded once a minute to ensure that the dashboard always contains up-to-date data
  • Delete - removes block.

You can add to the block, either statistical data or tables. Press Settings button (second on the block button pane), and you will see Metrics Edit Panel:

Metrics

As you see above, it contains the following fields:

  • General Settings
    • Title - a sensical title for a metric. It will be displayed as a title of your block.
    • Description - short description of your block.
  • Visualization
    • Renderer - defines a view, in which data will be presented. There are two possible values:
      • Single Value - in this mode, only the first selected data field will be displayed.
      • Table - in this mode multiple fields can be displayed.

        Note

        Renderer also governs Metrics and Reports sections visibility.
  • Metrics - defines data, used for calculations in current block. This section is shown when Single Value renderer is selected.
    • Data Source - application, from which data should be extracted. For now, it's only Mirasvit Reports.
    • Data - one or more fields (columns), which should be gathered and displayed. They will be explained below.
  • Reports - defines a report, which acts as a base for the current block. This section is shown when the Table renderer is selected.
    • Report - defines, which exactly Advanced shall be used.
    • Columns - allows you to select which columns should be displayed. It does not affect Conditions - since they applied before the block is rendered.

      Note

      In this field can be selected only columns, set as Active in corresponding Report. Read more about it here.
  • Time Range
    • Override Dashboard Time - by enabling this option, you can fix your block on a specific period. Otherwise, data on your block will be displayed according to the date range selected for the current Dashboard.

      Note

      Blocks with overridden time ranges are marked with special icon at the upper-right corner.
    • Range - is a hidden field that appears only when Override Time mode is used. It allows you to pick up a range for which block should display data.
    • Compare To - is a hidden field, which appears only when Override Time mode is used. It allows you to pick up a range, which shall be used for comparison.
  • Filter - allows you to filter raw data, used by this block, with one or more filters. Read more about it below.

Depending on Renderer parameter, you can also set additional visualization options.

If Renderer is Single Value, two possible visualization option available:

  • Gauge - is the speedometer-like arc, which can be used for indicating dangerous levels (for example, refund amount). It has the following additional parameters:
    • Is Active - activates additional Gauge visualization.
    • Min - minimal value (left "green" bound of arc).
    • Max - maximum value (right "red" bound of arc)
  • Spark Line - is the curve line chart, which displays the dynamics of the selected value by dates. If you had selected Compare To option in Time Range section, there would be two curve outlines - one for current data, and second for comparison.
    • Is Active - activates additional Spark Line visualization.

Selecting Metrics Data

The selection of Metrics data is a little tricky. Field Data in Metrics Edit Pane contains all available fields in the selected category. There are the following Categories:

  • Orders - allows you to analyze orders.
  • Order Items - allows you to analyze products that were bought by customers.
  • Order Payments - completed payments
  • Order Transactions - transactions (e. q. all actions, such as invoicing or shipping), which performed on your orders.
  • Taxes - extracted taxes for all actually paid orders
  • Order Addresses - addresses that used as billing or shipping in orders.
  • Quotes - quotes, created by customers (includes abandoned).
  • Quote Items - products that a customer placed to the quote.
  • Invoices - invoices, created for your orders.
  • Postcodes - postal codes, used in billing and shipping addresses (used, for example, determining country ship disperse).
  • Customers - your customers.
  • Customer Addresses - addresses, that customers are using in their accounts.
  • Products - your products.
  • Categories - categories, where at least one product is assigned.

Each this category contains a number of fields. There are four types of them:

  • Numerical fields - can be used "as is", for example, IDs. There are two additional subtypes of numerical fields:
    • Total [Field] - calculates total value of the entire column.
    • Average [Field] - calculates the average value of the entire column.
  • Group of [Field] - non-numerical field that can be used as a filter.

Combine them to create a query, and the block will display the result with an automatic date clip.

Note

You can combine fields from different categories - but for some reports, some fields will return empty data. For example, categories Orders, Customers, Order Items are compatible, while Products and Customers are not.

We recommend to use fields from the same Category - it is enough for most reports.

Example

If you need to calculate the average total of all orders, and split they on status, you will need to select in Data two fields from category Order:

  • Group of Status
  • Average Subtotal Metrics Selection

Properly configured, our dashboards should look, as in our demo:

  • Daily View dashboard

    Daily View dashboard

  • All in One dashboard

    All in One dashboard

Filtering Data

Each block contains a Filter section, available both at the creation stage and on block editing. It is a table, which contains zero or more conditions applied to general data. selected at Metrics section.

Dashboard Filter

Each condition is represented by row with the following properties:

  • Column - a raw data column, which is used for filtering. It can differ depending on Metrics data but currently offer only numeric and text columns.
  • Operator - is the comparison type. There are the following comparison operators available:
    • Equal To and Not Equal To
    • Greater Than and Lesser Than
    • Equals of Greater Than and Equals of Lesser Than
    • Is One Of and Is Not One Of
  • Value - is the value, to which eligible raw data should fit. This field is text-based, so if you wish to use Is One of operator, values shall be comma-separated.
  • Action - contains a button for removing condition.

If Table was used as Renderer (in Visualization section), filter section also will feature three additional fields:

  • Sort By - selects, which column shall be used for sorting.
  • Sort Direction - defines, whether sorting should be ASC or DESC.
  • Limit - defines how many rows should be displayed in the block.

Note

Warning: If you had selected more than one condition, data shall fit them all like they were combined with AND operator.

Adding Blocks to Dashboard

After a Dashboard is created, you need to add blocks there. Open your newly-created Dashboard, and press the View Mode button, which is located in the right end of title ribbon: Dashboard Menu It will bring you to the Blocks Configuration mode, as shown below: Dashboard Edit

To add a block, press the Add Block button on the title ribbon. It will create an empty block rectangle, as you can see on the screenshot above.

This block has four buttons on its bottom pane:

  • Move - allows you to move a block visually on the marked zone. You can also resize the block if you wish - just drag and drop its right-bottom corner.
  • Settings - allows you to select data, which will be displayed on that block (read more below).
  • Refresh - allows you to preview (or refresh) previewed data in the Edit Mode.

    Note

    By default, each block is reloaded once a minute to ensure that the dashboard always contains up-to-date data
  • Delete - removes block.

You can add to the block, either statistical data or tables. Press Settings button (second on the block button pane), and you will see Metrics Edit Panel:

Metrics

As you see above, it contains the following fields:

  • General Settings
    • Title - a sensical title for a metric. It will be displayed as a title of your block.
    • Description - short description of your block.
  • Visualization
    • Renderer - defines a view, in which data will be presented. There are two possible values:
      • Single Value - in this mode, only the first selected data field will be displayed.
      • Table - in this mode multiple fields can be displayed.

        Note

        Renderer also governs Metrics and Reports sections visibility.
  • Metrics - defines data, used for calculations in current block. This section is shown when Single Value renderer is selected.
    • Data Source - application, from which data should be extracted. For now, it's only Mirasvit Reports.
    • Data - one or more fields (columns), which should be gathered and displayed. They will be explained below.
  • Reports - defines a report, which acts as a base for the current block. This section is shown when the Table renderer is selected.
    • Report - defines, which exactly Advanced shall be used.
    • Columns - allows you to select which columns should be displayed. It does not affect Conditions - since they applied before the block is rendered.

      Note

      In this field can be selected only columns, set as Active in corresponding Report. Read more about it here.
  • Time Range
    • Override Dashboard Time - by enabling this option, you can fix your block on a specific period. Otherwise, data on your block will be displayed according to the date range selected for the current Dashboard.

      Note

      Blocks with overridden time ranges are marked with special icon at the upper-right corner.
    • Range - is a hidden field that appears only when Override Time mode is used. It allows you to pick up a range for which block should display data.
    • Compare To - is a hidden field, which appears only when Override Time mode is used. It allows you to pick up a range, which shall be used for comparison.
  • Filter - allows you to filter raw data, used by this block, with one or more filters. Read more about it below.

Depending on Renderer parameter, you can also set additional visualization options.

If Renderer is Single Value, two possible visualization option available:

  • Gauge - is the speedometer-like arc, which can be used for indicating dangerous levels (for example, refund amount). It has the following additional parameters:
    • Is Active - activates additional Gauge visualization.
    • Min - minimal value (left "green" bound of arc).
    • Max - maximum value (right "red" bound of arc)
  • Spark Line - is the curve line chart, which displays the dynamics of the selected value by dates. If you had selected Compare To option in Time Range section, there would be two curve outlines - one for current data, and second for comparison.
    • Is Active - activates additional Spark Line visualization.

Selecting Metrics Data

The selection of Metrics data is a little tricky. Field Data in Metrics Edit Pane contains all available fields in the selected category. There are the following Categories:

  • Orders - allows you to analyze orders.
  • Order Items - allows you to analyze products that were bought by customers.
  • Order Payments - completed payments
  • Order Transactions - transactions (e. q. all actions, such as invoicing or shipping), which performed on your orders.
  • Taxes - extracted taxes for all actually paid orders
  • Order Addresses - addresses that used as billing or shipping in orders.
  • Quotes - quotes, created by customers (includes abandoned).
  • Quote Items - products that a customer placed to the quote.
  • Invoices - invoices, created for your orders.
  • Postcodes - postal codes, used in billing and shipping addresses (used, for example, determining country ship disperse).
  • Customers - your customers.
  • Customer Addresses - addresses, that customers are using in their accounts.
  • Products - your products.
  • Categories - categories, where at least one product is assigned.

Each this category contains a number of fields. There are four types of them:

  • Numerical fields - can be used "as is", for example, IDs. There are two additional subtypes of numerical fields:
    • Total [Field] - calculates total value of the entire column.
    • Average [Field] - calculates the average value of the entire column.
  • Group of [Field] - non-numerical field that can be used as a filter.

Combine them to create a query, and the block will display the result with an automatic date clip.

Note

You can combine fields from different categories - but for some reports, some fields will return empty data. For example, categories Orders, Customers, Order Items are compatible, while Products and Customers are not.

We recommend to use fields from the same Category - it is enough for most reports.

Example

If you need to calculate the average total of all orders, and split they on status, you will need to select in Data two fields from category Order:

  • Group of Status
  • Average Subtotal Metrics Selection

Properly configured, our dashboards should look, as in our demo:

  • Daily View dashboard

    Daily View dashboard

  • All in One dashboard

    All in One dashboard

Filtering Data

Each block contains a Filter section, available both at the creation stage and on block editing. It is a table, which contains zero or more conditions applied to general data. selected at Metrics section.

Dashboard Filter

Each condition is represented by row with the following properties:

  • Column - a raw data column, which is used for filtering. It can differ depending on Metrics data but currently offer only numeric and text columns.
  • Operator - is the comparison type. There are the following comparison operators available:
    • Equal To and Not Equal To
    • Greater Than and Lesser Than
    • Equals of Greater Than and Equals of Lesser Than
    • Is One Of and Is Not One Of
  • Value - is the value, to which eligible raw data should fit. This field is text-based, so if you wish to use Is One of operator, values shall be comma-separated.
  • Action - contains a button for removing condition.

If Table was used as Renderer (in Visualization section), filter section also will feature three additional fields:

  • Sort By - selects, which column shall be used for sorting.
  • Sort Direction - defines, whether sorting should be ASC or DESC.
  • Limit - defines how many rows should be displayed in the block.

Note

Warning: If you had selected more than one condition, data shall fit them all like they were combined with AND operator.

Adding Blocks to Dashboard

After a Dashboard is created, you need to add blocks there. Open your newly-created Dashboard, and press the View Mode button, which is located in the right end of title ribbon: Dashboard Menu It will bring you to the Blocks Configuration mode, as shown below: Dashboard Edit

To add a block, press the Add Block button on the title ribbon. It will create an empty block rectangle, as you can see on the screenshot above.

This block has four buttons on its bottom pane:

  • Move - allows you to move a block visually on the marked zone. You can also resize the block if you wish - just drag and drop its right-bottom corner.
  • Settings - allows you to select data, which will be displayed on that block (read more below).
  • Refresh - allows you to preview (or refresh) previewed data in the Edit Mode.

    Note

    By default, each block is reloaded once a minute to ensure that the dashboard always contains up-to-date data
  • Delete - removes block.

You can add to the block, either statistical data or tables. Press Settings button (second on the block button pane), and you will see Metrics Edit Panel:

Metrics

As you see above, it contains the following fields:

  • General Settings
    • Title - a sensical title for a metric. It will be displayed as a title of your block.
    • Description - short description of your block.
  • Visualization
    • Renderer - defines a view, in which data will be presented. There are two possible values:
      • Single Value - in this mode, only the first selected data field will be displayed.
      • Table - in this mode multiple fields can be displayed.

        Note

        Renderer also governs Metrics and Reports sections visibility.
  • Metrics - defines data, used for calculations in current block. This section is shown when Single Value renderer is selected.
    • Data Source - application, from which data should be extracted. For now, it's only Mirasvit Reports.
    • Data - one or more fields (columns), which should be gathered and displayed. They will be explained below.
  • Reports - defines a report, which acts as a base for the current block. This section is shown when the Table renderer is selected.
    • Report - defines, which exactly Advanced shall be used.
    • Columns - allows you to select which columns should be displayed. It does not affect Conditions - since they applied before the block is rendered.

      Note

      In this field can be selected only columns, set as Active in corresponding Report. Read more about it here.
  • Time Range
    • Override Dashboard Time - by enabling this option, you can fix your block on a specific period. Otherwise, data on your block will be displayed according to the date range selected for the current Dashboard.

      Note

      Blocks with overridden time ranges are marked with special icon at the upper-right corner.
    • Range - is a hidden field that appears only when Override Time mode is used. It allows you to pick up a range for which block should display data.
    • Compare To - is a hidden field, which appears only when Override Time mode is used. It allows you to pick up a range, which shall be used for comparison.
  • Filter - allows you to filter raw data, used by this block, with one or more filters. Read more about it below.

Depending on Renderer parameter, you can also set additional visualization options.

If Renderer is Single Value, two possible visualization option available:

  • Gauge - is the speedometer-like arc, which can be used for indicating dangerous levels (for example, refund amount). It has the following additional parameters:
    • Is Active - activates additional Gauge visualization.
    • Min - minimal value (left "green" bound of arc).
    • Max - maximum value (right "red" bound of arc)
  • Spark Line - is the curve line chart, which displays the dynamics of the selected value by dates. If you had selected Compare To option in Time Range section, there would be two curve outlines - one for current data, and second for comparison.
    • Is Active - activates additional Spark Line visualization.

Selecting Metrics Data

The selection of Metrics data is a little tricky. Field Data in Metrics Edit Pane contains all available fields in the selected category. There are the following Categories:

  • Orders - allows you to analyze orders.
  • Order Items - allows you to analyze products that were bought by customers.
  • Order Payments - completed payments
  • Order Transactions - transactions (e. q. all actions, such as invoicing or shipping), which performed on your orders.
  • Taxes - extracted taxes for all actually paid orders
  • Order Addresses - addresses that used as billing or shipping in orders.
  • Quotes - quotes, created by customers (includes abandoned).
  • Quote Items - products that a customer placed to the quote.
  • Invoices - invoices, created for your orders.
  • Postcodes - postal codes, used in billing and shipping addresses (used, for example, determining country ship disperse).
  • Customers - your customers.
  • Customer Addresses - addresses, that customers are using in their accounts.
  • Products - your products.
  • Categories - categories, where at least one product is assigned.

Each this category contains a number of fields. There are four types of them:

  • Numerical fields - can be used "as is", for example, IDs. There are two additional subtypes of numerical fields:
    • Total [Field] - calculates total value of the entire column.
    • Average [Field] - calculates the average value of the entire column.
  • Group of [Field] - non-numerical field that can be used as a filter.

Combine them to create a query, and the block will display the result with an automatic date clip.

Note

You can combine fields from different categories - but for some reports, some fields will return empty data. For example, categories Orders, Customers, Order Items are compatible, while Products and Customers are not.

We recommend to use fields from the same Category - it is enough for most reports.

Example

If you need to calculate the average total of all orders, and split they on status, you will need to select in Data two fields from category Order:

  • Group of Status
  • Average Subtotal Metrics Selection

Properly configured, our dashboards should look, as in our demo:

  • Daily View dashboard

    Daily View dashboard

  • All in One dashboard

    All in One dashboard

Filtering Data

Each block contains a Filter section, available both at the creation stage and on block editing. It is a table, which contains zero or more conditions applied to general data. selected at Metrics section.

Dashboard Filter

Each condition is represented by row with the following properties:

  • Column - a raw data column, which is used for filtering. It can differ depending on Metrics data but currently offer only numeric and text columns.
  • Operator - is the comparison type. There are the following comparison operators available:
    • Equal To and Not Equal To
    • Greater Than and Lesser Than
    • Equals of Greater Than and Equals of Lesser Than
    • Is One Of and Is Not One Of
  • Value - is the value, to which eligible raw data should fit. This field is text-based, so if you wish to use Is One of operator, values shall be comma-separated.
  • Action - contains a button for removing condition.

If Table was used as Renderer (in Visualization section), filter section also will feature three additional fields:

  • Sort By - selects, which column shall be used for sorting.
  • Sort Direction - defines, whether sorting should be ASC or DESC.
  • Limit - defines how many rows should be displayed in the block.

Note

Warning: If you had selected more than one condition, data shall fit them all like they were combined with AND operator.

Email Notifications

Our Advanced Reports extension allows you to create rich reports and send them via email as annual documents.

You can create such an email-based report from Reports -> Advanced Reports -> Email Notifications.

How to Create Email Notification

Jump to Reports -> Advanced Reports -> Email Notifications and press theAdd New Email button.

You will be led to the Email Report creation page, which is divided into two subsections:

General information contains basic information about the sending of Email Report:

  • Title - an internal title of an Email Report.
  • Status - whether the Email Notification is active and should be sent.
  • Subject - a topic for the email, which encloses your Reports.
  • Recipient - comma-separated emails of persons who should receive these Reports.
  • Schedule - text-based schedule for sending messages. It uses converted Cron notation.

    A useful manual on it can be found here.

    Example

    Send Email Report at 23:59 every day:

    Enter Text: '''23:59 every day```

    The real schedule is behind it: '''59 23 *```

Body contains one or more rows, each containing a block with extracted and processed data about your store's work.

Each row has the following parameters:

  • Block - this is the name given to the Report or Dashboard block which contains data collection.
  • Date Interval - you can use this field to override the default block data range and force the collection of data for a certain period. Leave empty if you need to insert a report or a block.
  • Rows limit - limits records that are processed while collecting data. It is used primarily to resolve performance issues (for example, having too much data to process at once can make emails get stuck while sending). Leave this section empty to process all data

The body can contain any number of Reports or Dashboard blocks. Therefore, you can automate your reports in a single email.

Report Builder

Report Builder is a unique tool that allows you to modify existing reports or create your reports and even define dynamic columns.

It consists of two different components:

  • Report Builder - this allows you to define Reports.
  • Config Builder - this allows you to add new dynamic columns with complex calculations.

Building Reports

Report Builder is only enabled for certain custom reports. Before modifying or creating a new report, you need to clone an existing report as a wireframe.

You can edit a previously copied Report just by clicking Edit Report in the dropdown menu.

Report builder menu

Proceed now to the Quick Guide. You can also check Short FAQ on the most commonly arising issues.

Quick Guide for creating Report with Report Builder

Visit any copied or custom report and press Edit Report in the dropdown menu. You will see a popup as shown in the screenshot below:

Report builder

To create a custom report or modify an existing one, you will need at least dimensions and columns.

  • Dimensions - a list of columns (or one column) made to group data in the report (which can be by Date, Customer Group, Order, SKU, etc.)
  • Columns - a list of columns for the grid

After saving, the report will be available in the top menu, section Reports -> Advanced Reports.

Aggregators

SUM - exports summary values. For example, the total aggregated SUM is added to a report, which will then display the summary value of grand totals from all orders for the specified day.

AVG - represents the 'average,' and will be displayed as the summary value divided by the number of aggregate items.

COUNT - used for orders. It will show the number of aggregated items, e.g the number of orders placed on a specified day.

VALUE - shows the exact value of a field. Don't aggregate data by this column. Otherwise, it will produce unintended results.

JOIN - will show an aggregated number of items separated by a comma, e.g. the number of orders made.

Short FAQ

  • How can I add a product attribute to my report?

    The attributes are located under the table catalog_product_entity. Thus, to add an attribute, select the table catalog_product_entity under Tables, then in the Columns search for the required attribute, choose it, and paste it in the Default Columns.

  • Report Totals not shown

    Please note that the total is shown only for columns with the suffixes __sum, __avg, __concat, and only for relations of type 11 or 1n.

Synthetic Columns Config Builder

Sometimes for a Report, you need a special column that can be calculated from existing fields.

Our extension provides you with a Config Builder. It is a tool which allows you to define the so-called Synthetic Fields. They will be added to the Database View section and act like a normal column while actually being calculated on-the-fly.

It is located at Reports -> Config Builder and has a similar menu interface, as that in the Report Builder - divided into two columns. Config Grid is displayed here, which also lists all the defined synthetic fields.

Quick Summary:

How to create a Synthetic Field Column Config

Open either the Report Builder or Config Builder menu, and select the Add New Config action on the right menu section. You will be brought to the Config Workspace:

Config

It is very simple and contains the following fields:

  • Title - the new synthetic field's name (named whatever you wish).
  • XML Config - column definition as XML document.

Example

Quick Example of Synthetic Field Config It defines a new synthetic field which calculates the Gross Profit on-the-fly based on the actual invoiced orders.

<config>
    <table name="sales_order" group="Sales" label="Orders">
        <column name="custom_gross_profit" label="Custom Gross Profit"
                fields="base_subtotal_invoiced,base_total_invoiced_cost,base_total_refunded,base_to_global_rate" type="money"
                expr="(%1 - IFNULL(%2, 0) - IFNULL(%3, 0)) * %4" />
    </table>
</config>

Here is how this config is built:

  • config - is the document element, e. g. all other tags should be contained inside it.
  • table - defines a table in which the new synthetic field should be added
    • name - name of that table, which should be given without your table prefix. This means that if you have in your database a prefix likemage_ and real table name mage_sales_order, you need to enter here just sales_order.
    • group - name of a group, under which this table appears in the Report Builder. Default values: Sales, Products, Customers, Categories, Other. Tables without an explicitly set group will fall into the Other group.
    • label - the label on a table that is used in identifying a table.
  • column - defines how a column should be calculated
    • name - the unique name of the column, MySQL-compatible.
    • label - the name that will be displayed on the Report.
    • type - data type that will display its value. The supported types are: money, country, date, qty, number, select, percent, store, str.
    • fields - a comma-separated list of fields, which will be used in calculations.
    • expr - this attribute contains MySQL expression to calculate field value. You can use placeholders, where %1 corresponds to the first field in previous attribute, %2 - to second and so on.
    • options - non-mandatory attribute where the data type select or country is used. Here you need to enter either the full name or the class which implements method toOptionArray for this column.

After config is created, your column custom_gross_profit will appear in the field Columns in the corresponding section of Database View Pane of Report Builder.

How to adjust relations between tables

The module should determine how to link different tables to build reports from multiple tables.
The connection between two or more tables is called a table relationship.
Using the config builder, you can explicitly set the type of relation the module should use in order to connect two tables.
Below is an example of building a relationship between sales_order and sales_order_item tables.

Example

    <config>
        <relation name="sales_order-sales_order_item" type="1n">
        <leftTable>sales_order_item</leftTable>
        <rightTable>sales_order</rightTable>
        <condition>%2.entity_id=%1.order_id AND %1.parent_item_id IS NULL</condition>
      </relation>
    </config>

Troubleshoot

This section describes the most common problems that customers report and how they can be resolved:

I do not want the Advanced Dashboard to be the default startup page

After installing the module, the Advanced Dashboard page will become a default startup page at the admin panel area.

Solution:

You need to change the startup page in the admin panel settings.
For this, navigate to the Stores > Settings > Configuration > Advanced > Admin and change the startup page. For more information, please refer to the official Magento documentation.

No valid keys error

The error No valid keys may appear in the logs or the cron_schedule table as a message for the job_code reports_postcode_update.
Our module, Mirasvit Reports, uses the Google Maps API to download detailed information about the postcodes specified in the orders, so as to make it possible to view the "Sales by Geo-data" report.
This process is executed once each hour and only by cron (in the background).

To access the Google Maps API, we provide keys with the extension. The keys have a daily quote, and once the quote has expired, our module shows this message. This ensures that it does not make an error, but simply reports that today's quote for the keys has expired and will be restored tomorrow.
So you can ignore this error.

How can I translate columns' labels?

The columns' titles are created dynamically, based on the name of the table's field in your database. To translate them, you need to use the column name:
"Orders","Orders"

Some of the names do not contain the "Total" or "Average" keywords, so you should translate them without "Total" or "Average" keywords (columns with aggregator sum and avg correspondingly).
To translate "Total" and "Average" keywords, you can use the following strings:
"Average %1", "Average %1"
"Total %1", "Total %1"

My state, province or other location is not highlighted on a map in the Sales by Geo-data report

In some cases, a row showing a particular country's state (province or other regional district) is displayed in a report grid. However, the corresponding part of the map is not highlighted.

Solution:

In its documentation, Google states that a region code should be written in uppercase ISO-3166-2 compliant format. For example, for Germany, to highlight the state, we can use either its Subdivision Name (Bayern) or a corresponding Code (DE-BY).

For states, our module uses the subdivision names. However, the practice shows that not all correctly formed subdivision names are always visible on a map. If that is true to you, you need to use the appropriate Code instead.

To change the subdivision name to code, you can use the Magento translation mechanism. You can place the string below to your theme's translation file (in admin panel):
"Bayern", "DE-BY"

Then clean the translation cache php bin/magento cache:clean translate and refresh it.

How to upgrade the extension

To upgrade the extension, take the following steps:

  1. Back up your store's database and web directory.
  2. Log in to your server's SSH console and navigate to the root directory of the Magento 2 store.
  3. Update the current extension with all its dependencies:
        composer require mirasvit/module-reports:* --update-with-dependencies

    Note

    In some cases, the command above may not be applicable, or you might not be able to update just the current module, and need to upgrade all the Mirasvit modules in a bundle. In this case, the command above will be of no effect.

    Instead, run the composer update mirasvit/* command. It will update all Mirasvit modules installed in your store.

  4. Update the extension:

        php -f bin/magento setup:upgrade
  5. Clean the cache

        php -f bin/magento cache:clean
  6. Deploy static view files
        rm -rf pub/static/*     
        rm -rf var/view_preprocessed/*  
        php -f bin/magento setup:static-content:deploy

Disabling Extension

Temporarily Disable

To temporarily disable the extension, please take the following steps:

  1. Log in to your server's SSH console and navigate to the root directory of the Magento 2 store.
  2. Disable the extension:
        php  -f  bin/magento  module:disable  Mirasvit_Report  Mirasvit_Reports  Mirasvit_Dashboard

    Note

    Always be sure to check when the other Mirasvit modules can build reports. If you have such modules, please use this command:

        php  -f  bin/magento  module:disable  Mirasvit_Reports  Mirasvit_Dashboard
  3. Log in to the Magento backend and refresh the store's cache (if enabled).

Extension Removal

To uninstall the extension, please take the following steps:

  1. Log in to your server's SSH console and navigate to the root directory of the Magento 2 store.
  2. Remove the extension:
        composer remove mirasvit/module-reports
  3. Log in to the Magento backend and refresh the store's cache (if enabled).

Change Log

1.3.39

(2020-10-23)

Improvements

  • Code improvements

1.3.38

(2020-10-15)

Improvements

  • Code improvements

1.3.37

(2020-10-07)

Improvements

  • Added global filter by order status
  • added column aggregators description

1.3.36

(2020-08-13)

Fixed

  • Magento 2.4.0 compatibility


1.3.35

(2020-07-29)

Improvements

  • Support of Magento 2.4

Fixed

  • Test for reports with filters in email notifications

1.3.34

(2020-05-28)

Improvement

  • Was changed menu structure according to the Magento development guidelines

1.3.33

(2020-04-06)

Fixed

  • Issue with attachments in the Email Notifications for Magento 2.2.7 and older

1.3.32

(2020-03-03)

Improvements

  • Code improvements

1.3.31

(2019-04-04)

Improvements

  • GEO Chart

1.3.30

(2019-03-01)

Improvements

  • Minor changes

1.3.29

(2019-01-25)

Improvements

  • Sales Order Item Strategy

1.3.27

(2018-12-20)

Fixed

  • Email Reports

1.3.25

(2018-11-29)

Improvements

  • Major changes in UI

Fixed

  • Compatibility with Magento 2.3

1.3.24

(2018-10-26)

Fixed

  • 'This report no longer exists' error after saving report settings

1.3.23

(2018-10-12)

Fixed

  • Sales by attribute shows zero totals for some attributes

Documentation

  • new table attribute 'group'

1.3.22

(2018-10-02)

Fixed

  • Catalog Attribute report shows wrong values (affects since 1.3.21)

1.3.21

(2018-09-28)

Fixed

  • Sales by Attribute report shows 0 for simple items grouped by configurable attributes
  • Do not display 'View Customer' action in Abandoned Carts report for records without registered customer

1.3.20

(2018-09-17)

Fixed

  • Abandoned Products report does not properly show data

1.3.19

(2018-09-04)

Improvements

  • Add order increment IDs column to product detailed report
  • Add Order Payment columns to Sales Overview report

Fixed

  • Show number of unknown postcodes in community edition
  • Correct link to mst_report.xml schema validation file

Documentation

  • How to create Low Stock report, widget and email notification

1.3.18

(2018-08-13)

Improvements

  • Add order items columns to Product Performance report
  • Use shipping address state for Geo report as the fallback, if state has not been downloaded

Documentation

  • Troubleshoot for case when region part is not highlighted on a map in the Sales by Geo-data report

1.3.17

(2018-08-10)

Improvements

  • Do not log 'No valid keys' error
  • Use free daily quote instead of keys for downloading info about unknown postcodes

Documentation

  • How to build table relationship using Config Builder tool
  • How to translate column's names

1.3.16

(2018-08-03)

Improvements

  • Add Order Item columns to Sales reports

Documentation

  • No valid keys troubleshoot

1.3.15

(2018-07-27)

Fixed

  • Product Performance detailed report does not filter by selected product

1.3.14

(2018-07-24)

Fixed

  • Update API codes for fetching geodata and update unknown post codes

1.3.13

(2018-07-19)

Improvements

  • Add customer group filter to Product Performance report

Fixed

  • Report emails sent multiple times

1.3.12

(2018-07-13)

Fixed

  • Report New vs Returning Customers: treat guest customers as new

Documentation

  • Change admin panel startup page

1.3.11

(2018-07-02)

Improvements

  • Add order status filter to Sales by Category and Sales by Attribute reports

1.3.10

(2018-06-21)

Fixed

  • Correctly display 'Total Cost' value at Product Performance report

1.3.9

(2018-06-19)

Fixed

  • Report Sales by Geo-data is not filtered by date

1.3.8

(2018-06-19)

Improvements

  • ACL permissions for report settings

1.3.7

(2018-06-06)

Improvements

  • Add Payment Method filter to Sales Overview report

Documentation

  • Information about totals in custom reports
  • How to add attribute column to custom report with Report Builder

1.3.6

(2018-06-04)

Fixed

  • Issue with Total Cost
  • Issue with filtration by store view
  • Postcodes

1.3.5

(2018-04-25)

Improvements

  • Additional columns for Sales Overview and Sales by Attribute reports

1.3.4

(2018-04-17)

Fixed

  • Error displaying abandoned cart detailed report

1.3.3

(2018-04-17)

Fixed

  • Error during compilation: remove extra dependency
  • Compatibility with Magento 2.1

1.3.2

(2018-04-05)

Fixed

  • Detailed product report opened from Product Performance report does not display information for specific product

1.3.1

(2018-02-16)

Features

  • Report Builder

Documentation

  • Report Builder documentation

1.3.0

(2018-02-09)

Improvements

  • Geo Report

Fixed

  • Report Sales By Customer
  • Added Managing of Geo Data menu item

1.1.35

(2017-12-07)

Improvements

  • Added filters by "Customer Group", "Order Status", "Day of Week of purchase" to "Sales by Attribute" and "Sales by Attribute Set" reports

1.1.34

(2017-12-07)

Fixed

  • filters by "Customers > Products" and "Abandoned Carts > Abandoned Products" columns

1.1.33

(2017-12-06)

Fixed

  • Filter by "Products" column

1.1.32

(2017-12-04)

Improvements

  • Added "Product Total Margin" field

1.1.31

(2017-12-04)

Fixed

  • API urls for post codes
  • Added "mirasvit:reports:test" console command

1.1.30

(2017-11-13)

Features

  • Added "Customers" report

1.1.29

(2017-10-26)

Fixed

  • Updated connection for quote tables

Improvements

  • Added "Tax Title", "Tax Percent" to Orders report

1.1.28

(2017-10-24)

Features

  • Added "Sales by Attribute Set" report

1.1.27

(2017-10-17)

Improvements

  • Added column "Gross Margin" to "Product Performance" report

1.1.26

(2017-10-17)


1.1.25

(2017-10-17)

Improvements

  • Added column "Invoice ID" to Sales > Orders report
  • Added "Grand Total excluding Tax" column to the Sales reports

1.1.24

(2017-10-02)


1.1.23

(2017-09-27)

Fixed

  • Compatibility with Magento 2.2

1.1.22

(2017-09-18)

Fixed

  • Fix cron error 'undefined property' when executing 'reports_postcode_update' cron job
  • Compatibility with Magento 2.2.0rc

1.1.21

(2017-08-22)

Improvements

  • Added Transaction ID and Type to Orders report
  • Added "customer group" column to Abandoned Cart reports

Fixed

  • Fixed the hints for quarters when building a quarterly report.
  • Fixed the issue with duplication in "Qty Refunded" column
  • Corrected the calculation of the "out of stock estimate" for the case of a negative quantity of product in inventory

1.1.20

(2017-08-07)

Features

  • Added "Abandoned Products" report
  • Added "Abandoned Prodacts / Detail" report

Improvements

  • Added chart to "Product Performance Detail" report

1.1.19

(2017-08-02)

Fixed

  • Fixed accounting of "active" abandoned carts

1.1.18

(2017-08-02)

Fixed

  • Fixed requirements for compatibility with the mirasvit/module-report

1.1.17

(2017-08-02)

Features

  • Added "Abandoned Carts Overview" report
  • Added "Abandoned Carts" report

Improvements

  • Improved reports menu view

1.1.16

(2017-08-01)

Features

  • Added "Sales by Cart Price Rules" report
  • Added "Sales by Tax Rates" report

Improvements

  • Added ability to view the sold products from "Sales Overview" report

1.1.15

(2017-07-11)

Improvements

  • Added column "QTY refunded" to Sales Overview report

1.1.14

(2017-07-11)

Improvements

  • Added 2 columns "Out of Stock Estimation Date" and "Stock Qty"

1.1.13

(2017-07-11)

Improvements

  • New Charts

1.1.12

(2017-06-27)

Features

  • Modified the method of using Google geocoding

1.1.11

(2017-06-21)

Improvements

  • Refactoring

1.1.10

(2017-06-15)

Fixed

  • Fixed an issue with default filter in "Sales by Attribute" and "Sales by Category" reports

1.1.9

(2017-06-08)

Fixed

  • An issue with DaysOfWeek column

1.1.8

(2017-06-07)

Improvements

  • Removed global limitation by order status

1.1.7

(2017-05-31)

Fixed

  • Issue with duplication at "Product Performance" report

1.1.6

(2017-05-30)

Features

  • Added filters to Manage Geo Data Grid

1.1.5

(2017-05-30)

Fixed

  • Issue with geo redeclaration default UI

1.1.4

(2017-05-29)

Features

  • Added possibility to delete Geo data from admin panel

Fixed

  • Fixed an issue of obtaining and duplication of Geo data in different languages

1.1.2

(2017-05-17)

Fixed

  • Fixed Email Notification ACL

1.1.1

(2017-05-04)

Fixed

  • Fixed the issue with Gross Profit in the case when the cost of product is not defined
  • Fixed issue with cron job with Email Notifications

1.1.0

(2017-02-20)

Fixed

  • Pool and dateHelper at email notification
  • Pool at email notification

1.0.19

(2017-01-09)

Improvements

  • Ability to filter by order status
  • GEO

1.0.18.1

(2016-12-23)

Fixed

  • Fixed an issue with cronjob

1.0.18

(2016-12-22)

Improvements

  • Improved geo-data fetching logic

1.0.17

(2016-12-15)

Improvements

  • Base geo reports

Fixed

  • Fixed an issue with date ranges

1.0.16

(2016-09-20)


1.0.14

(2016-07-28)

Fixed

  • Fixed an issue with report Product Performance - Detail

1.0.13

(2016-07-27)

Fixed

  • Fixed an issue with wrong product cost calculations

1.0.12

(2016-07-01)

Fixed

  • Renamed report.xml to mreport.xml (compatibility with module-support)

1.0.11

(2016-06-24)

Fixed

  • Compatibility with Magento 2.1

Documentation

  • Updated installation instructions

1.0.9, 1.0.10

(2016-05-31)

Fixed

  • Fixed an issue with building reports based on all orders (filteration by status are missed)
  • Fixed an issue with wrong requirements

1.0.8

(2016-05-27)

Improvements

  • Added ability to filter all reports by store

1.0.7

(2016-05-25)

Fixed

  • Fixed permissions issue

1.0.6

(2016-05-19)

Improvements

  • Added Products column to Orders report

1.0.5

(2016-04-11)

Improvements

  • Integration tests
  • Refactoring

Fixed

  • Fixed an issue with menu
  • Minor fixes
  • Fixed an issue with filtration

Documentation

  • Updated installation steps

1.0.4

(2016-02-29)

Fixed

  • Fixed an issue with wrong requirejs declaration
  • Fixed an issue with percent calculation
  • Fixed an issue with applying the filters
  • Fixed an issue with di compilation
  • Removed geo export console command

1.0.3

(2016-02-02)

Improvements

  • Update required core version to 1.2