Toweringmedia Extension Docs

User Tools

Site Tools

You are here: start » magento2 » extensions » magento-2-reporting-pro
magento2:extensions:magento-2-reporting-pro

Differences

This shows you the differences between two versions of the page.

Link to this comparison view

magento2:extensions:magento-2-reporting-pro [2026/08/20 23:53] – created - external edit 127.0.0.1magento2:extensions:magento-2-reporting-pro [2026/09/16 20:21] (current) – swatwik
Line 1: Line 1:
-====== Magento 2 Reporting Pro User Guide ======+====== Magento 2 Reporting Pro ======
  
-===== Related overview =====+===== Overview =====
  
-For a shopper-friendly overview of features and setup, see the [[https://toweringmedia.com/magento-2-reporting-pro-user-guide|Magento 2 Reporting Pro User Guide - Dashboards & Customer Insights]] on the storefront. This wiki page remains the full technical documentation.+Magento 2 Reporting Pro adds a set of reporting screens to the Magento Admin for looking at sales and customer data. Instead of checking several Magento screens and putting the numbers together manually, the extension keeps the main sales, product and customer figures in one place.
  
-===== Extension context =====+The reports are useful for day-to-day checking as well as for preparing data for a client, sales team or purchasing team. Depending on the report, you can look at customers, guests, products, categories or manufacturers, apply a date range, change the columns and export the result.
  
-This is a Toweringmedia Magento 2 extension guide for the current admin extension catalog.+Customer reports also include segmentation and RFM information. This makes it possible to see not only how much a customer has purchased, but also how recently and how often they have purchased.
  
-===== Product page =====+===== Module Information =====
  
-  * [[https://toweringmedia.com/magento-2-reporting-pro|Magento 2 Reporting Pro]] (SKU ''Magento 2 Reporting Pro'')+^ Item ^ Details ^ 
 +| Composer Package | ''toweringmedia/module-reporting-pro'' | 
 +| Magento Module | ''Toweringmedia_ReportingPro'' | 
 +| Product Type | Sellable Magento 2 Extension |
  
-===== Overview =====+===== What this extension does =====
  
-Reporting Pro adds a set of customer and sales reports to Magento 2 that the stock reporting does not cover, including per-customer product history, loyalty ranking, customer segmentation, and sales by manufacturer. It also includes a custom report builder and a customer intelligence dashboard, with CSV export.+The easiest way to understand Reporting Pro is to look at the questions it helps answer:
  
-===== What this extension does =====+  * How much did the store sell during a particular period? 
 +  * Which customers are bringing in the most revenue? 
 +  * Which customers are new, returning, frequent or at risk? 
 +  * Which products and categories are selling the most? 
 +  * How are the different manufacturers performing? 
 +  * What products has a particular customer purchased? 
 +  * Which products are the top sellers for each customer? 
 +  * What is the profit and margin for a product when product cost is available?
  
-  * Top Sold Products per Customer report. +The extension also provides a Custom Report Builder for saved report definitions and export options for working with the report data outside Magento.
-  * Customer Loyalty Ranking and Customer Segment reports. +
-  * Customer Intelligence Dashboard and Customer Product Insights. +
-  * Sales by Manufacturer, Sales Detailed, Product Performance, and Category Product reports. +
-  * Custom Report Builder for ad-hoc reporting. +
-  * Export with a configurable row limit.+
  
-===== Requirements =====+===== Product page =====
  
-  * Magento 2.4.x (Open Source or Adobe Commerce). +  * [[https://toweringmedia.com/magento-2-reporting-pro|Magento 2 Reporting Pro]] (SKU: ''Magento 2 Reporting Pro'')
-  * PHP: ^8.1 || ^8.2 || ^8.3 || ^8.4 (as declared by the published package). +
-  * A current Toweringmedia license and Composer credentials for ''https://composer.toweringmedia.com/''. +
-  * Composer resolves ''toweringmedia/module-base'' automatically.+
  
 ===== Installation ===== ===== Installation =====
  
-Install and validate in a staging environment before production rollout.+Please refer to the installation guide for the installation steps:
  
-<code bash> +[[https://toweringmedia.com/installation|Installation Guide]]
-cd /path/to/magento +
-composer require toweringmedia/module-reporting-pro+
  
-bin/magento module:enable Toweringmedia_ReportingPro +===== Admin Configuration =====
-bin/magento setup:upgrade +
-bin/magento setup:di:compile +
-bin/magento setup:static-content:deploy -f +
-bin/magento cache:flush +
-</code>+
  
-Currently published versions at the time of writing:+The Reporting Pro settings can be found in the Magento Admin under:
  
-  * ''toweringmedia/module-reporting-pro'' — 1.3.4+**Stores > Configuration > Towering Media > Reporting Pro**
  
-Toweringmedia packages are served from the licensed Composer repository ''https://composer.toweringmedia.com/''. If Composer reports that the package could not be found, your credentials are missing or the license does not cover this package yet. Retrieve your keys from **My Account** on toweringmedia.com, or contact [[mailto:support@toweringmedia.com|support@toweringmedia.com]].+==== Report Data ====
  
-General installation notes that apply to every Toweringmedia extension are in the [[https://toweringmedia.com/installation|installation guide]].+There are two settings in this section. These are worth checking before using the reports on a live store.
  
-===== Configuration =====+^ Setting ^ Description ^ Example ^ 
 +| Counted Order Statuses | Select the order statuses that should be counted by the reports. Custom order statuses created in the store can be selected as well. | Complete, Closed, Pending | 
 +| Manufacturer Attribute | Enter the product attribute used for the manufacturer name. Sales by Manufacturer uses this attribute when grouping the products. | ''manufacturer'' |
  
-  * Stores > Configuration > Towering Media > **Reporting Pro** (config section ''toweringmedia_reportingpro''). +{{:magento2:extensions:reporting-pro-configuration-square.png?400|}}
-  * Groups include ''reports'' (eligible order statuses, manufacturer attribute), ''export'' (row limit), and ''customer_segmentation''. +
-  * Admin screens: Reports > **Reporting Pro by Towering Media** > Top Sold Products per Customer, Customer Loyalty Ranking, Customer Intelligence Dashboard, Custom Report Builder, Customer Segment Report, Category Product Report, Customer Product Insights, Sales by Manufacturer, Sales Detailed, Product Performance.+
  
-===== Basic usage and what to expect =====+==== Export ====
  
-  - Set the eligible order statuses first — this decides which orders count toward every report. Leaving it wrong is the most common cause of numbers that look too low. +**Maximum Rows Per Export** controls how many rows can be written to an export file.
-  - If you use Sales by Manufacturer, set the manufacturer attribute to match your catalog. +
-  - Open Reports > Reporting Pro by Towering Media and run a report over a date range you can verify against Magento's own sales report.+
  
-===== Validation checklist =====+The default value is **50000**.
  
-  * ''bin/magento module:status'' shows the module(s) as enabled. +If a store has a large amount of data, increasing this value should be done carefully because larger exports need more server resources. 
-  * Extension configuration saves without errors in Admin. + 
-  * The admin screens listed above are reachable and load without error. +==== Customer Segmentation ==== 
-  * Expected storefront/admin behavior is present after a cache flush. + 
-  * No critical PHP/JS errors appear in ''var/log/'' during the primary test flow.+The Customer Segmentation settings are used when the extension decides which segment a customer belongs to. 
 + 
 +The values should not simply be copied from one store to another. A wholesale store, for example, will normally have very different order sizes from a small retail store. 
 + 
 +^ Setting ^ Description ^ Example ^ 
 +| Corporate Category Keywords | Comma-separated category keywords used as one of the Corporate checks. | ''cookie,platter,catering,bulk'' | 
 +| Corporate Average Order Value | Average order value used as a Corporate customer check. | 1500 | 
 +| Corporate Average Units Per Order | Average units per order used as a Corporate customer check. | 40 | 
 +| Units That Make An Order Large | Number of units of one product that makes an order a large order. | 12 | 
 +| Large Orders Before Corporate | Number of large orders required for this Corporate check. | 2 | 
 +| Days of Silence Before At Risk | Number of days without an order before the customer is considered At Risk. | 90 | 
 +| Recency Score Bands (Days) | Day values used for the Recency part of the RFM score. | ''14,30,60,90'' | 
 +| Frequency Score Bands (Orders) | Order-count values used for the Frequency part of the RFM score. | ''1,3,6,12,20'' | 
 +| Monetary Score Bands (Base Currency) | Spending values used for the Monetary part of the RFM score. | ''250,750,2000,5000'' | 
 + 
 +The Magento **Use system value** option can be used where it is available. This is useful when the same setting should be inherited instead of being entered separately for every store view. 
 + 
 +{{:magento2:extensions:customer-segmentation-square.png?400|}} 
 + 
 +===== Reports Interfaces ===== 
 + 
 +The reporting screens follow a similar Magento Admin layout. Most screens have Filters, Export, Default View and Columns controls. Reports that support charts show the chart above the grid, followed by totals and the report rows. 
 + 
 +==== Customer Intelligence Dashboard ==== 
 + 
 +This is the main dashboard for a quick overview. 
 + 
 +At the top it shows: 
 + 
 +  * Revenue 
 +  * Orders 
 +  * Average Order Value 
 +  * Items Sold 
 +  * Total Customers 
 +  * New Customers 
 +  * Returning Customers 
 +  * Categories with Sales 
 + 
 +Below that are the top customers and top categories. 
 + 
 +The **Revenue and Orders** chart gives a simple view of how sales and order volume changed during the selected period. 
 + 
 +{{:magento2:extensions:customer-intelligence-dashboard-square.png?400|}} 
 + 
 +==== Custom Report Builder ==== 
 + 
 +The Custom Report Builder is where saved report definitions are listed. 
 + 
 +The screen shows the report name, grouping, number of columns and type. 
 + 
 +A new report can be created from this screen, and existing saved reports can be managed from the Action column. 
 + 
 +{{:magento2:extensions:custom-report-builder-square.png?400|}} 
 + 
 +==== Sales by Customer / Guest ==== 
 + 
 +This report is useful when you want to see sales by customer and also keep guest orders in the same report. 
 + 
 +The grid shows: 
 + 
 +  * Period 
 +  * Revenue 
 +  * Order Count 
 +  * Email 
 +  * Customer Name 
 +  * Guest indicator 
 + 
 +{{:magento2:extensions:sales-by-customer-guest-square.png?400|}} 
 + 
 +==== Customer Segment Report ==== 
 + 
 +This screen combines customer details with the segment information calculated by Reporting Pro. 
 + 
 +Along with the customer name and email, it shows: 
 + 
 +  * Segment 
 +  * Corporate flag 
 +  * RFM Score 
 +  * Order Count 
 +  * Revenue 
 +  * Quantity 
 +  * Average Order Value 
 +  * Purchase Frequency 
 +  * Days Since Last Order 
 +  * Last Order Date 
 +  * Top Category 
 + 
 +{{:magento2:extensions:customer-segment-report-square.png?400|}} 
 + 
 +==== Category Product Report ==== 
 + 
 +Category Product Report is useful for checking which products are generating sales inside each category. 
 + 
 +The report shows: 
 + 
 +  * Category 
 +  * Product 
 +  * SKU 
 +  * Revenue 
 +  * Quantity Sold 
 +  * Order Count 
 +  * Distinct Customers 
 +  * Last Order 
 + 
 +There is also a **Top 10 Categories by Revenue** chart. 
 + 
 +{{:magento2:extensions:category-product-report-square.png?400|}} 
 + 
 +==== Sales by Manufacturer ==== 
 + 
 +This report groups sales by the manufacturer attribute configured in Reporting Pro. 
 + 
 +It includes: 
 + 
 +  * Items Ordered 
 +  * Orders 
 +  * Subtotal 
 +  * Tax 
 +  * Discounts 
 +  * Total 
 +  * Invoiced 
 +  * Refunded 
 +  * Average Item Final Price 
 + 
 +The report can also show a comparison with the previous period. 
 + 
 +{{:magento2:extensions:sales-by-manufacturer-square.png?400|}} 
 + 
 +==== Sales Detailed ==== 
 + 
 +Sales Detailed is an order-level report. 
 + 
 +Select an **Order Window** first and the report returns the matching orders. 
 + 
 +The screen contains order, customer, billing, shipping, email and shipping-method information. 
 + 
 +This report is also intended for detailed exports, so it contains more order information than a normal summary report. 
 + 
 +{{:magento2:extensions:sales-detailed-square.png?400|}} 
 + 
 +==== Product Performance ==== 
 + 
 +Product Performance is the report to use when you want to compare products and their sales results. 
 + 
 +The default view can group configurable products with their variants. 
 + 
 +If individual child SKUs are required, change the **SKU View** to **Show every SKU**. 
 + 
 +Where cost has been entered for the product, the report also shows: 
 + 
 +  * Cost 
 +  * Profit 
 +  * Margin 
 + 
 +{{:magento2:extensions:product-performance-square.png?400|}} 
 + 
 +==== Customer Product Insights ==== 
 + 
 +This report starts from the customer and shows the products and categories that customer has purchased. 
 + 
 +It includes: 
 + 
 +  * Customer Segment 
 +  * Category 
 +  * Product 
 +  * Revenue 
 +  * Quantity 
 +  * Order Count 
 +  * Last Order 
 + 
 +{{:magento2:extensions:customer-product-insights-square.png?400|}} 
 + 
 +==== Top Sold Products per Customer ==== 
 + 
 +This report shows the products purchased by each customer and ranks them by sales. 
 + 
 +The grid includes: 
 + 
 +  * Quantity Sold 
 +  * Order Count 
 +  * Sales Amount 
 +  * Last Purchased Date 
 +  * Rank 
 + 
 +The **Top 10 Products by Revenue** chart provides a quick summary. 
 + 
 +{{:magento2:extensions:top-sold-products-per-customer-square.png?400|}} 
 + 
 +==== Customer Loyalty Ranking ==== 
 + 
 +Customer Loyalty Ranking gives a longer-term view of customer activity. 
 + 
 +It shows: 
 + 
 +  * Order Count 
 +  * Purchase Frequency 
 +  * Merchandise Amount 
 +  * Quantity Ordered 
 +  * First Order Date 
 +  * Last Order Date 
 +  * Days Since Last Order 
 +  * Loyalty Rank 
 + 
 +{{:magento2:extensions:customer-loyalty-ranking-square.png?400|}} 
 + 
 +===== Validation Checklist ===== 
 + 
 +After installation or an upgrade, these are the checks I would normally run before considering the extension ready on a store: 
 + 
 +  * Open **Stores > Configuration > Towering Media > Reporting Pro** and make sure the configuration is available. 
 +  * Check **Counted Order Statuses** and confirm that the required statuses are selected. 
 +  * If Sales by Manufacturer is being used, check that the **Manufacturer Attribute** is correct. 
 +  * Review the customer segmentation values instead of assuming the default values are right for the store. 
 +  * Make sure the Reporting Pro data has been built or refreshed. 
 +  * Open the dashboard and check that the KPI values and chart are loading. 
 +  * Open the main reports and try a few different date ranges and filters. 
 +  * Check both configurable grouping and **Show every SKU** in Product Performance. 
 +  * Export at least one report to CSV and one to Excel XML and compare the result with the grid. 
 +  * Run ''composer install'' and ''./bin/check'' before a release.
  
 ===== Troubleshooting ===== ===== Troubleshooting =====
  
-  * **Composer cannot find the package**: confirm the ''https://composer.toweringmedia.com/'' repository and your credentials are present in ''auth.json'', and that your license covers this package. +==== A report is empty ====
-  * **Feature not visible**: verify module status, flush cache, and redeploy static content. +
-  * **Admin setting not applying**: clear cache and confirm the config scope (default / website / store view). +
-  * **Unexpected behavior**: retest with only the required related modules enabled.+
  
-===== Support =====+First check the date range. This is the most common reason for an empty report.
  
-  * [[mailto:support@toweringmedia.com|support@toweringmedia.com]] +Then check **Counted Order Statuses** and make sure the reporting data has been built or refreshed.
-  * [[https://toweringmedia.com/magento-maintenance-support|Magento maintenance and support]]+
  
-===== Related Magento 2 docs =====+==== Dashboard numbers do not match expectations ====
  
-  * [[magento2:extensions:start|Magento 2 extension index]] +Check the date range and the counted order statuses.
-  * [[start|Global docs home]]+
  
 +Also check the comparison period selected on the dashboard.
 +
 +==== Manufacturer is blank or grouped incorrectly ====
 +
 +Check the **Manufacturer Attribute** under Reporting Pro configuration.
 +
 +The report uses the attribute configured there.
 +
 +==== Customer segments look wrong ====
 +
 +Check the segmentation thresholds.
 +
 +Corporate and At Risk decisions depend on those settings, and the RFM score bands also affect the displayed score.
 +
 +==== Product Performance shows unexpected rows ====
 +
 +Look at the **SKU View**.
 +
 +**Group by configurable** combines variants under the parent, while **Show every SKU** lists the child SKUs separately.
 +
 +==== An order is missing from Sales Detailed ====
 +
 +Check the **Order Window** and any active filters.
 +
 +Sales Detailed is based on the orders that fall inside the selected window.
 +
 +==== The export stops before all rows are included ====
 +
 +Check **Maximum Rows Per Export**.
 +
 +The configured value is a limit for the export. If you increase it, make sure the server has enough memory for a larger file.
 +
 +==== The report is not showing recent orders ====
 +
 +Check the Reporting Pro reporting data.
 +
 +The reporting screens use the extension's reporting aggregates and fact data, so those tables need to be up to date.
 +
 +==== Magento commands are required after an upgrade ====
 +
 +Follow the upgrade instructions for the installed version.
 +
 +Where the release requires it, run:
 +
 +<code bash>
 +php bin/magento setup:upgrade
 +php bin/magento setup:di:compile
 +</code>
 +
 +===== Support =====
 +
 +  * [[mailto:support@toweringmedia.com|support@toweringmedia.com]]
 +  * [[https://toweringmedia.com/magento-maintenance-support|Magento maintenance and support]]
magento2/extensions/magento-2-reporting-pro.txt · Last modified: by swatwik