Personal tools
Namespaces

Variants
Actions

Hosting Quota Notifications 1.X For WHMCS

From ModulesGarden Wiki
(Difference between revisions)
Jump to: navigation, search
(→‎Integration Code)
 
(680 intermediate revisions by 6 users not shown)
Line 1: Line 1:
−
<meta name="keywords" content="hosting renewals for whmcs, hosting renewals configuration, whmcs hosting renewals management, whmcs hosting renewals installation, whmcs hosting renewals common problems, about whmcs hosting renewals, whmcs hosting renewals documentation, whmcs hosting renewals faq, whmcs hosting renewals help, whmcs hosting renewals guide, whmcs hosting renewals wiki, whmcs hosting renewals tutorial, whmcs hosting renewals tips, whmcs hosting renewals 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 Hosting Renewals 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/hosting_renewals/features Hosting Renewals For WHMCS]=
+
 
{|
 
{|
−
|style="padding: 10px 0px 5px 0px;"|'''Hosting Renewals For WHMCS''' is a module which offers your customers a possibility to manage their billing cycles, recurring payments and services' renewals.<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 will let your clients turn on/off automatic renewals, decide whether and when to renew their web hosting services and even change billing cycles on the fly.<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 />
−
With our product you will be able to configure billing cycle changing rules, prepare various discounts and send personalized email notifications to your customers.
+
You can also define email templates and view details of each sent notification owing to logs.
 
|}
 
|}
 
<!--a comment maybe? -->
 
<!--a comment maybe? -->
−
*'''Client Area Features:'''
 
−
{|
 
−
|style="padding: 10px 0px 0px 30px;"|✔ Renew Services Before Due Date
 
−
|}
 
−
{|
 
−
|style="padding: 0px 0px 0px 30px;"|✔ Turn On/Off Auto Renewals
 
−
|}
 
−
{|
 
−
|style="padding: 0px 0px 10px 30px;"|✔ Change Billing Cycle
 
−
|}
 
−
 
 
*'''Admin Area Features:'''
 
*'''Admin Area Features:'''
 
{|
 
{|
−
|style="padding: 10px 0px 0px 30px;"|✔ Configure Billing Cycle Switching Rules
+
|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;"|✔ Configure Client Area Features Per Product Or Product Group
+
|style="padding: 0px 0px 0px 30px;"|✔ Configure Notification Groups
 
|}
 
|}
 
{|
 
{|
−
|style="padding: 0px 0px 0px 30px;"|✔ Disable Auto Renewal For New Products
+
|style="padding: 0px 0px 0px 30px;"|✔ Choose Between Two Types Of Group Counting:
 
|}
 
|}
 
{|
 
{|
−
|style="padding: 0px 0px 0px 30px;"|✔ Enable/Disable Auto Renewal For All Instances Of Product
+
|style="padding: 0px 0px 0px 45px;"|✔ Tiered - Define Tiers Of Usage
 
|}
 
|}
 
{|
 
{|
−
|style="padding: 0px 0px 0px 30px;"|✔ Define Application Of Discount Upon Meeting Defined Rules
+
|style="padding: 0px 0px 0px 45px;"|✔ Fixed - Define Usage Grow Over Time
 
|}
 
|}
 
{|
 
{|
−
|style="padding: 0px 0px 0px 30px;"|✔ Choose Between Two Types Of Discounts - One Time And Recurring
+
|style="padding: 0px 0px 0px 30px;"|✔ Assign Multiple Products To Single Notification Group
 
|}
 
|}
 
{|
 
{|
−
|style="padding: 0px 0px 0px 30px;"|✔ Enable/Disable Domain Renewal Along With Product
+
|style="padding: 0px 0px 0px 30px;"|✔ Assign Email Templates Per Notification Group
 
|}
 
|}
 
{|
 
{|
−
|style="padding: 0px 0px 0px 30px;"|✔ Send Email Notifications About Upcoming Renewals
+
|style="padding: 0px 0px 0px 30px;"|✔ Enable/Disable Notification Groups
 
|}
 
|}
 
{|
 
{|
−
|style="padding: 0px 0px 0px 30px;"|✔ Multiple Email Templates For Email Notification
+
|style="padding: 0px 0px 10px 30px;"|✔ View Logs Of Sent Notifications
−
|}
+
−
{|
+
−
|style="padding: 0px 0px 0px 30px;"|✔ Decide Whether Client Should Be Moved To Invoice Immediately After Renewal
+
−
|}
+
−
{|
+
−
|style="padding: 0px 0px 10px 30px;"|✔ View Logs
+
 
|}
 
|}
 
*'''General Info:'''
 
*'''General Info:'''
Line 60: Line 42:
 
|}
 
|}
 
{|
 
{|
−
|style="padding: 0px 0px 0px 30px;"|✔ Supports WHMCS Template Five and Six
+
|style="padding: 0px 0px 0px 30px;"|✔ Supports PHP 5.6 Up To PHP 7.2
 
|}
 
|}
 
{|
 
{|
−
|style="padding: 0px 0px 30px 30px;"|✔ Supports WHMCS V5 and V6
+
|style="padding: 0px 0px 30px 30px;"|✔ Supports WHMCS V7
 
|}
 
|}
  
 
=Installation=
 
=Installation=
 
{|
 
{|
−
|style="padding: 10px 0px 0px 0px;"|'''This tutorial will show you how to successfully install and configure Hosting Renewals 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 Hosting Renewals 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:HR1.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 these.
+
'' '''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:HR2.png]]
+
|style="padding: 0px 0px 20px 25px;"|[[File:PHP56_72.png]]
 
|}
 
|}
 
{|
 
{|
−
|style="padding: 0px 0px 15px 15px;"|'''3. When you install Hosting Renewals 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/hosting_renewals/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:HR3.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 a 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 20px 25px;"|[[File:HR4.png]]
+
|style="padding: 0px 0px 20px 25px;"|[[File:HQN_3.png]]
 
|}
 
|}
 
{|
 
{|
−
|style="padding: 0px 0px 15px 15px;"|'''5. Now, you have to set up chmod for the '' 'logs' '' folder located in '' 'your_whmcs/modules/addons/hosting_renewals'. '' '''<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 />
−
You will be now allowed to read activity logs in the module.
+
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:HR4_1.png]]
+
|style="padding: 0px 0px 30px 25px;"|[[File:HQN_4.png]]
 
|}
 
|}
 +
 +
==Configuration of Addon==
 
{|
 
{|
−
|style="padding: 0px 0px 15px 15px;"|'''6. Next, 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 '' 'Hosting Renewals' '' 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:HR5.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:HR6.png]]
+
|style="padding: 0px 0px 30px 25px;"|[[File:HQN_6.png]]
 
|}
 
|}
 +
 
{|
 
{|
−
|style="padding: 0px 0px 15px 15px;"|'''8. You have just successfully installed Hosting Renewals!'''<br />
+
|style="padding: 0px 0px 15px 15px;"|'''8. You have just successfully installed Hosting Quota Notifications For WHMCS!'''<br />
−
Access your module now at '' 'Addons' '' → '' 'Hosting Renewals'. ''
+
You can access your module in '' 'Addons' '' → '' 'Hosting Quota Notifications' ''.
 
|}
 
|}
 
{|
 
{|
−
|style="padding: 0px 0px 30px 25px;"|[[File:HR7.png]]
+
|style="padding: 0px 0px 30px 25px;"|[[File:HQN_7.png]]
 
|}
 
|}
  
 
=Configuration and Management=
 
=Configuration and Management=
 
{|
 
{|
−
|style="padding: 10px 0px 30px 15px;"|'''Hosting Renewals For WHMCS module allows your customers to fully manage their billing cycles and recurring payments.<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 through the below instructions to learn how to turn on/off auto-renewals, alter billing cycles and manage customized email notifications.  
+
 
|}
 
|}
−
 
 
==Configuration==
 
==Configuration==
 
{|
 
{|
−
|style="padding: 10px 0px 15px 15px;"|You can enable Hosting Renewals For WHMCS only for the products that have recurring payments configured.<br />
+
|style="padding: 10px 0px 15px 15px;"|In '' 'Configuration' '' page you can find the list of configured notification groups.<br />
−
Proceed to '' 'Addons' '' → '' 'Hosting Renewals' '' → '' 'Configuration' '' and choose product you wish to enable for renewals from a dropdown menu.
+
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 20px 25px;"|[[File:HR8.png]]
+
|style="padding: 0px 0px 20px 25px;"|[[File:HQN_9.png]]
 
|}
 
|}
 
{|
 
{|
−
|style="padding: 0px 0px 15px 15px;"|Press the name of a product with renewals enabled (previous step) and configure its rules.<br />
+
|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 />
−
Available options:<br />
+
You can choose between two types of resource usage counting:<br />
−
1. Option checked automatically, you may disable renewals for the product.<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.
−
2. If selected, clients are allowed to enable/disable auto-renewal in the client area.<br />
+
*Tiered - defines amount of resources. If client exceeds given limit, a notification will be sent.
−
3. If selected, clients are allowed to renew hosting before its due date.<br />
+
−
4. Check to let clients manage billing cycles.<br />
+
−
''Note that available billing cycles can be set up in 'Change Billing Cycle Rules' table.''<br/>
+
−
5. Disable auto renewal for a new hosting.<br />
+
−
6. Renew domain assigned to service.<br />
+
−
7. If auto renewal option is enabled, email notifications are not delivered.<br />
+
−
Once you have enabled desired options, press '' 'Save Changes'! ''
+
 
|}
 
|}
 
{|
 
{|
−
|style="padding: 0px 0px 20px 25px;"|[[File:HR8_1.png]]
+
|style="padding: 0px 0px 20px 25px;"|[[File:HQN_10.png]]
 
|}
 
|}
 
{|
 
{|
−
|style="padding: 0px 0px 15px 15px;"|If you have enabled the option allow changing billing cycle in the client area, you must also define between which billing cycles the switch can be made.<br />
+
|style="padding: 0px 0px 15px 15px;"|For example, shown below module uses fixed counting type.<br />
−
On the screen below you can see'' 'Change Billing Cycle Rules' '' table with  available billing cycles. Clients will be able to choose between billing cycles from the column of their current billing cycle.<br/>
+
As you can see, we have defined limits for both bandwidth and disk.<br />
−
For example, settings on the following screen will enable clients to switch any billing cycle only to a longer one.<br/> In our case, if a client currently uses '' 'Quarterly' '' billing cycle, then it can be changed to '' 'Semi-Annual' '' or '' 'Annually'. ''
+
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 20px 25px;"|[[File:HR8_2.png]]
+
|style="padding: 0px 0px 30px 25px;"|[[File:HQN_11.png]]
 
|}
 
|}
−
{|
 
−
|style="padding: 0px 0px 15px 15px;"|Additionally, you can enable/disable auto renewal for all products from a selected configuration.<br />
 
−
To do so, press '' 'Enable Auto Renewal'/'Disable Auto Renewal' '' button as shown on the following screen.
 
−
|}
 
−
{|
 
−
|style="padding: 0px 0px 20px 25px;"|[[File:HR8_3.png]]
 
−
|}
 
−
{|
 
−
|style="padding: 0px 0px 15px 15px;"|It is wise to inform your clients about incoming due date, you can do it by setting up notification emails.<br />
 
−
You can configure up to five notification emails and specify the time when they shall be sent to the clients depending on a billing cycle the clients use.<br />
 
−
Additionally, you can set up different email templates for each email notification.<br />
 
−
On the screen below you can see settings for a product with monthly, quarterly, semi-annually and annually pricing types.<br />
 
−
For each one of them a client receives only 2 notification emails.<br />
 
−
The first notification will be sent a week before the due date for monthly and quarterly billing cycles and 2 weeks before the due date for semi-annually and annually billing cycles.<br />
 
−
The second notification will be sent for each of the billing cycles a day before the due date.<br />
 
−
Save settings through pressing '' 'Save Changes' '' button.
 
−
|}
 
−
{|
 
−
|style="padding: 0px 0px 20px 25px;"|[[File:HR9.png]]
 
−
|}
 
−
{|
 
−
|style="padding: 0px 0px 15px 15px;"|Once you have configured the hosting renewals, new buttons in your admin area product's page should be available.<br />
 
−
|}
 
−
{|
 
−
|style="padding: 0px 0px 30px 25px;"|[[File:HR9_1.png]]
 
−
|}
 
−
 
−
==Templates==
 
−
{|
 
−
|style="padding: 10px 0px 15px 15px;"|When ''Hosting Renewals For WHMCS'' is  activated, only one email template is created for email notifications.<br />
 
−
You can create additional email templates for notifications easily. Move to '' 'Templates' '' section and press '' 'Add Template'. ''
 
−
|}
 
−
{|
 
−
|style="padding: 0px 0px 20px 25px;"|[[File:HR10.png]]
 
−
|}
 
−
{|
 
−
|style="padding: 0px 0px 15px 15px;"|If you already have some email templates prepared for notification, select it from a dropdown menu and press '' 'Add' '' button.<br />
 
−
As soon as you do that, it will be visible next to '' 'Upcoming Renewal Notice' '' email template and you will be able to assign it to a notification.
 
−
|}
 
−
{|
 
−
|style="padding: 0px 0px 20px 25px;"|[[File:HR10_1.png]]
 
−
|}
 
−
{|
 
−
|style="padding: 0px 0px 20px 15px;"|If you want to prepare a new email template, press '' 'Create New Template' '' button.
 
−
|}
 
−
{|
 
−
|style="padding: 0px 0px 20px 25px;"|[[File:HR10_2.png]]
 
−
|}
 
−
{|
 
−
|style="padding: 0px 0px 20px 15px;"|Afterwards, choose '' 'Product/Service' '' as an email template type and type in the name under which email template will be visible in your WHMCS.<br/>
 
−
Press '' 'Create'. ''
 
−
|}
 
−
{|
 
−
|style="padding: 0px 0px 20px 25px;"|[[File:HR10_3.png]]
 
−
|}
 
−
{|
 
−
|style="padding: 0px 0px 15px 15px;"|You will be moved to email template edition page. Start by filling in your company name, email address and email subject.<br />
 
−
Afterwards, create your email template content in a textbox marked on the following screen.<br />
 
−
Press '' 'Save Changes' '' button.
 
−
|}
 
−
{|
 
−
|style="padding: 0px 0px 20px 25px;"|[[File:HR11.png]]
 
−
|}
 
−
{|
 
−
|style="padding: 0px 0px 15px 15px;"|You can also use '' 'Merge Fields' '' in your email template.<br />
 
−
To view a full list of fields, scroll down. These codes are replaced with actual data during sending email.
 
−
|}
 
−
{|
 
−
|style="padding: 0px 0px 30px 25px;"|[[File:HR12.png]]
 
−
|}
 
−
 
−
==Assign Email Template==
 
−
{|
 
−
|style="padding: 10px 0px 15px 15px;"|You can assign any of email templates added at '' 'Templates' '' tab to a desired notification.<br />
 
−
To do so, enter product configuration at '' 'Hosting Renewal' '' → '' 'Configuration' '' and select email templates from a dropdown menu next to a desired notification.<br />
 
−
Confirm changes through pressing '' 'Save Changes' '' button.<br />
 
−
On the screen below you can see a previously created '' 'Last Day Notification' '' email template assigned to a notification sent a day before due date.
 
−
|}
 
−
{|
 
−
|style="padding: 0px 0px 30px 25px;"|[[File:HR12_1.png]]
 
−
|}
 
−
 
 
==Logs==
 
==Logs==
 
{|
 
{|
−
|style="padding: 10px 0px 20px 15px;"|All module activities are recorded in log files. To enable this feature, mark '' 'Enable File Logging' '' checkbox.
+
|style="padding: 10px 0px 15px 15px;"|Under '' 'Logs' '' page you can view information about sent notifications.
 
|}
 
|}
 
{|
 
{|
−
|style="padding: 0px 0px 20px 25px;"|[[File:HR12_2.png]]
+
|style="padding: 0px 0px 30px 25px;"|[[File:HQN_12.png]]
 
|}
 
|}
 +
==Notifications==
 
{|
 
{|
−
|style="padding: 0px 0px 20px 15px;"|You can view any of the logs. Simply, choose it from '' 'File' '' dropdown menu and press '' 'Show' '' button.<br />
+
|style="padding: 10px 0px 15px 15px;"|You can create as many notifications as you wish.<br />
−
''Note: You will not be able to choose a log file if there are no logged actions yet.''
+
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 25px;"|[[File:HR12_3.png]]
+
|style="padding: 0px 0px 30px 25px;"|[[File:HQN_13.png]]
−
|}
+
−
{|
+
−
|style="padding: 0px 0px 20px 15px;"|Exemplary info log is shown on the following screen.
+
−
|}
+
−
{|
+
−
|style="padding: 0px 0px 30px 25px;"|[[File:HR12_4.png]]
+
 
|}
 
|}
  
−
==Discounts==
+
=Tips=
 
{|
 
{|
−
|style="padding: 10px 0px 15px 15px;"|In '' 'Discounts' '' section you may set up various discounts for a changing billing cycle.<br /><br />
+
|style="padding: 10px 0px 30px 15px;"|
−
'''You can select two types of items:'''<br />
+
−
1. Products - applies to products selected in '' 'Items' '' field.<br />
+
−
2. Product Groups - applies to all products in a product group which is selected in the '' 'Items' '' field.<br /><br />
+
−
'''You can set up two types of discounts:'''<br />
+
−
1. One time discount - it applies to one billing cycle only.<br />
+
−
2. Recurring discount - it will be applied to all billing cycle payments, until your client again changes the billing cycle.<br />
+
−
Now, we will set up one time discount for '' 'Premium Product XL' '' and '' 'testProduct'. ''<br />
+
−
If a client switches to a quarterly billing cycle from any other billing cycle, they will receive a 50% discount for payment in the first billing period.
+
−
|}
+
−
{|
+
−
|style="padding: 0px 0px 20px 25px;"|[[File:HR12_5.png]]
+
−
|}
+
−
{|
+
−
|style="padding: 0px 0px 15px 15px;"|As you can see on the following screen, all discounts are listed below.<br />
+
−
Each of them can be easily removed by pressing '' 'Delete' '' button.
+
−
|}
+
−
{|
+
−
|style="padding: 0px 0px 30px 25px;"|[[File:HR12_6.png]]
+
 
|}
 
|}
  
−
==Integration Code==
+
=Update Instructions=
 
{|
 
{|
−
|style="padding: 10px 0px 20px 15px;"|In this section you have to do two things. First of all, choose a method the prices will be displayed in your client area to your clients. <br/> You can choose between four options. Simply select the one that seems perfect to you.
+
|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:HR13.png]]
 
−
|}
 
−
{|
 
−
|style="padding: 0px 0px 20px 15px;"|Integration described below allows your customers to manually renew product, turn on/off auto renewal and change billing cycle from their client area.<br/>
 
−
''These options are available for clients only if you have enabled them in the product's configuration!''
 
−
|}
 
−
{|
 
−
|style="padding: 0px 0px 20px 25px;"|[[File:HR14.png]]
 
−
|}
 
−
{|
 
−
|style="padding: 0px 0px 15px 15px;"|Once the integration has been done correctly, your clients should see buttons in the client area as marked on the screen:<br />
 
−
|}
 
−
{|
 
−
|style="padding: 0px 0px 30px 25px;"|[[File:HR17.png]]
 
−
|}
 
−
 
−
==Client Area==
 
−
{|
 
−
|style="padding: 10px 0px 20px 15px;"|Depending on the configuration per product you clients will be allowed to manage their renewals in your client area.<br/>
 
−
|}
 
−
{|
 
−
|style="padding: 0px 0px 20px 25px;"|[[File:HR17.png]]
 
−
|}
 
−
{|
 
−
|style="padding: 0px 0px 20px 15px;"|They can see the current status and use available buttons to perform allowed actions:
 
−
*Renew service
 
−
*Turn on/off the auto renewal
 
−
*Select billing cycle
 
−
|}
 
−
{|
 
−
|style="padding: 0px 0px 30px 25px;"|[[File:HR18.png]]
 
−
|}
 
−
 
−
=Additional Information=
 
−
{|
 
−
|style="padding: 10px 0px 30px 15px;"|1. If option '' 'Auto Renewal' '' was enabled, an adequate renewal invoice was generated, but then, due to some reasons, '' 'Auto Renewal' '' option is disabled.<br> In such a situation '''NO''' actions are triggered on the already generated invoice. It will not be either canceled or changed.  <br/>
 
−
Additionally, if credit card payment is enabled in your WHMCS, then your system will attempt to charge the credit card. With every failed attempt to charge the credit card,<br/> an email notification will be sent. <br/> <br/>
 
−
''Please be aware that this is due to the WHMCS functionality, not the module itself.''
 
−
|}
 
−
 
−
=Tips=
 
−
{|
 
−
|style="padding: 10px 0px 5px 15px;"|1. If your client turns off auto renewal and does not run the renewal manually, then the service status will change to suspended/terminated after a certain time period.<br />
 
−
Time period depends on WHMCS settings at '' 'Setup' '' → '' 'Automation Settings' '' → '' 'Automatic Module Functions''. '
 
−
|}
 
−
{|
 
−
|style="padding: 0px 0px 5px 15px;"|2. Hosting Renewals For WHMCS supports all billing cycles, from monthly to triennially.<br />
 
−
Depending on the chosen billing cycle, displayed value of a renew button is changing according to the following code which is located in '' 'language' '' directory in your language file:<br />
 
−
$LANG['cyclemonthly']='1 Month';
 
−
$LANG['cyclequarterly']='3 Months';
 
−
$LANG['cyclesemiannually']='6 Months';
 
−
$LANG['cycleannually']='1 Year';
 
−
$LANG['cyclebiennially']='2 Years';
 
−
$LANG['cycletriennially']='3 Years';
 
−
|}
 
−
{|
 
−
|style="padding: 0px 0px 15px 15px;"|3. You can forward a client directly to invoice page after a successful renew.<br />
 
−
To enable this, go to the '' 'Configuration' '' tab in our module and expand '' 'Additional Options'. ''<br />
 
−
Afterwards, mark '' 'Automatically relocate to the invoice ' '' checkbox and press '' 'Save Changes'. ''
 
−
|}
 
−
{|
 
−
|style="padding: 0px 0px 30px 25px;"|[[File:HR16.png]]
 
−
|}
 
−
 
 
=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
Translations
cPanel Modules
General
FAQ
Community