Personal tools
Namespaces

Variants
Actions

Hosting Quota Notifications 1.X For WHMCS

From ModulesGarden Wiki
(Difference between revisions)
Jump to: navigation, search
 
(763 intermediate revisions by 6 users not shown)
Line 1: Line 1:
−
<meta name="keywords" content="whmcs analyzer, whmcs analyzer configuration, whmcs analyzer management, whmcs analyzer installation, whmcs analyzer common problems, about whmcs analyzer, whmcs analyzer documentation, whmcs analyzer faq, whmcs analyzer help, whmcs analyzer guide, whmcs analyzer wiki, whmcs analyzer tutorial,whmcs analyzer tips, whmcs analyzer 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 Clients Profiler 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 [http://www.modulesgarden.com/products/whmcs/whmcs_analyzer/features WHMCS Analyzer]=
+
 
 +
=About [https://www.modulesgarden.com/products/whmcs/hosting-quota-notifications Hosting Quota Notifications For WHMCS]=
 
{|
 
{|
−
|style="padding: 10px 0px 5px 0px;"|'''WHMCS Analyzer''' is an innovative product that allows constant monitoring of your WHMCS system. Gather crucial data on your system,<br/> server and many others. Make regular scans to get a list of current issues that may raise and read suggested solutions to avoid or clarify them.  
+
|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.
 +
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 define email templates and view details of each sent notification owing to logs.
 
|}
 
|}
−
<!-- fixed -->
+
<!--a comment maybe? -->
−
*'''Global Features:'''
+
*'''Admin Area Features:'''
 
{|
 
{|
−
|style="padding: 10px 0px 0px 30px;"|✔ View WHMCS Modification Rating
+
|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 Server Environment Information
+
|style="padding: 0px 0px 0px 30px;"|✔ Configure Notification Groups
 
|}
 
|}
 
{|
 
{|
−
|style="padding: 0px 0px 0px 30px;"|✔ View WHMCS Environment Information
+
|style="padding: 0px 0px 0px 30px;"|✔ Choose Between Two Types Of Group Counting:
 
|}
 
|}
 
{|
 
{|
−
|style="padding: 0px 0px 0px 30px;"|✔ View WHMCS Files Information
+
|style="padding: 0px 0px 0px 45px;"|✔ Tiered - Define Tiers Of Usage
 
|}
 
|}
 
{|
 
{|
−
|style="padding: 0px 0px 0px 30px;"|✔ View WHMCS Database Information
+
|style="padding: 0px 0px 0px 45px;"|✔ Fixed - Define Usage Grow Over Time
 
|}
 
|}
 
{|
 
{|
−
|style="padding: 0px 0px 0px 30px;"|✔ View List Of Possible Issues And Solutions
+
|style="padding: 0px 0px 0px 30px;"|✔ Assign Multiple Products To Single Notification Group
 
|}
 
|}
 
{|
 
{|
−
|style="padding: 0px 0px 10px 30px;"|✔ Download WHMCS Environment Scan As PDF
+
|style="padding: 0px 0px 0px 30px;"|✔ Assign Email Templates Per Notification Group
 
|}
 
|}
−
*'''Scan Features:'''
 
 
{|
 
{|
−
|style="padding: 10px 0px 0px 30px;"|✔ Server Environment:
+
|style="padding: 0px 0px 0px 30px;"|✔ Enable/Disable Notification Groups
 
|}
 
|}
 
{|
 
{|
−
|style="padding: 0px 0px 0px 45px;"|✔ View Server Information
+
|style="padding: 0px 0px 10px 30px;"|✔ View Logs Of Sent Notifications
 
|}
 
|}
 +
*'''General Info:'''
 
{|
 
{|
−
|style="padding: 0px 0px 0px 45px;"|✔ View PHP Configuration
+
|style="padding: 10px 0px 0px 30px;"|✔ Multi-Language Support
 
|}
 
|}
 
{|
 
{|
−
|style="padding: 0px 0px 0px 30px;"|✔ WHMCS Environment:
+
|style="padding: 0px 0px 0px 30px;"|✔ Supports PHP 5.6 Up To PHP 7.2
 
|}
 
|}
 
{|
 
{|
−
|style="padding: 0px 0px 0px 45px;"|✔ View Basic WHMCS Settings
+
|style="padding: 0px 0px 30px 30px;"|✔ Supports WHMCS V7
 
|}
 
|}
 +
 +
=Installation=
 
{|
 
{|
−
|style="padding: 0px 0px 0px 45px;"|✔ View Active Addon Modules
+
|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.
 
|}
 
|}
 +
==Installation==
 
{|
 
{|
−
|style="padding: 0px 0px 0px 45px;"|✔ View Active Registrar Modules
+
|style="padding: 10px 0px 20px 15px;"|'''1. Log in to our client area and download the module.'''
 
|}
 
|}
 
{|
 
{|
−
|style="padding: 0px 0px 0px 45px;"|✔ View Active Payment Gateway Modules
+
|style="padding: 0px 0px 20px 25px;"|[[File:HQN_1.png]]
 
|}
 
|}
 
{|
 
{|
−
|style="padding: 0px 0px 0px 45px;"|✔ View Active Provisioning Modules
+
|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 the current PHP version in your WHMCS. To do so, proceed to ''' 'Utilities' › 'System' › 'PHP Info'.'''
 
|}
 
|}
 
{|
 
{|
−
|style="padding: 0px 0px 0px 30px;"|✔ WHMCS Files:
+
|style="padding: 0px 0px 20px 25px;"|[[File:PHP56_72.png]]
 
|}
 
|}
 
{|
 
{|
−
|style="padding: 0px 0px 0px 45px;"|✔ View Installed Hook Files
+
|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 />
 +
The content of PHP version files should look like this.
 
|}
 
|}
 
{|
 
{|
−
|style="padding: 0px 0px 0px 45px;"|✔ View Installed Addon Modules
+
|style="padding: 0px 0px 20px 25px;"|[[File:drfere.png]]
 
|}
 
|}
 
{|
 
{|
−
|style="padding: 0px 0px 0px 45px;"|✔ View Installed Template Files
+
|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/hosting_quota_notifications/license_RENAME.php' '' . Rename it from '' 'license_RENAME.php' '' to '' 'license.php' '' .
 
|}
 
|}
 
{|
 
{|
−
|style="padding: 0px 0px 0px 45px;"|✔ View Installed Order Form Template Files
+
|style="padding: 0px 0px 20px 25px;"|[[File:HQN_3.png]]
 
|}
 
|}
 
{|
 
{|
−
|style="padding: 0px 0px 0px 45px;"|✔ View Custom Files
+
|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 our client area'' → 'My Products' ''.
 
|}
 
|}
 
{|
 
{|
−
|style="padding: 0px 0px 0px 45px;"|✔ Not Existing In Clean WHMCS Installation
+
|style="padding: 0px 0px 30px 25px;"|[[File:HQN_4.png]]
−
|}
+
−
{|
+
−
|style="padding: 0px 0px 0px 45px;"|✔ View List Of Suspicious Files
+
−
|}
+
−
{|
+
−
|style="padding: 0px 0px 0px 30px;"|✔ WHMCS Database:
+
−
|}
+
−
{|
+
−
|style="padding: 0px 0px 0px 45px;"|✔ View Basic WHMCS Database Information
+
−
|}
+
−
{|
+
−
|style="padding: 0px 0px 0px 45px;"|✔ View Database Tables List
+
−
|}
+
−
{|
+
−
|style="padding: 0px 0px 0px 45px;"|✔ View Logged Database Errors
+
−
|}
+
−
{|
+
−
|style="padding: 0px 0px 10px 45px;"|✔ View List Of Suspicious Email Templates
+
−
|}
+
−
*'''General Info:'''
+
−
{|
+
−
|style="padding: 10px 0px 30px 30px;"|✔ Supports WHMCS V5 and V6
+
 
|}
 
|}
  
−
=Installation and Configuration=
+
==Configuration of Addon==
 
{|
 
{|
−
|style="padding: 10px 0px 15px 15px;"|'''This tutorial will show you how to successfully install and configure WHMCS Analyzer.''' <br/><br />
+
|style="padding: 10px 0px 15px 15px;"|'''6. Now you have to activate the module in your WHMCS system.'''<br />
−
We will guide you step by step through the whole installation and configuration process.  
+
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 15px;"|'''1. [http://www.modulesgarden.com/products/whmcs/whmcs_analyzer/download Download] WHMCS Analyzer directly from our webpage.'''
+
|style="padding: 0px 0px 20px 25px;"|[[File:HQN_5.png]]
 
|}
 
|}
 
{|
 
{|
−
|style="padding: 0px 0px 20px 25px;"|[[File:WHA_1.png]]
+
|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 '' 'Access Control' '' near required admin role groups and press '' 'Save Changes' ''.
 
|}
 
|}
 
{|
 
{|
−
|style="padding: 0px 0px 15px 15px;"|'''2. Upload and extract the files into the main WHMCS directory.'''<br/><br />
+
|style="padding: 0px 0px 30px 25px;"|[[File:HQN_6.png]]
−
Files in your WHMCS directory should look like on the following screen.
+
−
|}
+
−
{|
+
−
|style="padding: 0px 0px 20px 25px;"|[[File:WHA_2.png]]
+
−
|}
+
−
{|
+
−
|style="padding: 0px 0px 15px 15px;"|'''3. Now you have to allow access to '' 'analyzer' '' and '' 'temp' '' files, change access rights as writable.'''<br/> Proceed to '' 'YourWHMCS → Analyzer'. '' Set access rights to the mentioned file as writable.<br/><br/>
+
−
'''That is all, you may move the script itself!'''
+
 
|}
 
|}
  
−
=Management=
 
−
{|
 
−
|style="padding: 10px 0px 30px 15px;"|'''WHMCS Analyzer''' is a disparate product that works outside of your WHMCS system to provide you a comprehensive view on its every single aspect.
 
−
|}
 
−
==Start Analysis==
 
−
{|
 
−
|style="padding: 10px 0px 20px 15px;"|In order to start your system analysis, please enter '' 'analyzer' '' directory in your browser, like in the example:
 
−
http://your_WHMCS/analyzer
 
−
|}
 
−
{|
 
−
|style="padding: 0px 0px 20px 15px;"|In the every beginning you will be asked to generate htaccess. This step is obligatory due to security reasons.<br/> You will be asked to do that only when using the script for the first time.
 
−
|}
 
−
{|
 
−
|style="padding: 0px 0px 20px 25px;"|[[File:WHA_3.png]]
 
−
|}
 
−
{|
 
−
|style="padding: 0px 0px 15px 15px;"|Please note the generated username and the password, you will need them in the every next step to get access to the product.
 
−
|}
 
−
{|
 
−
|style="padding: 0px 0px 20px 25px;"|[[File:WHA_3_1.png]]
 
−
|}
 
−
{|
 
−
|style="padding: 0px 0px 15px 15px;"|Now, type in the generated in the previous step username and password to continue.
 
−
|}
 
−
{|
 
−
|style="padding: 0px 0px 20px 25px;"|[[File:WHA_3_2.png]]
 
−
|}
 
−
{|
 
−
|style="padding: 0px 0px 15px 15px;"|That's it! You may finally scan your system. Press '' 'Start Scanning' '' button when such appears.
 
−
|}
 
−
{|
 
−
|style="padding: 0px 0px 20px 25px;"|[[File:WHA_4.png]]
 
−
|}
 
 
{|
 
{|
−
|style="padding: 0px 0px 20px 15px;"| Wait a moment until every part is completed successfully.
+
|style="padding: 0px 0px 15px 15px;"|'''8. You have just successfully installed Hosting Quota Notifications For WHMCS!'''<br />
 +
You can access your module in '' 'Addons' '' → '' 'Hosting Quota Notifications' ''.
 
|}
 
|}
 
{|
 
{|
−
|style="padding: 0px 0px 30px 25px;"|[[File:WHA_5.png]]
+
|style="padding: 0px 0px 30px 25px;"|[[File:HQN_7.png]]
 
|}
 
|}
  
−
==Analysis Summary==
+
=Configuration and Management=
 
{|
 
{|
−
|style="padding: 10px 0px 15px 15px;"|When the analysis process has finished successfully, a full summary will be displayed on your screen.<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.'''
−
Read the below section to get a full view on data you will find there.
+
 
|}
 
|}
 +
==Configuration==
 
{|
 
{|
−
|style="padding: 0px 0px 30px 25px;"|[[File:WHA_5_1.png]]
+
|style="padding: 10px 0px 15px 15px;"|In '' 'Configuration' '' page you can find the list of configured notification groups.<br />
 +
You can enable/disable any of them, as well as alter or completely remove them.<br />
 +
Press '' 'Create New Group' '' to proceed.
 
|}
 
|}
−
===Total Rating===
 
 
{|
 
{|
−
|style="padding: 10px 0px 15px 15px;"|As a very first piece of information you will find '' 'Total Rating'. '' This is an objective evaluation of your system as a whole. <br/> The highest possible rate of any system is 6.0. If you have a lower grade, then your system probably lacks in some of the below features.<br/><br />
+
|style="padding: 0px 0px 20px 25px;"|[[File:HQN_9.png]]
−
Aspects taken into consideration when carrying out the evaluation:
+
−
*WHMCS version
+
−
*PHP version
+
−
*detected possible issues
+
 
|}
 
|}
 
{|
 
{|
−
|style="padding: 0px 0px 30px 25px;"|[[File:WHA_6.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.
 
|}
 
|}
−
===Analysis In Details===
 
 
{|
 
{|
−
|style="padding: 10px 0px 30px 15px;"|WHMCS Analyzer prepares a detailed summary on your system condition. The results are divided into four general categories, these are:
+
|style="padding: 0px 0px 20px 25px;"|[[File:HQN_10.png]]
−
*Server Environment
+
−
*WHMCS Environment
+
−
*WHMCS Files
+
−
*WHMCS Database<br/>
+
−
Underneath, you will find enumerated all of the scanned options in every category.
+
 
|}
 
|}
−
====Server Environment====
 
 
{|
 
{|
−
|style="padding: 10px 0px 15px 15px;"|Under this section you will find information on your system. These can be data on:<br/>
+
|style="padding: 0px 0px 15px 15px;"|For example, shown below module uses fixed counting type.<br />
−
''Please note that the below, these are only examples, results will depend on your system customization.''
+
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: 0px 0px 30px 25px;"|[[File:HQN_11.png]]
−
*Server Info
+
−
*Installed PHP Modules
+
−
*apache2handler
+
−
*Apache_Environment
+
−
*HTTP_Headers_Information
+
−
*bcmath
+
−
*bz2
+
−
*calendar
+
−
*Core
+
−
*ctype
+
−
*curl
+
−
*date
+
−
*dba
+
−
*dom
+
−
*ereg
+
−
*exif
+
−
*fileinfo
+
−
*filter
+
−
*ftp
+
−
*gd
+
−
*gettext
+
−
*hash
+
−
*iconv
+
−
|
+
−
*imap
+
−
*json
+
−
*libxml
+
−
*mbstring
+
−
*mcrypt
+
−
*mhash
+
−
*mongo
+
−
*mysql
+
−
*mysqli
+
−
*OAuth
+
−
*openssl
+
−
*pcre
+
−
*PDO
+
−
*pdo_mysql
+
−
*pdo_pgsql
+
−
*pgsql
+
−
*Phar
+
−
*posix
+
−
*pspell
+
−
*radius
+
−
*Reflection
+
−
*rrd
+
−
*runkit
+
−
|
+
−
*session
+
−
*shmop
+
−
*SimpleXML
+
−
*snmp
+
−
*soap
+
−
*sockets
+
−
*SPL
+
−
*ssh2
+
−
*standard
+
−
*svn
+
−
*sysvmsg
+
−
*tokenizer
+
−
*wddx
+
−
*xml
+
−
*xmlreader
+
−
*xmlrpc
+
−
*xmlwriter
+
−
*zip
+
−
*zlib
+
−
*Environment
+
−
*PHP_Variables
+
−
*PHP Init
+
−
*'''Possible Issues'''
+
 
|}
 
|}
 +
==Logs==
 
{|
 
{|
−
|style="padding: 20px 0px 20px 25px;"|[[File:WHA_8.png]]
+
|style="padding: 10px 0px 15px 15px;"|Under '' 'Logs' '' page you can view information about sent notifications.
 
|}
 
|}
 
{|
 
{|
−
|style="padding: 0px 0px 20px 15px;"|As you can see, the last on the list are '' 'Possible Issues'. '' In this box there are always enumerated and described points which may cause some interruptions<br/> in your WHMCS usage. It is important to always analyze them carefully and clarify if possible.
+
|style="padding: 0px 0px 30px 25px;"|[[File:HQN_12.png]]
 
|}
 
|}
 +
==Notifications==
 
{|
 
{|
−
|style="padding: 0px 0px 20px 25px;"|[[File:WHA_8_1.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;"|In some cases we try to suggest the best action to prevent or solve the issue. Press '' 'Possible Solution' '' to see it, '' 'Hide Solution' '' if you are already familiar with it.
+
|style="padding: 0px 0px 30px 25px;"|[[File:HQN_13.png]]
−
|}
+
−
{|
+
−
|style="padding: 0px 0px 30px 25px;"|[[File:WHA_8_2.png]]
+
 
|}
 
|}
  
−
====WHMCS Environment====
+
=Tips=
 
{|
 
{|
−
|style="padding: 10px 0px 20px 15px;"|Data on your WHMCS system environment, you will find here details on:
+
|style="padding: 10px 0px 30px 15px;"|
−
*Brief Info
+
−
*Additional Info
+
−
*Active Addons
+
−
*Active Payment Gateways
+
−
*Active Registrar Modules
+
−
*Active Provisioning Modules<br/>
+
−
Again, a list of '' 'Possible Issues' '' that may interrupt a proper work of your WHMCS environment if such exist.
+
−
|}
+
−
{|
+
−
|style="padding: 0px 0px 30px 25px;"|[[File:WHA_9.png]]
+
−
|}
+
−
====WHMCS Files====
+
−
{|
+
−
|style="padding: 10px 0px 15px 15px;"|This section includes a box with any '' 'Possible Issues' '' enumerated and described, just like in case of any other category.<br/>
+
−
Apart form that, data on:
+
−
*Brief Info
+
−
*WHMCS Addons Files
+
−
*WHMCS Hooks Files
+
−
*WHMCS Templates Files
+
−
*WHMCS Order Forms Templates Files
+
−
*Custom Files
+
−
*Fraud
+
−
|}
+
−
{|
+
−
|style="padding: 0px 0px 30px 25px;"|[[File:WHA_11.png]]
+
 
|}
 
|}
  
−
====WHMCS Database====
+
=Update Instructions=
 
{|
 
{|
−
|style="padding: 10px 0px 20px 15px;"|In this section a complete analysis of the following WHMCS database aspects is available:
+
|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/>
−
*Brief Info
+
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/>
−
*Database Table List
+
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/>
−
*Suspicious Templates
+
−
*Logged Errors<br/>
+
−
Additionally, there is again a '' 'Possible Issues' '' section with suggested solutions.
+
−
|}
+
−
{|
+
−
|style="padding: 0px 0px 30px 25px;"|[[File:WHA_13.png]]
+
−
|}
+
−
 
+
−
===Download File===
+
−
{|
+
−
|style="padding: 10px 0px 20px 15px;"|If you want to save your scan results you may download the current analysis. Press '' 'Download Results' '' button to save the results in a ' ''.PDF' '' file.
+
−
|}
+
−
{|
+
−
|style="padding: 0px 0px 20px 25px;"|[[File:WHA_15.png]]
+
−
|}
+
−
{|
+
−
|style="padding: 0px 0px 20px 15px;"|If you decide to save the results after each scan, it will be possible to easily compare them and see any changes in your system.
+
−
|}
+
−
{|
+
−
|style="padding: 0px 0px 30px 25px;"|[[File:WHA_16.png]]
+
−
|}
+
−
 
+
−
=Tips=
+
−
{|
+
−
|style="padding: 10px 0px 30px 15px;"|1. Due to a huge size of '' 'Server Environment' '' section, we advise to use '' 'Ctrl+F' '' keys shortage to look for precise information.  
+
 
|}
 
|}
 
=Common Problems=
 
=Common Problems=
 
{|
 
{|
−
|style="padding: 10px 0px 10px 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.'''
−
|}
+
−
{|
+
−
|style="padding: 0px 0px 10px 15px;"|2. In case you encounter an error like on the screen below, please make sure you have completed step three of our installation instruction.
+
−
|}
+
−
{|
+
−
|style="padding: 0px 0px 10px 25px;"|[[File:WHA_17.png]]
+
 
|}
 
|}

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
Translations
cPanel Modules
General
FAQ
Community