Personal tools
Namespaces

Variants
Actions

Hosting Quota Notifications 1.X For WHMCS

From ModulesGarden Wiki
(Difference between revisions)
Jump to: navigation, search
(→‎Settings)
 
(73 intermediate revisions by 3 users not shown)
Line 1: Line 1:
−
<meta name="keywords" content="emoji for whmcs, whmcs emoji configuration, whmcs emoji management, whmcs emoji installation, whmcs emoji common problems, about whmcs emoji, whmcs emoji documentation, whmcs emoji faq, whmcs emoji help, whmcs emoji guide, whmcs emoji wiki, whmcs emoji tutorial, whmcs emoji tips, whmcs emoji wiki, emoticons for whmcs, whmcs emoticons configuration, whmcs emoticons management, whmcs emoticons installation, whmcs emoticons common problems, about whmcs emoticons, whmcs emoticons documentation, whmcs emoticons faq, whmcs emoticons help, whmcs emoticons guide, whmcs emoticons wiki, whmcs emoticons tutorial, whmcs emoticons tips, whmcs emoticons 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 Emoji Picker 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/emoji-picker Emoji Picker For WHMCS]=
+
=About [https://www.modulesgarden.com/products/whmcs/hosting-quota-notifications Hosting Quota Notifications For WHMCS]=
 
{|
 
{|
−
|style="padding: 10px 0px 5px 0px;"|'''Emoji Picker For WHMCS''' will let both your clients and support teams add emojis to ticket conversations.<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.
−
You will be empowered to choose support departments that should display emojis and decide whether these symbols shall be visible in the admin 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 also provides support for emoji domains, allowing conversion of your clients' domain names from a Punycode format to emoji artworks.
+
You can also define email templates and view details of each sent notification owing to logs.
 
|}
 
|}
−
*'''Client Area Features:'''
+
<!--a comment maybe? -->
 +
*'''Admin Area Features:'''
 
{|
 
{|
−
|style="padding: 10px 0px 0px 30px;"|✔ Use Emoji In Tickets By:
+
|style="padding: 10px 0px 0px 30px;"|✔ Automatically Notify Your Clients Upon Exceeding Defined Limits Of Bandwidth And Disk Usage
 
|}
 
|}
 
{|
 
{|
−
|style="padding: 0px 0px 0px 45px;"|✔ Typing Emoji Code
+
|style="padding: 0px 0px 0px 30px;"|✔ Configure Notification Groups
 
|}
 
|}
 
{|
 
{|
−
|style="padding: 0px 0px 0px 45px;"|✔ Using Emoji Search Picker
+
|style="padding: 0px 0px 0px 30px;"|✔ Choose Between Two Types Of Group Counting:
 
|}
 
|}
 
{|
 
{|
−
|style="padding: 0px 0px 0px 30px;"|✔ Display Emoji In Ticket-Related Email Notifications
+
|style="padding: 0px 0px 0px 45px;"|✔ Tiered - Define Tiers Of Usage
 
|}
 
|}
 
{|
 
{|
−
|style="padding: 0px 0px 0px 30px;"|✔ Replace Punycode With Emoji Domains On:
+
|style="padding: 0px 0px 0px 45px;"|✔ Fixed - Define Usage Grow Over Time
 
|}
 
|}
 
{|
 
{|
−
|style="padding: 0px 0px 0px 45px;"|✔ Domains List And Domain Details
+
|style="padding: 0px 0px 0px 30px;"|✔ Assign Multiple Products To Single Notification Group
 
|}
 
|}
 
{|
 
{|
−
|style="padding: 0px 0px 0px 45px;"|✔ Services List And Service Details
+
|style="padding: 0px 0px 0px 30px;"|✔ Assign Email Templates Per Notification Group
 
|}
 
|}
 
{|
 
{|
−
|style="padding: 0px 0px 0px 45px;"|✔ HTML Invoice
+
|style="padding: 0px 0px 0px 30px;"|✔ Enable/Disable Notification Groups
 
|}
 
|}
 
{|
 
{|
−
|style="padding: 0px 0px 10px 45px;"|✔ Specific Email Notifications
+
|style="padding: 0px 0px 10px 30px;"|✔ View Logs Of Sent Notifications
 
|}
 
|}
−
 
−
*'''Admin Area Features:'''
 
−
{|
 
−
|style="padding: 10px 0px 0px 30px;"|✔ Toggle Emoji Availability For Each Support Department
 
−
|}
 
−
{|
 
−
|style="padding: 0px 0px 0px 30px;"|✔ Define Emoji Visibility In Admin Area
 
−
|}
 
−
{|
 
−
|style="padding: 0px 0px 0px 30px;"|✔ Use Emoji In Tickets By:
 
−
|}
 
−
{|
 
−
|style="padding: 0px 0px 0px 45px;"|✔ Typing Emoji Code
 
−
|}
 
−
{|
 
−
|style="padding: 0px 0px 0px 45px;"|✔ Using Emoji Search Picker
 
−
|}
 
−
{|
 
−
|style="padding: 0px 0px 0px 30px;"|✔ Toggle Converting Of Punycode To Emoji Domains
 
−
|}
 
−
{|
 
−
|style="padding: 0px 0px 10px 30px;"|✔ View And Delete Logs
 
−
|}
 
−
 
 
*'''General Info:'''
 
*'''General Info:'''
 
{|
 
{|
−
|style="padding: 10px 0px 0px 30px;"|✔ Supports Emoji Artworks Provided By [https://www.emojione.com/ EmojiOne]
+
|style="padding: 10px 0px 0px 30px;"|✔ Multi-Language Support
−
|}
+
−
{|
+
−
|style="padding: 0px 0px 0px 30px;"|✔ Custom Templates Support
+
−
|}
+
−
{|
+
−
|style="padding: 0px 0px 0px 30px;"|✔ Multi-Language Support
+
 
|}
 
|}
 
{|
 
{|
Line 74: Line 45:
 
|}
 
|}
 
{|
 
{|
−
|style="padding: 0px 0px 0px 30px;"|✔ Supports WHMCS Template Six
+
|style="padding: 0px 0px 30px 30px;"|✔ Supports WHMCS V7
−
|}
+
−
{|
+
−
|style="padding: 0px 0px 30px 30px;"|✔ Supports WHMCS V7.2 And Later
+
 
|}
 
|}
  
−
=Installation and Configuration=
+
=Installation=
 
{|
 
{|
−
|style="padding: 10px 0px 0px 0px;"|'''This tutorial will show you how to successfully install and configure Emoji Picker 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==
 
==Installation==
Line 90: Line 58:
 
|}
 
|}
 
{|
 
{|
−
|style="padding: 0px 0px 20px 25px;"|[[File:EM_1.png]]
+
|style="padding: 0px 0px 20px 25px;"|[[File:HQN_1.png]]
 
|}
 
|}
 
{|
 
{|
−
|style="padding: 0px 0px 15px 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/>
+
|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'.'''
+
'' '''Note''': You can check the current PHP version in your WHMCS. To do so, proceed to ''' 'Utilities' › 'System' › 'PHP Info'.'''
 
|}
 
|}
 
{|
 
{|
Line 101: Line 69:
 
{|
 
{|
 
|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 />
 
|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 your PHP version files should look like this.  
+
The content of PHP version files should look like this.  
 
|}
 
|}
 
{|
 
{|
−
|style="padding: 0px 0px 20px 25px;"|[[File:EM_2.png]]
+
|style="padding: 0px 0px 20px 25px;"|[[File:drfere.png]]
 
|}
 
|}
 
{|
 
{|
−
|style="padding: 0px 0px 15px 15px;"|'''4. When you install Emoji Picker For WHMCS for the first time, you have to rename the '' '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 />
−
This file is located in '' 'yourWHMCS/modules/addons/Emoji/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:EM_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 the 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 the quotation marks as presented on the following screen. You can find your license key in our 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:EM_4.png]]
+
|style="padding: 0px 0px 30px 25px;"|[[File:HQN_4.png]]
−
|}
+
−
{|
+
−
|style="padding: 0px 0px 15px 15px;"|'''6. Now, set up the  '' 'storage' '' folder as recursively writable.'''<br />
+
−
This folder is available at '' 'yourWHMCS/modules/addons/Emoji/' ''.
+
−
|}
+
−
{|
+
−
|style="padding: 0px 0px 30px 25px;"|[[File:EM_5.png]]
+
 
|}
 
|}
  
−
==Activation==
+
==Configuration of Addon==
 
{|
 
{|
−
|style="padding: 10px 0px 15px 15px;"|'''7. 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 and proceed to '' 'Setup' '' → '' 'Addon Modules'. ''<br />
+
Log in to your WHMCS admin area. Go to '' 'Setup' '' → '' 'Addon Modules' ''. Afterwards, find '' 'Hosting Quota Notifications' '' and press '' 'Activate' '' button.
−
Afterward, find '' 'Emoji Picker' '' and press the '' 'Activate' '' button.
+
 
|}
 
|}
 
{|
 
{|
−
|style="padding: 0px 0px 20px 25px;"|[[File:EM_6.png]]
+
|style="padding: 0px 0px 20px 25px;"|[[File:HQN_5.png]]
 
|}
 
|}
 
{|
 
{|
−
|style="padding: 0px 0px 15px 15px;"|'''8. In the next step you need to 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 the '' 'Configure' '' button and tick the checkboxes to assign desired admin roles.
+
To do so click on '' 'Configure' '' button, tick '' 'Access Control' '' near required admin role groups and press '' 'Save Changes' ''.
 
|}
 
|}
 
{|
 
{|
−
|style="padding: 0px 0px 20px 25px;"|[[File:EM_7.png]]
+
|style="padding: 0px 0px 30px 25px;"|[[File:HQN_6.png]]
−
|}
+
−
{|
+
−
|style="padding: 0px 0px 30px 15px;"|'''9. Congratulations, you have just successfully installed Emoji Picker For WHMCS!'''
+
 
|}
 
|}
  
−
==Configuration==
 
 
{|
 
{|
−
|style="padding: 10px 0px 30px 15px;"|'''Now you need to configure your newly installed module.'''<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' ''.
 
|}
 
|}
−
===Settings===
 
 
{|
 
{|
−
|style="padding: 10px 0px 15px 15px;"|Proceed to '' 'Addons' → 'Emoji' → 'Settings' '' to configure the following options:
+
|style="padding: 0px 0px 30px 25px;"|[[File:HQN_7.png]]
−
 
+
−
* '''Support Department Settings''' - choose which of your support departments will display emojis.<br/> Your clients will be able to use emojis while creating or replying in tickets, as well as view emojis in email notifications.<br/>''Note that you can change the status of multiple departments at once by using mass actions.''
+
−
 
+
−
* '''Emoji Search Picker In Text Area''' - if enabled, the emoji popup will be displayed when entering the emoji code in the ticket.
+
−
 
+
−
* '''Emoji Search Picker In Toolbar ''' - if enabled, the button with emoji search picker will be displayed in the ticket editor toolbar.
+
−
 
+
−
* '''Emoji In Admin Area''' - toggle on if you want the administrators to view and use emojis when creating and replying in tickets.<br/>If disabled, they will be visible in the admin area only in the form of emoji codes.<br/>''Note that your support can still type remembered emoji codes which will continue to be visible as artworks for your clients.
+
−
 
+
−
* '''Replace Domains With Emoji''' - toggle on if you want to have support for [https://en.wikipedia.org/wiki/Emoji_domain emoji domains].<br/>This will allow your clients to view already provided domains in [https://en.wikipedia.org/wiki/Punycode Punycode] format (''for example www.xn--qei8618mfvb.tld'') with [https://unicode.org/emoji/charts/emoji-list.html unicode emoji] (''for example www.''❤🍺😉''.tld'') in your client area<br/>''Note that this will also convert Punycode to the unicode emoji in the domain-related emails as well as on the HTML invoices.''
+
−
 
+
−
* ''' Characters Number For Popup Display''' - specify how many characters should be entered after the colon in order to display the emoji popup.<br/>E.g. if left for '' '0' '' then the emoji picker will be displayed immediately after the colon character is entered. For '' '1' '' the first emoji character name needs to be entered after colon e.t.c.<br/>''Note that 'Emoji Search Picker In Text Area' option must be enabled for this option.''
+
−
|}
+
−
{|
+
−
|style="padding: 0px 0px 30px 25px;"|[[File:EM_8.png]]
+
 
|}
 
|}
  
−
===Logs===
+
=Configuration and Management=
 
{|
 
{|
−
|style="padding: 10px 0px 20px 15px;"|The logs provide data about particular domain orders, invoices or email massages to which emojis have been successfully applied. The section also includes information concerning any existing errors.
+
|style="padding: 10px 0px 30px 15px;"|'''In this section we will show you how to properly set up and use Hosting Quota Notifications For WHMCS.'''
 
|}
 
|}
 +
==Configuration==
 
{|
 
{|
−
|style="padding: 0px 0px 30px 25px;"|[[File:EM_9.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.
 
|}
 
|}
−
 
−
=Management=
 
 
{|
 
{|
−
|style="padding: 10px 0px 30px 15px;"|'''Once Emoji Picker For WHMCS is installed and configured, you can use emoji in tickets as well as view them in domain names instead of a Punycode format.'''<br/>
+
|style="padding: 0px 0px 20px 25px;"|[[File:HQN_9.png]]
 
|}
 
|}
−
==Support Tickets==
 
−
===Client Area===
 
 
{|
 
{|
−
|style="padding: 10px 0px 20px 15px;"|In the client area, you can use emojis in tickets submitted in any of support departments with enabled emoji support.
+
|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:EM_10.png]]
+
|style="padding: 0px 0px 20px 25px;"|[[File:HQN_10.png]]
 
|}
 
|}
 
{|
 
{|
−
|style="padding: 0px 0px 15px 15px;"|When you compose a message and the '' 'Emoji Search Picker In Text Area' '' option is enabled in [https://www.docs.modulesgarden.com/Emoji_Picker_For_WHMCS#Settings settings], you can insert emoji by pressing ''':''' (colon).<br/>This will start showing the list of available emojis depending on the '' 'Characters Number For Popup Display' '' setting.<br/>Continue typing the name to search for available emoji.<br/>When ready, click on the chosen emoji to insert it or end its name using ''':''' (colon) again.
+
|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 25px;"|[[File:EM_11.png]]
+
|style="padding: 0px 0px 30px 25px;"|[[File:HQN_11.png]]
 
|}
 
|}
 +
==Logs==
 
{|
 
{|
−
|style="padding: 0px 0px 20px 15px;"|You can also view, browse and search through all available symbols by clicking on emoji picker if the '' 'Emoji Search Picker In Toolbar' '' option was enabled in [https://www.docs.modulesgarden.com/Emoji_Picker_For_WHMCS#Settings settings].
+
|style="padding: 10px 0px 15px 15px;"|Under '' 'Logs' '' page you can view information about sent notifications.
 
|}
 
|}
 
{|
 
{|
−
|style="padding: 0px 0px 20px 25px;"|[[File:EM_12.png]]
+
|style="padding: 0px 0px 30px 25px;"|[[File:HQN_12.png]]
 
|}
 
|}
 +
==Notifications==
 
{|
 
{|
−
|style="padding: 0px 0px 20px 15px;"|When the composed massage is sent, the inserted emoji codes are replaced with emoji artworks.
+
|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 25px;"|[[File:EM_13.png]]
+
|style="padding: 0px 0px 30px 25px;"|[[File:HQN_13.png]]
−
|}
+
−
{|
+
−
|style="padding: 0px 0px 20px 15px;"|This also applies to the tickets-related email notifications.
+
−
|}
+
−
{|
+
−
|style="padding: 0px 0px 30px 25px;"|[[File:EM_14.png]]
+
−
|}
+
−
 
+
−
===Admin Area===
+
−
{|
+
−
|style="padding: 10px 0px 15px 15px;"|If you have the '' 'Emoji In Admin Area' '' option enabled in the addon [https://www.docs.modulesgarden.com/Emoji_Picker_For_WHMCS#Settings settings], your support administrators can view and use emojis in their tickets as well. <br/>
+
−
'' '''Note''' that the 'Emoji Search Picker In Text Area' and 'Emoji Search Picker In Toolbar' options are also applied for this area.
+
−
|}
+
−
{|
+
−
|style="padding: 0px 0px 20px 25px;"|[[File:EM_15.png]]
+
−
|}
+
−
{|
+
−
|style="padding: 0px 0px 15px 15px;"|Otherwise, your support administrators will not be able to enter emojis, neither they will see them as artworks in messages.<br/>
+
−
'' '''Note''' that your support can still type remembered emoji codes which will continue to be visible as artworks for your clients.''
+
−
|}
+
−
{|
+
−
|style="padding: 0px 0px 30px 25px;"|[[File:EM_16.png]]
+
−
|}
+
−
 
+
−
==Domains==
+
−
{|
+
−
|style="padding: 10px 0px 15px 15px;"|The module can convert domains in the Punycode format to emoji domains.<br/>This applies to client area domain lists, service lists with domains, their details, as well as HTML invoices and email notifications related to domains.<br/>
+
−
 
+
−
'' '''Important:''' Read the second point of [https://www.docs.modulesgarden.com/Emoji_Picker_For_WHMCS#Common_Problems common problems] section explaining WHMCS problems with registration of emoji domains.''
+
−
<br/><br/>
+
−
For example, WHMCS displays a list of emoji domains in their original Punycode format by deafult.
+
−
|}
+
−
{|
+
−
|style="padding: 0px 0px 20px 25px;"|[[File:EM_17.png]]
+
−
|}
+
−
{|
+
−
|style="padding: 0px 0px 15px 15px;"|When you enable the '' 'Replace Domains With Emoji' '' option in the addon [https://www.docs.modulesgarden.com/Emoji_Picker_For_WHMCS#Settings settings], the Punycode will be replaced in the client area with the emoji format.<br/>
+
−
'' '''Note:''' The domains use [https://unicode.org/emoji/charts/full-emoji-list.html unicode emoji], not the graphical artworks as presented in tickets. This means that their appearance may differ depending on the web browser.''
+
−
|}
+
−
{|
+
−
|style="padding: 0px 0px 20px 25px;"|[[File:EM_18.gif]]
+
−
|}
+
−
{|
+
−
|style="padding: 0px 0px 15px 15px;"|This will also apply to several email notifications related to the domains. Currently, the supported email templates are:
+
−
*Support Ticket Reply
+
−
*Support Ticket Opened
+
−
*Support Ticket Opened by Admin
+
−
*Invoice Created
+
−
*Order Confirmation
+
−
*Invoice Payment Confirmation
+
−
|}
+
−
{|
+
−
|style="padding: 0px 0px 20px 25px;"|[[File:EM_19.png]]
+
−
|}
+
−
{|
+
−
|style="padding: 0px 0px 15px 15px;"|The same goes for HTML invoices.<br/>
+
−
'' '''Note:''' Currently, the domains on the PDF invoices will still be shown in the Punycode format.''
+
−
|}
+
−
{|
+
−
|style="padding: 0px 0px 30px 25px;"|[[File:EM_20.png]]
+
 
|}
 
|}
  
 
=Tips=
 
=Tips=
 
{|
 
{|
−
|style="padding: 10px 0px 10px 15px;"|1. The module supports only '''the WHMCS built-in ticket system'''.<br/>Separate ticketing systems such as [https://www.modulesgarden.com/products/whmcs/zendesk Zendesk], [https://www.modulesgarden.com/products/whmcs/kayako Kayako], [https://www.modulesgarden.com/products/whmcs/freshdesk Freshdesk] etc. are '''not''' supported by this module.
+
|style="padding: 10px 0px 30px 15px;"|
−
|}
+
−
{|
+
−
|style="padding: 0px 0px 10px 15px;"|2. If you plan to use emoji domains, it is recommended that the  '' '[https://docs.whmcs.com/Domains_Tab#Allow_IDN_Domains Allow IDN Domains]' '' option is enabled in your WHMCS general settings.
+
−
|}
+
−
{|
+
−
|style="padding: 0px 0px 30px 15px;"|3. The feature of replacing domains with emoji works only for the client area.<br/>In the admin area, these domains will be still displayed using Punycode.
+
 
|}
 
|}
  
Line 290: Line 178:
 
=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.'''
−
|}
+
−
{|
+
−
|style="padding: 0px 0px 10px 15px;"|2. This module '''does not''' fix the problem of broken emoji domain registration system occurring directly in WHMCS.<br/>It is due to WHMCS solely that the registration attempt of a domain with emoji artworks or with emoji already converted to Punycode is automatically cleared from the '' 'Domain' '' field after placing an order.<br/>Our module only converts the already properly applied Punycode domain into emoji (e.g. when a client uses the existing domain for their service or the Punycode is placed manually into the domain field by the administrator).
+
−
|}
+
−
{|
+
−
|style="padding: 0px 0px 10px 15px;"|3. The 1.0 version does not replace the domain Punycode format on PDF invoices. This feature works only with HTML invoices for the time being.
+
−
|}
+
−
{|
+
−
|style="padding: 0px 0px 10px 15px;"|4. In the WHMCS versions prior to 7.5, the emoji domain replacement will not work on the order summary, and the domain will still be diplayed in the Punycode format there.<br/> This is caused by lack of a required WHMCS hook.
+
−
|}
+
−
{|
+
−
|style="padding: 0px 0px 10px 15px;"|5. It may turn out that when you preview an email in the WHMCS client's profile in the admin area, the message is suddenly cut off at the point where the emoji domain name should start.<br/>This is a WHMCS bug and despite this inconvenience, the message itself is sent to the client correctly.
+
−
|}
+
−
{|
+
−
|style="padding: 0px 0px 30px 15px;"|6. Emoji Picker For WHMCS is currently '''not''' compatible with [https://www.modulesgarden.com/products/whmcs/multibrand Multibrand For WHMCS] or [https://www.modulesgarden.com/products/whmcs/resellers-center Resellers Center For WHMCS] modules. Do not use these products together.
+
 
|}
 
|}

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