Personal tools
Namespaces

Variants
Actions

Hosting Quota Notifications 1.X For WHMCS

From ModulesGarden Wiki
(Difference between revisions)
Jump to: navigation, search
(→‎Product Configuration)
 
(366 intermediate revisions by 4 users not shown)
Line 1: Line 1:
−
<meta name="keywords" content="g suite for whmcs, g suite configuration, g suite management, g suite installation, g suite guide, modulesgarden g suite, g suite wiki, g suite tutorial, g suite tips, whmcs google  module wiki, g suite common problems, about g suite for whmcs, g suite documentation, g suite faq, g suite 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 G Suite 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/g-suite G Suite For WHMCS]=
+
 
{|
 
{|
−
|style="padding: 10px 0px 10px 0px;"|'''G Suite For WHMCS''' will enable you to provision and manage Google accounts in your own WHMCS 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.
−
Authenticate through OAuth 2.0, create flexible products and let your clients order ready Google services directly from your website.
+
Notifications can be sent in two ways: upon exceeding given resource tier or after exceeding given resource limit in a specified time period.<br />
 +
You can also define email templates and view details of each sent notification owing to logs.
 
|}
 
|}
 
<!--a comment maybe? -->
 
<!--a comment maybe? -->
 
*'''Admin Area Features:'''
 
*'''Admin Area Features:'''
 
{|
 
{|
−
|style="padding: 10px 0px 0px 30px;"|✔ Create/Suspend/Unsuspend/Terminate Account
+
|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;"|✔ Change Package
+
|style="padding: 0px 0px 0px 30px;"|✔ Configure Notification Groups
 
|}
 
|}
 
{|
 
{|
−
|style="padding: 0px 0px 0px 30px;"|✔ Define Plan Name
+
|style="padding: 0px 0px 0px 30px;"|✔ Choose Between Two Types Of Group Counting:
 
|}
 
|}
 
{|
 
{|
−
|style="padding: 0px 0px 0px 30px;"|✔ Define Renewal Type
+
|style="padding: 0px 0px 0px 45px;"|✔ Tiered - Define Tiers Of Usage
 
|}
 
|}
 
{|
 
{|
−
|style="padding: 0px 0px 0px 30px;"|✔ Choose Action On Terminate
+
|style="padding: 0px 0px 0px 45px;"|✔ Fixed - Define Usage Grow Over Time
 
|}
 
|}
 
{|
 
{|
−
|style="padding: 0px 0px 0px 30px;"|✔ Log API Requests
+
|style="padding: 0px 0px 0px 30px;"|✔ Assign Multiple Products To Single Notification Group
 
|}
 
|}
 
{|
 
{|
−
|style="padding: 0px 0px 0px 30px;"|✔ Set Configurable Options Per Product:
+
|style="padding: 0px 0px 0px 30px;"|✔ Assign Email Templates Per Notification Group
 
|}
 
|}
 
{|
 
{|
−
|style="padding: 0px 0px 0px 45px;"|✔ Product SKU ID
+
|style="padding: 0px 0px 0px 30px;"|✔ Enable/Disable Notification Groups
 
|}
 
|}
 
{|
 
{|
−
|style="padding: 0px 0px 10px 45px;"|✔ Number of Seats
+
|style="padding: 0px 0px 10px 30px;"|✔ View Logs Of Sent Notifications
−
|}
+
−
*'''Client Area Features:'''
+
−
{|
+
−
|style="padding: 10px 0px 0px 30px;"|✔ View Customer Info
+
−
|}
+
−
{|
+
−
|style="padding: 0px 0px 0px 30px;"|✔ Log In To Control Panel
+
−
|}
+
−
{|
+
−
|style="padding: 0px 0px 10px 30px;"|✔ Log In To Webmail
+
−
|}
+
−
*'''Available Google Services:'''
+
−
{|
+
−
|style="padding: 10px 0px 0px 30px;"|✔ Google Apps For Business
+
−
|}
+
−
{|
+
−
|style="padding: 0px 0px 0px 30px;"|✔ Google Vault
+
−
|}
+
−
{|
+
−
|style="padding: 0px 0px 10px 30px;"|✔ Google Drive Storage
+
 
|}
 
|}
 
*'''General Info:'''
 
*'''General Info:'''
 
{|
 
{|
−
|style="padding: 10px 0px 0px 30px;"|✔ Authentication And API Calls Utilize OAuth 2.0
+
|style="padding: 10px 0px 0px 30px;"|✔ Multi-Language Support
 
|}
 
|}
 
{|
 
{|
−
|style="padding: 0px 0px 0px 30px;"|✔ Multi-Language Support
+
|style="padding: 0px 0px 0px 30px;"|✔ Supports PHP 5.6 Up To PHP 7.2
 
|}
 
|}
 
{|
 
{|
−
|style="padding: 0px 0px 0px 30px;"|✔ Supports PHP 5.4 Up To PHP 7
+
|style="padding: 0px 0px 30px 30px;"|✔ Supports WHMCS V7
−
|}
+
−
{|
+
−
|style="padding: 0px 0px 0px 30px;"|✔ Supports WHMCS Templates Five and Six
+
−
|}
+
−
{|
+
−
|style="padding: 0px 0px 30px 30px;"|✔ Supports WHMCS V6 and V7
+
 
|}
 
|}
  
−
=Installation and Authentication=
+
=Installation=
 
{|
 
{|
−
|style="padding: 10px 0px 0px 0px;"|'''This tutorial will show you how to successfully install and authenticate G Suite 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 authentication process.
+
We will guide you step by step through the whole installation and configuration process.
 
|}
 
|}
 +
==Installation==
 
{|
 
{|
−
|style="padding: 20px 0px 20px 15px;"|'''1. Log in to your client area and download the module.'''
+
|style="padding: 10px 0px 20px 15px;"|'''1. Log in to our client area and download the module.'''
 
|}
 
|}
 
{|
 
{|
−
|style="padding: 0px 0px 20px 25px;"|[[File:GA1.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:GA2.png]]
+
|style="padding: 0px 0px 20px 25px;"|[[File:PHP56_72.png]]
 
|}
 
|}
 
{|
 
{|
Line 98: Line 72:
 
|}
 
|}
 
{|
 
{|
−
|style="padding: 0px 0px 20px 25px;"|[[File:ftgt.png]]
+
|style="padding: 0px 0px 20px 25px;"|[[File:drfere.png]]
 
|}
 
|}
 
{|
 
{|
−
|style="padding: 0px 0px 15px 15px;"|'''4. When you install G Suite 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/servers/googleapps/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:GA3.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 20px 25px;"|[[File:GA4.png]]
+
|style="padding: 0px 0px 30px 25px;"|[[File:HQN_4.png]]
 
|}
 
|}
−
==API Configuration==
+
 
 +
==Configuration of Addon==
 
{|
 
{|
−
|style="padding: 10px 0px 15px 15px;"|'''6. Now you have to authenticate the module through setting up API Access.'''<br />
+
|style="padding: 10px 0px 15px 15px;"|'''6. Now you have to activate the module in your WHMCS system.'''<br />
−
Create API Access in Google Console. You can do it here → [https://code.google.com/apis/console/ https://code.google.com/apis/console/]
+
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 15px;"|'''7. After you have logged in, create a new project.'''
+
|style="padding: 0px 0px 20px 25px;"|[[File:HQN_5.png]]
 
|}
 
|}
 
{|
 
{|
−
|style="padding: 0px 0px 20px 25px;"|[[File:GA5.png]]
+
|style="padding: 0px 0px 15px 15px;"|'''7. In the next step you need to permit access to this module.'''<br />
 +
To do so click on '' 'Configure' '' button, tick '' 'Access Control' '' near required admin role groups and press '' 'Save Changes' ''.
 
|}
 
|}
 
{|
 
{|
−
|style="padding: 0px 0px 15px 15px;"|'''8. You have just entered Google API Manager. Firstly, go to '' 'OAuth consent screen' '' under '' 'Credentials' '' section.<br />
+
|style="padding: 0px 0px 30px 25px;"|[[File:HQN_6.png]]
−
Afterwards, enter email address and product name, they will be visible during your requests.<br />
+
−
Save changes through pressing '' 'Save' '' button.
+
−
|}
+
−
{|
+
−
|style="padding: 0px 0px 20px 25px;"|[[File:GA5_1.png]]
+
−
|}
+
−
{|
+
−
|style="padding: 0px 0px 15px 15px;"|'''9. To proceed, go to '' 'Google APIs' '' under '' 'Overview' '' tab.'''<br />
+
−
Find '' 'Google Apps Reseller API' '' among all applications.
+
−
|}
+
−
{|
+
−
|style="padding: 0px 0px 20px 25px;"|[[File:GA5_2.png]]
+
−
|}
+
−
{|
+
−
|style="padding: 0px 0px 15px 15px;"|'''10. You have to enable '' 'Google Apps Reseller API' '' as shown on the following screen.'''
+
−
|}
+
−
{|
+
−
|style="padding: 0px 0px 20px 25px;"|[[File:GA5_2.1.png]]
+
−
|}
+
−
{|
+
−
|style="padding: 0px 0px 20px 15px;"|'''11. Now, switch to '' 'Credentials' '' tab and add new credentials .'''
+
−
|}
+
−
{|
+
−
|style="padding: 0px 0px 20px 25px;"|[[File:GA5_4.png]]
+
−
|}
+
−
{|
+
−
|style="padding: 0px 0px 15px 15px;"|'''12. Afterwards, tick '' 'Web application'. '''''<br />
+
−
Next, enter website URL into '' 'Authorized JavaScript origins' '' field and path to '' 'oauth_callback.php' '' into '' 'Authorized redirect URI' '' field.<br />
+
−
Confirm changes through pressing '' 'Create'. ''
+
−
|}
+
−
{|
+
−
|style="padding: 0px 0px 20px 25px;"|[[File:GA5_5.png]]
+
−
|}
+
−
{|
+
−
|style="padding: 0px 0px 20px 15px;"|'''13. Well done, now when you have all the necessary details you can proceed to authenticate Google Apps.'''
+
−
|}
+
−
{|
+
−
|style="padding: 0px 0px 30px 25px;"|[[File:GA5_6.png]]
+
 
|}
 
|}
  
−
==Product Configuration==
 
−
{|
 
−
|style="padding: 10px 0px 20px 15px;"|'''14. Now go back to your WHMCS system and create a new product for your GoogleApps.'''<br/>
 
−
Move to '' 'Setup' → 'Products/Services' → 'Products/Services' ''  and add a new product.
 
−
|}
 
−
{|
 
−
|style="padding: 0px 0px 20px 25px;"|[[File:GA5_6_1.png]]
 
−
|}
 
−
{|
 
−
|style="padding: 0px 0px 20px 15px;"|'''15. Choose product type and product group from dropdown menus and enter your new product's name. '' 'Continue'. ''
 
−
|}
 
−
{|
 
−
|style="padding: 0px 0px 20px 25px;"|[[File:GA5_6_2.png]]
 
−
|}
 
−
{|
 
−
|style="padding: 0px 0px 20px 15px;"|'''16. Go to '' 'Module Settings' '' of your product and choose '' 'Googleapps' '' from a '' 'Module Name' '' dropdown menu.'''
 
−
|}
 
−
{|
 
−
|style="padding: 0px 0px 20px 25px;"|[[File:GA5_7.png]]
 
−
|}
 
−
{|
 
−
|style="padding: 0px 0px 20px 15px;"|'''17. Enter your previously obtained '' 'Client ID', 'Client Secret' '' and make sure that '' 'Callback URL' '' is correct.<br/>
 
−
Then press '' 'Grant access with Google account'. '''''
 
−
|}
 
−
{|
 
−
|style="padding: 0px 0px 20px 25px;"|[[File:GA5_8.png]]
 
−
|}
 
−
{|
 
−
|style="padding: 0px 0px 20px 15px;"|'''18. If your entered data are correct, you will be redirected to the page with permission request. Press '' 'Allow access' '' button.'''
 
−
|}
 
−
{|
 
−
|style="padding: 0px 0px 20px 25px;"|[[File:GA5_9.png]]
 
−
|}
 
−
{|
 
−
|style="padding: 0px 0px 15px 15px;"|'''19. You will be redirected back to your WHMCS and you will see a following screen.'''<br />
 
−
Configure the available options at your discretion.
 
−
|}
 
−
{|
 
−
|style="padding: 0px 0px 20px 25px;"|[[File:GA14.png]]
 
−
|}
 
−
{|
 
−
|style="padding: 0px 0px 15px 15px;"|xxxxx
 
−
|}
 
 
{|
 
{|
−
|style="padding: 0px 0px 15px 15px;"|'''20. Move to 'Custom Fields' now. Fields called '' 'GoogleApps Domain' '' and '' 'GoogleApps PurchaseOrderID' '' are added automatically.'''<br />
+
|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 30px 25px;"|[[File:GA19.png]]
+
|style="padding: 0px 0px 30px 25px;"|[[File:HQN_7.png]]
 
|}
 
|}
  
 
=Configuration and Management=
 
=Configuration and Management=
 
{|
 
{|
−
|style="padding: 10px 0px 30px 0px;"|Configuration and management of G Suite For WHMCS is very intuitive. Read the below sections to see how easy it is.
+
|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.'''
 
|}
 
|}
−
==Basic Configuration==
+
==Configuration==
 
{|
 
{|
−
|style="padding: 10px 0px 15px 15px;"|Let's start the module settings from choosing '' 'Default Product SKU ID'. '' In other words Google services.<br />
+
|style="padding: 10px 0px 15px 15px;"|In '' 'Configuration' '' page you can find the list of configured notification groups.<br />
−
As you can see on the following screen our module supports Google Apps For Business, Google Drive Storage and Google Vault.
+
You can enable/disable any of them, as well as alter or completely remove them.<br />
 +
Press '' 'Create New Group' '' to proceed.
 
|}
 
|}
 
{|
 
{|
−
|style="padding: 0px 0px 20px 25px;"|[[File:GA16.png]]
+
|style="padding: 0px 0px 20px 25px;"|[[File:HQN_9.png]]
 
|}
 
|}
 
{|
 
{|
−
|style="padding: 0px 0px 20px 15px;"|'' 'Plan Name' '' allows you to select the method of payment. You can pay once per year (Annual), once per month (Flexible) or as the client chooses (Automatic).
+
|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 25px;"|[[File:GA17.png]]
+
|style="padding: 0px 0px 20px 25px;"|[[File:HQN_10.png]]
 
|}
 
|}
 
{|
 
{|
−
|style="padding: 0px 0px 20px 15px;"|Here you can decide whether on terminate you want to suspend or cancel customer's services.
+
|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 30px 25px;"|[[File:GA18.png]]
+
|style="padding: 0px 0px 30px 25px;"|[[File:HQN_11.png]]
 
|}
 
|}
−
 
+
==Logs==
−
==Configurable Options==
+
 
{|
 
{|
−
|style="padding: 10px 0px 15px 15px;"|In order to automatically generate configurable options, simply press button marked on the screen. <br/>
+
|style="padding: 10px 0px 15px 15px;"|Under '' 'Logs' '' page you can view information about sent notifications.
 
|}
 
|}
 
{|
 
{|
−
|style="padding: 0px 0px 20px 25px;"|[[File:GA21.png]]
+
|style="padding: 0px 0px 30px 25px;"|[[File:HQN_12.png]]
 
|}
 
|}
 +
==Notifications==
 
{|
 
{|
−
|style="padding: 0px 0px 20px 15px;"|In your WHMCS system press '' 'Setup' '' → '' 'Products/Services' '' → '' 'Configurable Options'. ''<br />  
+
|style="padding: 10px 0px 15px 15px;"|You can create as many notifications as you wish.<br />
−
Find '' 'GoogleApps' '' options on the list.
+
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:GA22.png]]
+
|style="padding: 0px 0px 30px 25px;"|[[File:HQN_13.png]]
−
|}
+
−
{|
+
−
|style="padding: 0px 0px 20px 15px;"|Here you can manage and alter added configurable options.
+
−
|}
+
−
{|
+
−
|style="padding: 0px 0px 20px 25px;"|[[File:GA23.png]]
+
−
|}
+
−
{|
+
−
|style="padding: 0px 0px 20px 15px;"|Provide values for your new option and enter your desired price. '' 'Save Changes'. ''
+
−
|}
+
−
{|
+
−
|style="padding: 0px 0px 20px 25px;"|[[File:GA24.png]]
+
−
|}
+
−
{|
+
−
|style="padding: 0px 0px 20px 15px;"|At your product '' 'Module Settings' '' you can fill out the fields for ' ''Default Number of Seats' '' and '' 'Default Max Number of Seats'. ''<br/>Remember, however, that these values will be used only if configurable options are NOT generated.
+
−
|}
+
−
{|
+
−
|style="padding: 0px 0px 20px 25px;"|[[File:GA25.png]]
+
−
|}
+
−
{|
+
−
|style="padding: 0px 30px 15px 15px;"|From now on you can easily and quickly change value of your product. Remember that you can add more configurable options for other values.<br />
+
−
|}
+
−
==Admin Area==
+
−
{|
+
−
|style="padding: 10px 0px 15px 15px;"|Let's check your new product in admin area product page. It should look like on the screen below.<br />
+
−
|}
+
−
{|
+
−
|style="padding: 0px 0px 30px 25px;"|[[File:GA19.1.png]]
+
 
|}
 
|}
  
−
==Client Area==
+
=Tips=
 
{|
 
{|
−
|style="padding: 10px 0px 20px 15px;"|This is how the module will look like in the client area. G Suite For WHMCS also allows your customers to quickly access Google account services.
+
|style="padding: 10px 0px 30px 15px;"|
−
|}
+
−
{|
+
−
|style="padding: 0px 0px 30px 25px;"|[[File:GA20.png]]
+
 
|}
 
|}
  
−
==Update of Existing Customers==
+
=Update Instructions=
 
{|
 
{|
−
|style="padding: 10px 0px 15px 15px;"|You can link existing customers accounts by properly filling in the Custom Fields: '' 'GoogleApps Domain' '' and '' 'GoogleApps PurchaseOrderID'. ''<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/>
−
After your customers order a new subscription, they should insert their primary Google account domain name in the '' 'GoogleApps Domain' '' field.<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/>
−
Then, the new subscription will be added to that account.<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/>
−
If you want to manually create an order for existing subscription, additionally to the above, you need to find the '' 'Purchase Order ID' '' (usually on the invoice).<br />
+
−
Copy the ID and paste it to the '' 'GoogleApps PurchaseOrderID'' ' field.<br />
+
−
Afterwards '''do not''' run the create command - just press '' 'Save Changes' '' button. You can also change the status to '' 'Active'. ''
+
 
|}
 
|}
−
{|
 
−
|style="padding: 0px 0px 30px 25px;"|[[File:GA28.png]]
 
−
|}
 
−
 
−
=Tips=
 
−
{|
 
−
|style="padding: 10px 0px 10px 15px;"|1. Our module allows to use Google Apps Reseller account.
 
−
|}
 
−
{|
 
−
|style="padding: 0px 0px 10px 15px;"|2. Avoid using localhost and Raw IP during the authorization.
 
−
|}
 
−
{|
 
−
|style="padding: 0px 0px 10px 15px;"|3. Callback URL is fetched from your WHMCS System URL. You can set it in the '' 'General Settings' '' of your system.
 
−
|}
 
−
{|
 
−
|style="padding: 0px 0px 5px 15px;"|4. To change your API access and OAuth, go to product configuration page and add <code>&logout=1&revoke=1</code> to the URL.<br/> Example:<br />
 
−
http://yourwebsite/whmcs/admin/configproducts.php?action=edit&id=28&logout=1&revoke=1
 
−
|}
 
−
{|
 
−
|style="padding: 0px 0px 10px 15px;"|5. If you want to better understand Google Apps Reseller API and our module concept, visit this [https://developers.google.com/admin-sdk/reseller/v1/how-tos/concepts page]
 
−
|}
 
−
{|
 
−
|style="padding: 0px 0px 30px 15px;"|6. To set up a trial product, go to the module settings, mark '' 'Trial' '' checkbox and switch '' 'Plan Name' '' to '' 'FLEXIBLE'. ''
 
−
|}
 
−
 
 
=Common Problems=
 
=Common Problems=
 
{|
 
{|
−
|style="padding: 10px 0px 5px 15px;"|'''1. When you have problems with connection, check whether your SELinux or firewall does not block ports.'''
+
|style="padding: 10px 0px 30px 15px;"|'''1. When you have problems with connection, check whether your SELinux or firewall does not block ports.'''
−
|}
+
−
{|
+
−
|style="padding: 0px 0px 5px 15px;"|2. It is possible that while authenticating our module you will get an error:
+
−
Error: redirect_uri_mismatch
+
−
If you do, make sure that URLs provided in Google account and your WHMCS system are same.<br/> Keep in mind that address with prefix '' 'www' '' varies from address without prefix '' 'www'. ''
+
−
|}
+
−
{|
+
−
|style="padding: 0px 0px 30px 15px;"|3. In case you encounter error similar to the one below, you most probably disabled the output buffering in the PHP configuration.
+
−
Notice: ob_clean(): failed to delete buffer.
+
−
To solve the problem, please set the '' 'output_buffering' '' value to '' 'On' '' in the php.ini file.
+
 
|}
 
|}

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