Personal tools
Namespaces

Variants
Actions

Hosting Quota Notifications 1.X For WHMCS

From ModulesGarden Wiki
(Difference between revisions)
Jump to: navigation, search
 
(485 intermediate revisions by 5 users not shown)
Line 1: Line 1:
−
<meta name="keywords" content="godaddy domain registrar for blesta, godaddy domain registrar configuration, godaddy domain registrar management, godaddy domain registrar installation, godaddy domain registrar guide, modulesgarden godaddy domain registrar, godaddy domain registrar wiki,godaddy domain registrar tutorial, godaddy domain registrar tips, godaddy module wiki, godaddy domain registrar common problems, about godaddy domain registrar, godaddy domain registrar documentation, godaddy domain registrars faq, godaddy domain registrar help"></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 GoDaddy Domain Registrar For Blesta Module."></meta>
+
<meta name="description" content="ModulesGarden Wiki Contains All The Information You Need About The Hosting Quota Notifications For WHMCS Module."></meta>
  
−
=About [http://www.modulesgarden.com/products/whmcs/godaddy_domain_registrar_blesta/features Godaddy Domain Registrar For Blesta]=
+
=About [https://www.modulesgarden.com/products/whmcs/hosting-quota-notifications Hosting Quota Notifications For WHMCS]=
 
{|
 
{|
−
|style="padding: 10px 0px 10px 0px;"|'''Godaddy Domain Registrar For Blesta''' enables registration of GoDaddy domains in your Blesta system.<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.
−
Your clients will be able to order and manage their domains directly in your Blesta client area.<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 is an excellent tool for every GoDaddy API Reseller who works with Blesta platform.
+
You can also define email templates and view details of each sent notification owing to logs.
 
|}
 
|}
−
 
+
<!--a comment maybe? -->
−
<!--fix dla features-->
+
*'''Admin Area Features:'''
−
*'''Client Area Features:'''
+
 
{|
 
{|
−
|style="padding: 10px 0px 0px 30px;"|✔ Access Shopper ID And Password
+
|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;"|✔ Log In To Shopper Panel
+
|style="padding: 0px 0px 0px 30px;"|✔ Configure Notification Groups
 
|}
 
|}
 
{|
 
{|
−
|style="padding: 0px 0px 0px 30px;"|✔ Toggle Registrar Lock
+
|style="padding: 0px 0px 0px 30px;"|✔ Choose Between Two Types Of Group Counting:
 
|}
 
|}
 
{|
 
{|
−
|style="padding: 0px 0px 0px 30px;"|✔ Toggle EPP Code Visibility
+
|style="padding: 0px 0px 0px 45px;"|✔ Tiered - Define Tiers Of Usage
 
|}
 
|}
 
{|
 
{|
−
|style="padding: 0px 0px 10px 30px;"|✔ Update Contact Details
+
|style="padding: 0px 0px 0px 45px;"|✔ Fixed - Define Usage Grow Over Time
 
|}
 
|}
−
*'''Admin Area Features:'''
 
 
{|
 
{|
−
|style="padding: 10px 0px 0px 30px;"|✔ Register/Transfer/Renew/Cancel Domain
+
|style="padding: 0px 0px 0px 30px;"|✔ Assign Multiple Products To Single Notification Group
 
|}
 
|}
 
{|
 
{|
−
|style="padding: 0px 0px 0px 30px;"|✔ Update Nameservers
+
|style="padding: 0px 0px 0px 30px;"|✔ Assign Email Templates Per Notification Group
 
|}
 
|}
 
{|
 
{|
−
|style="padding: 0px 0px 0px 30px;"|✔ Access Shopper ID And Password
+
|style="padding: 0px 0px 0px 30px;"|✔ Enable/Disable Notification Groups
 
|}
 
|}
 
{|
 
{|
−
|style="padding: 0px 0px 0px 30px;"|✔ Toggle Registrar Lock
+
|style="padding: 0px 0px 10px 30px;"|✔ View Logs Of Sent Notifications
−
|}
+
−
{|
+
−
|style="padding: 0px 0px 0px 30px;"|✔ Toggle EPP Code Visibility
+
−
|}
+
−
{|
+
−
|style="padding: 0px 0px 10px 30px;"|✔ Update Contact Details
+
 
|}
 
|}
 
*'''General Info:'''
 
*'''General Info:'''
 
{|
 
{|
−
|style="padding: 10px 0px 0px 30px;"|✔ Supports 301 Different TLDs & gTLDs
+
|style="padding: 10px 0px 0px 30px;"|✔ Multi-Language Support
 
|}
 
|}
 
{|
 
{|
−
|style="padding: 0px 0px 0px 30px;"|✔ Multi-Language Support
+
|style="padding: 0px 0px 0px 30px;"|✔ Supports PHP 5.6 Up To PHP 7.2
 
|}
 
|}
 
{|
 
{|
−
|style="padding: 0px 0px 30px 30px;"|✔ Supports Blesta 3.6.2
+
|style="padding: 0px 0px 30px 30px;"|✔ Supports WHMCS V7
 
|}
 
|}
  
−
=Installation and Configuration=
+
=Installation=
 
{|
 
{|
−
|style="padding: 10px 0px 30px 0px;"|'''In this brief tutorial we will show you how to successfully install and set up GoDaddy Domain Registrar For Blesta.'''<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 process.
+
We will guide you step by step through the whole installation and configuration process.
 
|}
 
|}
 
==Installation==
 
==Installation==
 
{|
 
{|
−
|style="padding: 10px 0px 15px 15px;"|'''1. In the beginning make sure that you are the [https://www.godaddy.com/help/what-is-an-api-reseller-plan-5939 GoDaddy API Reseller] and your API User account is active.'''<br/>
+
|style="padding: 10px 0px 20px 15px;"|'''1. Log in to our client area and download the module.'''
−
''Info: Please note that GoDaddy API Reseller and GoDaddy Reseller are not the same! Our module can be successfully used only with the former account.''
+
 
|}
 
|}
 
{|
 
{|
−
|style="padding: 0px 0px 20px 15px;"|'''2. Log in to your client area and download GoDaddy Domain Registrar For Blesta.'''
+
|style="padding: 0px 0px 20px 25px;"|[[File:HQN_1.png]]
 
|}
 
|}
 
{|
 
{|
−
|style="padding: 0px 0px 20px 25px;"|[[File:GDRB_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 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 the current PHP version in your WHMCS. To do so, proceed to ''' 'Utilities' › 'System' › 'PHP Info'.'''
 
|}
 
|}
 
{|
 
{|
−
|style="padding: 0px 0px 15px 15px;"|'''3. Upload and extract the module into the main Blesta directory.'''<br/>
+
|style="padding: 0px 0px 20px 25px;"|[[File:PHP56_72.png]]
−
Files in your Blesta directory should look like this.  
+
 
|}
 
|}
 
{|
 
{|
−
|style="padding: 0px 0px 20px 25px;"|[[File:GDRB_2.png]]
+
|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 />
 +
The content of PHP version files should look like this.  
 
|}
 
|}
 
{|
 
{|
−
|style="padding: 0px 0px 15px 15px;"|'''4. When you install GoDaddy Domain Registrar for the first time you have to rename '' 'license_RENAME.php' '' file.'''<br/>
+
|style="padding: 0px 0px 20px 25px;"|[[File:drfere.png]]
−
File is located in '' 'components/modules/go_daddy/license_RENAME.php'.'' Rename it from '' 'license_RENAME.php' '' to '' 'license.php'.''
+
 
|}
 
|}
 
{|
 
{|
−
|style="padding: 0px 0px 20px 25px;"|[[File:GDRB_3.png]]
+
|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/hosting_quota_notifications/license_RENAME.php' '' . Rename it from '' 'license_RENAME.php' '' to '' 'license.php' '' .
 
|}
 
|}
 
{|
 
{|
−
|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 20px 25px;"|[[File:HQN_3.png]]
−
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'.''
+
 
|}
 
|}
 
{|
 
{|
−
|style="padding: 0px 0px 30px 25px;"|[[File:GDRB_4.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 />
 +
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' ''.  
 
|}
 
|}
−
 
−
==Configuration==
 
 
{|
 
{|
−
|style="padding: 10px 0px 10px 0px;"|'''Before you can go one, you must generate your GoDaddy API Key and API Secret. You will need them to activate your registrar module.'''<br/>
+
|style="padding: 0px 0px 30px 25px;"|[[File:HQN_4.png]]
−
Underneath you will find instructions where to find your API details.
+
−
|}
+
−
{|
+
−
|style="padding: 0px 0px 15px 15px;"|'''6. Firstly, log into your GoDaddy account and enter site: https://developer.godaddy.com/'''<br/>
+
−
Find '' 'Keys' '' section.
+
−
|}
+
−
{|
+
−
|style="padding: 0px 0px 20px 25px;"|[[File:GDRB_5.png]]
+
−
|}
+
−
{|
+
−
|style="padding: 0px 0px 15px 15px;"|'''7. You will be moved to a section where keys can be generated and then managed. Please find '' 'Production' '' keys.'''<br/> It should be seen at the bottom of the page, under '' 'Test' '' keys.<br/>Press '+' to generate a new key.
+
−
|}
+
−
{|
+
−
|style="padding: 0px 0px 20px 25px;"|[[File:GDRB_6.png]]
+
−
|}
+
−
{|
+
−
|style="padding: 0px 0px 15px 15px;"|'''8. Keep your API Key and Secret in a safe place, you will need them in a moment. Note that it is not possible to vie '' 'API Secret' '' again!<br/>
+
−
Press '' 'OK' '' to finish.
+
−
|}
+
−
{|
+
−
|style="padding: 0px 0px 20px 25px;"|[[File:GDRB_7.png]]
+
−
|}
+
−
{|
+
−
|style="padding: 0px 0px 15px 15px;"|'''9. Now, log in to your Blesta and proceed to '' 'Settings' '' → '' 'Modules' '' → '' 'Available'. '' '''<br/>
+
−
Find '' 'GoDaddy Domain Registrar' '' and press '' 'Install' '' next to it.
+
−
|}
+
−
{|
+
−
|style="padding: 0px 0px 20px 25px;"|[[File:GDRB_7_1.png]]
+
−
|}
+
−
{|
+
−
|style="padding: 0px 0px 20px 15px;"|'''10. Afterwards, press '' 'Manage' '' to configure your API connection.
+
−
|}
+
−
{|
+
−
|style="padding: 0px 0px 20px 25px;"|[[File:GDRB_8.png]]
+
−
|}
+
−
{|
+
−
|style="padding: 0px 0px 15px 15px;"|'''11. Enter your live API '' 'API Key', 'API Secret' '' and a URL to domain management site.<br/>
+
−
Press '' 'Save Changes' '' when ready.
+
−
|}
+
−
{|
+
−
|style="padding: 0px 0px 30px 25px;"|[[File:GDRB_9.png]]
+
 
|}
 
|}
  
−
=Management=
+
==Configuration of Addon==
−
{|
+
−
|style="padding: 10px 0px 30px 15px;"|'''GoDaddy Domain Registrar allows you to offer GoDaddy TLDs through the Blesta system to your customers.'''<br/>
+
−
In this short guide we will present you the possibilities of our module.
+
−
|}
+
−
==Packages==
+
−
===New Package===
+
−
{|
+
−
|style="padding: 10px 0px 15px 15px;"|Before you can offer new TLD for sale you must create some packages with selected TLDs and pricing.<br/>
+
−
Go to '' 'Packages' → 'Browse' '' and press '' 'Create Package'.''
+
−
|}
+
−
{|
+
−
|style="padding: 0px 0px 20px 25px;"|[[File:GDRB_10.png]]
+
−
|}
+
−
{|
+
−
|style="padding: 0px 0px 15px 15px;"|You will see an extensive form. Start with naming your package, select module - '' 'GoDaddy Domain Registrar' '' and activate it now.<br/>
+
−
''Surely you can activate it later on.''
+
−
|}
+
−
{|
+
−
|style="padding: 0px 0px 20px 25px;"|[[File:GDRB_11.png]]
+
−
|}
+
−
{|
+
−
|style="padding: 0px 0px 15px 15px;"|Next, you have to configure your module options.<br/>
+
−
*select type: '' 'Domain Registration' ''
+
−
*Select TLD you wish to allow for sale in this package
+
−
*provide default nameservers - they can be changed later on.
+
−
|}
+
−
{|
+
−
|style="padding: 0px 0px 20px 25px;"|[[File:GDRB_12.png]]
+
−
|}
+
−
{|
+
−
|style="padding: 0px 0px 20px 15px;"|In the next step set your prices.
+
−
|}
+
−
{|
+
−
|style="padding: 0px 0px 20px 25px;"|[[File:GDRB_13.png]]
+
−
|}
+
−
{|
+
−
|style="padding: 0px 0px 20px 15px;"|You may also provide the content of a welcome email.
+
−
|}
+
 
{|
 
{|
−
|style="padding: 0px 0px 20px 25px;"|[[File:GDRB_14.png]]
+
|style="padding: 10px 0px 15px 15px;"|'''6. Now you have to activate the module in your WHMCS system.'''<br />
 +
Log in to your WHMCS admin area. Go to '' 'Setup' '' → '' 'Addon Modules' ''. Afterwards, find '' 'Hosting Quota Notifications' '' and press '' 'Activate' '' button.
 
|}
 
|}
 
{|
 
{|
−
|style="padding: 0px 0px 15px 15px;"|Finally, select a group to which the package will belong to. If you do not have any groups yet, you may quickly create one right now.<br/>
+
|style="padding: 0px 0px 20px 25px;"|[[File:HQN_5.png]]
−
Do not forget to press '' 'Create Package' '' button in the end.  
+
 
|}
 
|}
 
{|
 
{|
−
|style="padding: 0px 0px 20px 25px;"|[[File:GDRB_15.png]]
+
|style="padding: 0px 0px 15px 15px;"|'''7. In the next step you need to permit access to this module.'''<br />
 +
To do so click on '' 'Configure' '' button, tick '' 'Access Control' '' near required admin role groups and press '' 'Save Changes' ''.
 
|}
 
|}
 
{|
 
{|
−
|style="padding: 0px 0px 30px 15px;"|Your package is ready now, create as many packages as you need to diversify your pricing offer.
+
|style="padding: 0px 0px 30px 25px;"|[[File:HQN_6.png]]
 
|}
 
|}
  
−
===Order Forms===
 
 
{|
 
{|
−
|style="padding: 10px 0px 20px 15px;"|Once you have your package ready, you have to create a new order form. Move to '' 'Packages' → 'Order Forms' '' and press '' 'Add Order Form'.''
+
|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:GDRB_16.png]]
+
|style="padding: 0px 0px 30px 25px;"|[[File:HQN_7.png]]
−
|}
+
−
{|
+
−
|style="padding: 0px 0px 15px 15px;"|Provide '' 'Basic' '' settings for the order form that will be assigned to your previously created package.
+
−
*set the status
+
−
*name the order form
+
−
*provide a unique label ''(next to the label a URL to this order form in client area will appear)
+
−
*select type of the form - '' 'Domain And Other' ''
+
−
*choose template from the available
+
−
*configure any additional options like allowing coupons or human verification, etc
+
−
*select domain package group - the one you created in the previous step
+
−
*select allowed currencies and payment gateways<br/>
+
−
Press '' 'Add Form' '' when everything is ready.
+
−
|}
+
−
{|
+
−
|style="padding: 0px 0px 30px 25px;"|[[File:GDRB_17.png]]
+
 
|}
 
|}
  
−
==Ordering==
+
=Configuration and Management=
 
{|
 
{|
−
|style="padding: 10px 0px 15px 15px;"|Ordering GoDaddy domains goes alike ordering other domains.<br/>
+
|style="padding: 10px 0px 30px 15px;"|'''In this section we will show you how to properly set up and use Hosting Quota Notifications For WHMCS.'''
−
Check domain availability, order selected domain, make the payment and wait until it is activated.
+
 
|}
 
|}
 +
==Configuration==
 
{|
 
{|
−
|style="padding: 0px 0px 30px 25px;"|[[File:GDRB_19.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.
 
|}
 
|}
−
 
−
==Domain Management==
 
−
===Admin Area===
 
 
{|
 
{|
−
|style="padding: 10px 0px 15px 15px;"|In the admin area you can manage all the aspects of the domain. Find the ordered domains under '' 'Services' '' table.<br/>
+
|style="padding: 0px 0px 20px 25px;"|[[File:HQN_9.png]]
−
Press '' 'Manage' '' to see details of the domain.
+
 
|}
 
|}
 
{|
 
{|
−
|style="padding: 0px 0px 30px 25px;"|[[File:GDRB_20.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.
 
|}
 
|}
−
====Basic Options====
 
 
{|
 
{|
−
|style="padding: 10px 0px 15px 15px;"|The first tab gathers data on service information, allowed actions and upgrade/downgrade feature.<br/>
+
|style="padding: 0px 0px 20px 25px;"|[[File:HQN_10.png]]
−
'''Service Information:'''
+
−
*some basic data on the domain such as name, label, quantity, dates etc.<br/>
+
−
'''Actions:'''
+
−
*Suspend/cancel/schedule cancellation and change renew date<br/>
+
−
Select action, provide details depending on the chosen action and save the changes.<br/>
+
−
'''Upgrade/Downgrade'''
+
−
*If set up, you may choose other package or term from available to upgrade it or downgrade.
+
−
*enter coupon code to use
+
−
*select prorate<br/>
+
−
Again save the changes.
+
 
|}
 
|}
 
{|
 
{|
−
|style="padding: 0px 0px 30px 25px;"|[[File:GDRB_21.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.
 
|}
 
|}
−
 
−
====Name Servers====
 
 
{|
 
{|
−
|style="padding: 10px 0px 15px 15px;"|In the next section you can preview ordered name servers. Update them if required.
+
|style="padding: 0px 0px 30px 25px;"|[[File:HQN_11.png]]
 
|}
 
|}
 +
==Logs==
 
{|
 
{|
−
|style="padding: 0px 0px 30px 25px;"|[[File:GDRB_22.png]]
+
|style="padding: 10px 0px 15px 15px;"|Under '' 'Logs' '' page you can view information about sent notifications.
 
|}
 
|}
−
====Settings====
 
 
{|
 
{|
−
|style="padding: 10px 0px 15px 15px;"|'' 'Settings' ''  section includes important details, such as:
+
|style="padding: 0px 0px 30px 25px;"|[[File:HQN_12.png]]
−
*Domain ID
+
−
*Shopper ID and Password
+
−
*exact expiry date
+
−
*setup options: renewable/privacy/status
+
−
Here you can also:
+
−
*manage the registrar lock
+
−
*enable/disable auto-renewal option
+
−
*preview EPP code
+
 
|}
 
|}
 +
==Notifications==
 
{|
 
{|
−
|style="padding: 0px 0px 30px 25px;"|[[File:GDRB_23.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.
 
|}
 
|}
−
====Contact Details====
 
 
{|
 
{|
−
|style="padding: 10px 0px 15px 15px;"|The very last section contains all contact details to:
+
|style="padding: 0px 0px 30px 25px;"|[[File:HQN_13.png]]
−
*Registrant Contact
+
−
*Billing Contact
+
−
*Admin Contact
+
−
*Technical Contact
+
−
You may change/update the details here.
+
−
|}
+
−
{|
+
−
|style="padding: 0px 0px 30px 25px;"|[[File:GDRB_24.png]]
+
 
|}
 
|}
  
−
===Client Area===
+
=Tips=
 
{|
 
{|
−
|style="padding: 10px 0px 15px 15px;"|Your customers can perform various actions on their GoDaddy domain from the client area.<br/>
+
|style="padding: 10px 0px 30px 15px;"|
−
Clients can view basic information related to domains and perform several actions on them. Read below see exactly what can be done.<br/>
+
−
In addition to that, your clients can find here their GoDaddy account details and log into it through pressing '' 'Go To Control Panel' '' button.
+
−
|}
+
−
{|
+
−
|style="padding: 0px 0px 20px 25px;"|[[File:GDRB_25.png]]
+
−
|}
+
−
{|
+
−
|style="padding: 0px 0px 20px 15px;"|At '' 'Information' '' tab clients can see basic details on their domain. Used package name, status, recurring amount etc.
+
−
|}
+
−
{|
+
−
|style="padding: 0px 0px 20px 25px;"|[[File:GDRB_26.png]]
+
−
|}
+
−
{|
+
−
|style="padding: 0px 0px 20px 15px;"|'' 'Nameservers' '' tab allows clients to preview and change nameservers used by their domains.
+
−
|}
+
−
{|
+
−
|style="padding: 0px 0px 20px 25px;"|[[File:GDRB_27.png]]
+
−
|}
+
−
{|
+
−
|style="padding: 0px 0px 15px 15px;"|'' 'Settings'' ' section includes:
+
−
*domain management data - shopper ID and password
+
−
*'' 'Go To Control Panel' '' - press to log into the panel
+
−
*registrar lock -  our customers can also lock/unlock their domains to prevent them from being transferred
+
−
*enable or disable auto renewal option
+
−
*preview EPP code
+
−
|}
+
−
{|
+
−
|style="padding: 0px 0px 20px 25px;"|[[File:GDRB_28.png]]
+
−
|}
+
−
{|
+
−
|style="padding: 0px 0px 20px 15px;"|Under '' 'Contact Details' '' your clients can also view and modify any contact information.
+
−
|}
+
−
{|
+
−
|style="padding: 0px 0px 30px 25px;"|[[File:GDRB_29.png]]
+
 
|}
 
|}
  
−
=Tips=
+
=Update Instructions=
 
{|
 
{|
−
|style="padding: 10px 0px 30px 15px;"|1. To use the test mode, simply select '' 'Sandbox' '' under the module management page.
+
|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=
 
=Common Problems=
 
{|
 
{|
−
|style="padding: 10px 0px 10px 15px;"|'''1. When you have problems with connection, check whether your SELinux or firewall does not block ports.'''
+
|style="padding: 10px 0px 30px 15px;"|'''1. When you have problems with connection, check whether your SELinux or firewall does not block ports.'''
 
|}
 
|}

Latest revision as of 11: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