The module lets you adjust reports to your needs through using various filters and even your own PHP code. It also permits to display prepared reports in tables, graphs or charts.
You can generate reports in XML, CSV and PDF, as well as schedule their creation 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 these.

File is located in '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 in your client area → 'My Products'.

'storage' folder is located in 'your_whmcs/modules/addons/reportgenerator/'.
Note: If you set up chmods incorrectly, export report and generate PDF report functionalities will not work.

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' → 'Cron Setup'.

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

Module also offers additional useful features like predefined reports, import/export of reports, generating reports in PDF, ability to send them to admins and much more.

Here you can manage your reports by viewing (1), editing (2) and removing them (8).
Additionally, you can generate PDF version of reports (3) as well as export reports to CSV (4 & 5), XML (6) and XML structure (7).

More information about creating new reports will be presented in the Creating Report 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.

If you wish to create your own report, we strongly recommend creating reports shown below firstly in order to get some practice.
The first report will be quite simple and described step by step while the next ones will be more and more complex.
We will show you how specific options affect a final report.

In order to create additional charts on your report you need to add a new section.
Below we will show you how to set up a single section. This exemplary report will show all new clients whose accounts were created during the last month.
Start by entering report name and description.

As you can see, default columns have been loaded. For purposes of this report we will remove them through pressing 'Remove All The Columns'.

Type in the table name and a list of all available columns will show up. Now, select desired column.

In some situations preview may be replaced with error, which will contain information about lacking or miss-configured settings of report.
On the following screen error message is caused by using incorrect function 'COUNT()'.

Now, report will be generated using only accounts created during the last 30 days.
Note: Time period for report can be changed later at the report view or email configuration.

We will order records by client last name. Choose 'Clients Table : lastname' and 'Ascending' as shown on the following screen.
Your report displaying all new accounts created during the last month is ready, press 'Generate Report' to save it.

As you can see, column names are names of table columns.
Our module allows you to easily change column names under which table columns will be displayed.
You will find more information about setting up custom column names in Tables And Columns Definitions section.
While viewing report with enabled filtering by date you can easily change time periods as shown on the following screen.

As previously, start by defining report name and description. Additionally, choose report type and starting table.

Press 'Join Another Table' to proceed.

We want to display a client even if he/she has no orders, therefore from 'Please Specify A Join Type' we will choose:
'Return all rows from the left table, even if there are no matches at the right table'.

It is time to decide which columns will be used to join chosen columns.
In the table 'Orders' we can find column 'userid' in which there is stored ID of client who made an order.
Therefore we will join them using 'Clients Table : ID' and 'Orders Table : userid'.
In the end press 'Confirm!'

The first column will be displayed by:

concat(tblclients.id, '# ', tblclients.firstname, ' ', tblclients.lastname) as Client

Concat will join provided columns while 'Client' is alias for this column. Alias will be used for generated report.

COUNT(*) as Orders

Count along with grouping by allow us to count records for each client.

Orders Table : ID as Any_Order_Exist

This column was added to handle clients who do not have any orders.
Due to join type, 'COUNT(*) as Orders' will be filled with 1 for them.
Proceed to 'Groups & Limits' tab to set up grouping by (currently our generator does not recognize what should be counted).

Additionally, let's set up sorting clients by quantity of orders, we can use column alias for this.
As we predicted, clients with 0 orders have assigned 1 order. Proceed to 'Your Own Code' to fix that.

Code has to be placed in delimiters as shown below.

<?php 
// your custom code here
?> 

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 typical array where the key is a column name and value is a current row value.
Important 1: Use this field with caution, because every mistake made here can result with error in your production environment.
Note: While working on $result you can use aliases!
What we need to do is assign 0 to 'Orders' column if 'Any_Order_Exist' column is empty.
Additionally, we are unable to remove previously added column, therefore we will display 'Yes/No' in 'Any_Order_Exist' depending on existence of any order assigned to client.
Code placed below will do it for you:

<?php
foreach($result as $element) // iterate over all records storing current row in $element variable
{
if($element->Any_Order_Exist=="") // check if Any_Order_Exist is empty
{
 $element->Orders=0;      //assign 0 to Orders if Any_Order_Exist is empty
 $element->Any_Order_Exist='No'; //assign 'No' to Any_Order_Exist if it is empty
}
else  // if previous if was false, commands stored here will be ordered
{
 $element->Any_Order_Exist='Yes';  //assign 'Yes' to Any_Order_Exist
}
}
?>

We will also add second section displaying unpaid invoices which can be filtered by client first and last name.
Start by defining report name and description, choose report type and starting table.
Press 'Join Another Table' to proceed.

Conditions can be changed at the report view, they will be displayed under friendly name defined here.

Owing to previously introduced concat you can both make sure you will be counting invoices properly and display string generated by concat under summary column in table.
This concat returns client ID, lastname and firstname in one string.
Order records using 'Sum' alias and define limit of column for this report.
Now, let's create the second section. To do so, press 'Create New Section'.

Select date table and start of client table.
Additionally, join client table with invoice table as in previous section.

Proceed to condition tab and press 'Add New Condition' button.

Nonetheless, you will be able to easily filter for desired client in report view.
Now, create conditions shown below.

You can also increase limits of record displayed on the report.

Copy and paste code placed below:

<?php
foreach($result as $element)
if($element->companyname=='No Company Assigned')
{
 $element->companyname='';
}
?>

Your report is ready, press 'Generate Report' to finish.

We will add filtering results by clients' nationality to this report.
Join hosting table with client table as shown on the following screen.

Filter set up shown on the following screen will filter report output depending on client's country.

Start by selecting admin or admins to which email with report should be sent.
Afterwards, choose which of your reports should be sent and decide how often reports should be sent using 'Time Period' dropdown menu.
In addition to that, you can define filter values for generated report if report uses any.
Confirm through pressing 'Add Relation' button.

Each of those relations can be removed at any time through pressing 'Delete' button.

Press 'Browse' button and select your report XML file.
Afterwards, press 'Upload' button and your report will be uploaded into the module.

Press 'Update Report' as soon as you finish.

1. Protects generating reports from data lost during refreshing.
2. Pressing 'To PDF' adds a cron job which will generate a PDF report for you.
Reports generated by cron are available at 'Cron Jobs' → 'Cron Generated Reports'.
3. Font used to generate PDF reports is switched to font, which supports unicode.
During this option being enabled, generated PDF reports are much larger than earlier.

Go to 'Report Generator' → 'Settings' → 'Advanced Builder Settings' . As you can see, there are three text fields.
The first one, 'Table Definitions' enables you to easily change name of the tables visible on the reports created by module.
The second one, 'Column Definitions' does the same thing for columns.
'Additional Group Expressions' field, lets you set up predefined MySQL expressions which afterwards may be added through one click.
Note 1: 'Column Definitions' will set up custom name for all columns with that name.

It can be accessed at 'Migration' tab of our module and allows you to migrate reports from the previous version of Report Generator For WHMCS.
As you can see, all reports which existed in version 1.0 are listed here. In order to import report from the previous version of the module press 'Migrate' button next to it.
Important: Email settings will be lost during the upgrade.

Cause: Module is unable to save the file.
Solution: Set 'your_whmcs/modules/addons/reportgenerator/storage' folder as writable.
Ensure three writable folders are created inside of 'storage' folder:

• dumps
• export
• reports