Personal tools
Namespaces

Variants
Actions

Hosting Quota Notifications 1.X For WHMCS

From ModulesGarden Wiki
(Difference between revisions)
Jump to: navigation, search
(→‎Configuration of Addon)
 
(556 intermediate revisions by 6 users not shown)
Line 1: Line 1:
−
<meta name="keywords" content="EasyDCIM for whmcs, EasyDCIM configuration, whmcs EasyDCIM management, whmcs EasyDCIM installation, whmcs EasyDCIM common problems, about whmcs EasyDCIM, whmcs EasyDCIM documentation, whmcs EasyDCIM faq, whmcs EasyDCIM help, whmcs EasyDCIM guide, whmcs EasyDCIM wiki, whmcs EasyDCIM tutorial, whmcs EasyDCIM tips, whmcs EasyDCIM 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 EasyDCIM 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/easydcim/features EasyDCIM For WHMCS]=
+
=About [https://www.modulesgarden.com/products/whmcs/hosting-quota-notifications Hosting Quota Notifications For WHMCS]=
 
{|
 
{|
−
|style="padding: 10px 0px 10px 0px;"|'''EasyDCIM For WHMCS''' will allow you to move provisioning and management of bare metal servers directly to your WHMCS.<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.
−
Module will let your clients overview and manage their servers directly from your client area. They will be able to e.g. reboot servers or view resource usage graphs.<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 />
−
You will be also allowed to monitor, assign and manage all your EasyDCIM regardless of whether they are already ordered by your WHMCS customers or not.
+
You can also define email templates and view details of each sent notification owing to logs.
 
|}
 
|}
−
<!-- fixed -->
+
<!--a comment maybe? -->
−
*'''Client Area Features:'''
+
*'''Admin Area Features:'''
 
{|
 
{|
−
|style="padding: 10px 0px 0px 30px;"|✔ Power On/Off Server
+
|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;"|✔ Assign SoftLayer Server To Hosting
+
|style="padding: 0px 0px 0px 30px;"|✔ Configure Notification Groups
 
|}
 
|}
 
{|
 
{|
−
|style="padding: 0px 0px 10px 30px;"|✔ Assign Hosting To Unassigned SoftLayer Server
+
|style="padding: 0px 0px 0px 30px;"|✔ Choose Between Two Types Of Group Counting:
 
|}
 
|}
−
*'''General Info:'''
 
 
{|
 
{|
−
|style="padding: 10px 0px 0px 30px;"|✔ Supports Bare Metal Servers
+
|style="padding: 0px 0px 0px 45px;"|✔ Tiered - Define Tiers Of Usage
 
|}
 
|}
 
{|
 
{|
−
|style="padding: 0px 0px 0px 30px;"|✔ Multi-Language Support
+
|style="padding: 0px 0px 0px 45px;"|✔ Fixed - Define Usage Grow Over Time
 
|}
 
|}
 
{|
 
{|
−
|style="padding: 0px 0px 0px 30px;"|✔ Supports PHP 5.3 Up To PHP 7
+
|style="padding: 0px 0px 0px 30px;"|✔ Assign Multiple Products To Single Notification Group
 
|}
 
|}
 
{|
 
{|
−
|style="padding: 0px 0px 0px 30px;"|✔ Supports WHMCS Templates Five and Six
+
|style="padding: 0px 0px 0px 30px;"|✔ Assign Email Templates Per Notification Group
 
|}
 
|}
 
{|
 
{|
−
|style="padding: 0px 0px 30px 30px;"|✔ Supports WHMCS V6 and V7
+
|style="padding: 0px 0px 0px 30px;"|✔ Enable/Disable Notification Groups
 
|}
 
|}
−
 
−
=Installation and Configuration=
 
 
{|
 
{|
−
|style="padding: 10px 0px 30px 15px;"|'''This tutorial will show you how to successfully install and configure EasyDCIM For WHMCS.''' <br />
+
|style="padding: 0px 0px 10px 30px;"|✔ View Logs Of Sent Notifications
−
We will guide you step by step through the whole installation and configuration process.
+
 
|}
 
|}
−
==Installation==
+
*'''General Info:'''
 
{|
 
{|
−
|style="padding: 10px 0px 20px 15px;"|'''1. Log in to your client area and download EasyDCIM For WHMCS.'''
+
|style="padding: 10px 0px 0px 30px;"|✔ Multi-Language Support
 
|}
 
|}
 
{|
 
{|
−
|style="padding: 0px 0px 20px 25px;"|[[File:ED_1.png]]
+
|style="padding: 0px 0px 0px 30px;"|✔ Supports PHP 5.6 Up To PHP 7.2
 
|}
 
|}
 
{|
 
{|
−
|style="padding: 0px 0px 15px 15px;"|'''2. Upload and extract the module into the main WHMCS directory.'''<br />
+
|style="padding: 0px 0px 30px 30px;"|✔ Supports WHMCS V7
−
Files in your WHMCS directory should look like these.
+
−
|}
+
−
{|
+
−
|style="padding: 0px 0px 20px 25px;"|[[File:ED_2.png]]
+
 
|}
 
|}
  
−
 
+
=Installation=
−
==Configuration of Server==
+
 
{|
 
{|
−
|style="padding: 10px 0px 15px 15px;"|'''8. Now, we will show you how to configure a new product.''' <br />
+
|style="padding: 10px 0px 30px 15px;"|'''This tutorial will show you how to successfully install and configure Hosting Quota Notifications For WHMCS.''' <br />
−
Go to '' 'Setup' '' → '' 'Products/Services' '' → '' 'Servers' '' and press '' 'Add New Server' '' button.
+
We will guide you step by step through the whole installation and configuration process.
 
|}
 
|}
 +
==Installation==
 
{|
 
{|
−
|style="padding: 0px 0px 20px 25px;"|[[File:ED_7.png]]
+
|style="padding: 10px 0px 20px 15px;"|'''1. Log in to our client area and download the module.'''
 
|}
 
|}
 
{|
 
{|
−
|style="padding: 0px 0px 15px 15px;"|'''9. Next, choose '' 'EasyDCIM' '' from '' 'Type' '' dropdown menu.<br />
+
|style="padding: 0px 0px 20px 25px;"|[[File:HQN_1.png]]
−
Fill in your server name, IP address, username and password and press '' 'Save Changes'. '''''
+
 
|}
 
|}
 
{|
 
{|
−
|style="padding: 0px 0px 20px 25px;"|[[File:ED_8.png]]
+
|style="padding: 0px 0px 10px 15px;"|'''2. In the downloaded file you will find two packages that support different PHP versions.'''<br/>As presented on the screen below, the first one is dedicated to PHP 5.6 up to PHP 7.0, while the second one is aimed at PHP 7.1 up to PHP 7.2.<br/>It does not apply to open source versions.<br/>
 +
'' '''Note''': You can check the current PHP version in your WHMCS. To do so, proceed to ''' 'Utilities' › 'System' › 'PHP Info'.'''
 
|}
 
|}
 
{|
 
{|
−
|style="padding: 0px 0px 15px 15px;"|'''10. After configuring your server correctly, you will see a following screen.''' <br />
+
|style="padding: 0px 0px 20px 25px;"|[[File:PHP56_72.png]]
−
In order to check connection with a EasyDCIM server, simply press '' 'Test Connection' '' as shown on the screen below.  
+
 
|}
 
|}
 
{|
 
{|
−
|style="padding: 0px 0px 20px 25px;"|[[File:ED_9.png]]
+
|style="padding: 0px 0px 15px 15px;"|'''3. Extract the downloaded file and choose the one with the right PHP version. Upload and extract the PHP file into the main WHMCS directory.'''<br />
 +
The content of PHP version files should look like this.  
 
|}
 
|}
 
{|
 
{|
−
|style="padding: 0px 0px 20px 15px;"|'''11. It is time to create a server group, to do so click on '' 'Create Server Group'. ''
+
|style="padding: 0px 0px 20px 25px;"|[[File:drfere.png]]
 
|}
 
|}
 
{|
 
{|
−
|style="padding: 0px 0px 20px 25px;"|[[File:ED_10.png]]
+
|style="padding: 0px 0px 15px 15px;"|'''4. When you install Hosting Quota Notifications For WHMCS for the first time you have to rename '' 'license_RENAME.php' '' file.'''<br />
 +
File is located in '' 'modules/addons/hosting_quota_notifications/license_RENAME.php' '' . Rename it from '' 'license_RENAME.php' '' to '' 'license.php' '' .
 
|}
 
|}
 
{|
 
{|
−
|style="padding: 0px 0px 20px 15px;"|'''12. Enter name, click on your previously created server, press '' 'Add' '' and afterwards '' 'Save Changes'. '''''
+
|style="padding: 0px 0px 20px 25px;"|[[File:HQN_3.png]]
 
|}
 
|}
 
{|
 
{|
−
|style="padding: 0px 0px 30px 25px;"|[[File:ED_11.png]]
+
|style="padding: 0px 0px 15px 15px;"|'''5. In order to configure your license key, you have to edit a previously renamed '' 'license.php' '' file.'''<br />
 +
Enter your license key between quotation marks as presented on the following screen. You can find your license key in our client area'' → 'My Products' ''.  
 
|}
 
|}
−
 
−
==Configuration of Product==
 
 
{|
 
{|
−
|style="padding: 10px 0px 15px 15px;"|'''13. In order to create and configure a product go to '' 'Setup' '' → '' 'Products/Services' '' → '' 'Products/Services'. '''''<br />
+
|style="padding: 0px 0px 30px 25px;"|[[File:HQN_4.png]]
−
Click on '' 'Create a New Group'.''
+
−
|}
+
−
{|
+
−
|style="padding: 0px 0px 20px 25px;"|[[File:ED_12.png]]
+
−
|}
+
−
{|
+
−
|style="padding: 0px 0px 20px 15px;"|'''14. Enter product group name and press '' 'Save Changes'. '''''
+
−
|}
+
−
{|
+
−
|style="padding: 0px 0px 20px 25px;"|[[File:ED_13.png]]
+
−
|}
+
−
{|
+
−
|style="padding: 0px 0px 15px 15px;"|'''15. When you have a product group, you can assign your product to it.'''<br />
+
−
To create a product click on '' 'Create a New Product'.''
+
−
|}
+
−
{|
+
−
|style="padding: 0px 0px 20px 25px;"|[[File:ED_14.png]]
+
−
|}
+
−
{|
+
−
|style="padding: 0px 0px 15px 15px;"|'''16.  Afterwards, choose your product group and enter your product name and press '' 'Continue'. '''''
+
−
|}
+
−
{|
+
−
|style="padding: 0px 0px 20px 25px;"|[[File:ED_15.png]]
+
−
|}
+
−
{|
+
−
|style="padding: 0px 0px 15px 15px;"|'''17. Now go to '' 'Module Settings' '' section, choose both '' 'EasyDCIM' '' and your previously created server group from dropdown menus.<br />
+
−
Next, '' 'Save Changes'. '''''
+
−
|}
+
−
{|
+
−
|style="padding: 0px 0px 20px 25px;"|[[File:ED_17.png]]
+
−
|}
+
−
{|
+
−
|style="padding: 0px 0px 15px 15px;"|'''17. Next, it is time to configure product. On ToDo!!!!
+
−
|}
+
−
{|
+
−
|style="padding: 0px 0px 20px 25px;"|[[File:ED_17.png]]
+
 
|}
 
|}
  
−
 
+
==Configuration of Addon==
−
{|
+
−
|style="padding: 0px 0px 15px 15px;"|'''9. Now, optionally you can generate default configurable options to allow orders tailored to your clients needs.<br />
+
−
We recommend viewing and modyfying them to fit your provisioning capabilities. You can find them under '' 'Setup' '' → '' 'Products/Services' '' → '' 'Configurable Options' ''.
+
−
 
+
−
|}
+
−
{|
+
−
|style="padding: 0px 0px 30px 25px;"|[[File:ED_9.png]]
+
−
|}
+
−
 
+
−
=Management=
+
−
{|
+
−
|style="padding: 10px 0px 30px 15px;"|'''At this section we will show you possibilities of EasyDCIM For WHMCS.'''<br />
+
−
Our module allows you to offer EasyDCIM via your WHMCS system.<br />
+
−
In addition to that, you can easily manage your servers owing to SoftLayer Control Panel addon.
+
−
|}
+
−
==Workflow - From Order To Created Server==
+
−
{|
+
−
|style="padding: 10px 0px 15px 15px;"|Now, we will show you what steps need to be taken to prepare server to be used by a client.<br />
+
−
1. Client orders EasyDCIM from your WHMCS client area.
+
−
|}
+
−
{|
+
−
|style="padding: 0px 0px 20px 25px;"|[[File:ED_13.png]]
+
−
|}
+
−
{|
+
−
|style="padding: 0px 0px 20px 15px;"|2. You will receive an email with server creation request.
+
−
|}
+
−
{|
+
−
|style="padding: 0px 0px 20px 25px;"|[[File:ED_14.png]]
+
−
|}
+
−
{|
+
−
|style="padding: 0px 0px 20px 15px;"|3. Log in to your SoftLayer panel.
+
−
|}
+
−
{|
+
−
|style="padding: 0px 0px 15px 15px;"|4. Create user account (or use the existing one if an account for specified client already exists).<br />
+
−
Remember to set up sufficient account permissions to use all of the client area features of EasyDCIM For WHMCS module.
+
−
|}
+
−
{|
+
−
|style="padding: 0px 0px 20px 15px;"|5. Assign client to machine.
+
−
|}
+
−
{|
+
−
|style="padding: 0px 0px 20px 15px;"|6. Save client username and API key.
+
−
|}
+
−
{|
+
−
|style="padding: 0px 0px 15px 15px;"|7. Go back to your WHMCS admin area and proceed to the '' 'SoftLayer Control Panel' '' → '' 'Ordered Devices' '' → '' 'All'. ''<br />
+
−
Press '' 'Assign Server' '' as shown on the following screen.
+
−
|}
+
−
{|
+
−
|style="padding: 0px 0px 20px 25px;"|[[File:ED_15.png]]
+
−
|}
+
 
{|
 
{|
−
|style="padding: 0px 0px 15px 15px;"|8. Provide here primary IP address of server and previously created user API access details.<br />
+
|style="padding: 10px 0px 15px 15px;"|'''6. Now you have to activate the module in your WHMCS system.'''<br />
−
Confirm assignment through pressing '' 'Save' '' button.<br />
+
Log in to your WHMCS admin area. Go to '' 'Setup' '' → '' 'Addon Modules' ''. Afterwards, find '' 'Hosting Quota Notifications' '' and press '' 'Activate' '' button.
−
''Note 1: Primary IP address of server can be found in '' 'SoftLayer Control Panel' '' → '' 'SoftLayer Devices' '' 26 '' 'Unassigned'. '' ''<br />
+
−
''Note 2: User API access details can be found in SoflLayer panel → '' 'Account' '' → '' 'Users'. ''''
+
 
|}
 
|}
 
{|
 
{|
−
|style="padding: 0px 0px 20px 25px;"|[[File:ED_16.png]]
+
|style="padding: 0px 0px 20px 25px;"|[[File:HQN_5.png]]
 
|}
 
|}
 
{|
 
{|
−
|style="padding: 0px 0px 20px 15px;"|If you assigned server to user correctly, a you should see something similar to the following screen in the client are.
+
|style="padding: 0px 0px 15px 15px;"|'''7. In the next step you need to permit access to this module.'''<br />
 +
To do so click on '' 'Configure' '' button, tick '' 'Access Control' '' near required admin role groups and press '' 'Save Changes' ''.
 
|}
 
|}
 
{|
 
{|
−
|style="padding: 0px 0px 30px 25px;"|[[File:ED_16_1.png]]
+
|style="padding: 0px 0px 30px 25px;"|[[File:HQN_6.png]]
 
|}
 
|}
  
−
==Admin Area==
 
 
{|
 
{|
−
|style="padding: 10px 0px 15px 15px;"|As soon as you set up server for client, you can request various actions and server details from WHMCS admin area.<br />
+
|style="padding: 0px 0px 15px 15px;"|'''8. You have just successfully installed Hosting Quota Notifications For WHMCS!'''<br />
−
'' 'Suspend' ''/'' 'Unsuspend' '' actions change status of user account at the SoftLayer server.<br />
+
You can access your module in '' 'Addons' '' → '' 'Hosting Quota Notifications' ''.
−
'' 'Create' ''/'' 'Terminate' ''/'' 'Change Package' '' actions send an email to admin with specific requests.
+
 
|}
 
|}
 
{|
 
{|
−
|style="padding: 0px 0px 20px 25px;"|[[File:ED_17.png]]
+
|style="padding: 0px 0px 30px 25px;"|[[File:HQN_7.png]]
−
|}
+
−
{|
+
−
|style="padding: 0px 0px 20px 15px;"|Our module allows you to check server power status (1), do commands like: default/soft/hard reboot (2) and even power it on/off (3).
+
−
|}
+
−
{|
+
−
|style="padding: 0px 0px 20px 25px;"|[[File:ED_17_1.png]]
+
−
|}
+
−
{|
+
−
|style="padding: 0px 0px 15px 15px;"|With our module, you are able to view server details.<br />
+
−
Simply, press '' 'Show Server Details' ''.
+
−
|}
+
−
{|
+
−
|style="padding: 0px 0px 20px 25px;"|[[File:ED_18.png]]
+
−
|}
+
−
{|
+
−
|style="padding: 0px 0px 20px 15px;"|As you can see on the following screen, under server details you can find various details about server assigned to your client.
+
−
|}
+
−
{|
+
−
|style="padding: 0px 0px 20px 25px;"|[[File:ED_19.png]]
+
−
|}
+
−
{|
+
−
|style="padding: 0px 0px 20px 15px;"|You can also access server bandwidth graphs through pressing '' 'Show Bandwidth Graph'. ''
+
−
|}
+
−
{|
+
−
|style="padding: 0px 0px 20px 25px;"|[[File:ED_20.png]]
+
−
|}
+
−
{|
+
−
|style="padding: 0px 0px 20px 15px;"|Both, private and public network bandwidth graphs can be accessed that way.
+
−
|}
+
−
{|
+
−
|style="padding: 0px 0px 30px 25px;"|[[File:ED_21.png]]
+
 
|}
 
|}
  
−
==Client Area==
+
=Configuration and Management=
 
{|
 
{|
−
|style="padding: 10px 0px 15px 15px;"|In the client area of module your customer can view all details concerning his server as well as bandwidth graphs.<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.'''
−
They can even manage rDNS records, of course if you only give them such permission.<br />
+
−
Your clients can view server power status (4), switch their servers on/off (5) and order various types of reboot (6-8).  
+
 
|}
 
|}
 +
==Configuration==
 
{|
 
{|
−
|style="padding: 0px 0px 20px 25px;"|[[File:ED_22.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 20px 15px;"|Let's look at '' 'Server Details' ''(1) to you. As you can see, your clients can find here complete server specification.
+
|style="padding: 0px 0px 20px 25px;"|[[File:HQN_9.png]]
 
|}
 
|}
 
{|
 
{|
−
|style="padding: 0px 0px 20px 25px;"|[[File:ED_23.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.
 
|}
 
|}
 
{|
 
{|
−
|style="padding: 0px 0px 20px 15px;"|Your clients can view bandwidth of public and private networks in the '' 'Bandwidth Graphs' '' (2).
+
|style="padding: 0px 0px 20px 25px;"|[[File:HQN_10.png]]
 
|}
 
|}
 
{|
 
{|
−
|style="padding: 0px 0px 20px 25px;"|[[File:ED_24.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;"|'' 'rDNS Management' '' (3) page allows your customers to easily update and remove existing rDNS records.
+
|style="padding: 0px 0px 30px 25px;"|[[File:HQN_11.png]]
 
|}
 
|}
 +
==Logs==
 
{|
 
{|
−
|style="padding: 0px 0px 20px 25px;"|[[File:ED_25.png]]
+
|style="padding: 10px 0px 15px 15px;"|Under '' 'Logs' '' page you can view information about sent notifications.
 
|}
 
|}
 
{|
 
{|
−
|style="padding: 0px 0px 15px 15px;"|Our module also allows your clients to add new rDNS records.<br />
+
|style="padding: 0px 0px 30px 25px;"|[[File:HQN_12.png]]
−
Adding a new rDNS record includes choosing rDNS IP address, providing TTL and hostname and pressing '' 'Add'. ''
+
 
|}
 
|}
 +
==Notifications==
 
{|
 
{|
−
|style="padding: 0px 0px 30px 25px;"|[[File:ED_26.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.
 
|}
 
|}
−
==EasyDCIM Addon==
 
 
{|
 
{|
−
|style="padding: 10px 0px 30px 15px;"|In '' 'EasyDCIM' '' addon you can view the list of all orders of SoftLayer product and the list of available dedicated servers.<br/>
+
|style="padding: 0px 0px 30px 25px;"|[[File:HQN_13.png]]
−
Let's proceed to further possibilities of our addon.
+
−
|}
+
−
===SoftLayer Product Orders===
+
−
{|
+
−
|style="padding: 10px 0px 15px 15px;"|'' 'Ordered Services' '' tab allows you to view the list of all ordered EasyDCIM products.<br/>
+
−
Orders are sorted by their status, each tab contains orders with different statuses.<br/>
+
−
In addition, you can view basic details of each order, such as client who made it, hosting id or assigned server.
+
−
|}
+
−
{|
+
−
|style="padding: 0px 0px 20px 25px;"|[[File:ED_27.png]]
+
−
|}
+
−
{|
+
−
|style="padding: 0px 0px 15px 15px;"|From here you can also easily assign server to hosting or change assigned server if hosting already have one assigned.<br />
+
−
Server assignment is shown at the [[#Workflow_-_From_Order_To_Created_Server|'''Workflow''']] section.<br />
+
−
Let's see how to easily remove assigned server.<br />
+
−
For that purpose press '' 'Change Assignment' '' button.
+
−
|}
+
−
{|
+
−
|style="padding: 0px 0px 20px 25px;"|[[File:ED_28.png]]
+
−
|}
+
−
{|
+
−
|style="padding: 0px 0px 20px 15px;"|Afterwards, press '' 'Remove Assignment' '' button.
+
−
|}
+
−
{|
+
−
|style="padding: 0px 0px 30px 25px;"|[[File:ED_29.png]]
+
 
|}
 
|}
  
−
===SoftLayer Devices===
+
=Tips=
 
{|
 
{|
−
|style="padding: 10px 0px 20px 15px;"|In order to view list of your EasyDCIM proceed to '' 'SoftLayer Devices' '' → '' 'All'. ''
+
|style="padding: 10px 0px 30px 15px;"|
−
|}
+
−
{|
+
−
|style="padding: 0px 0px 20px 25px;"|[[File:ED_30.png]]
+
−
|}
+
−
{|
+
−
|style="padding: 0px 0px 15px 15px;"|List of all unassigned EasyDCIM can be accessed under '' 'SoftLayer Devices' '' → '' 'Unassigned'. ''<br />
+
−
From here you can even assign server to hosting through pressing '' 'Assign To Hosting''' button.
+
−
|}
+
−
{|
+
−
|style="padding: 0px 0px 20px 25px;"|[[File:ED_31.png]]
+
−
|}
+
−
{|
+
−
|style="padding: 0px 0px 20px 15px;"|Afterwards, choose hosting you wish to assign server to, fill API access details of SoftLayer user created for your customer and press '' 'Save'. ''
+
−
|}
+
−
{|
+
−
|style="padding: 0px 0px 30px 25px;"|[[File:ED_32.png]]
+
 
|}
 
|}
  
−
=Tips=
+
=Update Instructions=
 
{|
 
{|
−
|style="padding: 10px 0px 5px 15px;"|1. We advice to create one SoftLayer user per each order.<br />
+
|style="padding: 10px 0px 30px 15px;"|Essential guidance through the process of updating the module is offered '''[https://www.docs.modulesgarden.com/How_To_Update_WHMCS_Module here]'''.<br/><br/>
−
Currently, suspending SoftLayer hosting suspends SoftLayer user bounded to it.
+
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 5px 15px;"|2. If a reboot command has been issued successfully in the past 20 minutes, another remote management command will not be allowed.<br />
 
−
This is to avoid any type of server failures.
 
−
|}
 
−
{|
 
−
|style="padding: 0px 0px 30px 15px;"|3. If you want to disable displaying of API access details form in your template there is two things you need to do.<br />
 
−
1. Check '' 'Hide API Access Details' '' checkbox at your SoftLayer product → '' 'Module Settings' ''.<br />
 
−
2. Modify your template → '' 'clientareaproductdetails.tpl' '' as shown below:
 
−
{if $username}
 
−
//code responsible for displaying form with API access details
 
−
{/if}
 
−
''Note: Portal template already has such solution in its clientareaproductdetails.tpl file, so you can view how it's implemented.''
 
−
|}
 
−
 
 
=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