Personal tools
Namespaces

Variants
Actions

Hosting Quota Notifications 1.X For WHMCS

From ModulesGarden Wiki
(Difference between revisions)
Jump to: navigation, search
(→‎About Client Profile Viewer For WHMCS)
 
(488 intermediate revisions by 5 users not shown)
Line 1: Line 1:
−
<meta name="keywords" content="client profile viewer for whmcs, client profile viewer configuration, whmcs client profile viewer management, whmcs client profile viewer installation, whmcs client profile viewer common problems, about whmcs client profile viewer, whmcs client profile viewer documentation, whmcs client profile viewer faq, whmcs client profile viewer help, whmcs client profile viewer guide, whmcs client profile viewer wiki, whmcs client profile viewer tutorial, whmcs client profile viewer tips, whmcs client profile viewer 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 Profile Viewer 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-profile-viewer Client Profile Viewer For WHMCS]=
+
 
{|
 
{|
−
|style="padding: 10px 0px 10px 0px;"|'''Client Profile Viewer For WHMCS''' is a module which was created to gather all the key information about each of your clients in one simple tooltip.<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.
−
Contact details, purchased products and services, income – all of these and many more organized in convenient widgets will be displayed each time you hover over a client's name.<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 />
−
The module enables you to not only conveniently preview the information about each customer but also modify it according to your needs.
+
You can also define email templates and view details of each sent notification owing to logs.
 
|}
 
|}
−
<!-- fixed -->
+
<!--a comment maybe? -->
−
*'''Addon Module Features:'''
+
*'''Admin Area Features:'''
 
{|
 
{|
−
|style="padding: 10px 0px 0px 30px;"|✔ View The Widgets With Details Of Clients In A Tooltip On Mouseover
+
|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;"|✔ Drag & Drop Configuration Of Each Widget Displayed In The Tooltip
+
|style="padding: 0px 0px 0px 30px;"|✔ Configure Notification Groups
 
|}
 
|}
 
{|
 
{|
−
|style="padding: 0px 0px 0px 30px;"|✔ Access Various Parts Of System On Click
+
|style="padding: 0px 0px 0px 30px;"|✔ Choose Between Two Types Of Group Counting:
 
|}
 
|}
 
{|
 
{|
−
|style="padding: 0px 0px 0px 30px;"|✔ Configure Admin Roles Assigned To Each Configuration
+
|style="padding: 0px 0px 0px 45px;"|✔ Tiered - Define Tiers Of Usage
 
|}
 
|}
 
{|
 
{|
−
|style="padding: 0px 0px 0px 30px;"|✔ Define The Manner In Which The Tooltip Disappears
+
|style="padding: 0px 0px 0px 45px;"|✔ Fixed - Define Usage Grow Over Time
 
|}
 
|}
 
{|
 
{|
−
|style="padding: 0px 0px 0px 30px;"|✔ Define The Delay For Showing The Tooltip
+
|style="padding: 0px 0px 0px 30px;"|✔ Assign Multiple Products To Single Notification Group
 
|}
 
|}
 
{|
 
{|
−
|style="padding: 0px 0px 10px 30px;"|✔ Automatically Flag Client Tickets To Assigned Admin
+
|style="padding: 0px 0px 0px 30px;"|✔ Assign Email Templates Per Notification Group
 
|}
 
|}
−
*'''Widgets:'''
 
 
{|
 
{|
−
|style="padding: 10px 0px 0px 30px;"|✔ Income
+
|style="padding: 0px 0px 0px 30px;"|✔ Enable/Disable Notification Groups
 
|}
 
|}
 
{|
 
{|
−
|style="padding: 0px 0px 0px 30px;"|✔ Tickets
+
|style="padding: 0px 0px 10px 30px;"|✔ View Logs Of Sent Notifications
−
|}
+
−
{|
+
−
|style="padding: 0px 0px 0px 30px;"|✔ Services Amount
+
−
|}
+
−
{|
+
−
|style="padding: 0px 0px 0px 30px;"|✔ Client Admin Notes
+
−
|}
+
−
{|
+
−
|style="padding: 0px 0px 0px 30px;"|✔ Client Notes
+
−
|}
+
−
{|
+
−
|style="padding: 0px 0px 0px 30px;"|✔ Client Custom Notes
+
−
|}
+
−
{|
+
−
|style="padding: 0px 0px 0px 30px;"|✔ Client Custom Status
+
−
|}
+
−
{|
+
−
|style="padding: 0px 0px 0px 30px;"|✔ Quick Actions
+
−
|}
+
−
{|
+
−
|style="padding: 0px 0px 0px 30px;"|✔ Profile Tabs
+
−
|}
+
−
{|
+
−
|style="padding: 0px 0px 0px 30px;"|✔ Person Assigned
+
−
|}
+
−
{|
+
−
|style="padding: 0px 0px 0px 30px;"|✔ Log In As Client
+
−
|}
+
−
{|
+
−
|style="padding: 0px 0px 10px 30px;"|✔ Send SMS - Integrated With SMS Center For WHMCS [http://www.modulesgarden.com/products/whmcs/sms_center/features (read more)]
+
−
|}
+
−
*'''Widgets Configuration:'''
+
−
{|
+
−
|style="padding: 10px 0px 0px 30px;"|✔ Income:
+
−
|}
+
−
{|
+
−
|style="padding: 0px 0px 0px 45px;"|✔ Define The Range Of Income Statistic
+
−
|}
+
−
{|
+
−
|style="padding: 0px 0px 0px 30px;"|✔ Tickets:
+
−
|}
+
−
{|
+
−
|style="padding: 0px 0px 0px 45px;"|✔ Define Which Statuses Of Tickets Are Counted
+
−
|}
+
−
{|
+
−
|style="padding: 0px 0px 0px 30px;"|✔ Services Amount:
+
−
|}
+
−
{|
+
−
|style="padding: 0px 0px 0px 45px;"|✔ Define If Product/Domain Status Is Shown
+
−
|}
+
−
{|
+
−
|style="padding: 0px 0px 0px 45px;"|✔ Define Which Additional Links Are Shown
+
−
|}
+
−
{|
+
−
|style="padding: 0px 0px 0px 30px;"|✔ Client Admin Notes:
+
−
|}
+
−
{|
+
−
|style="padding: 0px 0px 0px 45px;"|✔ Define How Much Of A Note Should Be Shown In The Main Tooltip
+
−
|}
+
−
{|
+
−
|style="padding: 0px 0px 0px 30px;"|✔ Client Custom Notes:
+
−
|}
+
−
{|
+
−
|style="padding: 0px 0px 0px 45px;"|✔ Enable/Disable Notes For All, Group Notes And My Notes
+
−
|}
+
−
{|
+
−
|style="padding: 0px 0px 0px 45px;"|✔ Define The Length Of Notes Displayed In The Main Tooltip
+
−
|}
+
−
{|
+
−
|style="padding: 0px 0px 0px 45px;"|✔ Define The Limits Of Notes Displayed In The Main Tooltip Per Group
+
−
|}
+
−
{|
+
−
|style="padding: 0px 0px 0px 45px;"|✔ Define The Limits Of Notes Per Group
+
−
|}
+
−
{|
+
−
|style="padding: 0px 0px 0px 30px;"|✔ Client Custom Status:
+
−
|}
+
−
{|
+
−
|style="padding: 0px 0px 0px 45px;"|✔ Define Whether To Show Client Status Before Their Name
+
−
|}
+
−
{|
+
−
|style="padding: 0px 0px 0px 45px;"|✔ Define Whether To Color Client Name
+
−
|}
+
−
{|
+
−
|style="padding: 0px 0px 0px 30px;"|✔ Quick Actions:
+
−
|}
+
−
{|
+
−
|style="padding: 0px 0px 0px 45px;"|✔ Define Visible Options
+
−
|}
+
−
{|
+
−
|style="padding: 0px 0px 0px 30px;"|✔ Profile Tabs:
+
−
|}
+
−
{|
+
−
|style="padding: 0px 0px 0px 45px;"|✔ Define Visible Options
+
−
|}
+
−
{|
+
−
|style="padding: 0px 0px 10px 45px;"|✔ Define Amount Of Columns To Display Tabs
+
 
|}
 
|}
 
*'''General Info:'''
 
*'''General Info:'''
Line 142: Line 42:
 
|}
 
|}
 
{|
 
{|
−
|style="padding: 0px 0px 0px 30px;"|✔ Supports PHP 5.4 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 Profile Viewer 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 Profile Viewer 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:CLP_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:CLP_2.png]]
+
|style="padding: 0px 0px 20px 25px;"|[[File:PHP56_72.png]]
 
|}
 
|}
 
{|
 
{|
−
|style="padding: 0px 0px 15px 15px;"|'''3. When you install Client Profile Viewer 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/clientsprofiler/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:CLP_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:CLP_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 Profile Viewer' '' 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:CLP_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:CLP_6.png]]
+
−
|}
+
−
{|
+
−
|style="padding: 0px 0px 15px 15px;"|'''7. You have just successfully installed Client Profile Viewer For WHMCS!'''<br/>
+
−
You can access your module under '' 'Addons' '' → '' 'Client Profile Viewer' ''.
+
−
|}
+
−
{|
+
−
|style="padding: 0px 0px 30px 25px;"|[[File:CLP_7.png]]
+
 
|}
 
|}
  
−
=Configuration and Management=
+
==Configuration of Addon==
−
{|
+
−
|style="padding: 10px 0px 30px 15px;"|'''Client Profile Viewer For WHMCS is a module which allows you to quickly display clients' details across the WHMCS.<br/>
+
−
Additionally, you can easily configure access to the clients' information depending on the admin role.
+
−
|}
+
−
==Configuration==
+
−
{|
+
−
|style="padding: 10px 0px 15px 15px;"|In '' 'Configuration' '' page you can manage tooltip configurations as well as add new ones.<br/>
+
−
Each configuration can have multiple admin roles assigned while one admin role can be assigned to a single configuration only.<br/>
+
−
As you can see on the following screen, you can view the list of enabled widgets and assigned admin roles of each configuration.
+
−
|}
+
−
{|
+
−
|style="padding: 0px 0px 30px 25px;"|[[File:CLP_8.png]]
+
−
|}
+
−
===Add Configuration===
+
−
{|
+
−
|style="padding: 10px 0px 20px 15px;"|To add a new configuration, press '' 'Add New Configuration' '' button.
+
−
|}
+
−
{|
+
−
|style="padding: 0px 0px 20px 25px;"|[[File:CLP_9.png]]
+
−
|}
+
−
{|
+
−
|style="padding: 0px 0px 15px 15px;"|Afterwards, fill in '' 'Configuration Name'.''<br/>
+
−
Add admin roles through choosing each of them from a dropdown menu and pressing '' 'Add'.''<br/>
+
−
Additionally, select widgets in the configuration the same way you have added admin roles.
+
−
|}
+
−
{|
+
−
|style="padding: 0px 0px 20px 25px;"|[[File:CLP_10.png]]
+
−
|}
+
 
{|
 
{|
−
|style="padding: 0px 0px 20px 15px;"|If you wish to change the order in which widgets are displayed, simply drag widget to a desired location and drop it.  
+
|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 20px 25px;"|[[File:CLP_11.png]]
+
|style="padding: 0px 0px 20px 25px;"|[[File:HQN_5.png]]
 
|}
 
|}
 
{|
 
{|
−
|style="padding: 0px 0px 20px 15px;"|Press '' 'Create' '' to confirm creation of the configuration.
+
|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 30px 25px;"|[[File:CLP_12.png]]
+
|style="padding: 0px 0px 30px 25px;"|[[File:HQN_6.png]]
 
|}
 
|}
  
−
===Advanced Configuration===
 
 
{|
 
{|
−
|style="padding: 10px 0px 20px 15px;"|Some of the widgets may have additional configuration, more information about them can be found in this subsection.
+
|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;"|'''Client Admin Notes'''
+
|style="padding: 0px 0px 30px 25px;"|[[File:HQN_7.png]]
−
*'' 'First Letters' '' - defines the amount of letters of a note shown in the main tooltip. All notes are available after pressing '' '+' '' button.
+
 
|}
 
|}
−
{|
 
−
|style="padding: 0px 0px 20px 25px;"|[[File:CLP_13.png]]
 
−
|}
 
−
{|
 
−
|style="padding: 0px 0px 15px 15px;"|'''Client Custom Notes'''
 
−
*'' 'My Notes' '' - shows '' 'My Notes' '' in the main tooltip.
 
−
*'' 'Group Notes' '' - displays notes visible for my admin role in the main tooltip.
 
−
*'' 'Notes For All' '' - if checked, global notes will be visible in the main tooltip.<br /><br />
 
  
−
*'' 'My Notes Limit' '' - defines limit for notes added to '' 'My Notes' '' group.
+
=Configuration and Management=
−
*'' 'Group Notes Limit' '' - defines limit for notes added to '' 'Group Notes' '' group.
+
−
*'' 'Notes For All Limit' '' - defines limit for notes added to '' 'Notes For All' '' group.<br /><br />
+
−
 
+
−
*'' 'My Notes View Limit' '' - defines amount of '' 'My Notes' '' shown in the main widget.
+
−
*'' 'Group Notes View Limit' '' - defines amount of '' 'Group Notes' '' shown in the main widget.
+
−
*'' 'Notes For All View Limit' '' - defines amount of '' 'Notes For All' '' shown in the main widget.<br /><br />
+
−
 
+
−
*'' 'Notes View Length Limit' '' - defines length of notes, from each group, shown in the main widget.
+
−
|}
+
 
{|
 
{|
−
|style="padding: 0px 0px 20px 25px;"|[[File:CLP_13_1.png]]
+
|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 15px 15px;"|'''Client Custom Status'''
+
|style="padding: 10px 0px 15px 15px;"|In '' 'Configuration' '' page you can find the list of configured notification groups.<br />
−
*'' 'Inline' '' -  if checked, status is displayed before client's name.
+
You can enable/disable any of them, as well as alter or completely remove them.<br />
−
*'' 'Color' '' -  if checked, client's first and last name are displayed using selected status color.
+
Press '' 'Create New Group' '' to proceed.
 
|}
 
|}
 
{|
 
{|
−
|style="padding: 0px 0px 20px 25px;"|[[File:CLP_14.png]]
+
|style="padding: 0px 0px 20px 25px;"|[[File:HQN_9.png]]
 
|}
 
|}
 
{|
 
{|
−
|style="padding: 0px 0px 15px 15px;"|'''Income'''
+
|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 />
−
*'' 'Range' '' - enables you to define a time period for invoices taken into consideration.
+
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 25px;"|[[File:CLP_14_1.png]]
+
|style="padding: 0px 0px 20px 25px;"|[[File:HQN_10.png]]
 
|}
 
|}
 
{|
 
{|
−
|style="padding: 0px 0px 15px 15px;"|'''Services Amount'''
+
|style="padding: 0px 0px 15px 15px;"|For example, shown below module uses fixed counting type.<br />
−
*'' 'Product Status' '' - shows product's status
+
As you can see, we have defined limits for both bandwidth and disk.<br />
−
*'' 'Domain Status' '' - shows domain's status
+
Settings shown below result in sending notification to client upon:
−
*'' 'Product Domain' '' - shows domain of a product<br /><br />
+
*bandwidth usage growth by 5GB during 21 days.
−
 
+
*disk usage growth by 100GB over period of 14 days.
−
*'' 'Product Domain WWW' '' - shows product's domain www link
+
−
*'' 'Product WHOIS' '' - shows product's domain whois link
+
−
*'' 'Product IntoDNS' '' - shows product's domain intoDNS link<br /><br />
+
−
 
+
−
*'' 'Domain WWW' '' - shows domain www link
+
−
*'' 'Domain WHOIS' '' - shows domain whois link
+
−
*'' 'Domain IntoDNS' '' - shows domain intoDNS link
+
 
|}
 
|}
 
{|
 
{|
−
|style="padding: 0px 0px 20px 25px;"|[[File:CLP_14_3.png]]
+
|style="padding: 0px 0px 30px 25px;"|[[File:HQN_11.png]]
 
|}
 
|}
 +
==Logs==
 
{|
 
{|
−
|style="padding: 0px 0px 15px 15px;"|'''Profile Tabs'''<br/>
+
|style="padding: 10px 0px 15px 15px;"|Under '' 'Logs' '' page you can view information about sent notifications.
−
*Tabs Map:
+
−
*:Select tabs that will be allowed to redirect to  from the Client's profile tooltip
+
−
*Columns:
+
−
*:Declare the number of columns to view the chosen tabs
+
 
|}
 
|}
 
{|
 
{|
−
|style="padding: 0px 0px 20px 25px;"|[[File:CLP_14_4.png]]
+
|style="padding: 0px 0px 30px 25px;"|[[File:HQN_12.png]]
 
|}
 
|}
 +
==Notifications==
 
{|
 
{|
−
|style="padding: 0px 0px 15px 15px;"|'''Quick Actions'''
+
|style="padding: 10px 0px 15px 15px;"|You can create as many notifications as you wish.<br />
−
*Select which of the available actions shall be allowed form the client's profile tooltip
+
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:CLP_14_5.png]]
+
|style="padding: 0px 0px 30px 25px;"|[[File:HQN_13.png]]
−
|}
+
−
{|
+
−
|style="padding: 0px 0px 15px 15px;"|'''Tickets'''
+
−
*checkboxes - marking a checkbox enables counting that type of tickets as well as shows direct link to the ticket's list of that type. 
+
−
|}
+
−
{|
+
−
|style="padding: 0px 0px 20px 25px;"|[[File:CLP_14_2.png]]
+
−
|}
+
−
{|
+
−
|style="padding: 0px 0px 15px 15px;"|[http://www.modulesgarden.com/products/whmcs/sms_center/features '''Send SMS (Sold Separately)''']
+
−
*'' 'Send SMS' '' - allows sending text messages to clients, type in the text in a box on pressing the '' '+' '' button.
+
−
*:''Please note that this widget works properly only with SMS Center For WHMCS module purchased, activated and correctly configured!''
+
−
*:''For more information on SMS Center For WHMCS, visit its [http://www.docs.modulesgarden.com/SMS_Center_For_WHMCS Wiki].''
+
−
|}
+
−
{|
+
−
|style="padding: 0px 0px 30px 25px;"|[[File:CLP_25.png]]
+
 
|}
 
|}
  
−
==Settings==
+
=Tips=
 
{|
 
{|
−
|style="padding: 10px 0px 15px 15px;"|'' 'Settings' '' page contains global settings for the module such as:<br/>
+
|style="padding: 10px 0px 30px 15px;"|
−
*'''Hide Tooltip''' - if checked, tooltip automatically disappears when cursor is moved outside of it.<br/>
+
−
*'''Show After''' - defines delay time for showing the tooltip.<br/>
+
−
*'''Hide After''' - defines delay time for hiding the tooltip when cursor is outside.
+
−
|}
+
−
{|
+
−
|style="padding: 0px 0px 30px 25px;"|[[File:CLP_16.png]]
+
 
|}
 
|}
  
−
==Tooltip==
+
=Update Instructions=
 
{|
 
{|
−
|style="padding: 10px 0px 15px 15px;"|Tooltip will be displayed across the WHMCS admin area, wherever client's name is displayed.<br/>
+
|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/>
−
On the following screen you can see a client tooltip in '' 'Clients' '' → '' 'View/Search Clients' ''. <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/>
−
As you know, tooltip is made of widgets, let us discuss over each of them.<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/>
−
''Note: Most of the widget titles are links to specific parts of the WHMCS system.''
+
 
|}
 
|}
−
{|
 
−
|style="padding: 0px 0px 30px 25px;"|[[File:CLP_17.png]]
 
−
|}
 
−
 
−
===Assigned Admin To Client===
 
−
{|
 
−
|style="padding: 10px 0px 15px 15px;"|Allows you to assign admin to specific client.<br/>
 
−
Admin assigned is visible only from the tooltip.
 
−
|}
 
−
{|
 
−
|style="padding: 0px 0px 20px 25px;"|[[File:CLP_18.png]]
 
−
|}
 
−
{|
 
−
|style="padding: 0px 0px 20px 0px;"|Once an admin is assigned they can automatically assign new tickets to the client and then stop assigning them.
 
−
|}
 
−
{|
 
−
|style="padding: 0px 0px 30px 25px;"|[[File:CLP_18_1.png]]
 
−
|}
 
−
 
−
===Client Custom Status===
 
−
{|
 
−
|style="padding: 10px 0px 20px 15px;"|Enables you to assign custom status and color to a client.
 
−
|}
 
−
{|
 
−
|style="padding: 0px 0px 30px 25px;"|[[File:CLP_19.png]]
 
−
|}
 
−
 
−
===Profile Tabs===
 
−
{|
 
−
|style="padding: 10px 0px 20px 15px;"|Quick redirection to tabs in client's profile.
 
−
|}
 
−
{|
 
−
|style="padding: 0px 0px 30px 25px;"|[[File:CLP_19_1.png]]
 
−
|}
 
−
 
−
===Quick Actions===
 
−
{|
 
−
|style="padding: 10px 0px 20px 15px;"|Move directly form clients profile tooltip to a chosen action section.
 
−
|}
 
−
{|
 
−
|style="padding: 0px 0px 30px 25px;"|[[File:CLP_19_2.png]]
 
−
|}
 
−
 
−
===Client Notes - Admin Notes, Notes And Custom Notes===
 
−
{|
 
−
|style="padding: 10px 0px 15px 15px;"|The screen presents three different widgets in fact, each of them displays notes from a different part of the system.<br/>
 
−
*Client Admin Notes - manages notes from the client's profile → '' 'Sumary' '', additionally it allows you to define a maximum number of letters displayed in the tooltip.
 
−
*Client Notes - manages notes from the client profile → '' 'Notes'.''
 
−
*Client Custom Notes - enables you to add notes visible in the tooltip only for you, your admin role or all admins.<br/>
 
−
Additionally, as you can see on the following screen, you can see the number of notes added and a maximum number of notes you can add.
 
−
|}
 
−
{|
 
−
|style="padding: 0px 0px 30px 25px;"|[[File:CLP_20.png]]
 
−
|}
 
−
 
−
===Income===
 
−
{|
 
−
|style="padding: 10px 0px 20px 15px;"|'' 'Income' '' widget displays the summary value of paid invoices as well as those still waiting for payment.
 
−
|}
 
−
{|
 
−
|style="padding: 0px 0px 30px 25px;"|[[File:CLP_21.png]]
 
−
|}
 
−
===Log In As Client===
 
−
{|
 
−
|style="padding: 10px 0px 15px 15px;"|This widget allows you to quickly log in as a client.<br/>
 
−
Press '' 'Log In As Client' '' to do so.
 
−
|}
 
−
{|
 
−
|style="padding: 0px 0px 30px 25px;"|[[File:CLP_22.png]]
 
−
|}
 
−
 
−
===Services===
 
−
{|
 
−
|style="padding: 10px 0px 15px 15px;"|Here you can find client's products, product addons and domains counted by their status.<br/>
 
−
Additionally, you can view all the items in the tooltip along with various links as shown on the screen below.
 
−
|}
 
−
{|
 
−
|style="padding: 0px 0px 30px 25px;"|[[File:CLP_23.png]]
 
−
|}
 
−
 
−
===Tickets===
 
−
{|
 
−
|style="padding: 10px 0px 20px 15px;"|'' 'Tickets' '' widget counts your client's tickets by status and provides a direct link to them.
 
−
|}
 
−
{|
 
−
|style="padding: 0px 0px 30px 25px;"|[[File:CLP_24.png]]
 
−
|}
 
−
===Send SMS===
 
−
{|
 
−
|style="padding: 10px 0px 20px 15px;"|'' 'Send SMS' '' widget allows quick sending text messages. This functionality is available only if SMS Center For WHMCS is activated!
 
−
|}
 
−
{|
 
−
|style="padding: 0px 0px 30px 25px;"|[[File:CLP_26.png]]
 
−
|}
 
−
 
−
=Tips=
 
−
{|
 
−
|style="padding: 10px 0px 30px 15px;"|1. If you wish some specific information like income to be visible at the top of the tooltip, simply change its position in the configuration.<br/>
 
−
Drag and drop the desired widget box in a required position.
 
−
|}
 
−
 
 
=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