Personal tools
Namespaces

Variants
Actions

Hosting Quota Notifications 1.X For WHMCS

From ModulesGarden Wiki
(Difference between revisions)
Jump to: navigation, search
(→‎Timing)
 
(430 intermediate revisions by 5 users not shown)
Line 1: Line 1:
−
<meta name="keywords" content="client area popup for whmcs, client area popup configuration, whmcs client area popup management, whmcs client area popup installation, whmcs client area popup common problems, about whmcs client area popup, whmcs client client area popup documentation, whmcs client area popup faq, whmcs client area popup help, whmcs client area popup guide, whmcs client area popup wiki, whmcs client area popup tutorial, whmcs client area popup tips, whmcs client area popup 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 Client Area Popup 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 [https://www.modulesgarden.com/products/whmcs/client-area-popup Client Area Popup For WHMCS]=
+
 
{|
 
{|
−
|style="padding: 10px 0px 10px 0px;"|'''Client Area Popup For WHMCS''' is a module that lets you create fully customized pop-ups that will be visible to your clients in their panel.<br />Prepare a ready pop-up in a form of an image, raw or HTML text to pass a message directly to your clients.<br />Design it using predefined styles, which can be always altered and upgraded to implement your idea perfectly.
+
|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;"|✔ Create Pop-ups Using Predefined Styles
+
|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;"|✔ Preview Pop-up With Single Click
+
|style="padding: 0px 0px 0px 30px;"|✔ Configure Notification Groups
 
|}
 
|}
 
{|
 
{|
−
|style="padding: 0px 0px 0px 30px;"|✔ Archive Pop-ups For Later Use
+
|style="padding: 0px 0px 0px 30px;"|✔ Choose Between Two Types Of Group Counting:
 
|}
 
|}
 
{|
 
{|
−
|style="padding: 0px 0px 0px 30px;"|✔ View Pop-up Restrictions
+
|style="padding: 0px 0px 0px 45px;"|✔ Tiered - Define Tiers Of Usage
 
|}
 
|}
 
{|
 
{|
−
|style="padding: 0px 0px 0px 30px;"|✔ View Number of Pop-up Displays
+
|style="padding: 0px 0px 0px 45px;"|✔ Fixed - Define Usage Grow Over Time
 
|}
 
|}
 
{|
 
{|
−
|style="padding: 0px 0px 0px 30px;"|✔Create Styles To Be Used By Pop-up
+
|style="padding: 0px 0px 0px 30px;"|✔ Assign Multiple Products To Single Notification Group
 
|}
 
|}
 
{|
 
{|
−
|style="padding: 0px 0px 10px 30px;"|✔ Preview Style With Single Click<
+
|style="padding: 0px 0px 0px 30px;"|✔ Assign Email Templates Per Notification Group
 
|}
 
|}
−
*'''Client Area Features:'''
 
 
{|
 
{|
−
|style="padding: 10px 0px 0px 30px;"|✔ View Pop-up If Restrictions Are Met
+
|style="padding: 0px 0px 0px 30px;"|✔ Enable/Disable Notification Groups
 
|}
 
|}
 
{|
 
{|
−
|style="padding: 0px 0px 10px 30px;"|✔ Close Pop-up Permanently
+
|style="padding: 0px 0px 10px 30px;"|✔ View Logs Of Sent Notifications
−
|}
+
−
*'''Pop-up Features:'''
+
−
{|
+
−
|style="padding: 10px 0px 0px 30px;"|✔ Define Pop-up Restrictions:
+
−
|}
+
−
{|
+
−
|style="padding: 0px 0px 0px 45px;"|✔ Display Frequency - How Often Pop-up Should Be Displayed
+
−
|}
+
−
{|
+
−
|style="padding: 0px 0px 0px 45px;"|✔ Hide  - Client Can Close Pop-up Permanently
+
−
|}
+
−
{|
+
−
|style="padding: 0px 0px 0px 45px;"|✔ Pages - Define Pages Where Pop-up Is Displayed
+
−
|}
+
−
{|
+
−
|style="padding: 0px 0px 0px 45px;"|✔ Required Languages
+
−
|}
+
−
{|
+
−
|style="padding: 0px 0px 0px 45px;"|✔ Required User Groups
+
−
|}
+
−
{|
+
−
|style="padding: 0px 0px 0px 45px;"|✔ Required Active Products
+
−
|}
+
−
{|
+
−
|style="padding: 0px 0px 0px 45px;"|✔ Required Active Products In Groups
+
−
|}
+
−
{|
+
−
|style="padding: 0px 0px 0px 45px;"|✔ Required Active Products With Servers
+
−
|}
+
−
{|
+
−
|style="padding: 0px 0px 0px 45px;"|✔ Required Active Addons
+
−
|}
+
−
{|
+
−
|style="padding: 0px 0px 0px 45px;"|✔ Required Active Domains Using TLDs
+
−
|}
+
−
{|
+
−
|style="padding: 0px 0px 0px 45px;"|✔ Lack Of Chosen Products
+
−
|}
+
−
{|
+
−
|style="padding: 0px 0px 0px 45px;"|✔ Lack Of Chosen Addons
+
−
|}
+
−
{|
+
−
|style="padding: 0px 0px 0px 45px;"|✔ Lack Of Domains Using TLDs
+
−
|}
+
−
{|
+
−
|style="padding: 0px 0px 0px 30px;"|✔ Define Time Frames For Pop-up To Be Shown
+
−
|}
+
−
{|
+
−
|style="padding: 0px 0px 0px 30px;"|✔ Define Pop-up Size
+
−
|}
+
−
{|
+
−
|style="padding: 0px 0px 0px 30px;"|✔ Assign Style To Pop-up
+
−
|}
+
−
{|
+
−
|style="padding: 0px 0px 0px 30px;"|✔ Choose Type And Provide Pop-up Content:
+
−
|}
+
−
{|
+
−
|style="padding: 0px 0px 0px 45px;"|✔ Raw Text
+
−
|}
+
−
{|
+
−
|style="padding: 0px 0px 0px 45px;"|✔ HTML
+
−
|}
+
−
{|
+
−
|style="padding: 0px 0px 10px 45px;"|✔ Image
+
 
|}
 
|}
 
*'''General Info:'''
 
*'''General Info:'''
 
{|
 
{|
−
|style="padding: 10px 0px 0px 30px;"|✔ Supports Default And Custom WHMCS Templates
+
|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 PHP 5.4 Up To PHP 7
+
|style="padding: 0px 0px 30px 30px;"|✔ Supports WHMCS V7
−
|}
+
−
{|
+
−
|style="padding: 0px 0px 30px 30px;"|✔ Supports WHMCS V6 and V7
+
 
|}
 
|}
  
 
=Installation=
 
=Installation=
 
{|
 
{|
−
|style="padding: 10px 0px 0px 0px;"|'''This tutorial will show you how to successfully install and configure Client Area Popup 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==
 
{|
 
{|
−
|style="padding: 20px 0px 20px 15px;"|'''1. Log in to your client area and download the module.'''
+
|style="padding: 10px 0px 20px 15px;"|'''1. Log in to our client area and download the module.'''
 
|}
 
|}
 
{|
 
{|
−
|style="padding: 0px 0px 20px 25px;"|[[File:CAP_1.png]]
+
|style="padding: 0px 0px 20px 25px;"|[[File:HQN_1.png]]
 
|}
 
|}
 
{|
 
{|
−
|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 7, while the second one is aimed at PHP 5.4 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:CAP_2.png]]
+
|style="padding: 0px 0px 20px 25px;"|[[File:PHP56_72.png]]
 
|}
 
|}
 
{|
 
{|
Line 139: Line 72:
 
|}
 
|}
 
{|
 
{|
−
|style="padding: 0px 0px 20px 25px;"|[[File:sdftsert.png]]
+
|style="padding: 0px 0px 20px 25px;"|[[File:drfere.png]]
 
|}
 
|}
 
{|
 
{|
−
|style="padding: 0px 0px 15px 15px;"|'''4. When you install Client Area Popup For WHMCS 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/PopupModule/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:CAP_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 the 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:CAP_4.png]]
+
|style="padding: 0px 0px 30px 25px;"|[[File:HQN_4.png]]
 
|}
 
|}
  
 +
==Configuration of Addon==
 
{|
 
{|
−
|style="padding: 0px 0px 10px 15px;"|'''6. Set permissions to file: '' 'modules/addons/PopupModule/templates/clientarea/assets/popup' '' to  '' '0777'. ''
+
|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 15px 15px;"|'''7. Now you have to activate the module in your WHMCS system. '''<br />
+
|style="padding: 0px 0px 20px 25px;"|[[File:HQN_5.png]]
−
Log in to your WHMCS admin area. Go to '' 'Setup' '' → '' 'Addon Modules'. '' Afterwards, find '' 'Client Area Popup' '' and press '' 'Activate' '' button.
+
 
|}
 
|}
 
{|
 
{|
−
|style="padding: 0px 0px 20px 25px;"|[[File:CAP_5.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;"|'''8. In the next step you need to permit access to this module.'''<br />
+
|style="padding: 0px 0px 30px 25px;"|[[File:HQN_6.png]]
−
To do so, click on '' 'Configure' '' button, tick '' 'Full Administrator' '' and press '' 'Save Changes'. ''
+
 
|}
 
|}
 +
 
{|
 
{|
−
|style="padding: 0px 0px 20px 25px;"|[[File:CAP_6.png]]
+
|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 15px 15px;"|'''9. You have just successfully installed Client Area Popup For WHMCS!'''<br />
+
|style="padding: 0px 0px 30px 25px;"|[[File:HQN_7.png]]
−
You can access your module under '' 'Addons' '' → '' 'Client Area Popup'.''
+
−
|}
+
−
{|
+
−
|style="padding: 0px 0px 30px 25px;"|[[File:CAP_7.png]]
+
 
|}
 
|}
  
 
=Configuration and Management=
 
=Configuration and Management=
 
{|
 
{|
−
|style="padding: 10px 0px 30px 15px;"|'''Client Area Popup For WHMCS is a module which allows you to notify your clients by showing them customized pop-ups directly in their panel.'''<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.'''
−
Below, you will find instructions on how to draft and customize such pop-ups.
+
 
|}
 
|}
 
==Configuration==
 
==Configuration==
 
{|
 
{|
−
|style="padding: 10px 0px 30px 15px;"|The module does not require advanced configuration.<br /> That is why, we will immediately move to the most crucial part, which is creating a pop-up.
+
|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.
 
|}
 
|}
−
===Create Pop-up===
 
 
{|
 
{|
−
|style="padding: 10px 0px 20px 15px;"|To add a new pop-up simply press an appropriate button.  
+
|style="padding: 0px 0px 20px 25px;"|[[File:HQN_9.png]]
 
|}
 
|}
 
{|
 
{|
−
|style="padding: 0px 0px 30px 25px;"|[[File:CAP_8.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.
 
|}
 
|}
−
====General====
 
 
{|
 
{|
−
|style="padding: 10px 0px 20px 15px;"|Start with naming the pop-up.<br />''Note: the title will not be displayed in any way on the final pop-up.''<br />
+
|style="padding: 0px 0px 20px 25px;"|[[File:HQN_10.png]]
 
|}
 
|}
 
{|
 
{|
−
|style="padding: 0px 0px 20px 25px;"|[[File:CAP_9.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;"|If you have already other pop-ups created, you may copy their settings to the newly created one to save a lot of time.<br />
+
|style="padding: 0px 0px 30px 25px;"|[[File:HQN_11.png]]
−
Finally, select the initial status:<br>
+
−
*''Active'' - for enabled pop-ups.
+
−
*''Archived'' - for pop-ups awaiting activation in store.
+
 
|}
 
|}
 +
==Logs==
 
{|
 
{|
−
|style="padding: 0px 0px 30px 25px;"|[[File:CAP_10.png]]
+
|style="padding: 10px 0px 15px 15px;"|Under '' 'Logs' '' page you can view information about sent notifications.
 
|}
 
|}
−
 
−
====Look And Feel====
 
 
{|
 
{|
−
|style="padding: 10px 0px 15px 15px;"|The next part of creating a pop-up process concerns its interface, layout and general design.<br />
+
|style="padding: 0px 0px 30px 25px;"|[[File:HQN_12.png]]
−
*'''Size'''<br />
+
−
Auto - it automatically adjusts to the content.<br />
+
−
Custom - if you want a customized size, then simply enter appropriate width and height.<br />
+
−
*'''Style'''<br />
+
−
Select style from the list of available and previously defined styles. <br />
+
−
''More about styles can be found [http://www.docs.modulesgarden.com/Client_Area_Popup_For_WHMCS#Styles here.]''<br />
+
 
|}
 
|}
 +
==Notifications==
 
{|
 
{|
−
|style="padding: 0px 0px 20px 25px;"|[[File:CAP_11.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]]
−
*'''Type'''
+
−
The pop-up may have a simple text form - select '' 'Text' '' and  then format the text.<br />
+
−
See the visualization [[media:CAP_29.png|'''here''']].
+
−
|}
+
−
{|
+
−
|style="padding: 0px 0px 20px 25px;"|[[File:CAP_12.png]]
+
−
|}
+
−
{|
+
−
|style="padding: 0px 0px 15px 15px;"|Provide ready code snippet that you want to insert into the pop-up content.<br />
+
−
See the visualization [[media:CAP_28.png|'''here''']].
+
−
|}
+
−
{|
+
−
|style="padding: 0px 0px 20px 25px;"|[[File:CAP_13.png]]
+
−
|}
+
−
{|
+
−
|style="padding: 0px 0px 15px 15px;"|Upload an '' 'Image'. ''<br />
+
−
See the visualization [[media:CAP_31.png|'''here''']].
+
−
|}
+
−
{|
+
−
|style="padding: 0px 0px 30px 25px;"|[[File:CAP_14.png]]
+
 
|}
 
|}
  
−
====Restrictions====
+
=Tips=
 
{|
 
{|
−
|style="padding: 0px 0px 15px 15px;"|Restrictions - this is the place where a pop-up is conditioned. Please set up the rules according to which the pop-up will be displayed to clients.<br />Only one restriction rule per group is required to show pop-up. If you choose restrictions from multiple conditions then at least one rule in each group must be fulfilled to show pup-up.
+
|style="padding: 10px 0px 30px 15px;"|
 
|}
 
|}
−
{|
 
−
|style="padding: 0px 0px 15px 15px;"|
 
−
For example: If you choose three products under '' 'Has Active Product' '' rule then client needs to have only one of active products to see the pop-up. <br />
 
−
But if you choose three products under '' 'Has Active Product' '' rule and three addons under '' 'Has Active Addon' '' rule then client will have to have at least one active product and at least one active addon from selected conditions to see the pop-up.
 
−
|}
 
−
{|
 
−
|style="padding: 0px 0px 15px 15px;"|General options:
 
−
*'''Display Frequency''' - define how often the pop-up will be displayed to a client, you may also make it visible all the time.
 
−
*'''Hide''' - if selected, clients will be allowed to close the pop-up permanently, even if it was configured to appear repeatedly.
 
−
*'''Non-logged In Users''' - if selected, the pop-up will be displayed to all guests and unlogged visitors.
 
−
*'''Pages''' - provide here specific wildcards URL of sites where the pop-up should be available from. Use comma to separate them if you plan to add more than one page.<br />''e.g.: '*action=invoices, *action=quotes' etc.''<br /><br />
 
  
−
Conditions:<br />
+
=Update Instructions=
−
''Press required text area and available options will appear.''<br />
+
−
*'''Languages''' - select languages, the pop-up will be displayed only to clients who use one of the chosen languages.
+
−
*'''User Groups''' - point groups, only clients in these groups will see the pop-up.
+
−
*'''Has Active Product''' - select any products that have to be active.
+
−
*'''Has Active Addon''' - select any  addons that have to be active.
+
−
*'''Has Active Product In Group''' - select any groups of products that a client has active products in. ''Note: At least one product in group is required.''
+
−
*'''Has Active TLDs''' - point any TLDs that have to be active for client.
+
−
*'''Has No Products''' - select which products client should not have to show pop-up
+
−
*'''Has No Addons''' - select which addons client should not have to show pop-up
+
−
*'''Has No TLDs''' - select which domains TLD user should not have to show pop-up
+
−
*'''Has Active Product With Server''' - select any servers where client have to have an active product.
+
−
If any of the above options is left blank, it will not be taken into consideration when creating a final list of clients to see the pop-up.
+
−
|}
+
 
{|
 
{|
−
|style="padding: 0px 0px 20px 25px;"|[[File:CAP_15.png]]
+
|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 15px;"|You will also find there an explanation of the checking process:
 
−
|}
 
−
{|
 
−
|style="padding: 0px 0px 30px 25px;"|[[File:CAP_16.png]]
 
−
|}
 
−
 
−
====Timing====
 
−
{|
 
−
|style="padding: 10px 0px 15px 15px;"|In the last section define time period within which the pop-up shall be active - when it will be displayed with the set up previously frequency.<br />
 
−
Choose a specific day and time to schedule the pop-up activation or select option '' 'Immediately' '' - then the pop-up will be active once you save the changes.<br /><br />
 
−
In the same way set up ending date. Provide specific date when the pop-up will be marked as '' 'Inactive'.''<br /> You may also check '' 'Never' '' if you do not want it to be deactivated.
 
−
|}
 
−
{|
 
−
|style="padding: 0px 0px 20px 25px;"|[[File:CAP_17.png]]
 
−
|}
 
−
{|
 
−
|style="padding: 0px 0px 20px 15px;"|Press '' 'Save' '' button once you have finished the configuration.
 
−
|}
 
−
{|
 
−
|style="padding: 0px 0px 30px 25px;"|[[File:CAP_18.png]]
 
−
|}
 
−
 
−
===Pop-ups===
 
−
{|
 
−
|style="padding: 10px 0px 15px 15px;"|The first and main section of the module is called '' 'Pop-ups'. ''<br />
 
−
You will find there all the most important information on existing pop-ups together with any possible action that can be taken on them.<br />Go through the following section to learn more.
 
−
|}
 
−
{|
 
−
|style="padding: 0px 0px 30px 25px;"|[[File:CAP_19.png]]
 
−
|}
 
−
 
−
====Actions====
 
−
{|
 
−
|style="padding: 10px 0px 15px 15px;"|
 
−
1. Preview the pop-up - a sample page with a visible pop-up will appear. This is the final look a client will receive.<br />
 
−
2. Edit the pop-up - change the restrictions, timing or style.<br />
 
−
3. Set the pop-up as inavtive, it will be moved to '' 'Inactive' '' tab.<br />
 
−
4. Move the pop-up to archive, you will be able to restore it at any time in the future.<br />
 
−
5. Delete the pop-up. You must be completely sure, you will not be able to have it back in any way.<br />
 
−
6. You may also perform bulk actions on multiple selected entries simultaneously.
 
−
|}
 
−
{|
 
−
|style="padding: 0px 0px 30px 25px;"|[[File:CAP_20.png]]
 
−
|}
 
−
 
−
====Types====
 
−
{|
 
−
|style="padding: 10px 0px 15px 15px;"|There are three types of pop-ups in the system:
 
−
*Active
 
−
*Inactive
 
−
*Archived
 
−
|}
 
−
{|
 
−
|style="padding: 0px 0px 20px 25px;"|[[File:CAP_21.png]]
 
−
|}
 
−
{|
 
−
|style="padding: 0px 0px 15px 15px;"|Inactive pop-ups are those for which the end date has been crossed and they are no longer displayed to clients.<br />
 
−
Just like in case of active pop-ups all actions are available. You may edit it to change the end date and at the same time activate it again.
 
−
|}
 
−
{|
 
−
|style="padding: 0px 0px 20px 25px;"|[[File:CAP_22.png]]
 
−
|}
 
−
{|
 
−
|style="padding: 0px 0px 15px 15px;"|Pop-ups in archive are moved there manually, these can be the previously active or inactive pop-ups ''(use action button to move entry to 'Archive').''
 
−
You may restore archived pop-ups any time and, depending on the end date of the resorted pop-up, it will be moved either to '' 'Active' '' or '' 'Inactive' '' group.
 
−
|}
 
−
{|
 
−
|style="padding: 0px 0px 30px 25px;"|[[File:CAP_23.png]]
 
−
|}
 
−
 
−
==Styles==
 
−
{|
 
−
|style="padding: 10px 0px 15px 15px;"|'' 'Styles' '' section contains a list of all predefined styles, that position your pop-ups.<br />There are 26 types of different styles, that vary from one another with up or down position, right/left/center, overlay option etc.
 
−
|}
 
−
{|
 
−
|style="padding: 0px 0px 20px 25px;"|[[File:CAP_24.png]]
 
−
|}
 
−
{|
 
−
|style="padding: 0px 0px 15px 15px;"|Before you start using any of the styles you can see their preview in the client area.<br />
 
−
See the visualization [[media:CAP_24_1.png|'''here''']].
 
−
|}
 
−
{|
 
−
|style="padding: 0px 0px 20px 25px;"|[[File:CAP_24_2.png]]
 
−
|}
 
−
{|
 
−
|style="padding: 0px 0px 15px 15px;"|If non of the predefined styles perfectly matches your needs, you may edit the styles.<br />
 
−
Press the icon as marked on the screen.
 
−
|}
 
−
{|
 
−
|style="padding: 0px 0px 20px 25px;"|[[File:CAP_25.png]]
 
−
|}
 
−
{|
 
−
|style="padding: 0px 0px 20px 15px;"|You are moved to the style edition page with CSS and HTML details. You may edit them as you need to adjust the style to your preferences.
 
−
|}
 
−
{|
 
−
|style="padding: 0px 0px 30px 25px;"|[[File:CAP_26.png]]
 
−
|}
 
−
===New Style===
 
−
{|
 
−
|style="padding: 10px 0px 15px 15px;"|In case the predefined styles are not sufficient and you do not want to lose any by editing its content, you may always add a new style.<br />Press the button as on the screen to do so.
 
−
|}
 
−
{|
 
−
|style="padding: 0px 0px 20px 25px;"|[[File:CAP_26_1.png]]
 
−
|}
 
−
{|
 
−
|style="padding: 0px 0px 15px 15px;"|Provide your customized content or copy and modify a predefined style content.<br />
 
−
Save the changes in the end.
 
−
|}
 
−
{|
 
−
|style="padding: 0px 0px 30px 25px;"|[[File:CAP_26_2.png]]
 
−
|}
 
−
 
−
==Documentation==
 
−
{|
 
−
|style="padding: 10px 0px 15px 15px;"|The last position in your navigation menu, when pressed, redirects to the article you are currently reading.
 
−
|}
 
−
{|
 
−
|style="padding: 0px 0px 30px 25px;"|[[File:CAP_27.png]]
 
−
|}
 
−
 
−
==Visualizations==
 
−
{|
 
−
|style="padding: 10px 0px 5px 15px;"|Now, let's take a look what Client Area Popup For WHMCS may give you in practice.<br /> Underneath, you will find several examples of pup-ups, each in a different style and of a different type.
 
−
|}
 
−
{|
 
−
|style="padding: 0px 0px 15px 15px;"|Type: '' 'Text' ''<br /> Style: '' 'left_up' ''
 
−
|}
 
−
{|
 
−
|style="padding: 0px 0px 20px 25px;"|[[File:CAP_28.png]]
 
−
|}
 
−
{|
 
−
|style="padding: 0px 0px 15px 15px;"|Type: '' 'Text' ''<br /> Style:  '' 'center_overlay' ''<br />
 
−
'' 'Overlay' means there is a gray background behind the pop-up text or image.''
 
−
|}
 
−
{|
 
−
|style="padding: 0px 0px 20px 25px;"|[[File:CAP_29.png]]
 
−
|}
 
−
{|
 
−
|style="padding: 0px 0px 15px 15px;"|Type: '' 'Image',''<br /> Style: '' 'center' ''
 
−
|}
 
−
{|
 
−
|style="padding: 0px 0px 20px 25px;"|[[File:CAP_30.png]]
 
−
|}
 
−
{|
 
−
|style="padding: 0px 0px 15px 15px;"|Type: '' 'Image',''<br /> Style: '' 'right_overlay_up' ''
 
−
|}
 
−
{|
 
−
|style="padding: 0px 0px 30px 25px;"|[[File:CAP_31.png]]
 
−
|}
 
−
 
−
=Tips=
 
−
{|
 
−
|style="padding: 10px 0px 10px 15px;"|1. For your comfort, '' 'HTML' '' type of pop-up content supports also '' 'JavaScript' '' to let you provide your preferable content.
 
−
|}
 
−
{|
 
−
|style="padding: 0px 0px 30px 15px;"|2. The module is ad blocker resistant unless in the tool your clients block the popup class deliberately.
 
−
|}
 
−
 
 
=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. If you encounter an error like on the below screen, please make sure you have successfully completed [http://www.docs.modulesgarden.com/Client_Area_Popup_For_WHMCS#Installation step 6] of the installation instructions.
+
−
|}
+
−
{|
+
−
|style="padding: 0px 0px 20px 25px;"|[[File:CAP_32.png]]
+
−
|}
+
−
{|
+
−
|style="padding: 0px 0px 30px 15px;"|3. If you have problems with your license, please make sure that the content of the file is correct.<br />
+
−
Please note that for '''Client Area Popup For WHMCS V1.0.1''' and later the license key begins with:
+
−
$client_area_popup_licensekey="ModulesGarden_ClientAreaPopup_W_XXXXXXXXXXXX";
+
−
 
+
−
'''Not''' as it was for the previous version:
+
−
$popup_module_licensekey="ModulesGarden_ClientAreaPopup_W_XXXXXXXXXXXX";
+
 
|}
 
|}

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