Personal tools
Namespaces

Variants
Actions

Hosting Quota Notifications 1.X For WHMCS

From ModulesGarden Wiki
(Difference between revisions)
Jump to: navigation, search
(About Client Area Designer For WHMCS)
 
(505 intermediate revisions by 5 users not shown)
Line 1: Line 1:
<meta name="keywords" content="client area designer for whmcs, client area designer configuration, whmcs client area designer management, whmcs client area designer installation, whmcs client area designer common problems, about whmcs client area designer, whmcs client client area designer documentation, whmcs client area designer faq, whmcs client area designer help, whmcs client area designer guide, whmcs client area designer wiki, whmcs client area designer tutorial, whmcs client area designer tips, whmcs client area designer 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 Designer 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/client-area-designer Client Area Designer For WHMCS]=
+
=About [https://www.modulesgarden.com/products/whmcs/hosting-quota-notifications Hosting Quota Notifications For WHMCS]=
 
{|
 
{|
|style="padding: 10px 0px 10px 0px;"|'''Client Area Designer For WHMCS''' is a module that allows administrators to manage their client area final view.<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.
Change the order of displayed elements, add new ones or hide them if you do not want your clients to access them.<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 />
Additionally, you may create new widgets and set up restrictions rules to show the widget to selected clients only.
+
You can also define email templates and view details of each sent notification owing to logs.
 
|}
 
|}
<!-- fixed -->
+
<!--a comment maybe? -->
*'''Module Features:'''
+
*'''Admin Area Features:'''
 
{|
 
{|
|style="padding: 10px 0px 0px 30px;"|✔ Customize Your Client Area By Modifying:
+
|style="padding: 10px 0px 0px 30px;"|✔ Automatically Notify Your Clients Upon Exceeding Defined Limits Of Bandwidth And Disk Usage
 
|}
 
|}
 
{|
 
{|
|style="padding: 0px 0px 0px 45px;"|✔ Navbar Elements
+
|style="padding: 0px 0px 0px 30px;"|✔ Configure Notification Groups
 
|}
 
|}
 
{|
 
{|
|style="padding: 0px 0px 0px 45px;"|✔ Sidebar Elements
+
|style="padding: 0px 0px 0px 30px;"|✔ Choose Between Two Types Of Group Counting:
 
|}
 
|}
 
{|
 
{|
|style="padding: 0px 0px 0px 45px;"|✔ Homepage Widgets
+
|style="padding: 0px 0px 0px 45px;"|✔ Tiered - Define Tiers Of Usage
 
|}
 
|}
 
{|
 
{|
|style="padding: 0px 0px 0px 30px;"|✔ Add Your Own Elements And Widgets
+
|style="padding: 0px 0px 0px 45px;"|✔ Fixed - Define Usage Grow Over Time
 
|}
 
|}
 
{|
 
{|
|style="padding: 0px 0px 0px 30px;"|✔ Scan Your Client Area In Search Of Custom Elements And Widgets
+
|style="padding: 0px 0px 0px 30px;"|✔ Assign Multiple Products To Single Notification Group
 
|}
 
|}
 
{|
 
{|
|style="padding: 0px 0px 10px 30px;"|✔ View And Modify List Of Known Locations In Your Client Area
+
|style="padding: 0px 0px 0px 30px;"|✔ Assign Email Templates Per Notification Group
 
|}
 
|}
*'''Navbar Element Features:'''
 
 
{|
 
{|
|style="padding: 10px 0px 0px 30px;"|✔ Define Name
+
|style="padding: 0px 0px 0px 30px;"|✔ Enable/Disable Notification Groups
 
|}
 
|}
 
{|
 
{|
|style="padding: 0px 0px 0px 30px;"|✔ Define URI
+
|style="padding: 0px 0px 10px 30px;"|✔ View Logs Of Sent Notifications
|}
+
{|
+
|style="padding: 0px 0px 0px 30px;"|✔ Define Icon
+
|}
+
{|
+
|style="padding: 0px 0px 0px 30px;"|✔ Define Display Rules:
+
|}
+
{|
+
|style="padding: 0px 0px 0px 45px;"|✔ Client Owns Domain
+
|}
+
{|
+
|style="padding: 0px 0px 0px 45px;"|✔ Client Owns Product
+
|}
+
{|
+
|style="padding: 0px 0px 0px 45px;"|✔ Client Is In Location
+
|}
+
{|
+
|style="padding: 0px 0px 10px 30px;"|✔ Add Multiple Links To Element
+
|}
+
 
+
*'''Sidebar Element Features:'''
+
{|
+
|style="padding: 10px 0px 0px 30px;"|✔ Define Name
+
|}
+
{|
+
|style="padding: 0px 0px 0px 30px;"|✔ Define Icon
+
|}
+
{|
+
|style="padding: 0px 0px 0px 30px;"|✔ Define Display Rules:
+
|}
+
{|
+
|style="padding: 0px 0px 0px 45px;"|✔ Client Owns Domain
+
|}
+
{|
+
|style="padding: 0px 0px 0px 45px;"|✔ Client Owns Product
+
|}
+
{|
+
|style="padding: 0px 0px 0px 45px;"|✔ Client Is In Location
+
|}
+
{|
+
|style="padding: 0px 0px 0px 45px;"|✔ Choose One Feature Per Element:
+
|}
+
{|
+
|style="padding: 0px 0px 0px 30px;"|✔ Add Multiple Links To Element
+
|}
+
{|
+
|style="padding: 0px 0px 10px 30px;"|✔ Define Custom Body And Footer Content - Support HTML, CSS And JavaScript
+
|}
+
 
+
*'''Homepage Widget Features:'''
+
{|
+
|style="padding: 10px 0px 0px 30px;"|✔ Define Name
+
|}
+
{|
+
|style="padding: 0px 0px 0px 30px;"|✔ Define Icon
+
|}
+
{|
+
|style="padding: 0px 0px 0px 30px;"|✔ Define Style Color
+
|}
+
{|
+
|style="padding: 0px 0px 0px 30px;"|✔ Define Widget Button
+
|}
+
{|
+
|style="padding: 0px 0px 0px 30px;"|✔ Choose One Feature Per Widget:
+
|}
+
{|
+
|style="padding: 0px 0px 0px 45px;"|✔ Add Multiple Links To Element
+
|}
+
{|
+
|style="padding: 0px 0px 10px 45px;"|✔ Define Custom Body And Footer Content - Support HTML, CSS And JavaScript
+
 
|}
 
|}
 
*'''General Info:'''
 
*'''General Info:'''
 
{|
 
{|
|style="padding: 10px 0px 0px 30px;"|✔ Multi-Language Support  
+
|style="padding: 10px 0px 0px 30px;"|✔ Multi-Language Support
 
|}
 
|}
 
{|
 
{|
|style="padding: 0px 0px 0px 30px;"|✔ Supports PHP 5.3 Up To PHP 7
+
|style="padding: 0px 0px 0px 30px;"|✔ Supports PHP 5.6 Up To PHP 7.2
 
|}
 
|}
 
{|
 
{|
|style="padding: 0px 0px 30px 30px;"|✔ Supports WHMCS V6 and V7
+
|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 Client Area Designer 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 Client Area Designer 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:CAD_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:CAD_2.png]]
+
|style="padding: 0px 0px 20px 25px;"|[[File:PHP56_72.png]]
 
|}
 
|}
 
{|
 
{|
|style="padding: 0px 0px 15px 15px;"|'''3. When you install Client Area Designer 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/ClientAreaDesigner/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:CAD_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 20px 25px;"|[[File:CAD_4.png]]
+
|style="padding: 0px 0px 20px 25px;"|[[File:HQN_3.png]]
 
|}
 
|}
 
{|
 
{|
|style="padding: 0px 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. Go to '' 'Setup' '' → '' 'Addon Modules'. '' Afterwards, find '' 'Client Area Designer' '' and press '' 'Activate' '' button.
+
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:CAD_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 '' 'Full Administrator' '' and press '' 'Save Changes'. ''
+
|}
+
{|
+
|style="padding: 0px 0px 20px 25px;"|[[File:CAD_6.png]]
+
|}
+
{|
+
|style="padding: 0px 0px 15px 15px;"|'''7. You have just successfully installed Client Area Designer For WHMCS!'''<br/>
+
You can access your module under '' 'Addons' '' → '' 'Client Area Designer'.''
+
|}
+
{|
+
|style="padding: 0px 0px 30px 25px;"|[[File:CAD_7.png]]
+
 
|}
 
|}
  
=Configuration and Management=
+
==Configuration of Addon==
 
{|
 
{|
|style="padding: 10px 0px 30px 15px;"|'''Client Area Designer For WHMCS is a module which allows you to adjust the layout of any panels available on your client area as well as add new widgets.'''<br/>
+
|style="padding: 10px 0px 15px 15px;"|'''6. Now you have to activate the module in your WHMCS system.'''<br />
The module does not require highly advanced configuration.<br/>That is why we will immediately move to the most crucial aspect, which is customizing the panels layout.
+
Log in to your WHMCS admin area. Go to '' 'Setup' '' → '' 'Addon Modules' ''. Afterwards, find '' 'Hosting Quota Notifications' '' and press '' 'Activate' '' button.
 
|}
 
|}
 
==Panels==
 
 
{|
 
{|
|style="padding: 10px 0px 30px 15px;"|Under '' 'Panels' '' tab you will find three sections dedicated to the visibility of different types of panels in your client area.
+
|style="padding: 0px 0px 20px 25px;"|[[File:HQN_5.png]]
*Navbars - Management of positions available on the navigation bar in your client area
+
*Sidebars - Management of panels available on the left sidebar in your client area
+
*Homepage Widgets - Modify and create new widgets available on your home page
+
 
|}
 
|}
===Navbars===
 
 
{|
 
{|
|style="padding: 10px 0px 15px 15px;"|On the first sight you will see two tables, each related to Primary Navbar Left or Right side.<br/>
+
|style="padding: 0px 0px 15px 15px;"|'''7. In the next step you need to permit access to this module.'''<br />
There are already all the predefined sections outlined with their official names and positions.<br/>
+
To do so click on '' 'Configure' '' button, tick '' 'Access Control' '' near required admin role groups and press '' 'Save Changes' ''.
''Info:
+
If you already see that you have more elements than it is visible in the addon, then use '' 'Scanner' '' to search for them.<br/> Read more about scanning option [http://www.docs.modulesgarden.com/Client_Area_Designer_For_WHMCS#Scanner here].''
+
 
|}
 
|}
 
{|
 
{|
|style="padding: 0px 0px 20px 25px;"|[[File:CAD_8.png]]
+
|style="padding: 0px 0px 30px 25px;"|[[File:HQN_6.png]]
|}
+
{|
+
|style="padding: 0px 0px 20px 15px;"|Those are the below navbar panels visible in the client area.
+
|}
+
{|
+
|style="padding: 0px 0px 20px 25px;"|[[File:CAD_9.png]]
+
|}
+
{|
+
|style="padding: 0px 0px 15px 15px;"|First of all, you may change the position of the elements.<br/>
+
Drag one panel and drop it in the required place.
+
|}
+
{|
+
|style="padding: 0px 0px 20px 25px;"|[[File:CAD_10.png]]
+
|}
+
{|
+
|style="padding: 0px 0px 15px 15px;"|Use action buttons to:
+
*edit the section
+
*delete '''(only custom elements)'''
+
*view child elements
+
|}
+
{|
+
|style="padding: 0px 0px 30px 25px;"|[[File:CAD_11.png]]
+
|}
+
====Edit Element====
+
{|
+
|style="padding: 10px 0px 15px 15px;"|When you are editing an existing parent element, you may:
+
*provide a new display name
+
*add icon
+
*hide the element
+
|}
+
{|
+
|style="padding: 0px 0px 20px 25px;"|[[File:CAD_12.png]]
+
|}
+
{|
+
|style="padding: 0px 0px 15px 15px;"|You may also provide some display rules, only clients who fulfill the rules will see the element.<br/>
+
If you leave this part empty, the element will be visible for all clients without limitations.
+
*select domains a client must own
+
*point product that must be owned
+
*location a client must enter<br/>
+
Do not forget to save the changes when ready.
+
|}
+
{|
+
|style="padding: 0px 0px 30px 25px;"|[[File:CAD_13.png]]
+
 
|}
 
|}
  
====New Parent Element====
 
 
{|
 
{|
|style="padding: 10px 0px 15px 15px;"|It is possible add a completely new parent element either on left or right side.<br/>Press '' 'Add'.''  
+
|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 20px 25px;"|[[File:CAD_14.png]]
+
|style="padding: 0px 0px 30px 25px;"|[[File:HQN_7.png]]
|}
+
{|
+
|style="padding: 0px 0px 15px 15px;"|Then you will have to fill out all the general info, content and display rules.<br/>
+
Start with '' 'General'.'' Provide:
+
*name visible for clients
+
*unique for the system identifier
+
*URI
+
*select icon from available
+
*finally select '' 'Display' '' to make the panel visible
+
|}
+
{|
+
|style="padding: 0px 0px 20px 25px;"|[[File:CAD_15.png]]
+
|}
+
{|
+
|style="padding: 0px 0px 15px 15px;"|If you want only some of the clients to see the panel, then set up the '' 'Display Rules'.''<br/>
+
In our case we have decided to select products a client must own to get access to '' 'Support Chat'.''<br/>
+
Save the changes in the end.
+
|}
+
{|
+
|style="padding: 0px 0px 20px 25px;"|[[File:CAD_16.png]]
+
|}
+
{|
+
|style="padding: 0px 0px 20px 15px;"|This is how our new panel looks like in the client area:
+
|}
+
{|
+
|style="padding: 0px 0px 30px 25px;"|[[File:CAD_17.png]]
+
 
|}
 
|}
  
====New Child Element====
+
=Configuration and Management=
 
{|
 
{|
|style="padding: 10px 0px 20px 15px;"|Let's now add one more element to the already existing '' 'Support' '' panel.
+
|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:CAD_18.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;"|You have to fill out the same data as in case of parent element:<br/>
+
|style="padding: 0px 0px 20px 25px;"|[[File:HQN_9.png]]
*name
+
*identifier
+
*URI
+
*icon
+
*finally select '' 'Display' '' to make it visible<br/>
+
This time we want all the clients to have access to our FAQ site, so we do no set any '' 'Display Rules'. ''
+
 
|}
 
|}
 
{|
 
{|
|style="padding: 0px 0px 20px 25px;"|[[File:CAD_19.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 20px 15px;"|As a custom element, you may delete it completely or edit.
+
|style="padding: 0px 0px 20px 25px;"|[[File:HQN_10.png]]
 
|}
 
|}
 
{|
 
{|
|style="padding: 0px 0px 20px 25px;"|[[File:CAD_20.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 20px 15px;"|Let's take a look at the new position in the client area:
+
|style="padding: 0px 0px 30px 25px;"|[[File:HQN_11.png]]
 
|}
 
|}
 +
==Logs==
 
{|
 
{|
|style="padding: 0px 0px 30px 25px;"|[[File:CAD_21.png]]
+
|style="padding: 10px 0px 15px 15px;"|Under '' 'Logs' '' page you can view information about sent notifications.
|}
+
 
+
===Sidebar Panels===
+
{|
+
|style="padding: 10px 0px 15px 15px;"|Sidebar panels section refers to the elements located on the left side of your client area.<br/>
+
Generally, management of sidebars is very similar to the Navbar panels described in the previous section.
+
 
|}
 
|}
 
{|
 
{|
|style="padding: 0px 0px 20px 25px;"|[[File:CAD_24.png]]
+
|style="padding: 0px 0px 30px 25px;"|[[File:HQN_12.png]]
 
|}
 
|}
 +
==Notifications==
 
{|
 
{|
|style="padding: 0px 0px 15px 15px;"|Available actions:
+
|style="padding: 10px 0px 15px 15px;"|You can create as many notifications as you wish.<br />
*change positioning by dragging and dropping the element in required place
+
The only requirement is their type being set to '' 'Product/Service' ''.<br />
*edit the section - change name, icon, content (if possible) and display rules
+
Additionally, you can use {if} statement, as shown below:
*delete elements - this option is available for custom entries only
+
{if $bw_over} Your bandwidth usage is over {$bw_over}MB{if $bw_current} (current: {$bw_current}MB){/if}.{/if}
*view child elements
+
{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:CAD_23.png]]
+
|style="padding: 0px 0px 30px 25px;"|[[File:HQN_13.png]]
 
|}
 
|}
  
====Edit Element====
+
=Tips=
 
{|
 
{|
|style="padding: 10px 0px 15px 15px;"|'''General''' section:
+
|style="padding: 10px 0px 30px 15px;"|
*provide a new display name
+
*add icon
+
*hide the element
+
|}
+
{|
+
|style="padding: 0px 0px 20px 25px;"|[[File:CAD_25.png]]
+
|}
+
{|
+
|style="padding: 0px 0px 15px 15px;"|'''Content:'''
+
*change the Body or Footer content.<br/>
+
Note that it is possible only if the element has no child elements.
+
|}
+
{|
+
|style="padding: 0px 0px 20px 25px;"|[[File:CAD_26.png]]
+
|}
+
{|
+
|style="padding: 0px 0px 15px 15px;"|'''Display rules''' - only clients who fulfill the rules will see the element.<br/>
+
If you leave this part empty, the element will be visible for all clients without limitations.
+
Do not forget to save the changes when ready.
+
|}
+
{|
+
|style="padding: 0px 0px 30px 25px;"|[[File:CAD_27.png]]
+
 
|}
 
|}
  
====New Parent Element====
+
=Update Instructions=
 
{|
 
{|
|style="padding: 10px 0px 15px 15px;"|You may add a completely new parent element either on left or right side.<br/>Press '' 'Add'.''  
+
|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:CAD_28.png]]
 
|}
 
{|
 
|style="padding: 0px 0px 15px 15px;"|Then you will have to fill out all the general info, content and display rules.<br/>
 
Start with '' 'General'.'' Provide:
 
*name visible for clients
 
*unique for the system identifier
 
*select icon from available
 
*finally select '' 'Display' '' to make the panel visible
 
|}
 
{|
 
|style="padding: 0px 0px 20px 25px;"|[[File:CAD_29.png]]
 
|}
 
{|
 
|style="padding: 0px 0px 15px 15px;"|Define Body and Footer content.<br/>
 
Note that if you provide the content here, you will not be able to add child elements to this item.
 
|}
 
{|
 
|style="padding: 0px 0px 20px 25px;"|[[File:CAD_30.png]]
 
|}
 
{|
 
|style="padding: 0px 0px 15px 15px;"|If you want only some of the clients to see the panel, then set up the '' 'Display Rules'.''<br/>
 
Save the changes in the end.
 
|}
 
{|
 
|style="padding: 0px 0px 20px 25px;"|[[File:CAD_31.png]]
 
|}
 
{|
 
|style="padding: 0px 0px 20px 15px;"|This is how our new panel looks like in the client area:
 
|}
 
{|
 
|style="padding: 0px 0px 30px 25px;"|[[File:CAD_32.png]]
 
|}
 
 
====New Child Element====
 
{|
 
|style="padding: 10px 0px 20px 15px;"|Let's now add one child element to client's '' 'Shortcuts'.''
 
|}
 
{|
 
|style="padding: 0px 0px 20px 25px;"|[[File:CAD_33.png]]
 
|}
 
{|
 
|style="padding: 0px 0px 15px 15px;"|Fill out all the required data to crate a correct link:<br/>
 
*name
 
*identifier
 
*URI
 
*icon
 
*select '' 'Display' ''
 
|}
 
{|
 
|style="padding: 0px 0px 20px 25px;"|[[File:CAD_34.png]]
 
|}
 
{|
 
|style="padding: 0px 0px 20px 15px;"|Any custom element can be deleted. In contrast to the default ones which may be only edited and hidden.
 
|}
 
{|
 
|style="padding: 0px 0px 20px 25px;"|[[File:CAD_35.png]]
 
|}
 
{|
 
|style="padding: 0px 0px 20px 15px;"|Now, you see an additional link under '' 'Shortcuts'.''
 
|}
 
{|
 
|style="padding: 0px 0px 30px 25px;"|[[File:CAD_36.png]]
 
|}
 
 
===Homepage Widgets===
 
{|
 
|style="padding: 10px 0px 15px 15px;"|The last type of panels are homepage widgets.<br/>
 
Available actions:
 
*change positioning by dragging and dropping the elements in required place
 
*edit the widget
 
*view child elements if there are any
 
*delete custom widgets
 
|}
 
{|
 
|style="padding: 0px 0px 20px 25px;"|[[File:CAD_37.png]]
 
|}
 
{|
 
|style="padding: 0px 0px 20px 15px;"|To visualize, these are the client area widgets we are going to alter in a moment:
 
|}
 
{|
 
|style="padding: 0px 0px 30px 25px;"|[[File:CAD_38.png]]
 
|}
 
 
====Edit widget====
 
{|
 
|style="padding: 10px 0px 15px 15px;"|'''General:'''
 
*provide a new display name
 
*change icon
 
*hide the element
 
|}
 
{|
 
|style="padding: 0px 0px 20px 25px;"|[[File:CAD_39.png]]
 
|}
 
{|
 
|style="padding: 0px 0px 15px 15px;"|Under '' 'Content' '' section you can overwrite the default text.<br/>
 
We will leave it empty as we do not want to change the content, just the look and feel of the widget.
 
|}
 
{|
 
|style="padding: 0px 0px 20px 25px;"|[[File:CAD_39_1.png]]
 
|}
 
{|
 
|style="padding: 0px 0px 15px 15px;"|'''Extras''' - here you can change the visual parts:
 
*widget color
 
*button name, URI and icon
 
|}
 
{|
 
|style="padding: 0px 0px 20px 25px;"|[[File:CAD_40.png]]
 
|}
 
{|
 
|style="padding: 0px 0px 20px 15px;"|That is how our adjusted widget looks like now:
 
|}
 
{|
 
|style="padding: 0px 0px 30px 25px;"|[[File:CAD_41.png]]
 
|}
 
====Add New Widget====
 
{|
 
|style="padding: 10px 0px 15px 15px;"|For presentation purposes we will create now a completely new widget.<br/>It will include a button redirection to our Knowledgebase and two links to FAQ and Upload Files form.<br/>
 
To start, simply press '' 'Add' '' button.
 
|}
 
{|
 
|style="padding: 0px 0px 20px 25px;"|[[File:CAD_42.png]]
 
|}
 
{|
 
|style="padding: 0px 0px 15px 15px;"|Then fill out all the general info, content and extras.<br/>
 
Start with '' 'General','' provide:
 
*widget name
 
*unique for the system identifier
 
*select icon from available
 
*finally select '' 'Display' '' to make the panel visible
 
|}
 
{|
 
|style="padding: 0px 0px 20px 25px;"|[[File:CAD_43.png]]
 
|}
 
{|
 
|style="padding: 0px 0px 15px 15px;"|As we are going to add two links inside the widget, so we have to skip this section.
 
|}
 
{|
 
|style="padding: 0px 0px 20px 25px;"|[[File:CAD_44.png]]
 
|}
 
{|
 
|style="padding: 0px 0px 15px 15px;"|Finally, customize your widget by defining color and button details.
 
Save the changes in the end.
 
|}
 
{|
 
|style="padding: 0px 0px 30px 25px;"|[[File:CAD_45.png]]
 
|}
 
 
====New Child Widget====
 
{|
 
|style="padding: 10px 0px 15px 15px;"|Let's now add a child element to the just created '' 'Knowledgebase'.''
 
|}
 
{|
 
|style="padding: 0px 0px 20px 25px;"|[[File:CAD_46.png]]
 
|}
 
{|
 
|style="padding: 0px 0px 15px 15px;"|Fill out the required data:<br/>
 
*name
 
*identifier
 
*URI
 
*icon
 
*select '' 'Display' ''
 
|}
 
{|
 
|style="padding: 0px 0px 20px 25px;"|[[File:CAD_47.png]]
 
|}
 
{|
 
|style="padding: 0px 0px 15px 15px;"|As you can see, we added two new entries under '' 'Knowledgebase' '' widget.<br/>
 
Surely, you can edit each one of them or delete.
 
|}
 
{|
 
|style="padding: 0px 0px 20px 25px;"|[[File:CAD_48.png]]
 
|}
 
{|
 
|style="padding: 0px 0px 20px 15px;"|Here is a final view of our customized client area with new elements:
 
|}
 
{|
 
|style="padding: 0px 0px 30px 25px;"|[[File:CAD_49.png]]
 
|}
 
 
==Locations==
 
{|
 
|style="padding: 10px 0px 15px 15px;"|In this you will find an extended list of all standard locations in your client area with its common name and URI.<br/>
 
These locations are searched through by the module scanner in search of custom panels and are available in '' 'Locations' '' field when setting up '' 'Display Rules'. ''
 
|}
 
{|
 
|style="padding: 0px 0px 20px 25px;"|[[File:CAD_50.png]]
 
|}
 
{|
 
|style="padding: 0px 0px 20px 15px;"|Press button with pencil icon next to location you are interested in to edit it.
 
|}
 
{|
 
|style="padding: 0px 0px 20px 25px;"|[[File:CAD_51.png]]
 
|}
 
{|
 
|style="padding: 0px 0px 20px 15px;"|There you can edit the name of existing location and its URI.
 
|}
 
{|
 
|style="padding: 0px 0px 30px 25px;"|[[File:CAD_52.png]]
 
|}
 
===New Location===
 
{|
 
|style="padding: 10px 0px 15px 15px;"|You may also add new if you have some custom locations and you wish to use them in our module.<br/>
 
Please note that your locations must be manageable by WHMCS.
 
|}
 
{|
 
|style="padding: 0px 0px 20px 25px;"|[[File:CAD_53.png]]
 
|}
 
{|
 
|style="padding: 0px 0px 15px 15px;"|Provide location name and URI.<br/>
 
When ready, your new location will be from now on used by Client Area Designer module.
 
|}
 
{|
 
|style="padding: 0px 0px 30px 25px;"|[[File:CAD_54.png]]
 
|}
 
 
==Scanner==
 
{|
 
|style="padding: 10px 0px 15px 15px;"|Scanner is a tool that allows our module to carefully browse through a chosen client's client area in search of any elements in known locations.<br/>
 
Select a client to log in as one and run the scanner.
 
|}
 
{|
 
|style="padding: 0px 0px 20px 25px;"|[[File:CAD_59.png]]
 
|}
 
{|
 
|style="padding: 0px 0px 15px 15px;"|You will see a preview of all locations. When the scan is finished, you will see a summary with the number of found panels.<br/> All newly found elements will be automatically added to proper positions in the addon.
 
|}
 
{|
 
|style="padding: 0px 0px 30px 25px;"|[[File:CAD_60.png]]
 
|}
 
 
==Documentation==
 
{|
 
|style="padding: 10px 0px 20px 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:CAD_55.png]]
 
|}
 
 
=Tips=
 
{|
 
|style="padding: 10px 0px 5px 15px;"|1. When you area adding new element into your client area, you may add the langs used in the lang file to allow translations and changes.<br/>
 
To do so:<br/>
 
*open your english.php file
 
*type in a new line in format:
 
$_LANG['element name'] = 'Element Name';
 
*to change/translate it simply, change the content after the '' '=' '' sign.
 
|}
 
{|
 
|style="padding: 0px 0px 30px 15px;"|2. Client Area Designer module supports only WHMCS template Six and any custom documentation that is based on this template and has been customized according to this  [https://developers.whmcs.com/themes/ documentation]. 
 
|}
 
 
 
=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.'''
 
|}
 
|}
<!--
 
{|
 
|style="padding: 0px 0px 10px 15px;"|2.
 
|}
 
 
-->
 

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.
Navigation
WHMCS Modules
WHMCS Widgets
Tools And Applications
Translations
General
FAQ
Community