Personal tools
Namespaces

Variants
Actions

Hosting Quota Notifications 1.X For WHMCS

From ModulesGarden Wiki
(Difference between revisions)
Jump to: navigation, search
(→‎Email Templates)
 
(309 intermediate revisions by 4 users not shown)
Line 1: Line 1:
−
<meta name="keywords" content="multibrand for whmcs, multibrand configuration, whmcs multibrand management, whmcs multibrand installation, whmcs multibrand common problems, about whmcs multibrand, whmcs multibrand documentation, whmcs multibrand faq, whmcs multibrand help, whmcs multibrand guide, whmcs multibrand wiki, whmcs multibrand tutorial, whmcs multibrand tips, whmcs multibrand 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 Multibrand 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/multibrand Multibrand For WHMCS]=
+
=About [https://www.modulesgarden.com/products/whmcs/hosting-quota-notifications Hosting Quota Notifications For WHMCS]=
 
{|
 
{|
−
|style="padding: 10px 0px 10px 0px;"|'''Multibrand For WHMCS''' will allow you to manage multiple brands on multiple websites while using just a single WHMCS installation.
+
|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.
−
You will be able to customize your brand through modifying factors like client area template, logo or brand language, and preview the changes with just a single click.<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 easily assign your clients to and migrate them between brands, as well as assign products and ticket departments to each brand.<br />
+
You can also define email templates and view details of each sent notification owing to logs.
−
Owing to Multibrand For WHMCS your customers will be able to log into specified client areas in accordance with the brand under which they purchased a product or service.  
+
 
|}
 
|}
 
<!--a comment maybe? -->
 
<!--a comment maybe? -->
−
*'''Addon Features:'''
 
−
{|
 
−
|style="padding: 10px 0px 0px 30px;"|✔ User Friendly Management Of Multiple Brands
 
−
|}
 
−
{|
 
−
|style="padding: 0px 0px 0px 30px;"|✔ Easy Modification Of Existing Brands
 
−
|}
 
−
{|
 
−
|style="padding: 0px 0px 0px 30px;"|✔ Assign/Unassign Clients To Multiple Brands
 
−
|}
 
−
{|
 
−
|style="padding: 0px 0px 0px 30px;"|✔ Assign Products To Brands
 
−
|}
 
−
{|
 
−
|style="padding: 0px 0px 0px 30px;"|✔ Assign Product Bundles To Brands
 
−
|}
 
−
{|
 
−
|style="padding: 0px 0px 0px 30px;"|✔ Assign Ticket Departments To Brands
 
−
|}
 
−
{|
 
−
|style="padding: 0px 0px 0px 30px;"|✔ Configure Payment Gateways For Each Brand Separately:
 
−
|}
 
−
{|
 
−
|style="padding: 0px 0px 0px 45px;"|✔ PayPal - Single Payment And Subscription
 
−
|}
 
−
{|
 
−
|style="padding: 0px 0px 0px 45px;"|✔ 2CheckOut - Single Payment Only
 
−
|}
 
−
{|
 
−
|style="padding: 0px 0px 0px 30px;"|✔ Display Active Clients, Invoices, Orders, Tickets And Services Associated To Brands
 
−
|}
 
−
{|
 
−
|style="padding: 0px 0px 0px 30px;"|✔ Quick Preview Of Branded Client Area
 
−
|}
 
−
{|
 
−
|style="padding: 0px 0px 0px 30px;"|✔ Publish/Unpublish Brands On Click
 
−
|}
 
−
{|
 
−
|style="padding: 0px 0px 0px 30px;"|✔ Set Brand As Default - Automatic Assignment Of New Clients
 
−
|}
 
−
{|
 
−
|style="padding: 0px 0px 0px 30px;"|✔ View Brand Reports - List Of Clients, Invoices, Orders, Tickets And Services
 
−
|}
 
−
{|
 
−
|style="padding: 0px 0px 0px 30px;"|✔ View Dynamic Brands Comparison Reports - Various Graph Types
 
−
|}
 
−
{|
 
−
|style="padding: 0px 0px 0px 30px;"|✔ Generate Separate Email Templates For Each Brand
 
−
|}
 
−
{|
 
−
|style="padding: 0px 0px 10px 30px;"|✔ Verify Integration Of Templates Used By Brands
 
−
|}
 
 
*'''Admin Area Features:'''
 
*'''Admin Area Features:'''
 
{|
 
{|
−
|style="padding: 10px 0px 0px 30px;"|✔ Order Branded Products
+
|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;"|✔ Create Branded Invoices
+
|style="padding: 0px 0px 0px 30px;"|✔ Configure Notification Groups
 
|}
 
|}
 
{|
 
{|
−
|style="padding: 0px 0px 0px 30px;"|✔ Create Branded Quotes
+
|style="padding: 0px 0px 0px 30px;"|✔ Choose Between Two Types Of Group Counting:
 
|}
 
|}
 
{|
 
{|
−
|style="padding: 0px 0px 0px 30px;"|✔ Open Branded Tickets
+
|style="padding: 0px 0px 0px 45px;"|✔ Tiered - Define Tiers Of Usage
 
|}
 
|}
 
{|
 
{|
−
|style="padding: 0px 0px 0px 30px;"|✔ Create Branded Announcements
+
|style="padding: 0px 0px 0px 45px;"|✔ Fixed - Define Usage Grow Over Time
 
|}
 
|}
 
{|
 
{|
−
|style="padding: 0px 0px 0px 30px;"|✔ Add Branded Knowledgebase Articles
+
|style="padding: 0px 0px 0px 30px;"|✔ Assign Multiple Products To Single Notification Group
 
|}
 
|}
 
{|
 
{|
−
|style="padding: 0px 0px 0px 30px;"|✔ Add Branded Downloads
+
|style="padding: 0px 0px 0px 30px;"|✔ Assign Email Templates Per Notification Group
 
|}
 
|}
 
{|
 
{|
−
|style="padding: 0px 0px 10px 30px;"|✔ Log In As Client To Chosen Brand
+
|style="padding: 0px 0px 0px 30px;"|✔ Enable/Disable Notification Groups
 
|}
 
|}
−
*'''Client Area Features:'''
 
 
{|
 
{|
−
|style="padding: 10px 0px 0px 30px;"|✔ Displayed Client Area Template And Default Language Depend On Brand
+
|style="padding: 0px 0px 10px 30px;"|✔ View Logs Of Sent Notifications
−
|}
+
−
{|
+
−
|style="padding: 0px 0px 0px 30px;"|✔ Access To Products, Invoices, Downloads, Ticket Departments and Payment Gateways Assigned To Brand
+
−
|}
+
−
{|
+
−
|style="padding: 0px 0px 0px 30px;"|✔ View Articles And Announcements Assigned To Brand
+
−
|}
+
−
{|
+
−
|style="padding: 0px 0px 0px 30px;"|✔ Receive Branded Emails And Invoices
+
−
|}
+
−
{|
+
−
|style="padding: 0px 0px 0px 30px;"|✔ Branded Clients Can Only Log Into Brand They Are Assigned To
+
−
|}
+
−
{|
+
−
|style="padding: 0px 0px 10px 30px;"|✔ Multibranded Clients Can Log Into All Existing Brands With The Same Access Details
+
−
|}
+
−
*'''Brand Configuration:'''
+
−
{|
+
−
|style="padding: 10px 0px 0px 30px;"|✔ Default Brand For New Accounts
+
−
|}
+
−
{|
+
−
|style="padding: 0px 0px 0px 30px;"|✔ Brand Name
+
−
|}
+
−
{|
+
−
|style="padding: 0px 0px 0px 30px;"|✔ Company Name
+
−
|}
+
−
{|
+
−
|style="padding: 0px 0px 0px 30px;"|✔ Brand URL Address
+
−
|}
+
−
{|
+
−
|style="padding: 0px 0px 0px 30px;"|✔ Brand Logo
+
−
|}
+
−
{|
+
−
|style="padding: 0px 0px 0px 30px;"|✔ Brand Language
+
−
|}
+
−
{|
+
−
|style="padding: 0px 0px 0px 30px;"|✔ Brand Template
+
−
|}
+
−
{|
+
−
|style="padding: 0px 0px 0px 30px;"|✔ Brand Address
+
−
|}
+
−
{|
+
−
|style="padding: 0px 0px 0px 30px;"|✔ Brand Signature
+
−
|}
+
−
{|
+
−
|style="padding: 0px 0px 0px 30px;"|✔ Brand Email
+
−
|}
+
−
{|
+
−
|style="padding: 0px 0px 0px 30px;"|✔ Brand Graph Color
+
−
|}
+
−
{|
+
−
|style="padding: 0px 0px 10px 30px;"|✔ Brand Terms Of Service URL
+
 
|}
 
|}
 
*'''General Info:'''
 
*'''General Info:'''
Line 148: 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 0px 30px;"|✔ Supports WHMCS Templates Five and Six
+
|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 30px 15px;"|'''This tutorial will show you how to successfully install and configure Multibrand For WHMCS.''' <br />
+
|style="padding: 10px 0px 30px 15px;"|'''This tutorial will show you how to successfully install and configure Hosting Quota Notifications For WHMCS.''' <br />
−
We will guide you step by step through the whole installation and configuration process.<br/><br/>
+
We will guide you step by step through the whole installation and configuration process.
−
'' '''Note:''' If you are still using any of Multibrand For WHMCS  previous versions '''prior to v2.x''', [https://www.docs.modulesgarden.com/Multibrand_1.X_For_WHMCS read about it here].''
+
 
|}
 
|}
 
==Installation==
 
==Installation==
 
{|
 
{|
−
|style="padding: 10px 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:MB2_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:MB2_2.png]]
+
|style="padding: 0px 0px 20px 25px;"|[[File:PHP56_72.png]]
 
|}
 
|}
 
{|
 
{|
Line 182: Line 72:
 
|}
 
|}
 
{|
 
{|
−
|style="padding: 0px 0px 20px 25px;"|[[File:MB2_2_2.png]]
+
|style="padding: 0px 0px 20px 25px;"|[[File:drfere.png]]
 
|}
 
|}
 
{|
 
{|
−
|style="padding: 0px 0px 15px 15px;"|'''4. When you install Multibrand 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/MultibrandFunctionality/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:MB2_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 a 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 30px 25px;"|[[File:MB2_4.png]]
+
|style="padding: 0px 0px 30px 25px;"|[[File:HQN_4.png]]
 
|}
 
|}
  
−
==Activating Addon Module==
+
==Configuration of Addon==
 
{|
 
{|
 
|style="padding: 10px 0px 15px 15px;"|'''6. Now you have to activate the module in your WHMCS system.'''<br />
 
|style="padding: 10px 0px 15px 15px;"|'''6. Now you have to activate the module in your WHMCS system.'''<br />
−
Log in to your WHMCS admin area. Go to '' 'Setup' '' → '' 'Addon Modules'. '' Afterwards, find '' 'Multibrand' '' and press '' 'Activate' '' button.
+
Log in to your WHMCS admin area. Go to '' 'Setup' '' → '' 'Addon Modules' ''. Afterwards, find '' 'Hosting Quota Notifications' '' and press '' 'Activate' '' button.
 
|}
 
|}
 
{|
 
{|
−
|style="padding: 0px 0px 20px 25px;"|[[File:MB2_5.png]]
+
|style="padding: 0px 0px 20px 25px;"|[[File:HQN_5.png]]
 
|}
 
|}
 
{|
 
{|
−
|style="padding: 0px 0px 15px 15px;"|'''7. In the next step you need to allow to hooks beeing enabled and permit access to this module.'''<br />
+
|style="padding: 0px 0px 15px 15px;"|'''7. In the next step you need to permit access to this module.'''<br />
−
To do so click on '' 'Configure' '' button, tick '' 'Access Control' '' near required admin role groups and press '' 'Save Changes'.''
+
To do so click on '' 'Configure' '' button, tick '' 'Access Control' '' near required admin role groups and press '' 'Save Changes' ''.
 
|}
 
|}
 
{|
 
{|
−
|style="padding: 0px 0px 30px 25px;"|[[File:MB2_6.png]]
+
|style="padding: 0px 0px 30px 25px;"|[[File:HQN_6.png]]
 
|}
 
|}
  
−
==Additional Settings==
 
 
{|
 
{|
−
|style="padding: 10px 0px 15px 15px;"|'''8. Now, set up the  '' 'storage' '' folder as recursively writable (with all subfolders).'''<br />
+
|style="padding: 0px 0px 15px 15px;"|'''8. You have just successfully installed Hosting Quota Notifications For WHMCS!'''<br />
−
This folder are located in '' 'your_whmcs/modules/addons/Multibrand/' '' location.
+
You can access your module in '' 'Addons' '' → '' 'Hosting Quota Notifications' ''.
 
|}
 
|}
 
{|
 
{|
−
|style="padding: 0px 0px 20px 25px;"|[[File:MB2_7.png]]
+
|style="padding: 0px 0px 30px 25px;"|[[File:HQN_7.png]]
−
|}
+
−
{|
+
−
|style="padding: 10px 0px 15px 15px;"|'''9. You will also need  set up  '' 'gateways' '' and '' 'callback' '' folders as writable.'''<br />
+
−
This folders are located in '' 'your_whmcs/modules/' '' and '' 'your_whmcs/modules/gateways'' accordingly locations (do '''NOT''' mistake with the in the Multibrand addon location)''
+
−
|}
+
−
{|
+
−
|style="padding: 0px 0px 20px 25px;"|[[File:MB2_7_0.png]]
+
−
|}
+
−
{|
+
−
|style="padding: 0px 0px 15px 15px;"|'''10. The next step is replacing '' 'invoicepdf.tpl' '' file with '' 'invoicepdf_rename.tpl' '' for each of the templates used.'''<br />
+
−
'' 'invoicepdf_rename.tpl' '' file is located in '' 'your_whmcs/templates/six/' '' folder.<br />
+
−
Simply, remove default '' 'invoicepdf.tpl' '' file from template folder and rename'' 'invoicepdf_rename.tpl' '' file to '' 'invoicepdf.tpl' '' in that folder.
+
−
|}
+
−
{|
+
−
|style="padding: 0px 0px 20px 25px;"|[[File:MB2_7_1.png]]
+
−
|}
+
−
 
+
−
==Integration Code==
+
−
{|
+
−
|style="padding: 10px 0px 15px 15px;"|'''11. Now you can access your Multibrand For WHMCS module.'''<br />
+
−
Simply go to the '' 'Addons' '' → '' 'Multibrand'.'' But before you start using the module you still need to do an '' 'Integration Code'. '' It is required for correct branding and it should be done for all templates that you want to use with brands.<br/>
+
−
So go to the '' 'Utilities' '' → '' 'Integration Code' ''and follow the instructions given there, depending on the version of WHMCS and templates you are using.
+
−
|}
+
−
{|
+
−
|style="padding: 0px 0px 20px 25px;"|[[File:MB2_8.png]]
+
−
|}
+
−
{|
+
−
|style="padding: 0px 0px 30px 15px;"|'''12. And that's all! You have now completed the installation of the module.'''<br />
+
−
|}
+
−
==Migration==
+
−
{|
+
−
|style="padding: 10px 0px 30px 15px;"|'''In the current beta 2.0.0 version, it is not possible to easily migrate data from 1.8.X to 2.X module version. <br/>
+
−
Such migration functionality will be added in a future stable version. We are sorry for the inconvenience.
+
 
|}
 
|}
  
 
=Configuration and Management=
 
=Configuration and Management=
 
{|
 
{|
−
|style="padding: 10px 0px 30px 15px;"|'''In this section we will show you how to properly set up and use Multibrand For WHMCS.'''
+
|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.'''
 
|}
 
|}
−
==Brands==
+
==Configuration==
 
{|
 
{|
−
|style="padding: 10px 0px 30px 15px;"|Under '' 'Brands' '' tab you can create and manage your brands using a single instance of WHMCS solution.
+
|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.
 
|}
 
|}
−
===New Brand===
 
 
{|
 
{|
−
|style="padding: 10px 0px 20px 15px;"|Let's start by creating a new brand. For that purpose go to '' 'Brands' '' tab and press '' 'Add a new brand' '' [[File:MB2_Plus.png|frameless]] button.
+
|style="padding: 0px 0px 20px 25px;"|[[File:HQN_9.png]]
 
|}
 
|}
 
{|
 
{|
−
|style="padding: 0px 0px 20px 25px;"|[[File:MB2_10.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;"|Fill out brand's '' 'Name' ''  and '' 'Domain' '' with desired values, and press '' 'Save' '' button.
+
|style="padding: 0px 0px 20px 25px;"|[[File:HQN_10.png]]
 
|}
 
|}
 
{|
 
{|
−
|style="padding: 0px 0px 20px 25px;"|[[File:MB2_11.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;"|Your first brand will be created. Next press the '' 'Edit' ' '' [[File:MB2_Edit.png|frameless]] action button.
+
|style="padding: 0px 0px 30px 25px;"|[[File:HQN_11.png]]
 
|}
 
|}
 +
==Logs==
 
{|
 
{|
−
|style="padding: 0px 0px 20px 25px;"|[[File:MB2_11_1.png]]
+
|style="padding: 10px 0px 15px 15px;"|Under '' 'Logs' '' page you can view information about sent notifications.
 
|}
 
|}
 
{|
 
{|
−
|style="padding: 0px 0px 20px 15px;"|You will be moved to the brand configuarion, where you can manage all brand's information and settings.
+
|style="padding: 0px 0px 30px 25px;"|[[File:HQN_12.png]]
 
|}
 
|}
 +
==Notifications==
 
{|
 
{|
−
|style="padding: 0px 0px 30px 25px;"|[[File:MB2_11_2.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 30px 15px;"|
+
|style="padding: 0px 0px 30px 25px;"|[[File:HQN_13.png]]
−
'' '''Note:''' Once the configuration of your brand is complete, will still need to set up a CNAME DNS record before the brand is published (status - enabled).''<br/>
+
−
''This record will point from branded domain towards your main domain used by WHMCS. To learn more about setting up CNAME records, proceed to the [[Multibrand_For_WHMCS#Creating_CNAME_Records|Creating CNAME Records]] section.''<br />
+
−
''Do not forget to publish the brand as soon as the CNAME record propagates worldwide.''
+
 
|}
 
|}
  
−
===Brand Information===
+
=Tips=
 
{|
 
{|
−
|style="padding: 10px 0px 15px 15px;"|In the Brand Information window, you can edit the brand name, domain name and custom logo. <br/>
+
|style="padding: 10px 0px 30px 15px;"|
−
In addition, you can see the current month revenue, total sale and last update of the brand.
+
−
|}
+
−
{|
+
−
|style="padding: 0px 0px 30px 25px;"|[[File:MB2_9.png]]
+
 
|}
 
|}
  
−
===Settings===
+
=Update Instructions=
 
{|
 
{|
−
|style="padding: 10px 0px 20px 15px;"|In this window you will be able to configure all the most important settings of your brand, including billing, payment gateways, SMTP and email templates configuration.
+
|style="padding: 10px 0px 30px 15px;"|Essential guidance through the process of updating the module is offered '''[https://www.docs.modulesgarden.com/How_To_Update_WHMCS_Module here]'''.<br/><br/>
 +
Keep in mind there is a quick and easy option in our client area that will let you upgrade the license of your module to an open source version at any time - and at a lower price!<br/>
 +
To take advantage of it, simply use the '''License Upgrade''' button located on the product's page and a discounted invoice will be generated automatically.<br/>
 
|}
 
|}
−
 
+
=Common Problems=
−
====General====
+
 
{|
 
{|
−
|style="padding: 10px 0px 15px 15px;"|In general settings you will configure the main brand options. <br/>
+
|style="padding: 10px 0px 30px 15px;"|'''1. When you have problems with connection, check whether your SELinux or firewall does not block ports.'''
−
First fill out brand's '' 'Email Address', 'Company Name' '' and '' 'TOS URL' ''. Next choose brand's '' 'Color', 'Ticket Departments' , 'Default Language',  'Template' '' and '' 'Order Template' ''.<br />
+
−
Be sure that chosen template is integrated correctly with Multibrand (see the [https://www.docs.modulesgarden.com/Multibrand_For_WHMCS#Integration_Code Integration Code] section). Finally toggle '' 'Auto Client Assign' '' if you desire. <br/>
+
−
Here you can also manage brand publication '' 'Status' '', but you should change it to '' 'Enable' '' only after you have configured the rest of the settings. <br/>
+
−
Do not forget to '' 'Save Configuration' ''.
+
−
<br/><br/>
+
−
'' '''Note:''' Only published brands can be set as default. New users created by admin or through API will be assigned to the default brand.''
+
 
|}
 
|}
−
{|
 
−
|style="padding: 0px 0px 30px 25px;"|[[File:MB2_11_3.png]]
 
−
|}
 
−
{|
 
−
 
−
====Billings====
 
−
{|
 
−
|style="padding: 10px 0px 15px 15px;"| In billing settings you can configure the appearance of your invoices.
 
−
*'''Invoice Branding''' - if enabled, the invoices will be branded with the number and basic information
 
−
*'''Invoice Pay To Text''' - address that is displayed on the invoice as the 'Pay To' details.
 
−
*'''Sequential Invoice Number Format''' - if invoice branding is enabled provided sequential invoice number format will be used
 
−
*'''Next Sequential Number''' - change this option only if you want to reset the automatic sequential numbering. Otherwise leave empty
 
−
'' '''Note:''' Remember to do the '[https://www.docs.modulesgarden.com/Multibrand_For_WHMCS#Additional_Settings Additional Settings]' step during module installation to make the PDF invoices also branded.''
 
−
|}
 
−
{|
 
−
|style="padding: 0px 0px 30px 25px;"|[[File:MB2_12.png]]
 
−
|}
 
−
 
−
====Payment Gateways====
 
−
{|
 
−
|style="padding: 10px 0px 15px 15px;"| This tab allows you to configure payment gateway for the brand which will work independently of that configured in WHMCS.<br />
 
−
You can check the list of currently available gates in the [https://www.docs.modulesgarden.com/Multibrand_For_WHMCS#About_Multibrand_For_WHMCS Feature List].<br/>
 
−
If you would like in future releases, to see a payment gateway that is not yet available, please contact our [https://www.modulesgarden.com/support support].<br/><br/>
 
−
'' '''Note:''' You may still use any other payment gateway that is active in your WHMCS system. These gates will have a ''' (WHMCS) ''' mark in the dropdown list.''<br/>
 
−
''Multibrand For WHMCS can work with any gateway that works within your WHMCS, the only limitation is that the other payment gateways use the same settings for all brands.''
 
−
<br/><br/>
 
−
To add a configuration of a payment gateway press '' 'Add' '' [[File:MB2_Plus.png|frameless]] button.
 
−
|}
 
−
{|
 
−
|style="padding: 0px 0px 20px 25px;"|[[File:MB2_13.png]]
 
−
|}
 
−
{|
 
−
|style="padding: 0px 0px 20px 15px;"|Next choose the desired gate from the list and press '' 'Confirm' '' button.
 
−
|}
 
−
{|
 
−
|style="padding: 0px 0px 20px 25px;"|[[File:MB2_14.png]]
 
−
|}
 
−
{|
 
−
|style="padding: 0px 0px 15px 15px;"|Finally fill the payment gateway settings, according to the details received from the provider. <br/>
 
−
Save the configuration and activate the gateway.
 
−
|}
 
−
{|
 
−
|style="padding: 0px 0px 30px 25px;"|[[File:MB2_15.png]]
 
−
|}
 
−
 
−
====SMTP====
 
−
{|
 
−
|style="padding: 10px 0px 15px 15px;"| If you would like to use for this brand a different outgoing mail configuration than the main WHMCS settings, you can do so in this tab.<br/>
 
−
In addition you can set custom CSS email styling and header and footer content.
 
−
|}
 
−
{|
 
−
|style="padding: 0px 0px 30px 25px;"|[[File:MB2_16.png]]
 
−
|}
 
−
 
−
====Email Templates====
 
−
{|
 
−
|style="padding: 10px 0px 15px 15px;"| In this window you can set up each branded email template in five available categories.<br/>
 
−
If enabled, the template configured here will be sent to the branded clients instead the one of configured in the main WHMCS template settings.<br/><br/>
 
−
To start edit a branded template, simply press '' 'Edit' '' [[File:MB2_Edit.png|frameless]] button.
 
−
|}
 
−
{|
 
−
|style="padding: 0px 0px 20px 25px;"|[[File:MB2_17.png]]
 
−
|}
 
−
{|
 
−
|style="padding: 0px 0px 15px 15px;"| Next, enter the desired subjecty and message content. You can also add them in several languages. <br/>
 
−
In addition, you can also use the available merge fields tags. Save the changes after finishing.
 
−
|}
 
−
{|
 
−
|style="padding: 0px 0px 20px 25px;"|[[File:MB2_18.png]]
 
−
|}
 
−
{|
 
−
|style="padding: 10px 0px 15px 15px;"| Finally toggle edited template to enabled and save configuration. Next to the edited template you will see the 'Branded' label. <br/>
 
−
If you would like to restore the default template, simply return to editing it and click the '' 'Delete Template' '' button.
 
−
|}
 
−
{|
 
−
|style="padding: 0px 0px 30px 25px;"|[[File:MB2_19.png]]
 
−
|}
 
−
 
−
===Services Pricing===
 
−
{|
 
−
|style="padding: 10px 0px 20px 15px;"|In this section you can configure separate prices for '' '''products''', '''addons''' '' and '' '''domains''' ''.<br/><br/>
 
−
To start, select the product, addon or domain tab and click on the '' 'Add' '' [[File:MB2_Plus.png|frameless]] button. In the following example we will add the braning for product pricing.
 
−
|}
 
−
{|
 
−
|style="padding: 0px 0px 20px 25px;"|[[File:MB2_20.png]]
 
−
|}
 
−
{|
 
−
|style="padding: 0px 0px 20px 15px;"|Select the product for which you want to set branded prices and click '' 'Save' ''.
 
−
|}
 
−
{|
 
−
|style="padding: 0px 0px 20px 25px;"|[[File:MB2_21.png]]
 
−
|}
 
−
{|
 
−
|style="padding: 0px 0px 20px 15px;"|Next open the pricing editor for the choosen product.
 
−
|}
 
−
{|
 
−
|style="padding: 0px 0px 20px 25px;"|[[File:MB2_22.png]]
 
−
|}
 
−
{|
 
−
|style="padding: 0px 0px 20px 15px;"|Here you can configure the desired prices in selected billing cycles and currencies. <br/>
 
−
You can also automatically fill in amounts from the main product and update them refreshing the currencies rate.<br/><br/>
 
−
 
−
'' '''Note:''' Availability of billing cycles, prices and currencies to be edited depends on their main configuration in WHMCS.''<br/>
 
−
''If one of them is not available for branding, it means that there is no corresponding configuration in the main WHMCS.''
 
−
|}
 
−
{|
 
−
|style="padding: 0px 0px 20px 25px;"|[[File:MB2_23.png]]
 
−
|}
 
−
{|
 
−
|style="padding: 0px 0px 30px 15px;"|From now on, the pricing for this product will be branded. In the same way, you can also configure pricing for the addons and domains.
 
−
|}
 
−
 
−
===Relations===
 
−
{|
 
−
|style="padding: 10px 0px 30px 15px;"|In the relations section you can see which '' '''Clients, Services, Invoices, Knowledgebase, Downloads''' '' and ''' ''Announcements'' ''' are assigned to this brand. <br/>
 
−
In addition, you can manually manage, assign and unassign selected items to brand.<br/><br/>
 
−
 
−
'' '''Note:''' Currently there is no possibility of mass management, assigning and unassigning selected items to the brand. This functionality will be implemented in future releases.
 
−
|}
 
−
 
−
====Clients====
 
−
{|
 
−
|style="padding: 10px 0px 15px 15px;"|In the clients tab you can see customers who are assigned to the brand and the date on which they were assigned.<br/>
 
−
Assignment takes place at the moment of client registration from the branded domain. You can also manually assign already existing customer to the brand or migrate to another.
 
−
 
−
'' '''Note:''' If the customers are already registered on one of the other brands and trie to log in to another brand, their will also be automatically assigned to it.''<br/>
 
−
Therefore, one customer can be assigned to several brands at the same time.
 
−
|}
 
−
{|
 
−
|style="padding: 0px 0px 20px 25px;"|[[File:MB2_24.png]]
 
−
|}
 
−
{|
 
−
|style="padding: 0px 0px 15px 15px;"| To assign an exiting client to the brand, press '' 'Add' '' [[File:MB2_Plus.png|frameless]] button. <br/>
 
−
In the open popup select the customer you want to add to the brand and press '' 'Save' ''.
 
−
|}
 
−
{|
 
−
|style="padding: 0px 0px 20px 25px;"|[[File:MB2_25.png]]
 
−
|}
 
−
{|
 
−
|style="padding: 0px 0px 15px 15px;"| You can also migrate the customer from this brand to another one. <br/>
 
−
Click '' 'Migrate' '' [[File:MB2_Migrate.png|frameless]] button next to the client and then select the brand to which you want to assign it.
 
−
|}
 
−
{|
 
−
|style="padding: 0px 0px 20px 25px;"|[[File:MB2_26.png]]
 
−
|}
 
−
{|
 
−
|style="padding: 0px 0px 30px 15px;"| And finally, if you want to delete the customer relationship with this brand, press the '' 'Delete' '' [[File:MB2_Delete.png|frameless]]  button and confirm the action.
 
−
|}
 
−
 
−
====Services====
 
−
{|
 
−
|style="padding: 10px 0px 15px 15px;"|xxxxxxxxxx
 
−
|}
 
−
{|
 
−
|style="padding: 0px 0px 20px 25px;"|[[File:MB2_XX.png]]
 
−
|}
 
−
====Invoices====
 
−
{|
 
−
|style="padding: 10px 0px 15px 15px;"|xxxxxxxxxx
 
−
|}
 
−
{|
 
−
|style="padding: 0px 0px 20px 25px;"|[[File:MB2_XX.png]]
 
−
|}
 
−
====Tickets====
 
−
{|
 
−
|style="padding: 10px 0px 15px 15px;"|xxxxxxxxxx
 
−
|}
 
−
{|
 
−
|style="padding: 0px 0px 20px 25px;"|[[File:MB2_XX.png]]
 
−
|}
 
−
====Knowledgebase====
 
−
{|
 
−
|style="padding: 10px 0px 15px 15px;"|xxxxxxxxxx
 
−
|}
 
−
{|
 
−
|style="padding: 0px 0px 20px 25px;"|[[File:MB2_XX.png]]
 
−
|}
 
−
====Downloads====
 
−
{|
 
−
|style="padding: 10px 0px 15px 15px;"|xxxxxxxxxx
 
−
|}
 
−
{|
 
−
|style="padding: 0px 0px 20px 25px;"|[[File:MB2_XX.png]]
 
−
|}
 
−
====Announcements====
 
−
{|
 
−
|style="padding: 10px 0px 15px 15px;"|xxxxxxxxxx
 
−
|}
 
−
{|
 
−
|style="padding: 0px 0px 20px 25px;"|[[File:MB2_XX.png]]
 
−
|}
 
−
 
−
==Statistics==
 
−
==Logs==
 
−
==Branded Admin Area Functionalities==
 
−
===Membership In The Admin Area===
 
−
===Invoices/Tickets/Quotes Creation From Admin Area===
 
−
===Announcements===
 
−
===Downloads===
 
−
===Knowledgebase===
 
−
==Branded Client Area Functionalities==
 
−
==Domains & CNAME Records Configuration==
 
−
===cPanel===
 
−
===DirectAdmin===
 
−
===Plesk===
 
−
==SSL Certificates==
 
−
===cPanel===
 
−
==Branding Limitations & Requirements==
 
−
===Limitations===
 
−
===Requirements===
 
−
=Tips=
 
−
=Common Problems=
 

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