Personal tools
Namespaces

Variants
Actions

Hosting Quota Notifications For WHMCS

From ModulesGarden Wiki
Jump to: navigation, search

Contents

About Hosting Quota Notifications For WHMCS

Hosting Quota Notifications For WHMCS allows to define rules on clients' services bandwidth and disk usage limits according to which automatic email notifications can be sent and tickets opened
to let the clients know they have exceed the previously set service usage.

Prepare ticket templates and their translations, use default email template or prepare your custom ones.

  • Module:
✔ Send Automated Notifications To Clients When They Exceed Defined Bandwidth And Disk Usage:
✔ By Email
✔ By Ticket
✔ Configure Notification Rules:
✔ Enable/Disable Notification Rules
✔ Choose Between Two Types Of Overages Calculation:
✔ Tiered - Define Tiers Of Resource Usage
✔ Fixed - Define Resource Usage In Specific Time Periods
✔ Assign Multiple Products To Single Notification Rule
✔ Assign Default Email Template
✔ Define Hours Interval Of Notification
✔ Configure Steps Per Disk And Bandwidth Rule:
✔ Define Resource Overage Values:
✔ In Specific Unit (MB, GB, TB)
✔ Based On Percentage Value Of WHMCS Soft Limit
✔ Assign Email And Ticket Templates Per Notification Rule Step
✔ Define Time Period Of Overage Calculation For Fixed Rule Step
✔ Define Action Taken Upon Resource Value Exceeding:
✔ None
✔ Auto-Suspend Product
✔ Auto-Terminate Product
✔ Configure Ticket Templates In Multiple Languages
✔ View Daily Usage Of Specific Service
✔ View Today, Last Week And Last Month Statistics Of:
✔ Sent Email Notifications
✔ Opened Tickets
✔ Suspended Services
✔ Terminated Services
✔ View Logs Of Sent Notifications, Opened Tickets And Performed Actions
  • General Info:
✔ Multi-Language Support
✔ Supports PHP 5.6 Up To PHP 7.2
✔ Supports WHMCS V7.2 And Later

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.

Note: If you are still using any versions of Hosting Quota Notifications For WHMCS prior to v2.x, read about it here.

Installation

1. Log in to our client area and download the module.
HQN2 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.

HQN2 2 1.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
6. In the next step, set up the 'storage' folder as recursively writable.

This folder is available at 'yourWHMCS/modules/addons/hosting_quota_notifications/'.

HQN2 4 1.png

Configuration of Addon

7. 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.

HQN2 5.png
8. 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'.

HQN2 6.png
9. You have just successfully installed Hosting Quota Notifications For WHMCS!

You can access your module at 'Addons' 'Hosting Quota Notifications'.

HQN2 7.png
10. The last thing you still need to do before starting to use the module with its full potential is setting up a cron command line.
You will find the cron line in the addon 'Home' page.

One hour interval is suggested (due to hourly sent notifications).

HQN2 8.png

Configuration and Management

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

Home

Dashboard of the addon includes statistics on the module actions attempts, either successful or failed.
  • Successful actions - marked in green - take a look at the number of emails sent, tickets opened and products suspended or terminated in the provided time periods.
  • Failed actions - marked in red - the module could not perform enumerated here actions due to external issues, for example: server errors (cannot suspend account), SMTP errors (cannot deliver email), etc.
    For more details on failed actions please refer to the logs section.
HQN2 29.png

Rules

This is a primary section which allows to create numerous rules according to which the services resource usage will be monitored and calculated and then adequate notifications sent.
HQN2 9.png

Rule Configuration

Let us begin with creating an exemplary rule according to which disk usage of selected service will be checked.
Press 'Add Rule'.
HQN2 10.png
Start with typing a custom name, selecting the usage calculating type: 'Tiered' or 'Fixed' (read more about these two methods here).
Select your products that this rule will cover.
HQN2 11.png
Once you have saved the changes, you will be moved to the rule configuration page.

Here you may:

  • Set the status of the rule to 'enabled' or 'disabled'
  • Change the name of the rule
  • Manage the types: 'Tiered' or 'Fixed'
  • Assign products from available
  • Select a default email template that will be sent to a client with notification. Set to 'None' to disable the option.
    You may use the predefined custom template ('Service Usage Limits Notification') implemented in the module or prepare your custom one. Find out more in this section.
  • Set notification hourly interval to send the notifications.

Save the changes when ready.

HQN2 12.png

Steps Configuration

Move to the next tab - 'Disk' to define steps conforming to which the usage will be verified.

Press 'Add Step' to begin.

HQN2 13.png
  • Start with selecting a Unit type: 'MB', 'GB', 'TB' or 'Percentage'
  • Provide numerical value, e.g.: 20 (depending on the unit selected it will be: 20MB, 20% etc.)
  • Period (Days) - number of days when the resource usage will be verified - (Fixed type only)
  • Email Template - select one per single step, if you choose 'default' then the one selected at the rule configuration will be used. Set to 'None' to disable the option.
  • Ticket Template - if you want to notify a client in form of an opened ticket, select the template here or set to 'None' to disable
  • Action - you may automatically 'Terminate' or 'Suspend' a service once selected limit has been reached.
    Set to 'None' if you do not want to trigger any action on the service.
HQN2 14.png
Surely, you may add more steps for the same rule and force different actions on the services.

You may edit the steps if needed or delete.

HQN2 15.png
Configure the steps for 'Bandwidth' usage limits in the very same way as in case of the described above 'Disk'.
HQN2 16.png

Calculation Methods

As mentioned above, here are two calculation types available: 'Fixed' and 'Tiered'. We will try to explain now the main differences between them and show an example of a full calculation.
  • Fixed type - resource usage calculated within a selected time period defined in the 'Period (Days)' field
  • Tiered type - full amount of resource usage
Take a look at the table below to see the differences between the two types.
Day Usage
Day 1 10 MB
Day 2 20 MB
Day 3 10 MB
Day 4 5 MB
  • For Fixed type:
    Period: Last 3 days
    Value: 30 MB
    Take the three last values from the Usage column, the sum of 20, 10 and 5 gives 35.
    30 MB limit has been exceeded during 3 days, therefore a notification is sent.
  • For Tiered type:
    Value: 40 MB
    Take the sum of values from the entire Usage column, 45 MB in this case.
    40 MB limit has been exceeded, therefore a notification is sent.
Apart from the calculation type, you must also select a unit - MB, GB, TB or percentage.
  • If you select any of MB, GB, TB and 20 as value, such amount of resource usage will be taken into consideration for every assigned product.
  • If you select 'Percentage' and 20 as value, then 20% of the set in WHMCS soft limit will be taken into consideration for every assigned product.
    For example, if in WHMCS the service limit is set to 100 MB, then 20% calculated from 100 gives 20 MB - this amount of resource will be considered for this single product.

Ticket Templates

Ticket Templates section gives you the opportunity to create as many templates that will be used to open informative tickets as needed.
Press 'Add Ticket Template' to create one.
HQN2 17.png
Type in the ticket template name, select a support department and support administrator to which the ticket will be automatically assigned.

Save changes.

HQN2 18.png
You will be immediately moved to the template configuration page where you can again rename it and change the department.
HQN2 19.png

Ticket Template Translations

Next, you need to proceed to the 'Template Translation' section. There you can provide the content of the template.

Press 'Add Template Translation'.

HQN2 21.png
Enter the template name, select language and type in the text in the 'Message' text field.
If you select default language, then this template will be used in case there is no translation in the client's language.
HQN2 22.png
There are numerous merge fields that you may use in the message to make it full and most informative.
As you can see, at the bottom there is a list of special merge fields specially designated for notifications. These are:
  • Notification Limit - displays the allowed resource usage limit
  • Notification Usage - stands for the current resource usage of the client service
  • Notification Kind - returned as Bandwidth or Usage
  • Notification Unit - returned as MB, GB or TB
  • Notification DifferenceUsageAndLimit - amount by which the limit has been exceeded
  • Notification PeriodDays - period of days when the usage is verified defined for 'Fixed' type
HQN2 23.png
Use action buttons to edit or delete the template translations.
HQN2 24.png
That is how such an automatically opened ticket may look like in your client's area.
HQN2 24 1.png

Services

Another section that we need to draw your attention to is called 'Services'.
You will find there products which are included in any of your configured rules with disk or bandwidth usage.

Press the icon marked on the screen below and you will get details on the current resource usage of the service per each day.

HQN2 25.png
Check out the statistics on the disk and bandwidth usage per single product.

Please note that WHCMS updates the quote and traffic load once a day only.

HQN2 26.png

Logs

Under 'Logs' page you can view information about sent notifications via email, opened tickets, errors, performed actions etc.
HQN2 27.png

Tips

1. There is one default email template that may be used to send email notifications. Find 'Service Usage Limits Notification' at WHMCS → Setup → Email Templates → Product/Service Messages.

You may edit the template freely, using special merge fields and create new ones on its basis. Allowed module special merge fields:

  • {$kind} - stands for bandwidth or usage
  • {$limit} - allowed resource usage limit
  • {$unit} - MB,GB or TB
  • {$usage} - current resource usage of the client
  • {$differenceUsageAndLimit} - amount by which the limit has been exceeded
  • {$periodDays} - period of days defined for 'Fixed' type
HQN2 30.png
That is how the email message may look like when delivered:
HQN2 28.png
2. When configuring a ticklet template you need to select an admin to which it will be assigned. However, the ticket will be automatically opened by a randomly selected administartor.

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.

Important

If you are updating your Hosting Quota Notifications module form version 1.0.0 to 1.1.0 please be noted that all data except logs will be migrated.
Keep in mind that 'Groups' used in version 1.0.0 have now been renamed to 'Rules'.

Common Problems

1. When you have problems with connection, check whether your SELinux or firewall does not block ports.
Navigation
WHMCS Modules
cPanel Modules
Magento Extensions
Magento Themes
PrestaShop Modules
Blesta Extensions
General
Social
Hosting Quota Notifications For WHMCS