Personal tools
Namespaces

Variants
Actions

Hosting Quota Notifications 1.X For WHMCS

From ModulesGarden Wiki
(Difference between revisions)
Jump to: navigation, search
(→‎Department Configuration)
 
(567 intermediate revisions by 6 users not shown)
Line 1: Line 1:
−
<meta name="keywords" content="premium support tickets for whmcs, premium support tickets configuration, whmcs premium support tickets management, whmcs premium support tickets installation, whmcs premium support tickets common problems, about whmcs premium support tickets, whmcs premium support tickets documentation, whmcs premium support tickets faq, whmcs premium support tickets help, whmcs premium support tickets guide, whmcs premium support tickets wiki, whmcs premium support tickets tutorial, whmcs premium support tickets tips, whmcs premium support tickets 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 Premium Support Tickets 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 [http://www.modulesgarden.com/products/whmcs/premium_support_tickets/features Premium Support Tickets For WHMCS]=
+
=About [https://www.modulesgarden.com/products/whmcs/hosting-quota-notifications Hosting Quota Notifications For WHMCS]=
 
{|
 
{|
−
|style="padding: 10px 0px 10px 0px;"|'''Premium Support Tickets For WHMCS''' will allow you to control the access to your support and charge fees for creating tickets in certain departments.<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.
−
The module enables your clients to purchase products and product addons containing support credit points used for creating support tickets in chosen departments.
+
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.
−
<!-- fixed -->
+
−
*'''Module Features:'''
+
−
{|
+
−
|style="padding: 10px 0px 0px 30px;"|✔ Add Support Credit Points Upon Ordering Specified Product Or Addon - Depending On Applied Rule
+
−
|}
+
−
{|
+
−
|style="padding: 0px 0px 0px 30px;"|✔ Remove Fixed Number Of Support Credit Points Upon Ticket Creation
+
−
|}
+
−
{|
+
−
|style="padding: 0px 0px 0px 30px;"|✔ Block Possibility To Create Tickets When Client Has Insufficient Number Of Support Credit Points
+
−
|}
+
−
{|
+
−
|style="padding: 0px 0px 10px 30px;"|✔ Store And Manage Support Credit Points Per Department
+
 
|}
 
|}
 +
<!--a comment maybe? -->
 
*'''Admin Area Features:'''
 
*'''Admin Area Features:'''
 
{|
 
{|
−
|style="padding: 10px 0px 0px 30px;"|✔ Define Number Of Support Credit Points Required To Open Ticket - According To Chosen Department And Priority
+
|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/Edit/Remove Rules
+
|style="padding: 0px 0px 0px 30px;"|✔ Configure Notification Groups
 
|}
 
|}
 
{|
 
{|
−
|style="padding: 0px 0px 0px 30px;"|✔ Enable/Disable Rules
+
|style="padding: 0px 0px 0px 30px;"|✔ Choose Between Two Types Of Group Counting:
 
|}
 
|}
 
{|
 
{|
−
|style="padding: 0px 0px 0px 30px;"|✔ View Support Credit Points Owned By Clients
+
|style="padding: 0px 0px 0px 45px;"|✔ Tiered - Define Tiers Of Usage
 
|}
 
|}
 
{|
 
{|
−
|style="padding: 0px 0px 10px 30px;"|✔ Modify Number Of Support Credit Points Owned By Clients
+
|style="padding: 0px 0px 0px 45px;"|✔ Fixed - Define Usage Grow Over Time
 
|}
 
|}
−
*'''Client Area Features:'''
 
 
{|
 
{|
−
|style="padding: 10px 0px 0px 30px;"|✔ Order Support Credit Points
+
|style="padding: 0px 0px 0px 30px;"|✔ Assign Multiple Products To Single Notification Group
 
|}
 
|}
 
{|
 
{|
−
|style="padding: 0px 0px 0px 30px;"|✔ View Available Support Credit Points Per Ticket Department
+
|style="padding: 0px 0px 0px 30px;"|✔ Assign Email Templates Per Notification Group
 
|}
 
|}
 
{|
 
{|
−
|style="padding: 0px 0px 10px 30px;"|✔ View Number Of Support Credit Points Required To Open Ticket - According To Chosen Department And Priority
+
|style="padding: 0px 0px 0px 30px;"|✔ Enable/Disable Notification Groups
 
|}
 
|}
−
*'''Rules Configuration:'''
 
 
{|
 
{|
−
|style="padding: 10px 0px 0px 30px;"|✔ Set Rule Type - Product/Product Group/Product Addon
+
|style="padding: 0px 0px 10px 30px;"|✔ View Logs Of Sent Notifications
−
|}
+
−
{|
+
−
|style="padding: 0px 0px 0px 30px;"|✔ Define Items Upon Ordering Which, Support Credit Points Are Added To Client's Account
+
−
|}
+
−
{|
+
−
|style="padding: 0px 0px 0px 30px;"|✔ Define Number Of Support Credit Points That Client's Account Shall Be Increased By
+
−
|}
+
−
{|
+
−
|style="padding: 0px 0px 0px 30px;"|✔ Define To Which Department Support Credit Points Should Be Added
+
−
|}
+
−
{|
+
−
|style="padding: 0px 0px 0px 30px;"|✔ Define Whether Support Credit Points Are Added To Client's Account After Each Billing Cycle Or Once Only
+
−
|}
+
−
{|
+
−
|style="padding: 0px 0px 10px 30px;"|✔ View Rule Status
+
 
|}
 
|}
 
*'''General Info:'''
 
*'''General Info:'''
Line 71: Line 42:
 
|}
 
|}
 
{|
 
{|
−
|style="padding: 0px 0px 0px 30px;"|✔ Supports WHMCS Templates Five and Six
+
|style="padding: 0px 0px 0px 30px;"|✔ Supports PHP 5.6 Up To PHP 7.2
 
|}
 
|}
 
{|
 
{|
−
|style="padding: 0px 0px 30px 30px;"|✔ Supports WHMCS V5 and V6
+
|style="padding: 0px 0px 30px 30px;"|✔ Supports WHMCS V7
 
|}
 
|}
  
 
=Installation=
 
=Installation=
 
{|
 
{|
−
|style="padding: 10px 0px 0px 15px;"|'''This tutorial will show you how to successfully install and configure Premium Support Tickets For WHMCS.''' <br />
+
|style="padding: 10px 0px 30px 15px;"|'''This tutorial will show you how to successfully install and configure Hosting Quota Notifications For WHMCS.''' <br />
 
We will guide you step by step through the whole installation and configuration process.
 
We will guide you step by step through the whole installation and configuration process.
 
|}
 
|}
 +
==Installation==
 
{|
 
{|
−
|style="padding: 20px 0px 20px 15px;"|'''1. Log in to your client area and download Premium Support Tickets For WHMCS.'''
+
|style="padding: 10px 0px 20px 15px;"|'''1. Log in to our client area and download the module.'''
 
|}
 
|}
 
{|
 
{|
−
|style="padding: 0px 0px 20px 25px;"|[[File:PST_1.png]]
+
|style="padding: 0px 0px 20px 25px;"|[[File:HQN_1.png]]
 
|}
 
|}
 
{|
 
{|
−
|style="padding: 0px 0px 15px 15px;"|'''2. Upload and extract the module into the main WHMCS directory.'''<br />
+
|style="padding: 0px 0px 10px 15px;"|'''2. In the downloaded file you will find two packages that support different PHP versions.'''<br/>As presented on the screen below, the first one is dedicated to PHP 5.6 up to PHP 7.0, while the second one is aimed at PHP 7.1 up to PHP 7.2.<br/>It does not apply to open source versions.<br/>
−
Files in your WHMCS directory should look like these.
+
'' '''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:PST_2.png]]
+
|style="padding: 0px 0px 20px 25px;"|[[File:PHP56_72.png]]
 
|}
 
|}
 
{|
 
{|
−
|style="padding: 0px 0px 15px 15px;"|'''3. When you install Premium Support Tickets for the first time you have to rename '' 'license_RENAME.php' '' file.'''<br />
+
|style="padding: 0px 0px 15px 15px;"|'''3. Extract the downloaded file and choose the one with the right PHP version. Upload and extract the PHP file into the main WHMCS directory.'''<br />
−
File is located in '' 'modules/addons/SupportTicketsLimiter/license_RENAME.php'. '' Rename it from '' 'license_RENAME.php' '' to '' 'license.php' '' .
+
The content of PHP version files should look like this.  
 
|}
 
|}
 
{|
 
{|
−
|style="padding: 0px 0px 20px 25px;"|[[File:PST_3.png]]
+
|style="padding: 0px 0px 20px 25px;"|[[File:drfere.png]]
 
|}
 
|}
 
{|
 
{|
−
|style="padding: 0px 0px 15px 15px;"|'''4. In order to configure your license key, you have to edit a previously renamed '' 'license.php' '' file.'''<br />
+
|style="padding: 0px 0px 15px 15px;"|'''4. When you install Hosting Quota Notifications For WHMCS for the first time you have to rename '' 'license_RENAME.php' '' file.'''<br />
−
Enter your license key between quotation marks as presented on the following screen. You can find your license key in your client area'' → 'My Products'. ''
+
File is located in '' 'modules/addons/hosting_quota_notifications/license_RENAME.php' '' . Rename it from '' 'license_RENAME.php' '' to '' 'license.php' '' .
 
|}
 
|}
 
{|
 
{|
−
|style="padding: 0px 0px 20px 25px;"|[[File:PST_4.png]]
+
|style="padding: 0px 0px 20px 25px;"|[[File:HQN_3.png]]
 
|}
 
|}
 
{|
 
{|
−
|style="padding: 0px 0px 15px 15px;"|'''5. Now you have to activate the module in your WHMCS system.'''<br />
+
|style="padding: 0px 0px 15px 15px;"|'''5. In order to configure your license key, you have to edit a previously renamed '' 'license.php' '' file.'''<br />
−
Log in to your WHMCS admin area. Go to '' 'Setup' '' → '' 'Addon Modules'. '' Afterwards, find '' 'Premium Support Tickets' '' and press '' 'Activate' '' button.
+
Enter your license key between quotation marks as presented on the following screen. You can find your license key in our client area'' → 'My Products' ''.  
 
|}
 
|}
 
{|
 
{|
−
|style="padding: 0px 0px 20px 25px;"|[[File:PST_5.png]]
+
|style="padding: 0px 0px 30px 25px;"|[[File:HQN_4.png]]
−
|}
+
−
{|
+
−
|style="padding: 0px 0px 15px 15px;"|'''6. In the next step you need to permit access to this module.'''<br />
+
−
To do so click on '' 'Configure' '' button, tick '' 'Access Control' '' near desired admin role groups and press '' 'Save Changes'. ''
+
−
|}
+
−
{|
+
−
|style="padding: 0px 0px 20px 25px;"|[[File:PST_6.png]]
+
−
|}
+
−
{|
+
−
|style="padding: 0px 0px 15px 15px;"|'''7. Proceed to '' 'Addons' '' → '' 'Premium Support Tickets' '' → '' 'Integration Code' '' and follow steps listed there.'''
+
−
Enter adequate tab, depending on which template you are using. There are different code snippets to alter for templates '' 'Six', 'Five' '' and '' 'Default'.''<br/>
+
−
Find and open file '' 'supportticketsubmit-stepone.tpl' '' located in the template directory you are using,  follow the steps described below:
+
−
|}
+
−
{|
+
−
|style="padding: 0px 0px 20px 25px;"|[[File:PST_7.png]]
+
−
|}
+
−
{|
+
−
|style="padding: 0px 0px 15px 15px;"|Find and open file '' 'supportticketsubmit-steptwo.tpl' '' located in the template directory you are using, follow the steps described below: <br/>
+
−
''Please mind the lines numbers, they might differ in your files!''
+
−
|}
+
−
{|
+
−
|style="padding: 0px 0px 20px 25px;"|[[File:PST_8.png]]
+
−
|}
+
−
{|
+
−
|style="padding: 0px 0px 30px 15px;"|'''8. You have just successfully installed Premium Support Tickets For WHMCS!'''
+
 
|}
 
|}
  
−
=Configuration and Management=
+
==Configuration of Addon==
 
{|
 
{|
−
|style="padding: 10px 0px 30px 15px;"|'''At this section we will show you possibilities of Premium Support Tickets For WHMCS.'''<br />
+
|style="padding: 10px 0px 15px 15px;"|'''6. Now you have to activate the module in your WHMCS system.'''<br />
−
Our module allows you to limit the quantity of new support tickets through introducing Support Credit Points.<br />
+
Log in to your WHMCS admin area. Go to '' 'Setup' '' → '' 'Addon Modules' ''. Afterwards, find '' 'Hosting Quota Notifications' '' and press '' 'Activate' '' button.
−
Those Support Credit Points will be required to open new tickets.<br />
+
−
The amount of Support Credit Points required to do so may vary depending on tickets' status and department they are created in.<br />
+
−
Support Credit Points may be obtained along with your products or by ordering special products or product addons.
+
 
|}
 
|}
−
==Rules List==
 
 
{|
 
{|
−
|style="padding: 10px 0px 15px 15px;"|Rules section defines which products or product addons your clients can receive Support Credit Points for.<br />
+
|style="padding: 0px 0px 20px 25px;"|[[File:HQN_5.png]]
−
Additionally, they define which department they can be spent in and if they are granted one time or with product's each billing cycle.<br />
+
−
As you can see, basic information related to the rules is listed under '' 'Rules' → 'Show Rules' '' tab.
+
 
|}
 
|}
 
{|
 
{|
−
|style="padding: 0px 0px 20px 25px;"|[[File:PST_9.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 20px 15px;"|You can view items assigned to the rule as well as departments, which Support Credit Points will be granted to, by pressing buttons marked on the following screen.
+
|style="padding: 0px 0px 30px 25px;"|[[File:HQN_6.png]]
−
|}
+
−
{|
+
−
|style="padding: 0px 0px 20px 25px;"|[[File:PST_10.png]]
+
−
|}
+
−
{|
+
−
|style="padding: 0px 0px 20px 15px;"|Additionally, you can easily manage each of the rules by using buttons in the '' 'Actions' '' column.
+
−
|}
+
−
{|
+
−
|style="padding: 0px 0px 30px 25px;"|[[File:PST_11.png]]
+
 
|}
 
|}
  
−
==Add Rule==
 
 
{|
 
{|
−
|style="padding: 10px 0px 20px 15px;"|Let us add a new rule, press '' 'Add Rule' '' to proceed.
+
|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:PST_12.png]]
+
|style="padding: 0px 0px 30px 25px;"|[[File:HQN_7.png]]
−
|}
+
−
{|
+
−
|style="padding: 0px 0px 15px 15px;"|Step 1. Fill in rule name and select rule type through pressing '' 'Select' '' button next to the desired item.<br />
+
−
Item type selected here defines the type of the item, for ordering which, your clients will receive Support Credit Points.
+
−
|}
+
−
{|
+
−
|style="padding: 0px 0px 20px 25px;"|[[File:PST_13.png]]
+
−
|}
+
−
{|
+
−
|style="padding: 0px 0px 15px 15px;"|Step 2. Select items the order and activation of which will result in receiving Support Credit Points.<br />
+
−
Alternatively, you can switch '' 'Select All' '' to '' 'On', '' then, this rule will be applied to all items in the selected items type.<br />
+
−
Press '' 'Next' '' or '' 'Step 3' '' to continue.
+
−
|}
+
−
{|
+
−
|style="padding: 0px 0px 20px 25px;"|[[File:PST_14.png]]
+
−
|}
+
−
{|
+
−
|style="padding: 0px 0px 15px 15px;"|Step 3. Now, define departments to apply Support Credit Points to by selecting desired ones or switching '' 'Select All' '' to '' 'On'. ''<br />
+
−
Next, select billing options for this rule, fill in amount of Support Credit Points added by the rule and select the rule status.<br />
+
−
Confirm creation of this rule through pressing '' 'Finish' '' button.
+
−
|}
+
−
{|
+
−
|style="padding: 0px 0px 20px 25px;"|[[File:PST_15.png]]
+
−
|}
+
−
{|
+
−
|style="padding: 0px 0px 20px 15px;"|As you can see on the following screen, the rule has been successfully added.
+
−
|}
+
−
{|
+
−
|style="padding: 0px 0px 30px 25px;"|[[File:PST_16.png]]
+
 
|}
 
|}
  
−
==Department Settings==
+
=Configuration and Management=
 
{|
 
{|
−
|style="padding: 10px 0px 15px 15px;"|By default, all tickets are free to open.<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.'''
−
In the '' 'Department Settings' '' tab you can define price per ticket.<br />
+
−
Let's set up support credit points required to open tickets in the '' 'Feedback' '' support department.<br />
+
−
Press '' 'Show Details' '' next to the '' 'Feedback' '' department as shown on the following screen to proceed.
+
 
|}
 
|}
 +
==Configuration==
 
{|
 
{|
−
|style="padding: 0px 0px 20px 25px;"|[[File:PST_17.png]]
+
|style="padding: 10px 0px 15px 15px;"|In '' 'Configuration' '' page you can find the list of configured notification groups.<br />
 +
You can enable/disable any of them, as well as alter or completely remove them.<br />
 +
Press '' 'Create New Group' '' to proceed.
 
|}
 
|}
 
{|
 
{|
−
|style="padding: 0px 0px 15px 15px;"|Now, start by defining base price per ticket, it will be added to the price per ticket status.<br />
+
|style="padding: 0px 0px 20px 25px;"|[[File:HQN_9.png]]
−
Afterwards, fill in the prices for low, normal and high status tickets.<br />
+
−
Confirm those settings through pressing '' 'Save'. ''
+
 
|}
 
|}
 
{|
 
{|
−
|style="padding: 0px 0px 30px 25px;"|[[File:PST_18.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.
 
|}
 
|}
−
 
−
==Clients==
 
 
{|
 
{|
−
|style="padding: 10px 0px 15px 15px;"|In the '' 'Clients' '' tab you can view the amount of Support Credit Points owned by your clients.<br />
+
|style="padding: 0px 0px 20px 25px;"|[[File:HQN_10.png]]
−
You can use filter to search for a specific client.
+
 
|}
 
|}
 
{|
 
{|
−
|style="padding: 0px 0px 20px 25px;"|[[File:PST_19.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;"|To display/hide client's Support Credit Points, press '' 'Show Detailed Information' ''/'' 'Hide  Detailed Information' '' as shown on the screen below.
+
|style="padding: 0px 0px 30px 25px;"|[[File:HQN_11.png]]
 
|}
 
|}
 +
==Logs==
 
{|
 
{|
−
|style="padding: 0px 0px 20px 25px;"|[[File:PST_20.png]]
+
|style="padding: 10px 0px 15px 15px;"|Under '' 'Logs' '' page you can view information about sent notifications.
 
|}
 
|}
 
{|
 
{|
−
|style="padding: 0px 0px 20px 15px;"|You can also manually add/remove credit points to a client, press '' 'Modify Support Credit Points' '' to do so.
+
|style="padding: 0px 0px 30px 25px;"|[[File:HQN_12.png]]
 
|}
 
|}
 +
==Notifications==
 
{|
 
{|
−
|style="padding: 0px 0px 20px 25px;"|[[File:PST_21.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 20px 15px;"|Now, fill in the amount of Support Credit Points to be added or removed and then press '' 'Save'. ''
+
|style="padding: 0px 0px 30px 25px;"|[[File:HQN_13.png]]
−
|}
+
−
{|
+
−
|style="padding: 0px 0px 30px 25px;"|[[File:PST_22.png]]
+
 
|}
 
|}
  
−
==Client Area==
+
=Tips=
 
{|
 
{|
−
|style="padding: 10px 0px 15px 15px;"|Let's proceed to the client area in order to create a ticket.<br />
+
|style="padding: 10px 0px 30px 15px;"|
−
As you can see, one of the departments is unavailable because this client does not own any Support Ticket Points assigned to this department.<br />
+
−
Let's create a ticket in '' '24/7 Support' '' department.
+
−
|}
+
−
{|
+
−
|style="padding: 0px 0px 20px 25px;"|[[File:PST_23.png]]
+
−
|}
+
−
{|
+
−
|style="padding: 0px 0px 15px 15px;"|Clients can view their Support Credit Points for chosen department.<br />
+
−
Additionally, they can see the price per each ticket priority as shown on the following screen.
+
−
|}
+
−
{|
+
−
|style="padding: 0px 0px 20px 25px;"|[[File:PST_24.png]]
+
−
|}
+
−
{|
+
−
|style="padding: 0px 0px 15px 15px;"|As you can see the number of client's points in the department has been reduced from 100 to 90 once the ticket has been correctly submitted.
+
−
|}
+
−
{|
+
−
|style="padding: 0px 0px 30px 25px;"|[[File:PST_25.png]]
+
 
|}
 
|}
  
−
==Sample Workflow==
+
=Update Instructions=
 
{|
 
{|
−
|style="padding: 10px 0px 30px 15px;"|In this section we will show you basic workflow of Premium Support Ticket For WHMCS usage.
+
|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/>
 
|}
 
|}
−
===New Product Department===
 
−
{|
 
−
|style="padding: 10px 0px 15px 15px;"|1. Let's start by creating a new ticket department, proceed to '' 'Setup' '' → '' 'Support' '' → '' 'Support Departments'. ''<br />
 
−
Now, press '' 'Add New Department'. ''
 
−
|}
 
−
{|
 
−
|style="padding: 0px 0px 20px 25px;"|[[File:PST_26.png]]
 
−
|}
 
−
{|
 
−
|style="padding: 0px 0px 15px 15px;"|2. Fill in department name, description and email address.<br />
 
−
Additionally, assign administrators to it, mark '' 'Clients Only' '' and press '' 'Add New Department'. ''
 
−
|}
 
−
{|
 
−
|style="padding: 0px 0px 30px 25px;"|[[File:PST_27.png]]
 
−
|}
 
−
 
−
===New Product Addon===
 
−
{|
 
−
|style="padding: 10px 0px 15px 15px;"|3. Now, let's create a rule, which will add Support Credit Points to the new department.<br />
 
−
In our case, Support Credit Points will be added through product addon.<br />
 
−
Therefore, we need to create the product addon first.<br />
 
−
Proceed to '' 'Setup' '' → '' 'Products/Services' '' → '' 'Product Addons' '' and press '' 'Add New Addon'. ''
 
−
|}
 
−
{|
 
−
|style="padding: 0px 0px 20px 25px;"|[[File:PST_28.png]]
 
−
|}
 
−
{|
 
−
|style="padding: 0px 0px 15px 15px;"|4. Fill in addon name, description and one time pricing.<br />
 
−
Additionally, choose one time billing type, mark '' 'Show on Order' '' and assign desired products.<br />
 
−
Proceed through pressing '' 'Save Changes'. ''
 
−
|}
 
−
{|
 
−
|style="padding: 0px 0px 30px 25px;"|[[File:PST_29.png]]
 
−
|}
 
−
 
−
===New Rule===
 
−
{|
 
−
|style="padding: 10px 0px 20px 15px;"|
 
−
5. Go to '' 'Addons' '' → '' 'Premium Support Ticket' '' and press '' 'Add Rule'. ''<br/>
 
−
6. Fill in the rule name and select '' 'Product Addon' '' rule type.<br />
 
−
7. Now, select previously created product addon and press '' 'Next'. ''<br />
 
−
8. Set up previously created department and select '' 'One Time' '' from '' 'Support Credit Points Frequency' '' dropdown menu.<br />
 
−
Now, fill in 200 into '' 'Support Credit Points' '' field and press '' 'Finish'. ''<br />
 
−
9. As you can see, rule appeared in rule list and is ready for use.
 
−
|}
 
−
{|
 
−
|style="padding: 0px 0px 30px 25px;"|[[File:PST_30.png]]
 
−
|}
 
−
 
−
===Department Configuration===
 
−
{|
 
−
|style="padding: 10px 0px 15px 15px;"|10. Let's set up amount of points required to open tickets in previously created department.<br />
 
−
Proceed to the '' 'Department Settings' '' tab and press '' 'Show Details' '' next to the previously created department.
 
−
|}
 
−
{|
 
−
|style="padding: 0px 0px 15px 15px;"|11. Let's leave '' 'Required Points' '' at 0, and fill in ''Low' '', '' 'Normal' '' and '' 'High' '' ticket statuses sequentially with 30, 60 and 120.<br />
 
−
Press '' 'Save' '' to confirm changes.
 
−
|}
 
−
{|
 
−
|style="padding: 10px 0px 30px 15px;"|[[File:PST_31.png]]
 
−
|}
 
−
 
−
===Example Order===
 
−
{|
 
−
|style="padding: 10px 0px 20px 15px;"|12. Log into client account and order one of product with the previously created product addon.
 
−
|}
 
−
{|
 
−
|style="padding: 0px 0px 30px 25px;"|[[File:PST_29.png]]
 
−
|}
 
−
 
−
===New Ticket===
 
−
{|
 
−
|style="padding: 10px 0px 15px 15px;"|13. After payment, both the product and the ordered along with it product addon are active.<br />
 
−
200 Support Credit Points were granted to this account and now can be spent in '' '24/7 Support' '' department.<br />
 
−
|}
 
−
{|
 
−
|style="padding: 0px 0px 20px 25px;"|[[File:PST_30.png]]
 
−
|}
 
−
{|
 
−
|style="padding: 0px 0px 15px 15px;"|14. Let's use Support Credit Points by opening a new ticket in the '' '24/7 Support' '' department with '' 'High' '' status.<br />
 
−
It will cost 120 Support Credit Points, there should be 200 points on your account so you can afford creating only one ticket with '' 'High' '' status.<br />
 
−
|}
 
−
{|
 
−
|style="padding: 0px 0px 20px 25px;"|[[File:PST_31.png]]
 
−
|}
 
−
{|
 
−
|style="padding: 0px 0px 20px 15px;"|15. As you can see on the following screen, the ticket was successfully created.
 
−
|}
 
−
{|
 
−
|style="padding: 0px 0px 20px 25px;"|[[File:PST_32.png]]
 
−
|}
 
−
{|
 
−
|style="padding: 0px 0px 20px 15px;"|16. Adequate number of Support Credit Points was removed from '' '24/7 Support' '' department points bundle.
 
−
|}
 
−
{|
 
−
|style="padding: 0px 0px 30px 25px;"|[[File:PST_33.png]]
 
−
|}
 
−
 
−
=Tips=
 
−
{|
 
−
|style="padding: 10px 0px 30px 15px;"|1. It is advised to set one of the departments as a free of charge one. Remember to assign it the lowest priority of support to keep other competitive.
 
−
|}
 
−
 
 
=Common Problems=
 
=Common Problems=
 
{|
 
{|
 
|style="padding: 10px 0px 30px 15px;"|'''1. When you have problems with connection, check whether your SELinux or firewall does not block ports.'''
 
|style="padding: 10px 0px 30px 15px;"|'''1. When you have problems with connection, check whether your SELinux or firewall does not block ports.'''
 
|}
 
|}

Latest revision as of 12:02, 13 September 2018

Contents

[edit] About Hosting Quota Notifications For WHMCS

Hosting Quota Notifications For WHMCS allows you to send automatic notifications to your clients whenever they exceed previously set bandwidth or disk usage.

Notifications can be sent in two ways: upon exceeding given resource tier or after exceeding given resource limit in a specified time period.
You can also define email templates and view details of each sent notification owing to logs.

  • Admin Area Features:
✔ Automatically Notify Your Clients Upon Exceeding Defined Limits Of Bandwidth And Disk Usage
✔ Configure Notification Groups
✔ Choose Between Two Types Of Group Counting:
✔ Tiered - Define Tiers Of Usage
✔ Fixed - Define Usage Grow Over Time
✔ Assign Multiple Products To Single Notification Group
✔ Assign Email Templates Per Notification Group
✔ Enable/Disable Notification Groups
✔ View Logs Of Sent Notifications
  • General Info:
✔ Multi-Language Support
✔ Supports PHP 5.6 Up To PHP 7.2
✔ Supports WHMCS V7

[edit] Installation

This tutorial will show you how to successfully install and configure Hosting Quota Notifications For WHMCS.

We will guide you step by step through the whole installation and configuration process.

[edit] Installation

1. Log in to our client area and download the module.
HQN 1.png
2. In the downloaded file you will find two packages that support different PHP versions.
As presented on the screen below, the first one is dedicated to PHP 5.6 up to PHP 7.0, while the second one is aimed at PHP 7.1 up to PHP 7.2.
It does not apply to open source versions.

Note: You can check the current PHP version in your WHMCS. To do so, proceed to 'Utilities' › 'System' › 'PHP Info'.

PHP56 72.png
3. Extract the downloaded file and choose the one with the right PHP version. Upload and extract the PHP file into the main WHMCS directory.

The content of PHP version files should look like this.

Drfere.png
4. When you install Hosting Quota Notifications For WHMCS for the first time you have to rename 'license_RENAME.php' file.

File is located in 'modules/addons/hosting_quota_notifications/license_RENAME.php' . Rename it from 'license_RENAME.php' to 'license.php' .

HQN 3.png
5. In order to configure your license key, you have to edit a previously renamed 'license.php' file.

Enter your license key between quotation marks as presented on the following screen. You can find your license key in our client area → 'My Products' .

HQN 4.png

[edit] Configuration of Addon

6. Now you have to activate the module in your WHMCS system.

Log in to your WHMCS admin area. Go to 'Setup' → 'Addon Modules' . Afterwards, find 'Hosting Quota Notifications' and press 'Activate' button.

HQN 5.png
7. In the next step you need to permit access to this module.

To do so click on 'Configure' button, tick 'Access Control' near required admin role groups and press 'Save Changes' .

HQN 6.png
8. You have just successfully installed Hosting Quota Notifications For WHMCS!

You can access your module in 'Addons' → 'Hosting Quota Notifications' .

HQN 7.png

[edit] Configuration and Management

In this section we will show you how to properly set up and use Hosting Quota Notifications For WHMCS.

[edit] Configuration

In 'Configuration' page you can find the list of configured notification groups.

You can enable/disable any of them, as well as alter or completely remove them.
Press 'Create New Group' to proceed.

HQN 9.png
Now, you can define all products related to this configuration and email template which will be used to notify your clients.

You can choose between two types of resource usage counting:

  • Fixed - define amount of resources over specific time period. If client usage growth has exceeded the given limit in specified time, a notification will be sent.
  • Tiered - defines amount of resources. If client exceeds given limit, a notification will be sent.
HQN 10.png
For example, shown below module uses fixed counting type.

As you can see, we have defined limits for both bandwidth and disk.
Settings shown below result in sending notification to client upon:

  • bandwidth usage growth by 5GB during 21 days.
  • disk usage growth by 100GB over period of 14 days.
HQN 11.png

[edit] Logs

Under 'Logs' page you can view information about sent notifications.
HQN 12.png

[edit] Notifications

You can create as many notifications as you wish.

The only requirement is their type being set to 'Product/Service' .
Additionally, you can use {if} statement, as shown below: 

{if $bw_over} Your bandwidth usage is over {$bw_over}MB{if $bw_current} (current: {$bw_current}MB){/if}.{/if}
{if $disk_over}Your disks usage is over {$disk_over}MB{if $disk_current} (current: {$disk_current}MB){/if}.{/if}

It will allow you to use this email template for bandwidth and disk notifications at the same time.

HQN 13.png

[edit] Tips

[edit] Update Instructions

Essential guidance through the process of updating the module is offered here.

Keep in mind there is a quick and easy option in our client area that will let you upgrade the license of your module to an open source version at any time - and at a lower price!
To take advantage of it, simply use the License Upgrade button located on the product's page and a discounted invoice will be generated automatically.

[edit] Common Problems

1. When you have problems with connection, check whether your SELinux or firewall does not block ports.
Retrieved from "https://www.docs.modulesgarden.com/index.php?title=Hosting_Quota_Notifications_1.X_For_WHMCS&oldid=41245"
Navigation
WHMCS Modules
WHMCS Widgets
Translations
cPanel Modules
General
FAQ
Community