Personal tools
Namespaces

Variants
Actions

Hosting Quota Notifications 1.X For WHMCS

From ModulesGarden Wiki
(Difference between revisions)
Jump to: navigation, search
(→‎About Zendesk Extended For Magento 2)
 
(527 intermediate revisions by 6 users not shown)
Line 1: Line 1:
−
<meta name="keywords" content="zendesk extended for magento 2, zendesk magento 2, magento zendesk, zendesk extended configuration, magento zendesk extended management, magento zendesk extended installation, magento zendesk extended common problems, about magento zendesk extended, magento zendesk extended documentation, magento zendesk extended faq, magento zendesk extended help, magento zendesk extended guide, magento zendesk extended wiki, magento zendesk extended tutorial, magento zendesk extended tips, magento zendesk extended wiki, magento extension"></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 Zendesk Extended For Magento Extension."></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/magento/zendesk-extended-m2 Zendesk Extended For Magento 2]=
+
=About [https://www.modulesgarden.com/products/whmcs/hosting-quota-notifications Hosting Quota Notifications For WHMCS]=
 
{|
 
{|
−
|style="padding: 10px 0px 5px 0px;"|'''Zendesk Extended For Magento 2''' enables the remote use of Zendesk tools upon the integration built between Magento and Zendesk.<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.
−
With this extension, all operations on Zendesk tickets or even the creation of Zendesk accounts can be performed within your eCommerce platform.<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 />
−
Your clients, at the same time, will be free to handle each submitted ticket straight in the Magento customer panel.
+
You can also define email templates and view details of each sent notification owing to logs.
 
|}
 
|}
−
<!-- comments are awesome, aren't they? -->
+
<!--a comment maybe? -->
−
*'''Customer Panel Features:'''
+
*'''Admin Area Features:'''
 
{|
 
{|
−
|style="padding: 10px 0px 0px 30px;"|✔ Open New Ticket
+
|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;"|✔ Add Several Attachments To Each Ticket Message
+
|style="padding: 0px 0px 0px 30px;"|✔ Configure Notification Groups
 
|}
 
|}
 
{|
 
{|
−
|style="padding: 0px 0px 0px 30px;"|✔ Add Reply To Tickets
+
|style="padding: 0px 0px 0px 30px;"|✔ Choose Between Two Types Of Group Counting:
 
|}
 
|}
 
{|
 
{|
−
|style="padding: 0px 0px 0px 30px;"|✔ View Tickets
+
|style="padding: 0px 0px 0px 45px;"|✔ Tiered - Define Tiers Of Usage
 
|}
 
|}
 
{|
 
{|
−
|style="padding: 0px 0px 10px 30px;"|✔ View Tickets Statistics
+
|style="padding: 0px 0px 0px 45px;"|✔ Fixed - Define Usage Grow Over Time
 
|}
 
|}
−
*'''Admin Panel Features:'''
 
 
{|
 
{|
−
|style="padding: 10px 0px 0px 30px;"|✔ View Full Tickets List
+
|style="padding: 0px 0px 0px 30px;"|✔ Assign Multiple Products To Single Notification Group
 
|}
 
|}
 
{|
 
{|
−
|style="padding: 0px 0px 0px 30px;"|✔ Open Ticket Directly From Extension
+
|style="padding: 0px 0px 0px 30px;"|✔ Assign Email Templates Per Notification Group
 
|}
 
|}
 
{|
 
{|
−
|style="padding: 0px 0px 0px 30px;"|✔ Manage Tickets - Reply, Add Notes, Modify Settings, View Logs
+
|style="padding: 0px 0px 0px 30px;"|✔ Enable/Disable Notification Groups
 
|}
 
|}
 
{|
 
{|
−
|style="padding: 0px 0px 0px 30px;"|✔ Delete Single Or Multiple Tickets
+
|style="padding: 0px 0px 10px 30px;"|✔ View Logs Of Sent Notifications
−
|}
+
−
{|
+
−
|style="padding: 0px 0px 0px 30px;"|✔ Display All Selected Customer Tickets On Their Page
+
−
|}
+
−
{|
+
−
|style="padding: 0px 0px 0px 30px;"|✔ Create Zendesk End-User Accounts For Your Clients Automatically
+
−
|}
+
−
{|
+
−
|style="padding: 0px 0px 0px 30px;"|✔ View Full Users List
+
−
|}
+
−
{|
+
−
|style="padding: 0px 0px 0px 30px;"|✔ Add New Admin User Account
+
−
|}
+
−
{|
+
−
|style="padding: 0px 0px 0px 30px;"|✔ Use Default Or Custom Admin Account
+
−
|}
+
−
{|
+
−
|style="padding: 0px 0px 0px 30px;"|✔ Define Custom Signature For Each Admin
+
−
|}
+
−
{|
+
−
|style="padding: 0px 0px 0px 30px;"|✔ Toggle Possibility To Add Attachments To Tickets
+
−
|}
+
−
{|
+
−
|style="padding: 0px 0px 0px 30px;"|✔ Export Tickets Overview - CSV And XML
+
−
|}
+
−
{|
+
−
|style="padding: 0px 0px 10px 30px;"|✔ Define Cache Lifetime - With Ability To Disable Cache
+
 
|}
 
|}
 
*'''General Info:'''
 
*'''General Info:'''
 
{|
 
{|
−
|style="padding: 10px 0px 0px 30px;"|✔ Supports Multiple Attachments In Single Ticket Message
+
|style="padding: 10px 0px 0px 30px;"|✔ Multi-Language Support
−
|}
+
−
{|
+
−
|style="padding: 0px 0px 0px 30px;"|✔ Supports Ticket Tags
+
−
|}
+
−
{|
+
−
|style="padding: 0px 0px 0px 30px;"|✔ Connection Test And Admin Validation
+
−
|}
+
−
{|
+
−
|style="padding: 0px 0px 0px 30px;"|✔ Multi-Language Support
+
 
|}
 
|}
 
{|
 
{|
−
|style="padding: 0px 0px 0px 30px;"|✔ Supports PHP 5.6 Up To PHP 7
+
|style="padding: 0px 0px 0px 30px;"|✔ Supports PHP 5.6 Up To PHP 7.2
 
|}
 
|}
 
{|
 
{|
−
|style="padding: 0px 0px 30px 30px;"|✔ Supports Magento 2.1 And Later
+
|style="padding: 0px 0px 30px 30px;"|✔ Supports WHMCS V7
 
|}
 
|}
  
 
=Installation=
 
=Installation=
 
{|
 
{|
−
|style="padding: 10px 0px 30px 0px;"|'''This tutorial will show you how to successfully install Zendesk Extended For Magento 2.''' <br />
+
|style="padding: 10px 0px 30px 15px;"|'''This tutorial will show you how to successfully install and configure Hosting Quota Notifications For WHMCS.''' <br />
−
We will guide you step by step through the whole installation and configuration process. <br />
+
We will guide you step by step through the whole installation and configuration process.
 
|}
 
|}
 
==Installation==
 
==Installation==
 
{|
 
{|
−
|style="padding: 10px 0px 20px 15px;"|'''1. Log in to your client area and download the module.'''
+
|style="padding: 10px 0px 20px 15px;"|'''1. Log in to our client area and download the module.'''
 
|}
 
|}
 
{|
 
{|
−
|style="padding: 0px 0px 20px 25px;"|[[File:ZEM2_1.png]]
+
|style="padding: 0px 0px 20px 25px;"|[[File:HQN_1.png]]
 
|}
 
|}
 
{|
 
{|
−
|style="padding: 0px 0px 15px 15px;"|'''2. Upload and extract the extension into the main Magento 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/>
−
Extracted files in your Magento directory should look like this:
+
'' '''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:ZEM2_2_1.png]]
+
|style="padding: 0px 0px 20px 25px;"|[[File:PHP56_72.png]]
 
|}
 
|}
 
{|
 
{|
−
|style="padding: 0px 0px 15px 15px;"|'''3. When you install Zendesk Extended For Magento 2 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 '' '/app/code/Modulesgarden/Zendesk/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:ZEM2_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 at 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 30px 25px;"|[[File:ZEM2_4.png]]
+
|style="padding: 0px 0px 20px 25px;"|[[File:HQN_3.png]]
 
|}
 
|}
−
 
−
==Configuration==
 
 
{|
 
{|
−
|style="padding: 10px 0px 15px 15px;"|'''5. Now, log in to Magento and go to '' 'Store' '' → '' 'Configuration' ''.'''<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 />
−
Afterwards, press '' 'Zendesk Extended' '' under '' 'ModulesGarden' '' section.
+
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:ZEM2_5.png]]
+
|style="padding: 0px 0px 30px 25px;"|[[File:HQN_4.png]]
−
|}
+
−
{|
+
−
|style="padding: 0px 0px 15px 15px;"|'''6. In '' 'General' '' section fill in '' 'Subdomain' '', '' 'Username' '' and '' 'Token' '' fields with your connection details. Next, press '' 'Save Config' ''.'''<br />
+
−
''Note: '' 'Subdomain' '' is a subdomain used by your Zendesk server.''<br />
+
−
''For example, as shown on the following screen, a full URL to Zendesk server is '' '<nowiki>https://mgsupport.zendesk.com</nowiki>' ''.''
+
−
|}
+
−
{|
+
−
|style="padding: 0px 0px 20px 25px;"|[[File:ZEM2_6.png]]
+
−
|}
+
−
{|
+
−
|style="padding: 0px 0px 20px 15px;"|'''7. You can also check whether the connection details provided by you are correct, press '' 'Check Connection' '' after saving configuration to do so.'''
+
−
|}
+
−
{|
+
−
|style="padding: 0px 0px 20px 25px;"|[[File:ZEM2_7.png]]
+
−
|}
+
−
{|
+
−
|style="padding: 0px 0px 30px 15px;"|'''8. You have just successfully installed Zendesk Extended For Magento 2!'''
+
 
|}
 
|}
  
−
=Configuration and Management=
+
==Configuration of Addon==
 
{|
 
{|
−
|style="padding: 10px 0px 30px 15px;"|'''Zendesk Extended For Magento 2 will help you gain profits from the usage of Zendesk support platform in your own Magento system.'''
+
|style="padding: 10px 0px 15px 15px;"|'''6. Now you have to activate the module in your WHMCS system.'''<br />
 +
Log in to your WHMCS admin area. Go to '' 'Setup' '' → '' 'Addon Modules' ''. Afterwards, find '' 'Hosting Quota Notifications' '' and press '' 'Activate' '' button.
 
|}
 
|}
−
==Configuration==
 
 
{|
 
{|
−
|style="padding: 10px 0px 30px 15px;"|Let's start by showing you other configuration possibilities of our extension.
+
|style="padding: 0px 0px 20px 25px;"|[[File:HQN_5.png]]
 
|}
 
|}
−
===General===
 
 
{|
 
{|
−
|style="padding: 10px 0px 15px 15px;"|
+
|style="padding: 0px 0px 15px 15px;"|'''7. In the next step you need to permit access to this module.'''<br />
−
In the '' 'General' '' section you can set up access details to your Zendesk server.<br />
+
To do so click on '' 'Configure' '' button, tick '' 'Access Control' '' near required admin role groups and press '' 'Save Changes' ''.
−
It was explained in the installation section of this documentation.<br />
+
−
''Please note that you have to save this configuration before you start configuring next sections!''
+
 
|}
 
|}
−
 
−
===Customer Frontend===
 
 
{|
 
{|
−
|style="padding: 10px 0px 20px 15px;"|'' 'Customer Frontend' '' lets you enable/disable attachments to the tickets, as well as define the default sort order of tickets in the customer panel.
+
|style="padding: 0px 0px 30px 25px;"|[[File:HQN_6.png]]
−
|}
+
−
===Cache===
+
−
{|
+
−
|style="padding: 10px 0px 20px 15px;"|'' 'Lifetime' '' variable in the '' 'Cache' '' section allows you to define how often changes should be synchronized with Zendesk server.<br />
+
−
Any changes made in your Magento result in clearing cache and performing a new synchronization.
+
−
|}
+
−
===Department===
+
−
{|
+
−
|style="padding: 10px 0px 15px 15px;"|'' 'Department' '' - choose a default group (agents) in Zendesk that tickets will be passed to.
+
−
|}
+
−
{|
+
−
|style="padding: 0px 0px 30px 25px;"|[[File:ZEM2_8.png]]
+
−
|}
+
−
{|
+
−
|style="padding: 10px 0px 15px 15px;"|Finally, click the '' 'Save Config' '' button for the second time for the changes to take effect.
+
 
|}
 
|}
  
−
==Settings - Zendesk Account Per Admin==
 
 
{|
 
{|
−
|style="padding: 10px 0px 15px 15px;"|Our extension allows your staff to use multiple accounts on a Zendesk server.<br />
+
|style="padding: 0px 0px 15px 15px;"|'''8. You have just successfully installed Hosting Quota Notifications For WHMCS!'''<br />
−
To set up an account for currently logged in admin, proceed to '' 'Zendesk' '' → '' 'Settings' ''.<br />
+
You can access your module in '' 'Addons' '' → '' 'Hosting Quota Notifications' ''.
−
Now, select '' 'No' '' from '' 'Use Global Settings' '', otherwise your admin will be using a default account on a Zendesk server.
+
 
|}
 
|}
 
{|
 
{|
−
|style="padding: 0px 0px 20px 25px;"|[[File:ZEM2_12.png]]
+
|style="padding: 0px 0px 30px 25px;"|[[File:HQN_7.png]]
−
|}
+
−
{|
+
−
|style="padding: 0px 0px 15px 15px;"|New fields shows up, fill them in with access details to your Zendesk user admin account.<br />
+
−
Additionally, using '' 'Signatures' '' text area you can define a signature added to your replies.<br />
+
−
Confirm through pressing '' 'Save Settings' ''.
+
−
|}
+
−
{|
+
−
|style="padding: 0px 0px 30px 25px;"|[[File:ZEM2_13.png]]
+
 
|}
 
|}
  
−
==Users==
+
=Configuration and Management=
 
{|
 
{|
−
|style="padding: 10px 0px 15px 15px;"|'' 'Users' '' page allows you to view the list of users, which contains both admins and end users.<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.'''
−
As you can see on the following screen, you can find information about each of your users and even search specific ones using filters.<br />
+
−
Additionally, you can edit and remove each account using buttons at the '' 'Action' '' column.
+
 
|}
 
|}
 +
==Configuration==
 
{|
 
{|
−
|style="padding: 0px 0px 20px 25px;"|[[File:ZEM2_14.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;"|You can easily proceed to the tickets of a specific user.<br />
+
|style="padding: 0px 0px 20px 25px;"|[[File:HQN_9.png]]
−
Simply, press the name as shown below.
+
 
|}
 
|}
 
{|
 
{|
−
|style="padding: 0px 0px 30px 25px;"|[[File:ZEM2_15.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.
 
|}
 
|}
−
===Add A New User===
 
 
{|
 
{|
−
|style="padding: 10px 0px 20px 15px;"|In order to add a new user, press '' 'Add User' '' button.
+
|style="padding: 0px 0px 20px 25px;"|[[File:HQN_10.png]]
 
|}
 
|}
 
{|
 
{|
−
|style="padding: 0px 0px 20px 25px;"|[[File:ZEM2_16.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 15px 15px;"|Next, fill in user details and decide what type of account it should be.<br />
+
|style="padding: 0px 0px 30px 25px;"|[[File:HQN_11.png]]
−
You can even add tags and notes to the account, press '' 'Save' '' to confirm creation of the account.<br />
+
−
''Note: Zendesk end-user account is automatically created for the client who does not have one.''
+
 
|}
 
|}
 +
==Logs==
 
{|
 
{|
−
|style="padding: 0px 0px 30px 25px;"|[[File:ZEM2_17.png]]
+
|style="padding: 10px 0px 15px 15px;"|Under '' 'Logs' '' page you can view information about sent notifications.
 
|}
 
|}
−
 
−
==Tickets==
 
 
{|
 
{|
−
|style="padding: 10px 0px 15px 15px;"|Tickets and their details can be viewed at the '' 'Tickets' '' page of our extension.<br />
+
|style="padding: 0px 0px 30px 25px;"|[[File:HQN_12.png]]
−
You can search for a specific ticket using filters.
+
 
|}
 
|}
 +
==Notifications==
 
{|
 
{|
−
|style="padding: 0px 0px 30px 25px;"|[[File:ZEM2_18.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.
 
|}
 
|}
−
===Ticket Overview===
 
 
{|
 
{|
−
|style="padding: 10px 0px 20px 15px;"|In order to view a specific ticket, find it on the list of tickets and click on it.
+
|style="padding: 0px 0px 30px 25px;"|[[File:HQN_13.png]]
−
|}
+
−
{|
+
−
|style="padding: 0px 0px 20px 25px;"|[[File:ZEM2_20.png]]
+
−
|}
+
−
{|
+
−
|style="padding: 0px 0px 15px 15px;"|You will be moved to the ticket page.<br />
+
−
As you can see, here you can view a full conversation and add a new reply.<br />
+
−
Using a sidebar you can easily switch between tabs.
+
−
|}
+
−
{|
+
−
|style="padding: 0px 0px 20px 25px;"|[[File:ZEM2_21.png]]
+
−
|}
+
−
{|
+
−
|style="padding: 0px 0px 20px 15px;"|At '' 'Add Note' '' page you can view previously created notes and add a new one.
+
−
|}
+
−
{|
+
−
|style="padding: 0px 0px 20px 25px;"|[[File:ZEM2_22.png]]
+
−
|}
+
−
{|
+
−
|style="padding: 0px 0px 20px 15px;"|To view the other tickets of the client, proceed to '' 'Other Tickets' '' page.
+
−
|}
+
−
{|
+
−
|style="padding: 0px 0px 20px 25px;"|[[File:ZEM2_23.png]]
+
−
|}
+
−
{|
+
−
|style="padding: 0px 0px 15px 15px;"|You can even change ticket's details at '' 'Options' '' page.<br />
+
−
Here you are able to switch ticket's department, subject, priority and status. You can even add a tag to the ticket.<br />
+
−
''Note: Zendesk server does not allow to reopen a previously closed tickets, so think twice before closing any.''
+
−
|}
+
−
{|
+
−
|style="padding: 0px 0px 20px 25px;"|[[File:ZEM2_24.png]]
+
−
|}
+
−
{|
+
−
|style="padding: 0px 0px 20px 15px;"|All replies are logged, to view the full log, move to the '' 'Log' '' tab.
+
−
|}
+
−
{|
+
−
|style="padding: 0px 0px 20px 25px;"|[[File:ZEM2_25.png]]
+
−
|}
+
−
{|
+
−
|style="padding: 0px 0px 20px 15px;"|In order to go back to the list of tickets, press '' 'Back To Tickets' ''.
+
−
|}
+
−
{|
+
−
|style="padding: 0px 0px 30px 25px;"|[[File:ZEM2_25_1.png]]
+
 
|}
 
|}
  
−
==Front-End - Client Area==
+
=Tips=
 
{|
 
{|
−
|style="padding: 10px 0px 15px 15px;"|Your customers can profit from the integration with Zendesk right away!<br />
+
|style="padding: 10px 0px 30px 15px;"|
−
Let's log into a client's account and press '' 'My Tickets' '' in order to proceed to the ticket dashboard.
+
−
|}
+
−
{|
+
−
|style="padding: 0px 0px 20px 25px;"|[[File:ZEM2_26.png]]
+
−
|}
+
−
{|
+
−
|style="padding: 0px 0px 15px 15px;"|As you can see on the following screen, here you can access the list of previously created tickets and ticket's statistics.<br />
+
−
Now, open a new ticket through pressing '' 'Open Ticket' ''.
+
−
|}
+
−
{|
+
−
|style="padding: 0px 0px 20px 25px;"|[[File:ZEM2_27.png]]
+
−
|}
+
−
{|
+
−
|style="padding: 0px 0px 15px 15px;"|Fill in ticket's subject, its message, type of the ticket and its priority.<br />
+
−
Optionally, you can add an attachment (if admin allows it). Send the ticket through pressing '' 'Submit' ''.
+
−
|}
+
−
{|
+
−
|style="padding: 0px 0px 20px 25px;"|[[File:ZEM2_28.png]]
+
−
|}
+
−
{|
+
−
|style="padding: 0px 0px 15px 15px;"|Now, let's take a look at the ticket itself, where some conversation with administration was already made.<br />
+
−
''Note: If you attach an image file, pressing on it will result in opening it in a new tab of your browser.''
+
−
|}
+
−
{|
+
−
|style="padding: 0px 0px 30px 25px;"|[[File:ZEM2_29.png]]
+
 
|}
 
|}
  
−
=Tips=
+
=Update Instructions=
 
{|
 
{|
−
|style="padding: 10px 0px 10px 15px;"|1. Attachments are saved in the '' 'your_magento\pub' '', therefore make sure you set it as writeable.
+
|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/>
 
|}
 
|}
−
{|
 
−
|style="padding: 0px 0px 10px 15px;"|2. If you use one Zendesk server with multiple Magento platforms, your clients' tickets will be available throughout all the platforms.
 
−
|}
 
−
 
 
=Common Problems=
 
=Common Problems=
 
{|
 
{|
−
|style="padding: 10px 0px 0px 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: 10px 0px 0px 15px;"|'''2. Error '' 'The page you requested was not found, and we have a fine guess why.' '' encountered while choosing '' 'Shipping method' '' condition.'''<br />
+
−
''Reason:'' This is related to Magento bug with missing DHL configuration variables.<br />
+
−
''Solution:'' To solve this please go to '' 'System' '' → '' 'Configuration' '' → '' 'Shipping methods' '' → '' 'DHL' '' and save the configuration.
+
−
|}
+
−
{|
+
−
|style="padding: 0px 0px 30px 15px;"|3. In case of any problems with the extension, that were not mentioned in this article, proceed to [http://www.docs.modulesgarden.com/General#Common_Problems_With_Magento_Extensions Common Problems With Magento Extensions] article.
+
 
|}
 
|}

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