Module lets you to adjust reports to your needs through using various filters, conditions and even your own PHP code. You can display ready reports in tables, graphs or charts.
You can also generate reports in XML, CSV and PDF, as well as schedule their creating and send them over an email to specified staff members.

We will guide you step by step through the whole installation and configuration process.

Files in your WHMCS directory should look like this.

File is located at 'modules/addons/reportgenerator/license_RENAME.php' . Rename it from 'license_RENAME.php' to 'license.php' .

Enter your license key between quotation marks as presented on the following screen. You can find your license key at your client area → 'My Products' .

'reports_xml' file is located at 'your_whmcs/modules/addons/reportgenerator/' .

Log in to your WHMCS admin area. Go to 'Setup' → 'Addon Modules' . Afterwards, find 'Report Generator' and press 'Activate' button.

To do so, click on 'Configure' button, tick 'Full Administrator' and press 'Save Changes' .

You can find them at your module 'Addons' → 'Report Generator' → 'Cron Jobs' .

You can access the module at 'Addons' → 'Report Generator' .

Module has also additional useful features like predefined reports, import/export of reports, generating reports in PDF and ability to send it to admins.

Here you can manage your reports by viewing (1), editing (2), generating report in PDF (3), exporting to XML file (4) and removing (5).

More information about creating new reports will be presented in the next section.

You can display report in a simple or widget format. To switch between them press one of the buttons marked on the screen below.

At every step of creating report you can add new sections.
Below we will show you how to set up a single section.
Start from entering report name and description.

Afterwards, tick all records from tables you want to display.
If you will decide to display additional column, you can define it in 'Additional Columns' field.

<?php 
// your custom code here
return $result; 
?> 

The '$result' variable is passed by reference and contains just iterated element of the result array.
In this way you can create new columns in your table or modify existing ones through modifying this variable.
You can access it as normal array where the key is a column name and value is a current row value.
Important: Use this field with caution, because every mistake made here can result with error in your production environment.

For example, to join table 'tblclients' with 'tblactivitylog' you should join it using 'tblclients - id' and 'tblactivitylog- clientid' .
If you have more than 2 tables in your report section, it is advised to create more join relations.

You can use predefined conditions. Select record to apply filter on, afterwards select 'Operation Type' and type value into 'Default Value' field.

To set 'Order By' , select record used to order by values displayed in report, afterwards select direction of ordering by (Ascending/Descending).
You can also use custom group by command through pressing 'Add your own group by query' and typing command in textbox which will appear.

You can also use customize order by command through pressing 'Add your own order by query' and entering command in a textbox which will appear.

To do it, simply enter a time period (in days) to create a report from.

You can create two types of charts which are pie chart and area chart.

Open lang file located at 'your_whmcs/modules/addons/mg_resellers/lang' . For test purposes we have chosen 'english.php' file.
Afterwards, enter:

$_LANG['record_name'] = 'displayed_record_name';

Where 'record_name' is a record name you want to display differently and 'displayed_record_name' is a name under which this record will be visible.
For example, to change record 'groupid' to 'Group ID' use this code:

$_LANG['groupid'] = 'Group ID';

Note 1: It will set up custom name for all records with that name.
Note 2: Custom table records support Multi-Language functionality.

$_LANG['table_name'] = 'displayed_table_name';

Simply select admin or admins to which email with report should be sent.
Afterwards, choose which of your reports should be sent.

You can specify report content through setting it up, for example, on the screen below we have chosen 'admin' staff member.
In this way the sent report will refer to 'admin' staff member.
Finish by selecting time period for email sending and press 'Add Relation' .

Afterwards, press 'Upload' button and your report will be uploaded to the module.

To do so, simply press 'Install on Page' button as presented on the following screen.