Reporter for VirtueMart (a.k.a. VirtueMart Reporter) is a sales/order reporting component for VirtueMart. You can generated standard reports and custom reports for selected products, categories, order statuses, countries, users etc. It allows you easily analyse the generated reports using plots and charts. You can download the reports (CSV) for greater flexibility. You can also set scheduled tasks to automatically generate reports for any set interval and send the reports directly through emails to your desired recipients. You can also view and download inventory status reports of your store.
Installation
You can download the latest installation packages from our site's download page for Reporter for VirtueMart. If you have an older version of Joomla! or VirtueMart or PHP please check the compatibility section to find the version of Reporter for VirtueMart compatible with your Joomla!, VirtueMart and PHP versions.
All Reporter for VirtueMart installation packages contain the component and all of its associated plugins. Installing it will install all of these items automatically. It can also be used to upgrade/update Reporter for VirtueMart; just install it without uninstalling the previous release.
Uninstallation
You can uninstall the component just like any other Joomla! component. In your site's back-end, just go to Extensions Manager, click on Uninstall, select Reporter for VirtueMart Package and click on Uninstall. This will completely remove Reporter for VirtueMart Package including all plugins and database information.
Configuration
General
General/global settings of Reporter for VirtueMart component.
Date Format
Select the date format for reports.
Round Off Prices
If yes, all prices will be rounded off as per your VirtueMart Currency Settings.
Report Storage
Select storage system for the generated reports. If file, the generated reports are saved in a file. If database, the generated reports are saved in database table.
Path to Storage Folder
Please specify the folder to store reports. This is applicable for when you set Report Storage as File.
Run Scheduled Tasks
If yes, cron jobs for schedules tasks will run.
Cron Job Interval
Cron job interval in minutes. Default is 60 minutes.
CSV File Name
Name of the downloadable CSV file and of the email attachment.
Email Format
Select the format of the notification email. HTML or Plain Text.
Attach Report In Emails
If yes, CSV report file is attached in the email notifications.
Advanced
Has Shared Inventory
Enable this option only if you use Shared stock/inventory for child products. The inventory reports of child products are generated based on this setting.
Overview
Overview section displays a quick order overview for the selected order statuses and the selected time period.
Order Statuses
Filter the reports by the selected order statuses.
Time Period
Filter the reports by the desired time period. Available options are - Last Week, Last Month, Last Year, This Week, This Month, This Year and Custom - Fixed Date Range.
Start Date
This shows the start date of the reporting period.
End Date
This shows the end date of the reporting period.
Reports
This section shows you the list of previously generated. Unread reports are marked with a 'New' badge. You can view individual reports by clicking on them or download them by clicking on the Download button.
You can generate new reports by clicking on the "Generate" button located at the top left corner in the page. Simply select the desired reporting template and click on Generate button in the modal window. If you want to send email notification then enable "Send Email" and add the desired email addresses in "Send Email To" field before clicking on the generate button.
View Report
Click on the individual report to view them. You can see the report overview chart at the top portion on the page. The overview chart displays a comparative plot for order values and order counts.
You can also plot charts to analyze the individual performances of your products, categories, order statuses, payment methods and shipment methods by selecting the desired chart type from the Drop Down List displayed at above the plot area.
You find the complete list of all order items at the bottom section of the page. The displayed columns/fields can be customised from the Template settings. You can sort the list by any selected columns. You can also hide any columns if you want.
To download the report in CSV format click on the Download button displayed at the top left section in the page.
Click on the Back button to see the list of all available reports.
Templates
Templates helps you manage preset filters and displayed columns in individuals reports. You can add, edit or delete reporting templates as per your requirements.
Name
Name of the template. Give a logical and unique name to the template for easy tracking.
Email Subject
Subject of the email. If empty, name will be assigned as the email subject.
General
Time Field
Select the time field on which the time period query to be applied. If Created On, the date range is applied on order date. If Modified On, the date range is applied on order last modified date.
Time Period
Select desired time period for the report from the drop down list. Available options are - Last Week, Last Month, Last Year, This Week, This Month, This Year, Custom - Dynamic Days and Custom - Fixed Range.
Products
Generate reports only for the selected products. If blank, reports will be generated for all products.
Categories
Generate reports only for the selected categories. If blank, reports will be generated for all categories.
Manufacturers
Generate reports only for the selected manufacturers. If blank, reports will be generated for all manufacturers.
Include Child Products
If yes, child products of the selected products and of the parent products assigned to the selected categories and selected manufacturers are included in the report.
Guests Only
If yes, only orders placed by guest users will be included in the reports.
Registered Users
Generate reports only for the selected users. If blank, reports will be generated for all users.
Shopper Groups
Generate reports only for the selected shopper groups. If blank, reports will be generated for all groups.
Countries
Generate reports only for the selected countries. If blank, reports will be generated for all countries.
Shipment Countries
Generate reports only for the selected shipment countries. If blank, reports will be generated for all shipment countries.
Order Statuses
Generate reports only for the selected order statuses. If blank, reports will be generated for all order statuses.
Tax & Calculation Rules
Generate reports only for the selected tax & calculation rules. Keep it blank to disable this filter.
Fields
Here you can manage the columns or the fields that you want to see in the reports generated by this template. Select the desired fields as per your need.
Scheduled Tasks
Scheduled Tasks allows you to automatically generate and email reports at a desired interval. You can add, edit or delete these tasks from Scheduled Tasks page.
Name
Name of the scheduled task. Give a logical and unique name to the task for easy tracking.
General
Template
Select a reporting template which is to be run against this task.
Start Date & Time
Set the start date and time for the task. Default is same as Created Date.
Once Only
If yes, the task will be disabled automatically after first run.
Send Email
If yes, a notification emails are sent everytime the task runs.
Send Email To
Enter the email address where you want to send the notification mails. You can add multiple email addressed seperated by comma (,).
Run This Task By
Select the Unit of Measurement for the interval i.e. minutes, hours, days, weeks or months.
Minutes / Hours / Days / Weeks / Months
Set your desired interval in minutes, hours, days, weeks or months.
Next Runs On
Next date and time when this task will run.
Last Ran On
Last date and time when this task ran.
Status
Set the status of the schedules task. i.e. Published, Unpublished or Trashed.
Created By
Displays the user who created the task.
Created Date
Displays the date and time when the was created.
Modified By
Displays the user who last modified the task.
Modified Date
Displays the date and time when the was last modified.
Hits
The number times the task ran in past.
Log
You can see the runtime log of the scheduled task here.
Inventory Status
You can view and download inventory status report in this section. You can also filter the list by availability, state, categories, manufacturers etc.
Plugins
The component comes with six (6) optional plugins which you may enable if you need.
VirtueMart Reporter - Due Date
This plugin dynamically adds a Due/Delivery Date columns to the report which is calculated from the Order Created Date of the order. You can set the "Column Name" and "Interval" in the plugin settings as per your requirement.
Reporter for VirtueMart - Invoice Number
This plugin adds respective invoice numbers of the orders to the reports. You can set the "Column Name" in the plugin settings as per your requirement.
VirtueMart Reporter - Order Total
This plugin dynamically adds an order total row in the CSV report if "Order Total" field is selected in the template settings. You can set the row "Label" in the plugin settings as per your requirement.
Reporter for VirtueMart - Sales Commission
This plugin can dynamically calculate and add commissions against each orders. You can assign separate commission rates for each Shopper Groups. You can find all the available options of this plugin below.
Column Name
Name of the commission column in reports.
Total Row Name
Name of the total commission row in reports.
Show in Mail Body
If yes, total commission amount is included in the mail body.
Applicable Templates
Select the applicable report templates.
Rounding Digits
Specifies the number of decimal digits to round to.
Commissions
Assign the rates of commission to each shopper groups.
Reporter for VirtueMart - Tax Total
This plugin dynamically adds total tax amount in the CSV reports. You can set the row "Label" in the plugin settings as per your requirement.
Reporter for VirtueMart - Total Order Sales Price
This plugin dynamically adds total order sales price amount in the CSV reports. You can set the row "Label" in the plugin settings as per your requirement.