Personal tools
Namespaces

Variants
Actions

Report Generator 3.X For WHMCS

From ModulesGarden Wiki
(Difference between revisions)
Jump to: navigation, search
(→‎Orders & Limits)
 
(121 intermediate revisions by 7 users not shown)
Line 2: Line 2:
 
<meta name="description" content="ModulesGarden Wiki Contains All The Information You Need About The Report Generator For WHMCS Module."></meta>
 
<meta name="description" content="ModulesGarden Wiki Contains All The Information You Need About The Report Generator For WHMCS Module."></meta>
  
−
=About [http://www.modulesgarden.com/products/whmcs/report_generator/features Report Generator For WHMCS]=
+
=About [https://www.modulesgarden.com/products/whmcs/report-generator Report Generator For WHMCS]=
 
{|
 
{|
−
|style="padding: 10px 0px 5px 0px;"|'''Report Generator For WHMCS''' is a module which allows you to create custom reports using SQL query builder and display in with tables and graphs.<br />
+
|style="padding: 10px 0px 5px 0px;"|'''Report Generator For WHMCS''' allows you to generate and manage any kind of reports using inbuilt creators.<br />
−
You can also generate report in XML or PDF and send it over email.
+
The module lets you adjust reports to your needs through using various filters and even your own PHP code.<br/> It also permits to display prepared reports in tables, graphs or charts.<br />
 +
You can also schedule the reports creation and send them over an email to specified staff members.
 
|}
 
|}
−
*'''Features:'''
+
<!-- fixed -->
 +
*'''Admin Area Features:'''
 
{|
 
{|
−
|style="padding: 10px 0px 0px 30px;"|✔ Query Builder For Dynamic Reports Creating
+
|style="padding: 10px 0px 0px 30px;"|✔ Generate Your Own Report Using One Of 3 Creators
 
|}
 
|}
 
{|
 
{|
−
|style="padding: 0px 0px 0px 30px;"|✔ Full Support For Reports Editing
+
|style="padding: 0px 0px 0px 30px;"|✔ View 30 Predefined Reports
 
|}
 
|}
 
{|
 
{|
−
|style="padding: 0px 0px 0px 30px;"|✔ Predefined Reports
+
|style="padding: 0px 0px 0px 30px;"|✔ Modify Report Results With Dynamic Filters
 
|}
 
|}
 
{|
 
{|
−
|style="padding: 0px 0px 0px 30px;"|✔ Multi Sections Of Dynamically Generated Reports
+
|style="padding: 0px 0px 0px 30px;"|✔ Generate PDF And CSV Files From Reports
 
|}
 
|}
 
{|
 
{|
−
|style="padding: 0px 0px 0px 30px;"|✔ Dynamic Filters
+
|style="padding: 0px 0px 0px 30px;"|✔ Print Reports With A Print Preview
 
|}
 
|}
 
{|
 
{|
−
|style="padding: 0px 0px 0px 30px;"|✔ Two View Types Of Report Pages (Simple And Widget Alike)
+
|style="padding: 0px 0px 0px 30px;"|✔ Schedule Automatic Reports With Specified Options Being Sent:
 
|}
 
|}
 
{|
 
{|
−
|style="padding: 0px 0px 0px 30px;"|✔ Print Reports
+
|style="padding: 0px 0px 0px 45px;"|✔ To Chosen Staff Members
 
|}
 
|}
 
{|
 
{|
−
|style="padding: 0px 0px 0px 30px;"|✔ Automatic Reports Sending To Desired Staff Members, With Specified User Conditions
+
|style="padding: 0px 0px 0px 45px;"|✔ To SFTP Server
 
|}
 
|}
 
{|
 
{|
−
|style="padding: 0px 0px 0px 30px;"|✔ Export To And Import From The XML
+
|style="padding: 0px 0px 0px 30px;"|✔ Export & Import Reports Structure To File
 
|}
 
|}
 
{|
 
{|
−
|style="padding: 0px 0px 10px 30px;"|✔ Export To PDF
+
|style="padding: 0px 0px 10px 30px;"|✔ Export Reports To XML File Format (Coming Soon)
 +
|}
 +
 
 +
*'''Report Creation Features:'''
 +
{|
 +
|style="padding: 10px 0px 0px 30px;"|✔ Choose One Of 3 Creators:
 +
|}
 +
{|
 +
|style="padding: 0px 0px 0px 45px;"|✔ Beginner:
 +
|}
 +
{|
 +
|style="padding: 0px 0px 0px 60px;"|✔ Drag & Drop Editor
 +
|}
 +
{|
 +
|style="padding: 0px 0px 0px 60px;"|✔ WHMCS Tables Only
 +
|}
 +
{|
 +
|style="padding: 0px 0px 0px 60px;"|✔ Join Tables With Known Relations Only
 +
|}
 +
{|
 +
|style="padding: 0px 0px 0px 45px;"|✔ Intermediate:
 +
|}
 +
{|
 +
|style="padding: 0px 0px 0px 60px;"|✔ Drag & Drop Editor
 +
|}
 +
{|
 +
|style="padding: 0px 0px 0px 60px;"|✔ All Tables Available
 +
|}
 +
{|
 +
|style="padding: 0px 0px 0px 60px;"|✔ Modify Output With PHP
 +
|}
 +
{|
 +
|style="padding: 0px 0px 0px 45px;"|✔ Advanced:
 +
|}
 +
{|
 +
|style="padding: 0px 0px 0px 60px;"|✔ Write SQL Query
 +
|}
 +
{|
 +
|style="padding: 0px 0px 0px 60px;"|✔ All Tables Available
 +
|}
 +
{|
 +
|style="padding: 0px 0px 0px 60px;"|✔ Modify Output With PHP
 +
|}
 +
{|
 +
|style="padding: 0px 0px 0px 30px;"|✔ Choose Section Display Type:
 +
|}
 +
{|
 +
|style="padding: 0px 0px 0px 45px;"|✔ Data Table
 +
|}
 +
{|
 +
|style="padding: 0px 0px 0px 45px;"|✔ Pie Chart
 +
|}
 +
{|
 +
|style="padding: 0px 0px 0px 45px;"|✔ Area Chart
 +
|}
 +
{|
 +
|style="padding: 0px 0px 0px 45px;"|✔ Column Chart
 +
|}
 +
{|
 +
|style="padding: 0px 0px 0px 30px;"|✔ Create Multi-Section Reports
 +
|}
 +
{|
 +
|style="padding: 0px 0px 0px 30px;"|✔ Clone Sections (Coming Soon)
 +
|}
 +
{|
 +
|style="padding: 0px 0px 0px 30px;"|✔ Create Section Using Multiple Tables
 +
|}
 +
{|
 +
|style="padding: 0px 0px 0px 30px;"|✔ Dynamic Filter Types:
 +
|}
 +
{|
 +
|style="padding: 0px 0px 0px 45px;"|✔ Data Range Filter - Available On Report View
 +
|}
 +
{|
 +
|style="padding: 0px 0px 0px 45px;"|✔ Dropdown Filter - Specify Available Options During Report Creation
 +
|}
 +
{|
 +
|style="padding: 0px 0px 0px 45px;"|✔ Number Range Filter
 +
|}
 +
{|
 +
|style="padding: 0px 0px 0px 45px;"|✔ Text Filter
 +
|}
 +
{|
 +
|style="padding: 0px 0px 0px 45px;"|✔ Cron Date Filter - Define Date Range For Scheduled Reports
 +
|}
 +
{|
 +
|style="padding: 0px 0px 0px 30px;"|✔ Live Preview Of Data Returned By Report Creator
 +
|}
 +
{|
 +
|style="padding: 0px 0px 0px 30px;"|✔ Live Preview Of SQL Query Built By Report Creator
 +
|}
 +
{|
 +
|style="padding: 0px 0px 0px 30px;"|✔ Live Preview Of Section Generated By Report Creator
 +
|}
 +
{|
 +
|style="padding: 0px 0px 10px 30px;"|✔ Toggle Between Automatic & Manual Refreshing Of Generated Section
 +
|}
 +
*'''Additional Basic & Intermediate Creators Features:'''
 +
{|
 +
|style="padding: 10px 0px 0px 30px;"|✔ Mark Tables With Known Relations And Automatically Configure Join In Table
 +
|}
 +
{|
 +
|style="padding: 0px 0px 0px 30px;"|✔ Advanced Conditioning:
 +
|}
 +
{|
 +
|style="padding: 0px 0px 0px 45px;"|✔ Define Static Condition
 +
|}
 +
{|
 +
|style="padding: 0px 0px 0px 45px;"|✔ Define Requested Relation Between Two Fields
 +
|}
 +
{|
 +
|style="padding: 0px 0px 0px 45px;"|✔ Add Dynamic Filter As Condition
 +
|}
 +
{|
 +
|style="padding: 0px 0px 0px 30px;"|✔ Output Field:
 +
|}
 +
{|
 +
|style="padding: 0px 0px 0px 45px;"|✔ Field - Display Field As Is
 +
|}
 +
{|
 +
|style="padding: 0px 0px 0px 45px;"|✔ Concat - Join Multiple Fields Into One
 +
|}
 +
{|
 +
|style="padding: 0px 0px 0px 45px;"|✔ Substr - Display Only Part Of Chosen Field
 +
|}
 +
{|
 +
|style="padding: 0px 0px 0px 45px;"|✔ Sum - Summarize All Values With The Same Value Of Group By Field
 +
|}
 +
{|
 +
|style="padding: 0px 0px 0px 45px;"|✔ Count - Count All Values With The Same Value Of Group By Field
 +
|}
 +
{|
 +
|style="padding: 0px 0px 0px 45px;"|✔ Max - Display Maximal Value Found Within Fields With The Same Value Of Group By Field
 +
|}
 +
{|
 +
|style="padding: 0px 0px 0px 45px;"|✔ Min - Display Minimal Value Found Within Fields With The Same Value Of Group By Field
 +
|}
 +
{|
 +
|style="padding: 0px 0px 0px 45px;"|✔ Avg - Display Average Of Fields With The Same Value Of Group By Field
 +
|}
 +
{|
 +
|style="padding: 0px 0px 0px 30px;"|✔ Limit Amount Of Data Displayed On Report
 +
|}
 +
{|
 +
|style="padding: 0px 0px 10px 30px;"|✔ Skip Chosen Amount Of First Records Displayed On Report
 +
|}
 +
 
 +
*'''General Info:'''
 +
{|
 +
|style="padding: 10px 0px 0px 30px;"|✔ Report Migration Tool
 +
|}
 +
{|
 +
|style="padding: 0px 0px 0px 30px;"|✔ Multi-Language Support
 +
|}
 +
{|
 +
|style="padding: 0px 0px 0px 30px;"|✔ Supports PHP 5.6 Up To PHP 7.2
 +
|}
 +
{|
 +
|style="padding: 0px 0px 0px 30px;"|✔ Supports WHMCS V7
 +
|}
 +
{|
 +
|style="padding: 0px 0px 10px 30px;"|✔ Easy Module Upgrade To [https://www.modulesgarden.com/products/whmcs/report-generator#open-source-version Open Source Version]
 +
|}
 +
*'''Predefined Reports:'''
 +
{|
 +
|style="padding: 10px 0px 0px 30px;"|✔ 'Clients Information' Section:
 +
|}
 +
{|
 +
|style="padding: 0px 0px 0px 45px;"|✔ Customers Per Country
 +
|}
 +
{|
 +
|style="padding: 0px 0px 0px 45px;"|✔ Most Valuable Clients
 +
|}
 +
{|
 +
|style="padding: 0px 0px 0px 45px;"|✔ Paid Orders Report
 +
|}
 +
{|
 +
|style="padding: 0px 0px 0px 45px;"|✔ Orders Report
 +
|}
 +
{|
 +
|style="padding: 0px 0px 0px 45px;"|✔ Created Panels Report
 +
|}
 +
{|
 +
|style="padding: 0px 0px 0px 45px;"|✔ User Accounts Created:
 +
|}
 +
{|
 +
|style="padding: 0px 0px 0px 60px;"|✔ Number Of Created User Accounts By Date
 +
|}
 +
{|
 +
|style="padding: 0px 0px 0px 60px;"|✔ List Of User Accounts Created
 +
|}
 +
{|
 +
|style="padding: 0px 0px 0px 45px;"|✔ Business Health Status:
 +
|}
 +
{|
 +
|style="padding: 0px 0px 0px 60px;"|✔ Domain Renewals For The Time Period
 +
|}
 +
{|
 +
|style="padding: 0px 0px 0px 60px;"|✔ Open Tickets For The Period
 +
|}
 +
{|
 +
|style="padding: 0px 0px 0px 60px;"|✔ New Invoices For The Time Period
 +
|}
 +
{|
 +
|style="padding: 0px 0px 0px 60px;"|✔ Invoice Reminders For The Time Period
 +
|}
 +
{|
 +
|style="padding: 0px 0px 0px 60px;"|✔ Hosting Renewals
 +
|}
 +
{|
 +
|style="padding: 0px 0px 0px 60px;"|✔ Suspended Services For The Time Period
 +
|}
 +
{|
 +
|style="padding: 0px 0px 0px 45px;"|✔ Complete Cases:
 +
|}
 +
{|
 +
|style="padding: 0px 0px 0px 60px;"|✔ Closed & Answered Status Tickets By The Staff Member
 +
|}
 +
{|
 +
|style="padding: 0px 0px 0px 60px;"|✔ Tickets Stats In Time By The Staff Member
 +
|}
 +
{|
 +
|style="padding: 0px 0px 0px 60px;"|✔ Completed To-Do List Tasks By The Staff Member
 +
|}
 +
{|
 +
|style="padding: 0px 0px 0px 60px;"|✔ To-Do Tasks Stats Per Status By The Staff Member
 +
|}
 +
{|
 +
|style="padding: 0px 0px 0px 60px;"|✔ Orders Summary
 +
|}
 +
{|
 +
|style="padding: 0px 0px 0px 45px;"|✔ Tasks And Tickets In Progress:
 +
|}
 +
{|
 +
|style="padding: 0px 0px 0px 60px;"|✔ General Tickets Statistics - For Selected Staff Member Or Team In Time
 +
|}
 +
{|
 +
|style="padding: 0px 0px 0px 60px;"|✔ To-Do List - Tasks Per Status For Selected Staff Member Or Team In Time
 +
|}
 +
{|
 +
|style="padding: 0px 0px 0px 60px;"|✔ To-Do List - Tasks In Progress For Selected Staff Member Or Team In Time
 +
|}
 +
{|
 +
|style="padding: 0px 0px 0px 45px;"|✔ Unpaid Invoices
 +
|}
 +
{|
 +
|style="padding: 0px 0px 0px 45px;"|✔ Client Payment History
 +
|}
 +
{|
 +
|style="padding: 0px 0px 0px 30px;"|✔ 'Services' Section:
 +
|}
 +
{|
 +
|style="padding: 0px 0px 0px 45px;"|✔ Product Income In Location
 +
|}
 +
{|
 +
|style="padding: 0px 0px 0px 45px;"|✔ Income Per Country
 +
|}
 +
{|
 +
|style="padding: 0px 0px 0px 45px;"|✔ MRR & Churn Metrics
 +
|}
 +
{|
 +
|style="padding: 0px 0px 0px 45px;"|✔ MRR & Churn Per Product
 +
|}
 +
{|
 +
|style="padding: 0px 0px 0px 45px;"|✔ Orders Number
 +
|}
 +
{|
 +
|style="padding: 0px 0px 0px 45px;"|✔ Orders Over The Weekdays
 +
|}
 +
{|
 +
|style="padding: 0px 0px 0px 45px;"|✔ Registered Services
 +
|}
 +
{|
 +
|style="padding: 0px 0px 0px 45px;"|✔ Renewals Report
 +
|}
 +
{|
 +
|style="padding: 0px 0px 0px 45px;"|✔ Tasks And Tickets In Progress:
 +
|}
 +
{|
 +
|style="padding: 0px 0px 0px 45px;"|✔ Transferred Domains Report
 +
|}
 +
{|
 +
|style="padding: 0px 0px 0px 30px;"|✔ 'CRM Related' Section:
 +
|}
 +
{|
 +
|style="padding: 0px 0px 0px 45px;"|✔ WWW Created Panels Report
 +
|}
 +
{|
 +
|style="padding: 0px 0px 0px 45px;"|✔ Traders Renewals Report
 +
|}
 +
{|
 +
|style="padding: 0px 0px 0px 45px;"|✔ WWW Renewals Report
 +
|}
 +
{|
 +
|style="padding: 0px 0px 0px 45px;"|✔ Leads Report
 +
|}
 +
{|
 +
|style="padding: 0px 0px 0px 30px;"|✔ 'Staff Members' Section:
 +
|}
 +
{|
 +
|style="padding: 0px 0px 0px 45px;"|✔ Tickets In Hours
 +
|}
 +
{|
 +
|style="padding: 0px 0px 0px 45px;"|✔ Ticket Replies By Admin
 +
|}
 +
{|
 +
|style="padding: 0px 0px 0px 45px;"|✔ Comments On Course Of Ticket Solving
 +
|}
 +
{|
 +
|style="padding: 0px 0px 0px 45px;"|✔ Ratings Of Ticket Solving Course
 
|}
 
|}
−
*'''Additionally:'''
 
 
{|
 
{|
−
|style="padding: 10px 0px 0px 30px;"|✔ Multi-Language Support
+
|style="padding: 0px 0px 0px 45px;"|✔ Ticket Response Rating
 
|}
 
|}
 
{|
 
{|
−
|style="padding: 0px 0px 30px 30px;"|✔ Supports WHMCS V5 and Later
+
|style="padding: 0px 0px 30px 45px;"|✔ Flexible Transactions Report
 
|}
 
|}
  
 
=Installation=
 
=Installation=
 
{|
 
{|
−
|style="padding: 10px 0px 0px 0px;"|'''This tutorial will show you how to successfully install and configure Report Generator For WHMCS.''' <br />
+
|style="padding: 10px 0px 0px 0px;"|'''This tutorial will show you how to successfully install and configure [https://www.modulesgarden.com/products/whmcs/report-generator Report Generator For WHMCS.]''' <br />
 
We will guide you step by step through the whole installation and configuration process. <br />
 
We will guide you step by step through the whole installation and configuration process. <br />
 
|}
 
|}
 
{|
 
{|
−
|style="padding: 20px 0px 20px 15px;"|'''1. Log in to your client area and download Report Generator For WHMCS.'''
+
|style="padding: 20px 0px 20px 15px;"|'''1. Log in to our client area and download the module.'''
 
|}
 
|}
 
{|
 
{|
−
|style="padding: 0px 0px 20px 25px;"|[[File:RG1.png]]
+
|style="padding: 0px 0px 20px 25px;"|[[File:RG2_1.png]]
 
|}
 
|}
 
{|
 
{|
−
|style="padding: 0px 0px 15px 15px;"|'''2. Upload and extract the module into the main WHMCS directory.'''<br />
+
|style="padding: 0px 0px 10px 15px;"|'''2. In the downloaded file you will find two packages that support different PHP versions.'''<br/>As presented on the screen below, the first one is dedicated to PHP 5.6 up to PHP 7.0, while the second one is aimed at PHP 7.1 up to PHP 7.2.<br/>It does not apply to open source versions.<br/>
−
Files in your WHMCS directory should look like this.
+
'' '''Note''': You can check the current PHP version in your WHMCS. To do so, proceed to ''' 'Utilities' › 'System' › 'PHP Info'.'''
 
|}
 
|}
 
{|
 
{|
−
|style="padding: 0px 0px 20px 25px;"|[[File:RG2.png]]
+
|style="padding: 0px 0px 20px 25px;"|[[File:PHP56_72.png]]
 
|}
 
|}
 
{|
 
{|
−
|style="padding: 0px 0px 15px 15px;"|'''3. When you install Report Generator for the first time you have to rename '' 'license_RENAME.php' '' file.'''<br />
+
|style="padding: 0px 0px 15px 15px;"|'''3. Extract the downloaded file and choose the one with the right PHP version. Upload and extract the PHP file into the main WHMCS directory.'''<br />
−
File is located at '' 'modules/addons/reportgenerator/license_RENAME.php' '' . Rename it from '' 'license_RENAME.php' '' to '' 'license.php' '' .
+
The content of PHP version files should look like this.  
 
|}
 
|}
 
{|
 
{|
−
|style="padding: 0px 0px 20px 25px;"|[[File:RG3.png]]
+
|style="padding: 0px 0px 20px 25px;"|[[File:RG2_2_1.png]]
 
|}
 
|}
 
{|
 
{|
−
|style="padding: 0px 0px 15px 15px;"|'''4. In order to configure your license key, you have to edit a previously renamed '' 'license.php' file.' '' '''<br />
+
|style="padding: 0px 0px 15px 15px;"|'''4. When you install Report Generator For WHMCS for the first time you have to rename '' 'license_RENAME.php' '' file.'''<br />
−
Enter your licence key between quotation marks as presented on the following screen. You can find your license key at your client area'' → 'My Products' ''.  
+
File is located in '' 'modules/addons/reportgenerator/license_RENAME.php'. '' Rename it from '' 'license_RENAME.php' '' to '' 'license.php'. ''
 
|}
 
|}
 
{|
 
{|
−
|style="padding: 0px 0px 20px 25px;"|[[File:RG4.png]]
+
|style="padding: 0px 0px 20px 25px;"|[[File:RG2_3.png]]
 
|}
 
|}
 
{|
 
{|
−
|style="padding: 0px 0px 15px 15px;"|'''5. Now you have to set chmod '' '755' '' or '' '777' '' to '' 'reports_xml' '' folder.'''<br />
+
|style="padding: 0px 0px 15px 15px;"|'''5. In order to configure your license key, you have to edit a previously renamed '' 'license.php' file.' '' '''<br />
−
'' 'reports_xml' '' file is located at '' 'your_whmcs/modules/addons/reportgenerator/' ''.
+
Enter your license key between quotation marks as presented on the following screen. You can find your license key in our client area'' → 'My Products'. ''
 
|}
 
|}
 
{|
 
{|
−
|style="padding: 0px 0px 20px 25px;"|[[File:RG4_1.png]]
+
|style="padding: 0px 0px 20px 25px;"|[[File:RG2_4.png]]
 
|}
 
|}
 
{|
 
{|
−
|style="padding: 0px 0px 15px 15px;"|'''6. Now you have to activate the module in your WHMCS system. '''<br />
+
|style="padding: 10px 0px 15px 15px;"|'''6. Now, set up the '' 'storage' '' folder as writable.'''<br />
−
Log in to your WHMCS admin area. Go to '' 'Setup' '' → '' 'Addon Modules' ''. Afterwards find '' 'Report Generator' '' and press '' 'Activate' '' button.
+
This folder should be available at '' 'your_whmcs/modules/addons/reportgenerator/' ''.
 
|}
 
|}
 
{|
 
{|
−
|style="padding: 0px 0px 20px 25px;"|[[File:RG5.png]]
+
|style="padding: 0px 0px 20px 25px;"|[[File:RG2_5.png]]
 
|}
 
|}
 
{|
 
{|
−
|style="padding: 0px 0px 15px 15px;"|'''7. In the next step you need to permit access to this module.'''<br />
+
|style="padding: 0px 0px 15px 15px;"|'''7. Now you have to activate the module in your WHMCS system.'''<br />
−
To do so click on '' 'Configure' '' button, tick '' 'Full Administrator' '' and press '' 'Save Changes' ''.
+
Log in to your WHMCS admin area. Go to '' 'Setup' '' → '' 'Addon Modules'. '' Afterwards, find '' 'Report Generator' '' and press '' 'Activate' '' button.
 
|}
 
|}
 
{|
 
{|
−
|style="padding: 0px 0px 20px 25px;"|[[File:RG6.png]]
+
|style="padding: 0px 0px 20px 25px;"|[[File:RG2_6.png]]
 
|}
 
|}
 
{|
 
{|
−
|style="padding: 0px 0px 15px 15px;"|'''8. Last step is setting up cron jobs'''<br />
+
|style="padding: 0px 0px 15px 15px;"|'''8. In the next step you need to permit access to this module.'''<br />
−
You can find them at your module '' 'Addons' '' → '' 'Report Generator' '' → '' 'Cron Jobs' ''.
+
To do so, click on '' 'Configure' '' button, tick '' 'Full Administrator' '' and press '' 'Save Changes'. ''
 
|}
 
|}
 
{|
 
{|
−
|style="padding: 0px 0px 20px 25px;"|[[File:RG7.png]]
+
|style="padding: 0px 0px 20px 25px;"|[[File:RG2_7.png]]
 
|}
 
|}
 
{|
 
{|
 
|style="padding: 0px 0px 15px 15px;"|'''9. You have just successfully installed Report Generator!'''<br />
 
|style="padding: 0px 0px 15px 15px;"|'''9. You have just successfully installed Report Generator!'''<br />
−
You can access the module at '' 'Addons' '' → '' 'Report Generator' ''.
+
You can access the module at '' 'Addons' '' → '' 'Report Generator'. ''
 
|}
 
|}
 
{|
 
{|
−
|style="padding: 0px 0px 30px 25px;"|[[File:RG8.png]]
+
|style="padding: 0px 0px 30px 25px;"|[[File:RG2_8.png]]
 
|}
 
|}
  
 
=Configuration and Management=
 
=Configuration and Management=
 
{|
 
{|
−
|style="padding: 10px 0px 30px 15px;"|'''Report Generator For WHMCS allows your to create custom reports using query builder and graphs.<br />
+
|style="padding: 10px 0px 30px 15px;"|'''Report Generator For WHMCS allows you to create custom reports using drag & drop WYSIWYG builder.<br/>
−
Module has also additional useful features like predefined reports, import/export of reports, generating reports in PDF and ability to send it to admins.
+
Module also offers additional useful features like predefined reports, import/export of reports, generating reports in PDF and CSV, ability to send them to admins and much more.
 
|}
 
|}
  
−
==Report List==
+
==Predefined Reports==
 
{|
 
{|
−
|style="padding: 10px 0px 15px 15px;"|At '' 'Report Lists' '' you can view all predefined reports as well as those created by you.<br />
+
|style="padding: 10px 0px 5px 15px;"|'' 'Reports' '' the main section of the module, gives a preview of all available reports, those predefined as well as those you create by yourself.<br/>
−
Here you can manage your reports by viewing (1), editing (2), generating report in PDF (3), exporting to XML file (4) and removing (5).
+
Predefined reports are divided into five categories plus custom reports if you have some.
 
|}
 
|}
 
{|
 
{|
−
|style="padding: 0px 0px 20px 25px;"|[[File:RG9.png]]
+
|style="padding: 10px 0px 20px 15px;"|'''Clients Information''' - eleven predefined reports that will show statistics on data related to your clients, for example statistics on placed orders, tasks, etc.
 
|}
 
|}
 
{|
 
{|
−
|style="padding: 0px 0px 20px 15px;"|For predefined reports you can only generate PDF file and view report.
+
|style="padding: 0px 0px 20px 25px;"|[[File:RG2_10.png]]
 
|}
 
|}
 
{|
 
{|
−
|style="padding: 0px 0px 20px 25px;"|[[File:RG10.png]]
+
|style="padding: 10px 0px 20px 15px;"|'''Services''' - nine different reports ready to analyze any services related data like income, renewals or transfers in your system.
 
|}
 
|}
 
{|
 
{|
−
|style="padding: 0px 0px 15px 15px;"|To create new report press '' 'Create New Report' '' or go to '' 'Reports List' '' → '' 'Create New Report' ''.<br />
+
|style="padding: 0px 0px 20px 25px;"|[[File:RG2_10_1.png]]
−
More information about creating new reports will be presented in the next section.
+
 
|}
 
|}
 
{|
 
{|
−
|style="padding: 0px 0px 30px 25px;"|[[File:RG11.png]]
+
|style="padding: 10px 0px 20px 15px;"|'''CRM Related''' - four ground reports based on your CRM data. Please note that you can see them only if you are using our CRM For WHMCS module.<br/> More about CRM For WHMCS can be found [https://www.modulesgarden.com/products/whmcs/crm/features here], instructions how to [https://www.docs.modulesgarden.com/CRM_For_WHMCS configure] your CRM.
 +
|}
 +
{|
 +
|style="padding: 0px 0px 20px 25px;"|[[File:RG2_10_2.png]]
 +
|}
 +
{|
 +
|style="padding: 0px 0px 15px 15px;"| '''Staff Members''' - three predefined reports related to staff members and tickets department.
 +
|}
 +
{|
 +
|style="padding: 0px 0px 20px 25px;"|[[File:RG2_10_3.png]]
 +
|}
 +
{|
 +
|style="padding: 0px 0px 20px 15px;"|'''Custom reports''' - all reports that you have personally created using our inbuilt creators.
 +
|}
 +
{|
 +
|style="padding: 0px 0px 30px 25px;"|[[File:RG2_10_4.png]]
 
|}
 
|}
 
===Report View===
 
===Report View===
 
{|
 
{|
−
|style="padding: 10px 0px 15px 15px;"|In report view you can see all tables and charts generated by the module.<br />
+
|style="padding: 10px 0px 20px 15px;"|Press '' 'Show' '' button next to a report you are interested in.
−
You can display report in a simple or widget format. To switch between them press one of the buttons marked on the screen below.
+
 
|}
 
|}
 
{|
 
{|
−
|style="padding: 0px 0px 30px 25px;"|[[File:RG12.png]]
+
|style="padding: 0px 0px 20px 25px;"|[[File:RG2_13.png]]
 
|}
 
|}
−
 
−
===PDF Report View===
 
 
{|
 
{|
−
|style="padding: 10px 0px 20px 15px;"|You can also view a PDF version of report which can be sent to admins or saved to PDF file on your disk.
+
|style="padding: 0px 0px 15px 15px;"|Depending on the type of report you choose, you can set the time frames within which you want to see the statistics.<br/>
 +
Provide the beginning and ending dates, then press '' 'Filter' '' button. Fresh report will be generated on the run.
 
|}
 
|}
 
{|
 
{|
−
|style="padding: 0px 0px 30px 25px;"|[[File:RG13.png]]
+
|style="padding: 0px 0px 30px 25px;"|[[File:RG2_13_1.png]]
 +
|}
 +
{|
 +
|style="padding: 0px 0px 20px 15px;"|In case of some reports, filtering is impossible due to the stable content of the report.
 +
|}
 +
{|
 +
|style="padding: 0px 0px 20px 25px;"|[[File:RG213_2.png]]
 +
|}
 +
{|
 +
|style="padding: 0px 0px 20px 15px;"|You can always view a printable version of the report or generate a PDF or CSV which can be saved on your disk.
 +
|}
 +
{|
 +
|style="padding: 0px 0px 30px 25px;"|[[File:RG2_14.png]]
 
|}
 
|}
  
 
==Creating Report==
 
==Creating Report==
 
{|
 
{|
−
|style="padding: 10px 0px 15px 15px;"|At beginning you have one section in your report, each section generate one data table and few charts on report.<br />
+
|style="padding: 10px 0px 5px 15px;"|In this section we will show you how to prepare a few exemplary reports.<br/>
−
At every step of creating report you can add new sections.<br />
+
We will now show you how to develop three different reports, each one will slightly more complicated than the previous one.<br/>
−
Below we will show you how to set up single section.<br />
+
The first steps are the same for each advancement level.
−
Start from entering report name and description.
+
 
|}
 
|}
 
{|
 
{|
−
|style="padding: 0px 0px 30px 25px;"|[[File:RG14.png]]
+
|style="padding: 0px 0px 15px 15px;"|Press '' 'Create Report'. ''
 +
|}
 +
{|
 +
|style="padding: 0px 0px 20px 25px;"|[[File:RG2_15_1.png]]
 +
|}
 +
{|
 +
|style="padding: 0px 0px 15px 15px;"|Now select the type of chart that you wish to achieve in the final result.<br/>
 +
You may generate a '' 'Colum', 'Pie', 'Table' '' or '' 'Area' '' chart. For presentation purposes we will start with a Table chart.<br/>
 +
Press it to select.
 +
|}
 +
{|
 +
|style="padding: 0px 0px 20px 25px;"|[[File:RG2_15.png]]
 +
|}
 +
{|
 +
|style="padding: 0px 0px 15px 15px;"|It is time to select the creator type. You can generate your report with:
 +
*creator for beginners
 +
*creator for admins on an intermediate level
 +
*creator for professionals - expert<br/>
 +
Let's begin with the easiest one - '' 'Beginner'. ''
 +
|}
 +
{|
 +
|style="padding: 0px 0px 30px 25px;"|[[File:RG2_16.png]]
 +
|}
 +
===Beginner - Unpaid Invoices Per Clients===
 +
{|
 +
|style="padding: 10px 0px 5px 15px;"|When you enter the creator, the first things you can see is a wide description table with example.<br/>When you are familiar with it, press and it will be automatically hidden.
 +
|}
 +
{|
 +
|style="padding: 0px 0px 15px 15px;"|The very first steps of creating a report is defining base table, only when it is selected, you may move to the next steps.br/>
 +
Depending on what your report is going to analyze, you must now find appropriate table.<br/> For example if you want to create a report that will base on clients, then find such WHMCS table.<br/>
 +
If you want to join it with another table, then drag it and drop into '' 'Join Additional Information','' note that you may join only tables highlighted in blue.
 +
|}
 +
{|
 +
|style="padding: 0px 0px 20px 25px;"|[[File:RG2_17.png]]
 +
|}
 +
{|
 +
|style="padding: 0px 0px 15px 15px;"|Now, let's move to '' 'Display If' '' section. From available '' 'Fields' '' drag option that you want to select.
 +
|}
 +
{|
 +
|style="padding: 0px 0px 20px 25px;"|[[File:RG2_17_1.png]]
 +
|}
 +
{|
 +
|style="padding: 0px 0px 20px 15px;"|We have decided to drag '' 'Status' '' and provide its value: '' 'Unpaid'.'' Then only unpaid invoices will be taken into consideration in the final report.
 +
|}
 +
{|
 +
|style="padding: 0px 0px 20px 25px;"|[[File:RG2_18.png]]
 +
|}
 +
{|
 +
|style="padding: 0px 0px 20px 15px;"|Let's move to '' 'Select Fields To Display On Final Report' '' section. Drag from ' ''Fields' ' section any ones that you wish to see on your report.
 +
|}
 +
{|
 +
|style="padding: 0px 0px 20px 25px;"|[[File:RG2_20.png]]
 +
|}
 +
{|
 +
|style="padding: 0px 0px 15px 15px;"|You can also decide the way the entries will be sorted.<br/>
 +
On the screen below you can see sorting by invoice due date in descending order.
 +
|}
 +
{|
 +
|style="padding: 0px 0px 20px 25px;"|[[File:RG2_21.png]]
 +
|}
 +
{|
 +
|style="padding: 0px 0px 15px 15px;"|Let's check how our report will look like.<br/>
 +
You can see there a list of clients, due date of their unpaid invoices together with the amount to pay and a selected payment method.
 +
|}
 +
{|
 +
|style="padding: 0px 0px 20px 25px;"|[[File:RG2_22.png]]
 +
|}
 +
{|
 +
|style="padding: 0px 0px 15px 15px;"|Take a look at the full creator view.<br/>Save the changes when your report is ready.<br/>
 +
Apart form the options used to generate this report, there are also '' 'Group By' '' and ' ''Limit'. ''<br/>We will show how to use them in other examples.
 +
|}
 +
{|
 +
|style="padding: 0px 0px 20px 25px;"|[[File:RG2_23.png]]
 +
|}
 +
{|
 +
|style="padding: 0px 0px 20px 15px;"|Finally, name your report and describe it shortly.
 +
|}
 +
{|
 +
|style="padding: 0px 0px 20px 25px;"|[[File:RG2_24.png]]
 +
|}
 +
{|
 +
|style="padding: 0px 0px 15px 15px;"|When everything is ready, you can see your report. You can always:<br/>
 +
1. Edit your report section<br/>
 +
2. Delete report section<br/>
 +
3. Print the report<br/>
 +
4. Generate PDF version<br/>
 +
5. Generate CSV version<br/>
 +
6. Add new section to the report<br/>
 +
7. Delete the whole report
 +
|}
 +
{|
 +
|style="padding: 0px 0px 30px 25px;"|[[File:RG2_25.png]]
 
|}
 
|}
  
−
===Main Settings===
+
===Intermediate Creator===
 +
{|
 +
|style="padding: 10px 0px 15px 15px;"|When you open the creator, the overall view is very similar to the '' 'Beginner' '' creator type.<br/>Here you also select items depending on your needs and drag them into proper fields.
 +
|}
 +
{|
 +
|style="padding: 0px 0px 20px 25px;"|[[File:RG3_26.png]]
 +
|}
 +
{|
 +
|style="padding: 0px 0px 15px 15px;"|The difference here is the possibility to make adjustments to your report with the use of PHP language.<br/>Whenever you commit any changes remember to save the section.
 +
|}
 +
{|
 +
|style="padding: 0px 0px 30px 25px;"|[[File:RG3_27.png]]
 +
|}
 +
 
 +
===Advanced Creator===
 +
{|
 +
|style="padding: 10px 0px 20px 15px;"|This creator allows to use advanced option, such as writing an SQL query. Just provide correct variables in the box on the left.
 +
|}
 +
{|
 +
|style="padding: 0px 0px 20px 25px;"|[[File:RG3_28.png]]
 +
|}
 +
{|
 +
|style="padding: 0px 0px 20px 15px;"|You can also add a filter that will be used while searching through the report. Give the details corresponding to your needs the most and save changes.
 +
|}
 +
{|
 +
|style="padding: 0px 0px 30px 25px;"|[[File:RG3_29.png]]
 +
|}
 +
<!--
 +
===Advanced Creator===
 +
{|
 +
|style="padding: 10px 0px 30px 15px;"|An update of this section will be at your disposal soon. We are sorry for the inconvenience.
 +
|}
 +
 
 +
{|
 +
|style="padding: 0px 0px 15px 15px;"|Join orders table to clients table. We will need it to display columns from both tables here.<br/>
 +
Press '' 'Join Another Table' '' to proceed.
 +
|}
 +
{|
 +
|style="padding: 0px 0px 20px 25px;"|[[File:RG2_24.png]]
 +
|}
 +
{|
 +
|style="padding: 0px 0px 15px 15px;"|It is time to think about how we want to connect these two tables.<br/>
 +
We want to display a client even if he/she has no orders, therefore from '' 'Please Specify A Join Type' '' we will choose:<br/>
 +
'' 'Return all rows from the left table, even if there are no matches at the right table'.''
 +
|}
 +
{|
 +
|style="padding: 0px 0px 20px 25px;"|[[File:RG2_25.png]]
 +
|}
 +
{|
 +
|style="padding: 0px 0px 15px 15px;"|Now select two tables to join. For purposes of this report, these will be tables '' 'Clients' '' and '' 'Orders'. ''<br/>
 +
It is time to decide which columns will be used to join chosen columns.<br />
 +
In the table '' 'Orders' '' we can find column '' 'userid' '' in which there is stored ID of client who made an order.<br/>
 +
Therefore we will join them using '' 'Clients Table : ID' '' and '' 'Orders Table : userid'. ''<br/>
 +
In the end press '' 'Confirm!' ''
 +
|}
 +
{|
 +
|style="padding: 0px 0px 20px 25px;"|[[File:RG2_26.png]]
 +
|}
 
{|
 
{|
−
|style="padding: 10px 0px 15px 15px;"|Firstly, select all tables you want to use in this section.<br />
+
|style="padding: 0px 0px 15px 15px;"|We want to display clients details in one column and quantity of orders in another one.<br/>
−
Afterwards, tick all records from tables you want to display.<br />
+
The first column will be displayed by:
−
If you decide to display aditional column, you can define them in '' 'Additional Columns' '' field.
+
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.<br/>
 +
Due to join type, '' 'COUNT(*) as Orders' '' will be filled with 1 for them.<br/>
 +
Proceed to '' 'Groups & Limits' '' tab to set up grouping by (currently our generator does not recognize what should be counted).
 
|}
 
|}
 
{|
 
{|
−
|style="padding: 0px 0px 20px 25px;"|[[File:RG15.png]]
+
|style="padding: 0px 0px 20px 25px;"|[[File:RG2_27.png]]
 
|}
 
|}
 
{|
 
{|
−
|style="padding: 0px 0px 20px 15px;"|To set date used in this section of report select this record from '' 'Date' '' dropdown menu.
+
|style="padding: 0px 0px 15px 15px;"|We want to group records by clients, therefore fill '' 'Group This Section By' '' with '' 'Clients Table : ID' '' which is a unique key at the client table.<br/>
 +
Additionally, let's set up sorting clients by quantity of orders, we can use column alias for this.<br/>
 +
As we predicted, clients with 0 orders have assigned 1 order. Proceed to '' 'Your Own Code' '' to fix that.
 
|}
 
|}
 
{|
 
{|
−
|style="padding: 0px 0px 20px 25px;"|[[File:RG16.png]]
+
|style="padding: 0px 0px 20px 25px;"|[[File:RG2_28.png]]
 
|}
 
|}
 
{|
 
{|
−
|style="padding: 0px 0px 15px 15px;"|At '' 'Custom PHP Function' '' you can alter displayed result. Remember to place your code in:<br />
+
|style="padding: 0px 0px 15px 15px;"|At '' 'Your Own Code' '' tab you can modify received output.<br/>
 +
Code has to be placed in delimiters as shown below.
 
  <?php  
 
  <?php  
 
  // your custom code here
 
  // your custom code here
−
return $result;
 
 
  ?>  
 
  ?>  
−
The '''$result''' variable is passed by refference, and contains just iterated element of the result array.<br />
+
The '' '$result' '' variable is passed by reference and contains just iterated element of the result array.<br/>
−
So you can create a new columns in your table or modyfing existing ones through modyfing this variable.<br />
+
In this way you can create new columns in your table or modify existing ones through modifying this variable.<br/>
−
You can access it as normal array, where the key is the column name and value is the current row value.<br />
+
You can access it as typical array where the key is a column name and value is a current row value.<br/>
−
''Important: <span style="color:#FF0000">Use this field with caution</span>, because every mistake made here can result with <span style="color:#FF0000">error in your production environment</span>.''
+
'''Important 1: <span style="color:#FF0000">Use this field with caution</span>, because every mistake made here can result with <span style="color:#FF0000">error in your production environment</span>.'''<br/>
 +
''Note: While working on $result you can use aliases!''<br/>
 +
What we need to do is assign 0 to '' 'Orders' '' column if '' 'Any_Order_Exist' '' column is empty.<br/>
 +
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.<br/>
 +
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
 +
{
 +
&nbsp;$element->Orders=0;      //assign 0 to Orders if Any_Order_Exist is empty
 +
&nbsp;$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
 +
{
 +
&nbsp;$element->Any_Order_Exist='Yes';  //assign 'Yes' to Any_Order_Exist
 +
}
 +
}
 +
?>
 
|}
 
|}
 
{|
 
{|
−
|style="padding: 0px 0px 20px 25px;"|[[File:RG17.png]]
+
|style="padding: 0px 0px 20px 25px;"|[[File:RG2_29.png]]
 
|}
 
|}
 
{|
 
{|
−
|style="padding: 0px 0px 15px 15px;"|Last step here is joining tables you added to this section, it is necesary to display report correctly.<br />
+
|style="padding: 0px 0px 20px 15px;"|Your code is ready, press '' 'Generate Report' '' to save it.
−
For example, to join table '' 'tblclients' '' with '' 'tblactivitylog' '' you should join it using '' 'tblclients - id' '' and '' 'tblactivitylog- clientid' ''.<br />
+
−
If you have more than 2 tables in your report section, it is adviced to create more join relations.
+
 
|}
 
|}
 
{|
 
{|
−
|style="padding: 0px 0px 30px 25px;"|[[File:RG18.png]]
+
|style="padding: 0px 0px 30px 25px;"|[[File:RG2_30.png]]
 
|}
 
|}
 +
-->
  
−
===Filters===
+
<!--
 +
===Expert - Unpaid Invoices===
 
{|
 
{|
−
|style="padding: 10px 0px 15px 15px;"|At '' 'Filters' '' tab you can decide which records should be displayed through setting conditions.<br />
+
|style="padding: 10px 0px 15px 15px;"|In the third report we will show you how to prepare report displaying clients with the highest number of unpaid invoices.<br/>
−
You can use predefined conditions. Select record to apply filter on, afterwards select '' 'Operation Type' '' and type value into '' 'Default Value' '' field.
+
We will also add second section displaying unpaid invoices which can be filtered by client first and last name.<br/>
 +
Start by defining report name and description, choose report type and starting table.<br/>
 +
Press '' 'Join Another Table' '' to proceed.
 
|}
 
|}
 
{|
 
{|
−
|style="padding: 0px 0px 20px 25px;"|[[File:RG19.png]]
+
|style="padding: 0px 0px 20px 25px;"|[[File:RG2_31.png]]
 
|}
 
|}
 
{|
 
{|
−
|style="padding: 0px 0px 20px 15px;"|You can also type your own conditions using field marked on the screen below.
+
|style="padding: 0px 0px 20px 15px;"|Now, join invoice table using '' 'Clients Table : ID' '' and '' 'Invoices Table : userid' '' and set it up to return tables only if there is a match in the invoice table.
 
|}
 
|}
 
{|
 
{|
−
|style="padding: 0px 0px 30px 25px;"|[[File:RG20.png]]
+
|style="padding: 0px 0px 20px 25px;"|[[File:RG2_32.png]]
 
|}
 
|}
 +
{|
 +
|style="padding: 0px 0px 20px 15px;"|Add '' 'COUNT(*) as Sum' '' column and proceed to the '' 'Conditions' '' tab.
  
−
===Orders & Limits===
+
|}
 
{|
 
{|
−
|style="padding: 10px 0px 15px 15px;"|At '' 'Order & Limits' '' tab you can set group by (which it is necesary if you set up '' 'Aditional Fields' ''), order by and limits.<br />
+
|style="padding: 0px 0px 20px 25px;"|[[File:RG2_33.png]]
−
To set '' 'Group By' '', select record to order by displayed values, afterwards select direction of grouping by.<br />
+
−
You can also use custom group by command through  pressing '' 'Add your own group by query' '' and typing command in textbox which will apear.
+
 
|}
 
|}
 
{|
 
{|
−
|style="padding: 0px 0px 20px 25px;"|[[File:RG21.png]]
+
|style="padding: 0px 0px 20px 15px;"|Press '' 'Create New Filter' '' button to define new condition for your report.
 
|}
 
|}
 
{|
 
{|
−
|style="padding: 0px 0px 15px 15px;"|In order to set group by, select record or time period to group by.<br />
+
|style="padding: 0px 0px 20px 25px;"|[[File:RG2_34.png]]
−
You can also use custom order by command through pressing '' 'Add your own order by query' '' and entering command in textbox which will apear.
+
 
|}
 
|}
 
{|
 
{|
−
|style="padding: 0px 0px 32px 25px;"|[[File:RG22.png]]
+
|style="padding: 0px 0px 15px 15px;"|Select column you want to define condition for, select filter operand, define default value of filter and filter friendly name.<br/>
 +
Conditions can be changed at the report view, they will be displayed under friendly name defined here.
 
|}
 
|}
 
{|
 
{|
−
|style="padding: 0px 0px 15px 15px;"|Through setting up limits you can define time period to create report from.<br />
+
|style="padding: 0px 0px 20px 25px;"|[[File:RG2_35.png]]
−
To do it, simply enter time period (in days) to create report from.
+
 
|}
 
|}
 
{|
 
{|
−
|style="padding: 0px 0px 30px 25px;"|[[File:RG23.png]]
+
|style="padding: 0px 0px 15px 15px;"|Fill '' 'concat(tblclients.id, tblclients.lastname, tblclients.firstname)' '' into '' 'Group This Section By' '' field.<br/>
 +
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.<br/>
 +
This concat returns client ID, lastname and firstname in one string.<br/>
 +
Order records using '' 'Sum' '' alias and define limit of column for this report.<br/>
 +
Now, let's create the second section. To do so, press '' 'Create New Section'. ''
 
|}
 
|}
−
 
−
===Charts===
 
 
{|
 
{|
−
|style="padding: 10px 0px 15px 15px;"|'' 'Charts' '' tab allows you to create any quantity of charts in your report.<br />
+
|style="padding: 0px 0px 20px 25px;"|[[File:RG2_36.png]]
−
You can create two type of charts which are pie chart and area chart.
+
 
|}
 
|}
 
{|
 
{|
−
|style="padding: 0px 0px 32px 25px;"|[[File:RG24.png]]
+
|style="padding: 0px 0px 15px 15px;"|In this section we want to display a list of all unpaid invoices of a selected client.<br/>
 +
Select date table and start of client table.<br/>
 +
Additionally, join client table with invoice table as in previous section.  
 
|}
 
|}
 
{|
 
{|
−
|style="padding: 0px 0px 20px 15px;"|To create pie chart, press on '' 'Pie Chart' '' button.
+
|style="padding: 0px 0px 20px 25px;"|[[File:RG2_37.png]]
 
|}
 
|}
 
{|
 
{|
−
|style="padding: 0px 0px 32px 25px;"|[[File:RG25.png]]
+
|style="padding: 0px 0px 15px 15px;"|Now, add desired columns. As you can see on the following screen, we have used concat to display clients details in the first column.<br/>
 +
Proceed to condition tab and press '' 'Add New Condition' '' button.
 
|}
 
|}
 
{|
 
{|
−
|style="padding: 0px 0px 20px 15px;"|Afterwards, type chart name and select record to create pie chart from.
+
|style="padding: 0px 0px 20px 25px;"|[[File:RG2_38.png]]
 
|}
 
|}
 
{|
 
{|
−
|style="padding: 0px 0px 20px 25px;"|[[File:RG26.png]]
+
|style="padding: 0px 0px 15px 15px;"|There are two conditions to add, their default values are left blank so default report will omit these conditions.<br />
 +
Nonetheless, you will be able to easily filter for desired client in report view.<br />
 +
Now, create conditions shown below.
 
|}
 
|}
 
{|
 
{|
−
|style="padding: 0px 0px 20px 15px;"|Creating area chart is simillar, to begin press on '' 'Area Chart' '' button.
+
|style="padding: 0px 0px 20px 25px;"|[[File:RG2_39.png]]
 
|}
 
|}
 
{|
 
{|
−
|style="padding: 0px 0px 20px 25px;"|[[File:RG27.png]]
+
|style="padding: 0px 0px 20px 25px;"|[[File:RG2_40.png]]
 
|}
 
|}
 
{|
 
{|
−
|style="padding: 0px 0px 20px 15px;"|Afterwards, type chart name, additional column counters (which are optional) and select record to create area chart from.
+
|style="padding: 0px 0px 15px 15px;"|Proceed to '' 'Groups & Limits' '' tab and set up ordering by ID.<br/>
 +
You can also increase limits of record displayed on the report.
 
|}
 
|}
 
{|
 
{|
−
|style="padding: 0px 0px 30px 25px;"|[[File:RG28.png]]
+
|style="padding: 0px 0px 20px 25px;"|[[File:RG2_41.png]]
 
|}
 
|}
−
===Saving Report===
 
 
{|
 
{|
−
|style="padding: 10px 0px 20px 15px;"|When your report is ready, save it through pressing '' 'Create Report' ''.
+
|style="padding: 0px 0px 15px 15px;"|Let's proceed to '' 'Your Own Code' '' section to replace '' 'No Company Assigned' '' with blank field.<br/>
 +
Copy and paste code placed below:
 +
<?php
 +
foreach($result as $element)
 +
if($element->companyname=='No Company Assigned')
 +
{
 +
&nbsp;$element->companyname=<nowiki>''</nowiki>;
 +
}
 +
?>
 +
Your report is ready, press '' 'Generate Report' '' to finish.
 
|}
 
|}
 
{|
 
{|
−
|style="padding: 0px 0px 30px 25px;"|[[File:RG28_1.png]]
+
|style="padding: 0px 0px 30px 25px;"|[[File:RG2_42.png]]
 
|}
 
|}
 +
-->
  
−
==Custom Table Records Names==
+
<!--
 +
==Modify Report==
 
{|
 
{|
−
|style="padding: 10px 0px 15px 15px;"|You can set custom table record names, it is quite simple.<br />
+
|style="padding: 10px 0px 20px 15px;"|All custom reports can be easily altered. Press '' 'Edit' '' next to report that you wish to modify.
−
Open lang file located at '' 'your_whmcs/modules/addons/mg_resellers/lang' '', in this example it is '' 'english.php' ''.<br />
+
−
Afterwards, enter:
+
−
''$_LANG['record_name'] = 'displayed_record_name';''
+
−
Where record_name is record name you want to display differently and displayed_record_name is name under which this record will be visible.<br />
+
−
For example, to change record '' 'groupid' '' to '' 'Group ID' '' use this code:<br />
+
−
''$_LANG['groupid'] = 'Group ID';''
+
−
''Note 1: It will set up custom name for all records with that name.''<br />
+
−
''Note 2: Custom table records support multi-language.''
+
 
|}
 
|}
 
{|
 
{|
−
|style="padding: 0px 0px 20px 25px;"|[[File:RG29.png]]
+
|style="padding: 0px 0px 20px 25px;"|[[File:RG2_43.png]]
 
|}
 
|}
 
{|
 
{|
−
|style="padding: 0px 0px 15px 15px;"|You can also set up custom table name in the same way.<br />
+
|style="padding: 0px 0px 15px 15px;"|Edit screen is the same as generate screen. Therefore you are allowed to modify and even entirely change report according to your needs.<br/>
−
''$_LANG['table_name'] = 'displayed_table_name';''
+
We will add filtering results by clients' nationality to this report.<br/>
 +
Join hosting table with client table as shown on the following screen.
 
|}
 
|}
 
{|
 
{|
−
|style="padding: 0px 0px 30px 25px;"|[[File:RG30.png]]
+
|style="padding: 0px 0px 20px 25px;"|[[File:RG2_44.png]]
 
|}
 
|}
 +
{|
 +
|style="padding: 0px 0px 15px 15px;"|Proceed to '' 'Conditions' '' tab and press '' 'Add New Filter'.''<br/>
 +
Filter set up shown on the following screen will filter report output depending on client's country.
 +
|}
 +
{|
 +
|style="padding: 0px 0px 30px 25px;"|[[File:RG2_44_1.png]]
 +
|}
 +
-->
  
−
==Email Configuration==
+
==Schedule Report==
 +
{|
 +
|style="padding: 10px 0px 15px 15px;"|At '' 'Schedule Reports' '' section, you can point which reports will be sent directly to administrators.<br/>
 +
Press '' 'Schedule Report' '' to begin.
 +
|}
 +
{|
 +
|style="padding: 0px 0px 20px 25px;"|[[File:RG2_45.png]]
 +
|}
 +
{|
 +
|style="padding: 0px 0px 15px 15px;"|Box with a form to fill in will appear. Start by selecting the report you want to schedule.<br/> On the dropdowm menu you will find all reports available in you module including your custom reports.<br/> ''Please note that the form may slightly differ depending on the selected report type.''<br/>
 +
Afterwards, specify the conditions, how often reports should be sent, time period for which the report shall be generated and way of sending, by email or by FTP etc.<br/>
 +
Additionally, provide staff email addresses or FTP/SFTP details.<br/>
 +
Confirm through pressing '' 'Add Rule' '' button.
 +
|}
 
{|
 
{|
−
|style="padding: 10px 0px 15px 15px;"|At '' 'Email Configuration' '' you can set up emails with reports sent to administrators.<br />
+
|style="padding: 0px 0px 20px 25px;"|[[File:RG2_46.png]]
−
Simply select admin or admins to which email with report should be sent.<br />
+
−
Afterwards choose which of your reports should be sent.
+
 
|}
 
|}
 
{|
 
{|
−
|style="padding: 0px 0px 20px 25px;"|[[File:RG31.png]]
+
|style="padding: 0px 0px 15px 15px;"|As you can see on the following screen, all scheduled reports are listed in the table with report name, frequency and assigned admin users.<br/>
 +
Each of planned relations can be removed or edited at any time, use action buttons to do so.
 
|}
 
|}
 
{|
 
{|
−
|style="padding: 0px 0px 15px 15px;"|At '' 'Additional Filters' '' depending on report choosed, various fields will apear.<br />
+
|style="padding: 0px 0px 30px 25px;"|[[File:RG2_47.png]]
−
You can specify report content setting them up, for example, on the screen below we have choosen '' 'admin' '' staff member.<br />
+
−
This way report sent will refer to '' 'admin' '' staff member.<br />
+
−
Finish by selecting time period for email sending and press '' 'Add Relation' ''.
+
 
|}
 
|}
 
{|
 
{|
−
|style="padding: 0px 0px 30px 25px;"|[[File:RG32.png]]
+
|style="padding: 0px 0px 20px 15px;"|'''At the end you have to add a cron job as shown below (each 24 hours suggested).
 +
php -q /your_whmcs/modules/addons/reportgenerator/cron/cron.php
 +
Do not forget to replace '' 'your_whmcs' '' with your WHMCS root location.
 
|}
 
|}
  
−
==Import==
+
==Import/Export==
 
{|
 
{|
−
|style="padding: 10px 0px 20px 15px;"|To import report from XML file into your Report Generator go to '' 'Import' '' tab.
+
|style="padding: 10px 0px 15px 15px;"|'' 'Import/Export' '' section allows to quickly import your saved previously reports if you have for example stored them on your external disk for later use.<br/>
 +
Just select file and press '' 'Import'. '' Imported report will appear on the list of your custom reports.
 
|}
 
|}
 
{|
 
{|
−
|style="padding: 0px 0px 20px 25px;"|[[File:RG33.png]]
+
|style="padding: 0px 0px 20px 25px;"|[[File:RG2_48.png]]
 
|}
 
|}
 
{|
 
{|
−
|style="padding: 0px 0px 15px 15px;"|Next, press '' 'Upload' '' button and select your report XML file.<br />
+
|style="padding: 0px 0px 15px 15px;"|Underneath, you can see a list of your custom reports. Press '' 'Export' '' button to save its files on your disk.
−
Afterwards, press '' 'Upload' '' button and your report will be uploaded to the module.
+
 
|}
 
|}
 
{|
 
{|
−
|style="padding: 0px 0px 20px 25px;"|[[File:RG34.png]]
+
|style="padding: 0px 0px 30px 25px;"|[[File:RG2_49.png]]
 
|}
 
|}
 +
 +
<!--
 +
==Migration==
 
{|
 
{|
−
|style="padding: 0px 0px 15px 15px;"|However your just imported report is still not available at reports list, you need to install it first.<br />
+
|style="padding: 10px 0px 15px 15px;"|Due to changes in the module and its structure, upgrading it from version 1.0 requires migration tool.<br/>
−
To do so, simply press '' 'Install on Page' '' button as presented on the following screen.
+
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.<br/>
 +
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.<br/>
 +
'''Important: Email settings will be lost during the upgrade.'''
 
|}
 
|}
 
{|
 
{|
−
|style="padding: 0px 0px 20px 25px;"|[[File:RG35.png]]
+
|style="padding: 0px 0px 20px 25px;"|[[File:RG2_52.png]]
 
|}
 
|}
 
{|
 
{|
−
|style="padding: 0px 0px 15px 15px;"|Now you can go to '' 'Reports List' '' and see that your report has been successfully installed and it is ready to use.<br />
+
|style="padding: 0px 0px 20px 15px;"|Afterwards, press '' 'Update Report' '' button. Your report is now available at '' 'Reports List' → 'User Generated Reports'.''
 
|}
 
|}
 
{|
 
{|
−
|style="padding: 0px 0px 30px 25px;"|[[File:RG36.png]]
+
|style="padding: 0px 0px 30px 25px;"|[[File:RG2_53.png]]
 
|}
 
|}
 +
-->
  
 
=Tips=
 
=Tips=
 
{|
 
{|
−
|style="padding: 10px 0px 30px 15px;"|In order to work properly, module requires PHP with a PDO support.
+
|style="padding: 10px 0px 10px 15px;"|1. If you want to edit your custom report and make it more complicated, you may do it with a more advanced creator.<br/>
 +
When you are editing a report you may choose from the beginning which creator type you are going to use.
 +
|}
 +
{|
 +
|style="padding: 0px 0px 30px 15px;"|2. Report Generator For WHMCS requires '' ZipArchive '' PHP library installed on your server.
 
|}
 
|}
  
−
=Common Problems=
+
=Update Instructions=
 
{|
 
{|
−
|style="padding: 10px 0px 10px 15px;"|1. When you have problems with connection, check whether your SELinux or firewall is not blocking ports.
+
|style="padding: 10px 0px 30px 15px;"|Essential guidance through the process of updating the module is offered '''[https://www.docs.modulesgarden.com/How_To_Update_WHMCS_Module here]'''.<br/><br/>
 +
Keep in mind there is a quick and easy option in our client area that will let you upgrade the license of your module to an open source version at any time - and at a lower price!<br/>
 +
To take advantage of it, simply use the '''License Upgrade''' button located on the product's page and a discounted invoice will be generated automatically.<br/>
 
|}
 
|}
 +
 +
=Common Problems=
 
{|
 
{|
−
|style="padding: 0px 0px 30px 15px;"|2. If you encounter any troubles with our module it is possible that you have not installed PDO.
+
|style="padding: 10px 0px 30px 15px;"|'''1. When you have problems with connection, check whether your SELinux or firewall does not block ports.'''
 
|}
 
|}

Latest revision as of 14:42, 2 August 2019

Contents

[edit] About Report Generator For WHMCS

Report Generator For WHMCS allows you to generate and manage any kind of reports using inbuilt creators.

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 also schedule the reports creation and send them over an email to specified staff members.

  • Admin Area Features:
✔ Generate Your Own Report Using One Of 3 Creators
✔ View 30 Predefined Reports
✔ Modify Report Results With Dynamic Filters
✔ Generate PDF And CSV Files From Reports
✔ Print Reports With A Print Preview
✔ Schedule Automatic Reports With Specified Options Being Sent:
✔ To Chosen Staff Members
✔ To SFTP Server
✔ Export & Import Reports Structure To File
✔ Export Reports To XML File Format (Coming Soon)
  • Report Creation Features:
✔ Choose One Of 3 Creators:
✔ Beginner:
✔ Drag & Drop Editor
✔ WHMCS Tables Only
✔ Join Tables With Known Relations Only
✔ Intermediate:
✔ Drag & Drop Editor
✔ All Tables Available
✔ Modify Output With PHP
✔ Advanced:
✔ Write SQL Query
✔ All Tables Available
✔ Modify Output With PHP
✔ Choose Section Display Type:
✔ Data Table
✔ Pie Chart
✔ Area Chart
✔ Column Chart
✔ Create Multi-Section Reports
✔ Clone Sections (Coming Soon)
✔ Create Section Using Multiple Tables
✔ Dynamic Filter Types:
✔ Data Range Filter - Available On Report View
✔ Dropdown Filter - Specify Available Options During Report Creation
✔ Number Range Filter
✔ Text Filter
✔ Cron Date Filter - Define Date Range For Scheduled Reports
✔ Live Preview Of Data Returned By Report Creator
✔ Live Preview Of SQL Query Built By Report Creator
✔ Live Preview Of Section Generated By Report Creator
✔ Toggle Between Automatic & Manual Refreshing Of Generated Section
  • Additional Basic & Intermediate Creators Features:
✔ Mark Tables With Known Relations And Automatically Configure Join In Table
✔ Advanced Conditioning:
✔ Define Static Condition
✔ Define Requested Relation Between Two Fields
✔ Add Dynamic Filter As Condition
✔ Output Field:
✔ Field - Display Field As Is
✔ Concat - Join Multiple Fields Into One
✔ Substr - Display Only Part Of Chosen Field
✔ Sum - Summarize All Values With The Same Value Of Group By Field
✔ Count - Count All Values With The Same Value Of Group By Field
✔ Max - Display Maximal Value Found Within Fields With The Same Value Of Group By Field
✔ Min - Display Minimal Value Found Within Fields With The Same Value Of Group By Field
✔ Avg - Display Average Of Fields With The Same Value Of Group By Field
✔ Limit Amount Of Data Displayed On Report
✔ Skip Chosen Amount Of First Records Displayed On Report
  • General Info:
✔ Report Migration Tool
✔ Multi-Language Support
✔ Supports PHP 5.6 Up To PHP 7.2
✔ Supports WHMCS V7
✔ Easy Module Upgrade To Open Source Version
  • Predefined Reports:
✔ 'Clients Information' Section:
✔ Customers Per Country
✔ Most Valuable Clients
✔ Paid Orders Report
✔ Orders Report
✔ Created Panels Report
✔ User Accounts Created:
✔ Number Of Created User Accounts By Date
✔ List Of User Accounts Created
✔ Business Health Status:
✔ Domain Renewals For The Time Period
✔ Open Tickets For The Period
✔ New Invoices For The Time Period
✔ Invoice Reminders For The Time Period
✔ Hosting Renewals
✔ Suspended Services For The Time Period
✔ Complete Cases:
✔ Closed & Answered Status Tickets By The Staff Member
✔ Tickets Stats In Time By The Staff Member
✔ Completed To-Do List Tasks By The Staff Member
✔ To-Do Tasks Stats Per Status By The Staff Member
✔ Orders Summary
✔ Tasks And Tickets In Progress:
✔ General Tickets Statistics - For Selected Staff Member Or Team In Time
✔ To-Do List - Tasks Per Status For Selected Staff Member Or Team In Time
✔ To-Do List - Tasks In Progress For Selected Staff Member Or Team In Time
✔ Unpaid Invoices
✔ Client Payment History
✔ 'Services' Section:
✔ Product Income In Location
✔ Income Per Country
✔ MRR & Churn Metrics
✔ MRR & Churn Per Product
✔ Orders Number
✔ Orders Over The Weekdays
✔ Registered Services
✔ Renewals Report
✔ Tasks And Tickets In Progress:
✔ Transferred Domains Report
✔ 'CRM Related' Section:
✔ WWW Created Panels Report
✔ Traders Renewals Report
✔ WWW Renewals Report
✔ Leads Report
✔ 'Staff Members' Section:
✔ Tickets In Hours
✔ Ticket Replies By Admin
✔ Comments On Course Of Ticket Solving
✔ Ratings Of Ticket Solving Course
✔ Ticket Response Rating
✔ Flexible Transactions Report

[edit] Installation

This tutorial will show you how to successfully install and configure Report Generator For WHMCS.

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

1. Log in to our client area and download the module.
RG2 1.png
2. In the downloaded file you will find two packages that support different PHP versions.
As presented on the screen below, the first one is dedicated to PHP 5.6 up to PHP 7.0, while the second one is aimed at PHP 7.1 up to PHP 7.2.
It does not apply to open source versions.

Note: You can check the current PHP version in your WHMCS. To do so, proceed to 'Utilities' › 'System' › 'PHP Info'.

PHP56 72.png
3. Extract the downloaded file and choose the one with the right PHP version. Upload and extract the PHP file into the main WHMCS directory.

The content of PHP version files should look like this.

RG2 2 1.png
4. When you install Report Generator For WHMCS for the first time you have to rename 'license_RENAME.php' file.

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

RG2 3.png
5. In order to configure your license key, you have to edit a previously renamed 'license.php' file.'

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

RG2 4.png
6. Now, set up the 'storage' folder as writable.

This folder should be available at 'your_whmcs/modules/addons/reportgenerator/' .

RG2 5.png
7. Now you have to activate the module in your WHMCS system.

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

RG2 6.png
8. In the next step you need to permit access to this module.

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

RG2 7.png
9. You have just successfully installed Report Generator!

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

RG2 8.png

[edit] Configuration and Management

Report Generator For WHMCS allows you to create custom reports using drag & drop WYSIWYG builder.

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

[edit] Predefined Reports

'Reports' the main section of the module, gives a preview of all available reports, those predefined as well as those you create by yourself.

Predefined reports are divided into five categories plus custom reports if you have some.

Clients Information - eleven predefined reports that will show statistics on data related to your clients, for example statistics on placed orders, tasks, etc.
RG2 10.png
Services - nine different reports ready to analyze any services related data like income, renewals or transfers in your system.
RG2 10 1.png
CRM Related - four ground reports based on your CRM data. Please note that you can see them only if you are using our CRM For WHMCS module.
More about CRM For WHMCS can be found here, instructions how to configure your CRM.
RG2 10 2.png
Staff Members - three predefined reports related to staff members and tickets department.
RG2 10 3.png
Custom reports - all reports that you have personally created using our inbuilt creators.
RG2 10 4.png

[edit] Report View

Press 'Show' button next to a report you are interested in.
RG2 13.png
Depending on the type of report you choose, you can set the time frames within which you want to see the statistics.

Provide the beginning and ending dates, then press 'Filter' button. Fresh report will be generated on the run.

RG2 13 1.png
In case of some reports, filtering is impossible due to the stable content of the report.
RG213 2.png
You can always view a printable version of the report or generate a PDF or CSV which can be saved on your disk.
RG2 14.png

[edit] Creating Report

In this section we will show you how to prepare a few exemplary reports.

We will now show you how to develop three different reports, each one will slightly more complicated than the previous one.
The first steps are the same for each advancement level.

Press 'Create Report'.
RG2 15 1.png
Now select the type of chart that you wish to achieve in the final result.

You may generate a 'Colum', 'Pie', 'Table' or 'Area' chart. For presentation purposes we will start with a Table chart.
Press it to select.

RG2 15.png
It is time to select the creator type. You can generate your report with:
  • creator for beginners
  • creator for admins on an intermediate level
  • creator for professionals - expert

Let's begin with the easiest one - 'Beginner'.

RG2 16.png

[edit] Beginner - Unpaid Invoices Per Clients

When you enter the creator, the first things you can see is a wide description table with example.
When you are familiar with it, press and it will be automatically hidden.
The very first steps of creating a report is defining base table, only when it is selected, you may move to the next steps.br/>

Depending on what your report is going to analyze, you must now find appropriate table.
For example if you want to create a report that will base on clients, then find such WHMCS table.
If you want to join it with another table, then drag it and drop into 'Join Additional Information', note that you may join only tables highlighted in blue.

RG2 17.png
Now, let's move to 'Display If' section. From available 'Fields' drag option that you want to select.
RG2 17 1.png
We have decided to drag 'Status' and provide its value: 'Unpaid'. Then only unpaid invoices will be taken into consideration in the final report.
RG2 18.png
Let's move to 'Select Fields To Display On Final Report' section. Drag from ' Fields' ' section any ones that you wish to see on your report.
RG2 20.png
You can also decide the way the entries will be sorted.

On the screen below you can see sorting by invoice due date in descending order.

RG2 21.png
Let's check how our report will look like.

You can see there a list of clients, due date of their unpaid invoices together with the amount to pay and a selected payment method.

RG2 22.png
Take a look at the full creator view.
Save the changes when your report is ready.

Apart form the options used to generate this report, there are also 'Group By' and ' Limit'.
We will show how to use them in other examples.

RG2 23.png
Finally, name your report and describe it shortly.
RG2 24.png
When everything is ready, you can see your report. You can always:

1. Edit your report section
2. Delete report section
3. Print the report
4. Generate PDF version
5. Generate CSV version
6. Add new section to the report
7. Delete the whole report

RG2 25.png

[edit] Intermediate Creator

When you open the creator, the overall view is very similar to the 'Beginner' creator type.
Here you also select items depending on your needs and drag them into proper fields.
RG3 26.png
The difference here is the possibility to make adjustments to your report with the use of PHP language.
Whenever you commit any changes remember to save the section.
RG3 27.png

[edit] Advanced Creator

This creator allows to use advanced option, such as writing an SQL query. Just provide correct variables in the box on the left.
RG3 28.png
You can also add a filter that will be used while searching through the report. Give the details corresponding to your needs the most and save changes.
RG3 29.png


[edit] Schedule Report

At 'Schedule Reports' section, you can point which reports will be sent directly to administrators.

Press 'Schedule Report' to begin.

RG2 45.png
Box with a form to fill in will appear. Start by selecting the report you want to schedule.
On the dropdowm menu you will find all reports available in you module including your custom reports.
Please note that the form may slightly differ depending on the selected report type.

Afterwards, specify the conditions, how often reports should be sent, time period for which the report shall be generated and way of sending, by email or by FTP etc.
Additionally, provide staff email addresses or FTP/SFTP details.
Confirm through pressing 'Add Rule' button.

RG2 46.png
As you can see on the following screen, all scheduled reports are listed in the table with report name, frequency and assigned admin users.

Each of planned relations can be removed or edited at any time, use action buttons to do so.

RG2 47.png
At the end you have to add a cron job as shown below (each 24 hours suggested). 
php -q /your_whmcs/modules/addons/reportgenerator/cron/cron.php

Do not forget to replace 'your_whmcs' with your WHMCS root location.

[edit] Import/Export

'Import/Export' section allows to quickly import your saved previously reports if you have for example stored them on your external disk for later use.

Just select file and press 'Import'. Imported report will appear on the list of your custom reports.

RG2 48.png
Underneath, you can see a list of your custom reports. Press 'Export' button to save its files on your disk.
RG2 49.png


[edit] Tips

1. If you want to edit your custom report and make it more complicated, you may do it with a more advanced creator.

When you are editing a report you may choose from the beginning which creator type you are going to use.

2. Report Generator For WHMCS requires ZipArchive PHP library installed on your server.

[edit] Update Instructions

Essential guidance through the process of updating the module is offered here.

Keep in mind there is a quick and easy option in our client area that will let you upgrade the license of your module to an open source version at any time - and at a lower price!
To take advantage of it, simply use the License Upgrade button located on the product's page and a discounted invoice will be generated automatically.

[edit] Common Problems

1. When you have problems with connection, check whether your SELinux or firewall does not block ports.
Retrieved from "https://www.docs.modulesgarden.com/index.php?title=Report_Generator_3.X_For_WHMCS&oldid=46604"
Navigation
WHMCS Modules
WHMCS Widgets
Translations
cPanel Modules
General
FAQ
Community