Personal tools
Namespaces

Variants
Actions

Hosting Quota Notifications 1.X For WHMCS

From ModulesGarden Wiki
(Difference between revisions)
Jump to: navigation, search
(→‎Logs)
 
(928 intermediate revisions by 6 users not shown)
Line 1: Line 1:
−
<meta name="keywords" content="recurring billing for whmcs, recurring billing configuration, whmcs recurring billing management, whmcs recurring billing installation, whmcs recurring billing common problems, about whmcs recurring billing, whmcs recurring billing documentation, whmcs recurring billing faq, whmcs recurring billing help, whmcs recurring billing guide, whmcs recurring billing wiki, whmcs recurring billing tutorial, whmcs recurring billing tips, whmcs recurring billing 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 Recurring Billing 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/recurring_billing/features Recurring Billing For WHMCS]=
+
 
{|
 
{|
−
|style="padding: 10px 0px 5px 0px;"|'''Recurring Billing For WHMCS''' .....
+
|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? -->
 
*'''Admin Area Features:'''
 
*'''Admin Area Features:'''
 
{|
 
{|
−
|style="padding: 10px 0px 0px 30px;"|✔  
+
|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;"|✔
+
|style="padding: 0px 0px 0px 30px;"|✔ Configure Notification Groups
 
|}
 
|}
 
{|
 
{|
−
|style="padding: 0px 0px 0px 30px;"|✔  
+
|style="padding: 0px 0px 0px 30px;"|✔ Choose Between Two Types Of Group Counting:
 
|}
 
|}
−
 
 
{|
 
{|
−
|style="padding: 0px 0px 0px 30px;"|✔  
+
|style="padding: 0px 0px 0px 45px;"|✔ Tiered - Define Tiers Of Usage
 
|}
 
|}
 
{|
 
{|
−
|style="padding: 0px 0px 10px 30px;"|✔  
+
|style="padding: 0px 0px 0px 45px;"|✔ Fixed - Define Usage Grow Over Time
 
|}
 
|}
−
*'''Client Area Features:'''
 
 
{|
 
{|
−
|style="padding: 10px 0px 10px 30px;"|✔  
+
|style="padding: 0px 0px 0px 30px;"|✔ Assign Multiple Products To Single Notification Group
 
|}
 
|}
−
 
−
 
−
*'''General Info:'''
 
 
{|
 
{|
−
|style="padding: 10px 0px 0px 30px;"|✔  
+
|style="padding: 0px 0px 0px 30px;"|✔ Assign Email Templates Per Notification Group
 
|}
 
|}
 
{|
 
{|
−
|style="padding: 0px 0px 0px 30px;"|✔  
+
|style="padding: 0px 0px 0px 30px;"|✔ Enable/Disable Notification Groups
 
|}
 
|}
 
{|
 
{|
−
|style="padding: 0px 0px 0px 30px;"|✔ Multi-Language Support
+
|style="padding: 0px 0px 10px 30px;"|✔ View Logs Of Sent Notifications
 
|}
 
|}
 +
*'''General Info:'''
 
{|
 
{|
−
|style="padding: 0px 0px 0px 30px;"|✔ Supports WHMCS Templates Five and Six
+
|style="padding: 10px 0px 0px 30px;"|✔ Multi-Language Support
 
|}
 
|}
 
{|
 
{|
−
|style="padding: 0px 0px 30px 30px;"|✔ Supports WHMCS V5 and V6
+
|style="padding: 0px 0px 0px 30px;"|✔ Supports PHP 5.6 Up To PHP 7.2
 +
|}
 +
{|
 +
|style="padding: 0px 0px 30px 30px;"|✔ Supports WHMCS V7
 
|}
 
|}
  
 
=Installation=
 
=Installation=
 
{|
 
{|
−
|style="padding: 10px 0px 30px 15px;"|'''This tutorial will show you how to successfully install and configure Recurring Billing 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.  
+
We will guide you step by step through the whole installation and configuration process.
 
|}
 
|}
 
==Installation==
 
==Installation==
 
{|
 
{|
−
|style="padding: 10px 0px 20px 15px;"|'''1. Log in to your client area and download Recurring Billing 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:RB_1.png]]
+
|style="padding: 0px 0px 20px 25px;"|[[File:HQN_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 on the following screen.
+
'' '''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:RB_2.png]]
+
|style="padding: 0px 0px 20px 25px;"|[[File:PHP56_72.png]]
 
|}
 
|}
 
{|
 
{|
−
|style="padding: 0px 0px 15px 15px;"|'''3. When you install Recurring Billing For WHMCS 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 in '' 'modules/addons/recurring_billing/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:RB_3.png]]
+
|style="padding: 0px 0px 20px 25px;"|[[File:drfere.png]]
 
|}
 
|}
 
{|
 
{|
−
|style="padding: 0px 0px 15px 15px;"|'''4. In order to configure your license key, you have to edit the previously renamed '' 'license.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 />
−
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'. ''  
+
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 30px 25px;"|[[File:RB_4.png]]
+
|style="padding: 0px 0px 20px 25px;"|[[File:HQN_3.png]]
 
|}
 
|}
−
 
−
==Activation==
 
 
{|
 
{|
−
|style="padding: 10px 0px 15px 15px;"|'''5. Now, you have to activate the module in your WHMCS system.'''<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 />
−
Log in to your WHMCS admin area and proceed to '' 'Setup' '' → '' 'Addon Modules'. ''<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' ''.  
−
Afterwards, find '' 'Recurring Billing' '' and press '' 'Activate' '' button.
+
 
|}
 
|}
 
{|
 
{|
−
|style="padding: 0px 0px 20px 25px;"|[[File:RB_5.png]]
+
|style="padding: 0px 0px 30px 25px;"|[[File:HQN_4.png]]
 
|}
 
|}
−
{|
 
−
|style="padding: 0px 0px 15px 15px;"|'''6. In the next step you need to permit access to this module.'''<br />
 
−
To do so, click on '' 'Configure' '' button, tick checkboxes to assign desired admin roles.<br />
 
−
Press '' 'Save Changes'. ''
 
−
|}
 
−
{|
 
−
|style="padding: 0px 0px 20px 25px;"|[[File:RB_6.png]]
 
−
|}
 
−
{|
 
−
|style="padding: 0px 0px 15px 15px;"|'''7. Now it is time to insert proper integration codes. Note that this step is required only if you are using WHMCS V5 x.x.<br/>
 
−
There is no integration required for WHMCS V6 x.x.'''<br/><br/>
 
−
Open the currently used template. For presentation purposes we opened modern template. You will them in '' 'yourWHMCs/template/orderforms/modern/viewcart.tpl'. ''<br/>
 
−
Find line 450. Insert the below code inside this line and save the changes.
 
−
  <nowiki><div class="signupfields">
 
−
                  <h2>Contracts</h2>
 
−
                  {$contractOutput}
 
−
              </div></nowiki>
 
−
Remember that you must insert the code to every used order form template. <br/><br/>
 
  
−
That is how a properly inserted code should look like:
+
==Configuration of Addon==
−
|}
+
−
{|
+
−
|style="padding: 0px 0px 30px 15px;"|'''8. You have just successfully installed Recurring Billing For WHMCS!'''
+
−
|}
+
−
 
+
−
=Configuration and Management=
+
−
{|
+
−
|style="padding: 10px 0px 30px 15px;"|'''Once you have properly installed and activated the product you may move to its actual configuration.<br/>'''
+
−
Read the below sections to learn how to use '''Recurring Billing For WHMCS''' completely.
+
−
|}
+
−
==Configuration==
+
−
{|
+
−
|style="padding: 10px 0px 15px 15px;"|In order to start using your Recurring Billing For WHMCS move to '' 'Addons → Recurring Billing'. ''<br/>
+
−
By default, you will be moved to the addon's dashboard with a guide opened. You will find there short notes on how to configure the product.<br/>
+
−
In this article we will expand these instructions a bit more.
+
−
|}
+
−
{|
+
−
|style="padding: 0px 0px 20px 25px;"|[[File:RB_.png]]
+
−
|}
+
−
{|
+
−
|style="padding: 0px 0px 30px 15px;"|Hide the guide when you have completed the configuration and learn how to reconstruct the process.
+
−
|}
+
−
===Contract Content===
+
−
{|
+
−
|style="padding: 10px 0px 15px 15px;"|First off all, create your first contract's content. To do so, move to '' 'Contract Content' '' section and press '' 'Add New' '' button.
+
−
|}
+
−
{|
+
−
|style="padding: 0px 0px 20px 25px;"|[[File:RB_.png]]
+
−
|}
+
−
{|
+
−
|style="padding: 0px 0px 15px 15px;"|Here you can compose the content of a contract.<br/>
+
−
*Type in the '''''' 'Name' ''''' of a contract
+
−
*Fill out the filed with ''''' 'Content', '''''' you may use ''''' 'Available Merge Fields' '''''  to do so
+
−
**''Client Fields''
+
−
**''Product Fields''
+
−
**''Contract Fields''
+
−
*Use advanced edition tool to perfectly shape the contract. <br/>
+
−
|}
+
−
{|
+
−
|style="padding: 0px 0px 10px 25px;"|[[File:RB_.png]]
+
−
|}
+
 
{|
 
{|
−
|style="padding: 0px 0px 15px 15px;"|Do not forget to '' 'Save' '' the changes once you have finished.
+
|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 '' 'Hosting Quota Notifications' '' and press '' 'Activate' '' button.
 
|}
 
|}
 
{|
 
{|
−
|style="padding: 0px 0px 10px 25px;"|[[File:RB_.png]]
+
|style="padding: 0px 0px 20px 25px;"|[[File:HQN_5.png]]
 
|}
 
|}
 
{|
 
{|
−
|style="padding: 0px 0px 15px 15px;"|Your newly created contract draft is now visible on the list. <br/>
+
|style="padding: 0px 0px 15px 15px;"|'''7. In the next step you need to permit access to this module.'''<br />
−
Use action buttons to edit the contract or delete it if you are sure it is useless.
+
To do so click on '' 'Configure' '' button, tick '' 'Access Control' '' near required admin role groups and press '' 'Save Changes' ''.
 
|}
 
|}
 
{|
 
{|
−
|style="padding: 0px 0px 30px 25px;"|[[File:RB_.png]]
+
|style="padding: 0px 0px 30px 25px;"|[[File:HQN_6.png]]
 
|}
 
|}
  
−
===Contract Templates===
 
 
{|
 
{|
−
|style="padding: 10px 0px 15px 15px;"|Now, that you have a contract's content draft, move to '' 'Contract Templates'. ''
+
|style="padding: 0px 0px 15px 15px;"|'''8. You have just successfully installed Hosting Quota Notifications For WHMCS!'''<br />
−
In this section you can predefine which contract content draft and a specific product a template will refer to.<br/>
+
You can access your module in '' 'Addons' '' → '' 'Hosting Quota Notifications' ''.
−
Press '' 'Add New' '' to begin.
+
 
|}
 
|}
 
{|
 
{|
−
|style="padding: 0px 0px 20px 25px;"|[[File:RB_.png]]
+
|style="padding: 0px 0px 30px 25px;"|[[File:HQN_7.png]]
−
|}
+
−
{|
+
−
|style="padding: 0px 0px 15px 15px;"|Fill out the contract template form. Name the template, as mentioned before, choose Content Name from the ones you prepared previously (see '' 'Contract Content' '' section).<br/> Select product that this template will be available with.<br/> ''Note! You can assign only one template to a single product!''<br/> Choose ''Fixed'' or ''Percentage'' values for Promotion and Penalty amounts.<br/>
+
−
Remember to '' 'Save' '' the changes.
+
−
|}
+
−
{|
+
−
|style="padding: 0px 0px 20px 25px;"|[[File:RB_.png]]
+
−
|}
+
−
{|
+
−
|style="padding: 0px 0px 15px 15px;"|Once you have added a new template, you have to fill out contract's details. An appropriate box should appear next to the template form.<br/>
+
−
Find there the payment type and the price set up, number of signed contracts and checkbox,<br/> which when selected allows to order assigned product without the need to accept this contract.<br/>
+
−
Press '' '+' '' to see more.
+
−
|}
+
−
{|
+
−
|style="padding: 0px 0px 20px 25px;"|[[File:RB_.png]]
+
−
|}
+
−
{|
+
−
|style="padding: 0px 0px 15px 15px;"|In this form you can define:
+
−
*Length - how long such contract shall last
+
−
*Promo Amount - as fixed amount or percentage, depending on the previously selected type in the template form
+
−
*Penalty Amount - as fixed amount or percentage, depending on the previously selected type in the template form
+
−
*Notice Period - number of days when a client may resign from the contact without any consequences or giving reason of resignation<br/>
+
−
Next to each of the options ''(except 'Notice Period') '' there will appear counted pricing of product.<br/>
+
−
Remember to '' 'Save' '' the changes again.
+
−
|}
+
−
{|
+
−
|style="padding: 0px 0px 30px 25px;"|[[File:RB_.png]]
+
 
|}
 
|}
  
−
===Configuration===
+
=Configuration and Management=
 
{|
 
{|
−
|style="padding: 10px 0px 15px 15px;"|The last step mentioned in the '' 'Guide' '' is setting up '' 'Notifications' '' and '' 'Penalty'. '' These options can be found under 'Configuration' tab.
+
|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.'''
 
|}
 
|}
 +
==Configuration==
 
{|
 
{|
−
|style="padding: 0px 0px 20px 25px;"|[[File:RB_.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.
 
|}
 
|}
 
{|
 
{|
−
|style="padding: 0px 0px 15px 15px;"|Select which email notifications you want your clients to receive, enter number of days before due date to send the notification.<br/>
+
|style="padding: 0px 0px 20px 25px;"|[[File:HQN_9.png]]
−
Enabled notifications are sent automatically with daily cron run. 
+
 
|}
 
|}
 
{|
 
{|
−
|style="padding: 0px 0px 20px 25px;"|[[File:RB_.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: 0px 0px 15px 15px;"|Define number of days when a client can be late with payment.<br/> If a client misses to make payment for longer than the specified here number of days, a penalty will be imposed on such client.<br/> ''Note: penalty type and amount are specified in 'Contract Template' details.''
+
|style="padding: 0px 0px 20px 25px;"|[[File:HQN_10.png]]
−
 
+
 
|}
 
|}
 
{|
 
{|
−
|style="padding: 0px 0px 20px 25px;"|[[File:RB_.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: 0px 0px 15px 15px;"|Here you can also turn off the guide or turn it on again once you have hidden it.<br/>
+
|style="padding: 0px 0px 30px 25px;"|[[File:HQN_11.png]]
−
'' 'Save' '' the changes once your configuration is ready.
+
 
|}
 
|}
 +
==Logs==
 
{|
 
{|
−
|style="padding: 0px 0px 30px 25px;"|[[File:RB_.png]]
+
|style="padding: 10px 0px 15px 15px;"|Under '' 'Logs' '' page you can view information about sent notifications.
 
|}
 
|}
−
 
−
==Management==
 
 
{|
 
{|
−
|style="padding: 10px 0px 15px 15px;"|
+
|style="padding: 0px 0px 30px 25px;"|[[File:HQN_12.png]]
 
|}
 
|}
 +
==Notifications==
 
{|
 
{|
−
|style="padding: 0px 0px 20px 25px;"|[[File:RB_.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 15px 15px;"|
+
|style="padding: 0px 0px 30px 25px;"|[[File:HQN_13.png]]
−
|}
+
−
{|
+
−
|style="padding: 0px 0px 20px 25px;"|[[File:RB_.png]]
+
−
|}
+
−
{|
+
−
|style="padding: 0px 0px 15px 15px;"|
+
−
|}
+
−
{|
+
−
|style="padding: 0px 0px 30px 25px;"|[[File:RB_.png]]
+
−
|}
+
−
===Client Area===
+
−
{|
+
−
|style="padding: 10px 0px 15px 15px;"|
+
−
|}
+
−
{|
+
−
|style="padding: 0px 0px 20px 25px;"|[[File:RB_.png]]
+
−
|}
+
−
{|
+
−
|style="padding: 0px 0px 15px 15px;"|
+
−
|}
+
−
{|
+
−
|style="padding: 0px 0px 20px 25px;"|[[File:RB_.png]]
+
−
|}
+
−
{|
+
−
|style="padding: 0px 0px 15px 15px;"|
+
−
|}
+
−
{|
+
−
|style="padding: 0px 0px 30px 25px;"|[[File:RB_.png]]
+
−
|}
+
−
===Admin Area===
+
−
{|
+
−
|style="padding: 10px 0px 15px 15px;"|
+
−
|}
+
−
{|
+
−
|style="padding: 0px 0px 20px 25px;"|[[File:RB_.png]]
+
−
|}
+
−
{|
+
−
|style="padding: 0px 0px 15px 15px;"|
+
−
|}
+
−
{|
+
−
|style="padding: 0px 0px 20px 25px;"|[[File:RB_.png]]
+
−
|}
+
−
{|
+
−
|style="padding: 0px 0px 15px 15px;"|
+
−
|}
+
−
{|
+
−
|style="padding: 0px 0px 30px 25px;"|[[File:RB_.png]]
+
−
|}
+
−
====Signed Contracts====
+
−
{|
+
−
|style="padding: 10px 0px 15px 15px;"|
+
−
|}
+
−
{|
+
−
|style="padding: 0px 0px 20px 25px;"|[[File:RB_.png]]
+
−
|}
+
−
{|
+
−
|style="padding: 0px 0px 15px 15px;"|
+
−
|}
+
−
{|
+
−
|style="padding: 0px 0px 20px 25px;"|[[File:RB_.png]]
+
−
|}
+
−
{|
+
−
|style="padding: 0px 0px 15px 15px;"|
+
−
|}
+
−
{|
+
−
|style="padding: 0px 0px 30px 25px;"|[[File:RB_.png]]
+
−
|}
+
−
====Dashboard====
+
−
{|
+
−
|style="padding: 10px 0px 15px 15px;"|
+
−
|}
+
−
{|
+
−
|style="padding: 0px 0px 20px 25px;"|[[File:RB_.png]]
+
−
|}
+
−
{|
+
−
|style="padding: 0px 0px 15px 15px;"|
+
−
|}
+
−
{|
+
−
|style="padding: 0px 0px 20px 25px;"|[[File:RB_.png]]
+
−
|}
+
−
{|
+
−
|style="padding: 0px 0px 15px 15px;"|
+
−
|}
+
−
{|
+
−
|style="padding: 0px 0px 30px 25px;"|[[File:RB_.png]]
+
−
|}
+
−
====Logs====
+
−
{|
+
−
|style="padding: 10px 0px 15px 15px;"|In '' 'Logs' '' section you have a full view on any attempted action on any contract.
+
−
|}
+
−
{|
+
−
|style="padding: 0px 0px 30px 25px;"|[[File:RB_.png]]
+
 
|}
 
|}
  
−
=Additional Information=
+
=Tips=
 
{|
 
{|
 
|style="padding: 10px 0px 30px 15px;"|
 
|style="padding: 10px 0px 30px 15px;"|
 
|}
 
|}
  
−
=Tips=
+
=Update Instructions=
 
{|
 
{|
−
|style="padding: 10px 0px 30px 15px;"|
+
|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=
 
=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 30px 15px;"|2. Remember that Recurring Billing For WHCMS contracts can be applied only to products with recurring payment type.
+
 
|}
 
|}

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