Personal tools
Namespaces

Variants
Actions

Hosting Quota Notifications 1.X For WHMCS

From ModulesGarden Wiki
(Difference between revisions)
Jump to: navigation, search
 
(525 intermediate revisions by 6 users not shown)
Line 1: Line 1:
−
<meta name="keywords" content="report generator for whmcs, report generator configuration, whmcs report generator management, whmcs report generator installation, whmcs report generator common problems, about whmcs report generator, whmcs report generator documentation, whmcs report generator faq, whmcs report generator help, whmcs report generator guide, whmcs report generator wiki, whmcs report generator tutorial, whmcs report generator tips, whmcs report generator wiki"></meta>
+
<meta name="keywords" content="hosting quota notifications for whmcs, hosting quota notifications configuration, whmcs hosting quota notifications management, whmcs hosting quota notifications installation, whmcs hosting quota notifications common problems, about whmcs hosting quota notifications, whmcs hosting quota notifications documentation, whmcs hosting quota notifications faq, whmcs hosting quota notifications help, whmcs hosting quota notifications guide, whmcs hosting quota notifications wiki, whmcs hosting quota notifications tutorial, whmcs hosting quota notifications tips, whmcs hosting quota notifications wiki"></meta>
−
<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 Hosting Quota Notifications For WHMCS Module."></meta>
  
−
 
+
=About [https://www.modulesgarden.com/products/whmcs/hosting-quota-notifications Hosting Quota Notifications For WHMCS]=
−
=About [http://www.modulesgarden.com/products/whmcs/report_generator/features Report Generator For WHMCS]=
+
 
{|
 
{|
−
|style="padding: 10px 0px 5px 0px;"|'''Report Generator For WHMCS''' allows you to generate and manage any kind of reports using inbuilt creators.<br />
+
|style="padding: 10px 0px 10px 0px;"|'''Hosting Quota Notifications For WHMCS''' allows you to send automatic notifications to your clients whenever they exceed previously set bandwidth or disk usage.
−
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 />
+
Notifications can be sent in two ways: upon exceeding given resource tier or after exceeding given resource limit in a specified time period.<br />
−
You can also schedule the reports creation and send them over an email to specified staff members.
+
You can also define email templates and view details of each sent notification owing to logs.
 
|}
 
|}
−
<!-- fixed -->
+
<!--a comment maybe? -->
 
*'''Admin Area Features:'''
 
*'''Admin Area Features:'''
 
{|
 
{|
−
|style="padding: 10px 0px 0px 30px;"|✔ Generate Your Own Report Using One Of 3 Creators
+
|style="padding: 10px 0px 0px 30px;"|✔ Automatically Notify Your Clients Upon Exceeding Defined Limits Of Bandwidth And Disk Usage
 
|}
 
|}
 
{|
 
{|
−
|style="padding: 0px 0px 0px 30px;"|✔ View 30 Predefined Reports
+
|style="padding: 0px 0px 0px 30px;"|✔ Configure Notification Groups
 
|}
 
|}
 
{|
 
{|
−
|style="padding: 0px 0px 0px 30px;"|✔ Modify Report Results With Dynamic Filters
+
|style="padding: 0px 0px 0px 30px;"|✔ Choose Between Two Types Of Group Counting:
 
|}
 
|}
 
{|
 
{|
−
|style="padding: 0px 0px 0px 30px;"|✔ Generate PDF And CSV Files From Reports
+
|style="padding: 0px 0px 0px 45px;"|✔ Tiered - Define Tiers Of Usage
 
|}
 
|}
 
{|
 
{|
−
|style="padding: 0px 0px 0px 30px;"|✔ Print Reports With A Print Preview
+
|style="padding: 0px 0px 0px 45px;"|✔ Fixed - Define Usage Grow Over Time
 
|}
 
|}
 
{|
 
{|
−
|style="padding: 0px 0px 0px 30px;"|✔ Schedule Automatic Reports With Specified Options Being Sent:
+
|style="padding: 0px 0px 0px 30px;"|✔ Assign Multiple Products To Single Notification Group
 
|}
 
|}
 
{|
 
{|
−
|style="padding: 0px 0px 0px 45px;"|✔ To Chosen Staff Members
+
|style="padding: 0px 0px 0px 30px;"|✔ Assign Email Templates Per Notification Group
 
|}
 
|}
 
{|
 
{|
−
|style="padding: 0px 0px 0px 45px;"|✔ To SFTP Server
+
|style="padding: 0px 0px 0px 30px;"|✔ Enable/Disable Notification Groups
 
|}
 
|}
 
{|
 
{|
−
|style="padding: 0px 0px 0px 30px;"|✔ Export & Import Reports Structure To File
+
|style="padding: 0px 0px 10px 30px;"|✔ View Logs Of Sent Notifications
 
|}
 
|}
−
{|
 
−
|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:'''
 
*'''General Info:'''
 
{|
 
{|
−
|style="padding: 10px 0px 0px 30px;"|✔ Report Migration Tool
+
|style="padding: 10px 0px 0px 30px;"|✔ Multi-Language Support
 
|}
 
|}
 
{|
 
{|
−
|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 V6 And V7
+
|style="padding: 0px 0px 30px 30px;"|✔ Supports WHMCS V7
−
|}
+
−
{|
+
−
|style="padding: 0px 0px 10px 30px;"|✔ Supports PHP7
+
−
|}
+
−
*'''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
+
−
|}
+
−
{|
+
−
|style="padding: 0px 0px 0px 45px;"|✔ Ticket Response Rating
+
−
|}
+
−
{|
+
−
|style="padding: 0px 0px 0px 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 30px 15px;"|'''This tutorial will show you how to successfully install and configure Hosting Quota Notifications 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.
 
|}
 
|}
 +
==Installation==
 
{|
 
{|
−
|style="padding: 20px 0px 20px 15px;"|'''1. Log in to your client area and download Report Generator For WHMCS.'''
+
|style="padding: 10px 0px 20px 15px;"|'''1. Log in to our client area and download the module.'''
 
|}
 
|}
 
{|
 
{|
−
|style="padding: 0px 0px 20px 25px;"|[[File:RG2_1.png]]
+
|style="padding: 0px 0px 20px 25px;"|[[File:HQN_1.png]]
 
|}
 
|}
 
{|
 
{|
−
|style="padding: 0px 0px 15px 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 7, while the second one is aimed at PHP 5.3.7 up to PHP 5.6.<br/>It does not apply to open source versions.<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/>
−
'' '''Note''': You can check current PHP version in your WHMCS. To do so proceed to ''' 'Utilities' → 'System' → 'PHP Info'.'''
+
'' '''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_2.png]]
+
|style="padding: 0px 0px 20px 25px;"|[[File:PHP56_72.png]]
 
|}
 
|}
 
{|
 
{|
Line 377: Line 72:
 
|}
 
|}
 
{|
 
{|
−
|style="padding: 0px 0px 20px 25px;"|[[File:RG2_2_1.png]]
+
|style="padding: 0px 0px 20px 25px;"|[[File:drfere.png]]
 
|}
 
|}
 
{|
 
{|
−
|style="padding: 0px 0px 15px 15px;"|'''4. When you install Report Generator for the first time you have to rename '' 'license_RENAME.php' '' file.'''<br />
+
|style="padding: 0px 0px 15px 15px;"|'''4. When you install Hosting Quota Notifications For WHMCS for the first time you have to rename '' 'license_RENAME.php' '' file.'''<br />
−
File is located in '' 'modules/addons/reportgenerator/license_RENAME.php'. '' Rename it from '' 'license_RENAME.php' '' to '' 'license.php'. ''
+
File is located in '' 'modules/addons/hosting_quota_notifications/license_RENAME.php' '' . Rename it from '' 'license_RENAME.php' '' to '' 'license.php' '' .
 
|}
 
|}
 
{|
 
{|
−
|style="padding: 0px 0px 20px 25px;"|[[File:RG2_3.png]]
+
|style="padding: 0px 0px 20px 25px;"|[[File:HQN_3.png]]
 
|}
 
|}
 
{|
 
{|
−
|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 />
+
|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 />
−
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'. ''
+
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:RG2_4.png]]
+
|style="padding: 0px 0px 30px 25px;"|[[File:HQN_4.png]]
 
|}
 
|}
 +
 +
==Configuration of Addon==
 
{|
 
{|
−
|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 you have to activate the module in your WHMCS system.'''<br />
−
Log in to your WHMCS admin area. Go to '' 'Setup' '' → '' 'Addon Modules'. '' Afterwards, find '' 'Report Generator' '' and press '' 'Activate' '' button.
+
Log in to your WHMCS admin area. Go to '' 'Setup' '' → '' 'Addon Modules' ''. Afterwards, find '' 'Hosting Quota Notifications' '' and press '' 'Activate' '' button.
 
|}
 
|}
 
{|
 
{|
−
|style="padding: 0px 0px 20px 25px;"|[[File:RG2_6.png]]
+
|style="padding: 0px 0px 20px 25px;"|[[File:HQN_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. In the next step you need to permit access to this module.'''<br />
−
To do so, click on '' 'Configure' '' button, tick '' 'Full Administrator' '' and press '' 'Save Changes'. ''
+
To do so click on '' 'Configure' '' button, tick '' 'Access Control' '' near required admin role groups and press '' 'Save Changes' ''.
 
|}
 
|}
 
{|
 
{|
−
|style="padding: 0px 0px 20px 25px;"|[[File:RG2_7.png]]
+
|style="padding: 0px 0px 30px 25px;"|[[File:HQN_6.png]]
 
|}
 
|}
 +
 
{|
 
{|
−
|style="padding: 0px 0px 15px 15px;"|'''8. You have just successfully installed Report Generator!'''<br />
+
|style="padding: 0px 0px 15px 15px;"|'''8. You have just successfully installed Hosting Quota Notifications For WHMCS!'''<br />
−
You can access the module at '' 'Addons' '' → '' 'Report Generator'. ''
+
You can access your module in '' 'Addons' '' → '' 'Hosting Quota Notifications' ''.
 
|}
 
|}
 
{|
 
{|
−
|style="padding: 0px 0px 30px 25px;"|[[File:RG2_8.png]]
+
|style="padding: 0px 0px 30px 25px;"|[[File:HQN_7.png]]
 
|}
 
|}
  
 
=Configuration and Management=
 
=Configuration and Management=
 
{|
 
{|
−
|style="padding: 10px 0px 30px 15px;"|'''Report Generator For WHMCS allows you to create custom reports using drag & drop WYSIWYG builder.<br/>
+
|style="padding: 10px 0px 30px 15px;"|'''In this section we will show you how to properly set up and use Hosting Quota Notifications For WHMCS.'''
−
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.
+
 
|}
 
|}
−
 
+
==Configuration==
−
==Predefined Reports==
+
 
{|
 
{|
−
|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/>
+
|style="padding: 10px 0px 15px 15px;"|In '' 'Configuration' '' page you can find the list of configured notification groups.<br />
−
Predefined reports are divided into five categories plus custom reports if you have some.
+
You can enable/disable any of them, as well as alter or completely remove them.<br />
 +
Press '' 'Create New Group' '' to proceed.
 
|}
 
|}
 
{|
 
{|
−
|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 25px;"|[[File:HQN_9.png]]
 
|}
 
|}
 
{|
 
{|
−
|style="padding: 0px 0px 20px 25px;"|[[File:RG2_10.png]]
+
|style="padding: 0px 0px 15px 15px;"|Now, you can define all products related to this configuration and email template which will be used to notify your clients.<br />
 +
You can choose between two types of resource usage counting:<br />
 +
*Fixed - define amount of resources over specific time period. If client usage growth has exceeded the given limit in specified time, a notification will be sent.
 +
*Tiered - defines amount of resources. If client exceeds given limit, a notification will be sent.
 
|}
 
|}
 
{|
 
{|
−
|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 20px 25px;"|[[File:HQN_10.png]]
 
|}
 
|}
 
{|
 
{|
−
|style="padding: 0px 0px 20px 25px;"|[[File:RG2_10_1.png]]
+
|style="padding: 0px 0px 15px 15px;"|For example, shown below module uses fixed counting type.<br />
 +
As you can see, we have defined limits for both bandwidth and disk.<br />
 +
Settings shown below result in sending notification to client upon:
 +
*bandwidth usage growth by 5GB during 21 days.
 +
*disk usage growth by 100GB over period of 14 days.
 
|}
 
|}
 
{|
 
{|
−
|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 [http://www.modulesgarden.com/products/whmcs/crm/features here], instructions how to [http://www.docs.modulesgarden.com/CRM_For_WHMCS configure] your CRM.
+
|style="padding: 0px 0px 30px 25px;"|[[File:HQN_11.png]]
 
|}
 
|}
 +
==Logs==
 
{|
 
{|
−
|style="padding: 0px 0px 20px 25px;"|[[File:RG2_10_2.png]]
+
|style="padding: 10px 0px 15px 15px;"|Under '' 'Logs' '' page you can view information about sent notifications.
 
|}
 
|}
 
{|
 
{|
−
|style="padding: 0px 0px 15px 15px;"| '''Staff Members''' - three predefined reports related to staff members and tickets department.
+
|style="padding: 0px 0px 30px 25px;"|[[File:HQN_12.png]]
 
|}
 
|}
 +
==Notifications==
 
{|
 
{|
−
|style="padding: 0px 0px 20px 25px;"|[[File:RG2_10_3.png]]
+
|style="padding: 10px 0px 15px 15px;"|You can create as many notifications as you wish.<br />
 +
The only requirement is their type being set to '' 'Product/Service' ''.<br />
 +
Additionally, you can use {if} statement, as shown below:
 +
{if $bw_over} Your bandwidth usage is over {$bw_over}MB{if $bw_current} (current: {$bw_current}MB){/if}.{/if}
 +
{if $disk_over}Your disks usage is over {$disk_over}MB{if $disk_current} (current: {$disk_current}MB){/if}.{/if}
 +
It will allow you to use this email template for bandwidth and disk notifications at the same time.
 
|}
 
|}
 
{|
 
{|
−
|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:HQN_13.png]]
−
|}
+
−
{|
+
−
|style="padding: 0px 0px 30px 25px;"|[[File:RG2_10_4.png]]
+
−
|}
+
−
===Report View===
+
−
{|
+
−
|style="padding: 10px 0px 20px 15px;"|Press '' 'Show' '' button next to a report you are interested in.
+
−
|}
+
−
{|
+
−
|style="padding: 0px 0px 20px 25px;"|[[File:RG2_13.png]]
+
−
|}
+
−
{|
+
−
|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: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==
+
=Tips=
 
{|
 
{|
−
|style="padding: 10px 0px 5px 15px;"|In this section we will show you how to prepare a few exemplary reports.<br/>
+
|style="padding: 10px 0px 30px 15px;"|
−
We will now show you how to develop three different reports, each one will slightly more complicated than the previous one.<br/>
+
−
The first steps are the same for each advancement level.
+
−
|}
+
−
{|
+
−
|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]]
+
 
|}
 
|}
  
−
===Intermediate Creator===
+
=Update Instructions=
 
{|
 
{|
−
|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: 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/>
 
|}
 
|}
−
{|
 
−
|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: 0px 0px 15px 15px;"|We want to display clients details in one column and quantity of orders in another one.<br/>
 
−
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.<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:RG2_27.png]]
 
−
|}
 
−
{|
 
−
|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:RG2_28.png]]
 
−
|}
 
−
{|
 
−
|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
 
−
// your custom code here
 
−
?>
 
−
The '' '$result' '' variable is passed by reference and contains just iterated element of the result array.<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 typical array where the key is a column name and value is a current row value.<br/>
 
−
'''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:RG2_29.png]]
 
−
|}
 
−
{|
 
−
|style="padding: 0px 0px 20px 15px;"|Your code is ready, press '' 'Generate Report' '' to save it.
 
−
|}
 
−
{|
 
−
|style="padding: 0px 0px 30px 25px;"|[[File:RG2_30.png]]
 
−
|}
 
−
-->
 
−
 
−
<!--
 
−
===Expert - Unpaid Invoices===
 
−
{|
 
−
|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/>
 
−
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:RG2_31.png]]
 
−
|}
 
−
{|
 
−
|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 20px 25px;"|[[File:RG2_32.png]]
 
−
|}
 
−
{|
 
−
|style="padding: 0px 0px 20px 15px;"|Add '' 'COUNT(*) as Sum' '' column and proceed to the '' 'Conditions' '' tab.
 
−
 
−
|}
 
−
{|
 
−
|style="padding: 0px 0px 20px 25px;"|[[File:RG2_33.png]]
 
−
|}
 
−
{|
 
−
|style="padding: 0px 0px 20px 15px;"|Press '' 'Create New Filter' '' button to define new condition for your report.
 
−
|}
 
−
{|
 
−
|style="padding: 0px 0px 20px 25px;"|[[File:RG2_34.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 20px 25px;"|[[File:RG2_35.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'. ''
 
−
|}
 
−
{|
 
−
|style="padding: 0px 0px 20px 25px;"|[[File:RG2_36.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 25px;"|[[File:RG2_37.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 25px;"|[[File:RG2_38.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 25px;"|[[File:RG2_39.png]]
 
−
|}
 
−
{|
 
−
|style="padding: 0px 0px 20px 25px;"|[[File:RG2_40.png]]
 
−
|}
 
−
{|
 
−
|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 20px 25px;"|[[File:RG2_41.png]]
 
−
|}
 
−
{|
 
−
|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:RG2_42.png]]
 
−
|}
 
−
-->
 
−
 
−
<!--
 
−
==Modify Report==
 
−
{|
 
−
|style="padding: 10px 0px 20px 15px;"|All custom reports can be easily altered. Press '' 'Edit' '' next to report that you wish to modify.
 
−
|}
 
−
{|
 
−
|style="padding: 0px 0px 20px 25px;"|[[File:RG2_43.png]]
 
−
|}
 
−
{|
 
−
|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/>
 
−
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 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]]
 
−
|}
 
−
-->
 
−
 
−
==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: 0px 0px 20px 25px;"|[[File:RG2_46.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 30px 25px;"|[[File:RG2_47.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/Export==
 
−
{|
 
−
|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:RG2_48.png]]
 
−
|}
 
−
{|
 
−
|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.
 
−
|}
 
−
{|
 
−
|style="padding: 0px 0px 30px 25px;"|[[File:RG2_49.png]]
 
−
|}
 
−
 
−
<!--
 
−
==Migration==
 
−
{|
 
−
|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/>
 
−
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:RG2_52.png]]
 
−
|}
 
−
{|
 
−
|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:RG2_53.png]]
 
−
|}
 
−
-->
 
−
 
−
=Tips=
 
−
{|
 
−
|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=
 
=Common Problems=
 
{|
 
{|
 
|style="padding: 10px 0px 30px 15px;"|'''1. When you have problems with connection, check whether your SELinux or firewall does not block ports.'''
 
|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 12:02, 13 September 2018

Contents

[edit] About Hosting Quota Notifications For WHMCS

Hosting Quota Notifications For WHMCS allows you to send automatic notifications to your clients whenever they exceed previously set bandwidth or disk usage.

Notifications can be sent in two ways: upon exceeding given resource tier or after exceeding given resource limit in a specified time period.
You can also define email templates and view details of each sent notification owing to logs.

  • Admin Area Features:
✔ Automatically Notify Your Clients Upon Exceeding Defined Limits Of Bandwidth And Disk Usage
✔ Configure Notification Groups
✔ Choose Between Two Types Of Group Counting:
✔ Tiered - Define Tiers Of Usage
✔ Fixed - Define Usage Grow Over Time
✔ Assign Multiple Products To Single Notification Group
✔ Assign Email Templates Per Notification Group
✔ Enable/Disable Notification Groups
✔ View Logs Of Sent Notifications
  • General Info:
✔ Multi-Language Support
✔ Supports PHP 5.6 Up To PHP 7.2
✔ Supports WHMCS V7

[edit] Installation

This tutorial will show you how to successfully install and configure Hosting Quota Notifications For WHMCS.

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

[edit] Installation

1. Log in to our client area and download the module.
HQN 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.

Drfere.png
4. When you install Hosting Quota Notifications For WHMCS for the first time you have to rename 'license_RENAME.php' file.

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

HQN 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' .

HQN 4.png

[edit] Configuration of Addon

6. 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 'Hosting Quota Notifications' and press 'Activate' button.

HQN 5.png
7. In the next step you need to permit access to this module.

To do so click on 'Configure' button, tick 'Access Control' near required admin role groups and press 'Save Changes' .

HQN 6.png
8. You have just successfully installed Hosting Quota Notifications For WHMCS!

You can access your module in 'Addons' → 'Hosting Quota Notifications' .

HQN 7.png

[edit] Configuration and Management

In this section we will show you how to properly set up and use Hosting Quota Notifications For WHMCS.

[edit] Configuration

In 'Configuration' page you can find the list of configured notification groups.

You can enable/disable any of them, as well as alter or completely remove them.
Press 'Create New Group' to proceed.

HQN 9.png
Now, you can define all products related to this configuration and email template which will be used to notify your clients.

You can choose between two types of resource usage counting:

  • Fixed - define amount of resources over specific time period. If client usage growth has exceeded the given limit in specified time, a notification will be sent.
  • Tiered - defines amount of resources. If client exceeds given limit, a notification will be sent.
HQN 10.png
For example, shown below module uses fixed counting type.

As you can see, we have defined limits for both bandwidth and disk.
Settings shown below result in sending notification to client upon:

  • bandwidth usage growth by 5GB during 21 days.
  • disk usage growth by 100GB over period of 14 days.
HQN 11.png

[edit] Logs

Under 'Logs' page you can view information about sent notifications.
HQN 12.png

[edit] Notifications

You can create as many notifications as you wish.

The only requirement is their type being set to 'Product/Service' .
Additionally, you can use {if} statement, as shown below: 

{if $bw_over} Your bandwidth usage is over {$bw_over}MB{if $bw_current} (current: {$bw_current}MB){/if}.{/if}
{if $disk_over}Your disks usage is over {$disk_over}MB{if $disk_current} (current: {$disk_current}MB){/if}.{/if}

It will allow you to use this email template for bandwidth and disk notifications at the same time.

HQN 13.png

[edit] Tips

[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=Hosting_Quota_Notifications_1.X_For_WHMCS&oldid=41245"
Navigation
WHMCS Modules
WHMCS Widgets
Tools And Applications
Translations
General
FAQ
Community