Personal tools
Namespaces

Variants
Actions

Hosting Quota Notifications 1.X For WHMCS

From ModulesGarden Wiki
(Difference between revisions)
Jump to: navigation, search
(Activation Of Addon)
 
(150 intermediate revisions by 4 users not shown)
Line 1: Line 1:
<h4 style="color: #ff0000; font-weight:bold; text-align:center;">Article update is ongoing on this page, watch out for broken links, unclear descriptions or images!<br/>
+
<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>
We are sorry for the inconvenience caused.</h4>
+
<meta name="description" content="ModulesGarden Wiki Contains All The Information You Need About The Hosting Quota Notifications For WHMCS Module."></meta>
<meta name="keywords" content="resellers center for whmcs, whmcs resellers center configuration, whmcs resellers center management, whmcs resellers center installation, whmcs resellers center common problems, about whmcs resellers center, whmcs resellers center documentation, whmcs resellers center faq, whmcs resellers center help, whmcs resellers center guide, whmcs resellers center wiki, whmcs resellers center tutorial, whmcs resellers center tips, whmcs resellers center wiki"></meta>
+
<meta name="description" content="ModulesGarden Wiki Contains All The Information You Need About The Resellers Center For WHMCS Module."></meta>
+
  
=About [https://www.modulesgarden.com/products/whmcs/resellers-center Resellers Center For WHMCS]=
+
=About [https://www.modulesgarden.com/products/whmcs/hosting-quota-notifications Hosting Quota Notifications For WHMCS]=
 
{|
 
{|
|style="padding: 10px 0px 10px 0px;"|'''Resellers Center For WHMCS''' gives your resellers the possibility to manage end clients and their orders through 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.
With this module, your resellers will be allowed to acquire their own customers and assign products, services and domains to them. <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 />
Thanks to that, end clients will be able to easily order services directly from your WHMCS. <br />
+
You can also define email templates and view details of each sent notification owing to logs.
Moreover, they will be able to log in to their own WHMCS account in order to manage their services, pay invoices or even create tickets.
+
 
|}
 
|}
<!-- fixed -->
+
<!--a comment maybe? -->
*'''Provider Features:'''
+
*'''Admin Area Features:'''
 
{|
 
{|
|style="padding: 10px 0px 0px 30px;"|✔ Define Global Configuration And Reseller Permissions
+
|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;"|✔ Manage Assignment Of Clients To Resellers
+
|style="padding: 0px 0px 0px 30px;"|✔ Configure Notification Groups
 
|}
 
|}
 
{|
 
{|
|style="padding: 0px 0px 0px 30px;"|✔ Create And Manage Pricing Groups
+
|style="padding: 0px 0px 0px 30px;"|✔ Choose Between Two Types Of Group Counting:
 
|}
 
|}
 
{|
 
{|
|style="padding: 0px 0px 0px 30px;"|✔ Assign Clients to Pricing Groups To Set Them As Resellers
+
|style="padding: 0px 0px 0px 45px;"|✔ Tiered - Define Tiers Of Usage
 
|}
 
|}
 
{|
 
{|
|style="padding: 0px 0px 0px 30px;"|✔ Assign Products, Addons And Domains To Pricing Groups
+
|style="padding: 0px 0px 0px 45px;"|✔ Fixed - Define Usage Grow Over Time
 
|}
 
|}
 
{|
 
{|
|style="padding: 0px 0px 0px 30px;"|✔ Define Pricing Range Per Products, Addons And Domains For Each Billing Cycle
+
|style="padding: 0px 0px 0px 30px;"|✔ Assign Multiple Products To Single Notification Group
 
|}
 
|}
 
{|
 
{|
|style="padding: 0px 0px 0px 30px;"|✔ Select Payouts Calculation Method Per Products, Addons And Domains:
+
|style="padding: 0px 0px 0px 30px;"|✔ Assign Email Templates Per Notification Group
 
|}
 
|}
 
{|
 
{|
|style="padding: 0px 0px 0px 45px;"|✔ Fixed Rate
+
|style="padding: 0px 0px 0px 30px;"|✔ Enable/Disable Notification Groups
 
|}
 
|}
 
{|
 
{|
|style="padding: 0px 0px 0px 45px;"|✔ Difference
+
|style="padding: 0px 0px 10px 30px;"|✔ View Logs Of Sent Notifications
|}
+
{|
+
|style="padding: 0px 0px 0px 45px;"|✔ Percent Rate
+
|}
+
{|
+
|style="padding: 0px 0px 0px 45px;"|✔ Percent From Difference Between Admin And Reseller Price
+
|}
+
{|
+
|style="padding: 0px 0px 0px 45px;"|✔ Admin Percent With Fixed Rate
+
|}
+
{|
+
|style="padding: 0px 0px 0px 45px;"|✔ Reseller Percent With Fixed Rate
+
|}
+
{|
+
|style="padding: 0px 0px 0px 30px;"|✔ Write Own Class To Calculate Reseller Profit
+
|}
+
{|
+
|style="padding: 0px 0px 0px 30px;"|✔ View Statistics On Resellers Sales, Income And End Clients
+
|}
+
{|
+
|style="padding: 0px 0px 0px 30px;"|✔ View Reseller Profits
+
|}
+
{|
+
|style="padding: 0px 0px 0px 30px;"|✔ Enable Reseller Own CNAME Domain Support
+
|}
+
{|
+
|style="padding: 0px 0px 0px 30px;"|✔ Select Available Store And Order Templates
+
|}
+
{|
+
|style="padding: 0px 0px 0px 30px;"|✔ Choose Email Templates Available For Branding
+
|}
+
{|
+
|style="padding: 0px 0px 0px 30px;"|✔ Choose Payment Gateways Available For End Clients
+
|}
+
{|
+
|style="padding: 0px 0px 0px 30px;"|✔ Choose Ticket Departments Available For End Clients
+
|}
+
{|
+
|style="padding: 0px 0px 0px 30px;"|✔ Determine Invoicing Method For Billing End Clients:
+
|}
+
{|
+
|style="padding: 0px 0px 0px 45px;"|✔ Provider As Issuer Of Invoices
+
|}
+
{|
+
|style="padding: 0px 0px 0px 45px;"|✔ Reseller As Issuer Of Invoices
+
|}
+
{|
+
|style="padding: 0px 0px 0px 30px;"|✔ Allow Invoice Branding
+
|}
+
{|
+
|style="padding: 0px 0px 0px 30px;"|✔ Define Default Sequential Invoice Number Format
+
|}
+
{|
+
|style="padding: 0px 0px 0px 30px;"|✔ Make Payouts To PayPal Account Or Credit Balance
+
|}
+
{|
+
|style="padding: 0px 0px 0px 30px;"|✔ Enable Automatic PayPal Payout Transfers
+
|}
+
{|
+
|style="padding: 0px 0px 0px 30px;"|✔ Prepare Documentation For Each Reseller
+
|}
+
{|
+
|style="padding: 0px 0px 10px 30px;"|✔ Access To Module Logs
+
|}
+
*'''Resellers Features:'''
+
{|
+
|style="padding: 10px 0px 0px 30px;"|✔ Configure Reseller Brand:
+
|}
+
{|
+
|style="padding: 0px 0px 0px 45px;"|✔ Domain
+
|}
+
{|
+
|style="padding: 0px 0px 0px 45px;"|✔ Company Name
+
|}
+
{|
+
|style="padding: 0px 0px 0px 45px;"|✔ Store Logo
+
|}
+
{|
+
|style="padding: 0px 0px 0px 45px;"|✔ Invoice Pay To Text
+
|}
+
{|
+
|style="padding: 0px 0px 0px 45px;"|✔ Sequential Invoice Number Format
+
|}
+
{|
+
|style="padding: 0px 0px 0px 45px;"|✔ Tickets Email Signature
+
|}
+
{|
+
|style="padding: 0px 0px 0px 45px;"|✔ Store And Order Template
+
|}
+
{|
+
|style="padding: 0px 0px 0px 45px;"|✔ Available Ticket Departments
+
|}
+
{|
+
|style="padding: 0px 0px 0px 30px;"|✔ Set Up Independent Payment Gateways Available For End Clients:
+
|}
+
{|
+
|style="padding: 0px 0px 0px 45px;"|✔ Bank Transfer
+
|}
+
{|
+
|style="padding: 0px 0px 0px 45px;"|✔ PayPal
+
|}
+
{|
+
|style="padding: 0px 0px 0px 45px;"|✔ Stripe
+
|}
+
{|
+
|style="padding: 0px 0px 0px 30px;"|✔ Define Order Of Payment Gateways
+
|}
+
{|
+
|style="padding: 0px 0px 0px 30px;"|✔ Define Prices Of Products, Addons And Domains Within Defined Limits
+
|}
+
{|
+
|style="padding: 0px 0px 0px 30px;"|✔ Add And Manage End Clients
+
|}
+
{|
+
|style="padding: 0px 0px 0px 30px;"|✔ View End Clients Orders, Invoices, Products, Addons And Domains
+
|}
+
{|
+
|style="padding: 0px 0px 0px 30px;"|✔ Place Orders For End Clients Manually
+
|}
+
{|
+
|style="padding: 0px 0px 0px 30px;"|✔ Manually Accept Order Of End Client Before Payment Receipt
+
|}
+
{|
+
|style="padding: 0px 0px 0px 30px;"|✔ Login As End Client
+
|}
+
{|
+
|style="padding: 0px 0px 0px 30px;"|✔ View Statistics On Sales, Income And End Clients
+
|}
+
{|
+
|style="padding: 0px 0px 0px 30px;"|✔ View Generated Profits
+
|}
+
{|
+
|style="padding: 0px 0px 0px 30px;"|✔ Access Documentation
+
|}
+
{|
+
|style="padding: 0px 0px 0px 30px;"|✔ Receive Payouts To PayPal Account Or Credit Balance
+
|}
+
{|
+
|style="padding: 0px 0px 0px 30px;"|✔ Receive Email Notifications On End Clients Orders
+
|}
+
{|
+
|style="padding: 0px 0px 0px 30px;"|✔ Reply To Tickets Submitted By End Clients
+
|}
+
{|
+
|style="padding: 0px 0px 0px 30px;"|✔ View Email Templates And Use Editor To Modify Their Content
+
|}
+
{|
+
|style="padding: 0px 0px 10px 30px;"|✔ Access Store By CNAME Domain Or Default Store URL
+
|}
+
*'''End Clients Features:'''
+
{|
+
|style="padding: 10px 0px 0px 30px;"|✔ Order Products, Addons And Domains
+
|}
+
{|
+
|style="padding: 0px 0px 0px 30px;"|✔ Use End Client Details For Registered Domains
+
|}
+
{|
+
|style="padding: 0px 0px 0px 30px;"|✔ View And Pay Invoices
+
|}
+
{|
+
|style="padding: 0px 0px 0px 30px;"|✔ Pay Using Credit Card And Store Payment Data
+
|}
+
{|
+
|style="padding: 0px 0px 0px 30px;"|✔ View And Manage Products
+
|}
+
{|
+
|style="padding: 0px 0px 0px 30px;"|✔ Receive Branded Email Notifications
+
|}
+
{|
+
|style="padding: 0px 0px 10px 30px;"|✔ Submit Tickets To Reseller
+
 
|}
 
|}
 
*'''General Info:'''
 
*'''General Info:'''
 
{|
 
{|
|style="padding: 10px 0px 0px 30px;"|✔ Migration Tool
+
|style="padding: 10px 0px 0px 30px;"|✔ Multi-Language Support
|}
+
{|
+
|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 WHMCS Template Six
+
|style="padding: 0px 0px 0px 30px;"|✔ Supports PHP 5.6 Up To PHP 7.2
 
|}
 
|}
 
{|
 
{|
Line 229: Line 50:
 
=Installation=
 
=Installation=
 
{|
 
{|
|style="padding: 10px 0px 30px 0px;"|Installation of Resellers Center For WHMCS requires a few simple modifications of the template files.<br />
+
|style="padding: 10px 0px 30px 15px;"|'''This tutorial will show you how to successfully install and configure Hosting Quota Notifications For WHMCS.''' <br />
No worries, we will guide you step by step through the entire installation process.<br/><br/>
+
We will guide you step by step through the whole installation and configuration process.
'' '''Note:''' If you are still using any of Resellers Center For WHMCS  previous versions '''prior to v3.x''', [https://www.docs.modulesgarden.com/Resellers_Center_2.X_For_WHMCS read about it here].''
+
 
|}
 
|}
 
==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:R3_1_new.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, while the second one is aimed at PHP 7.<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 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'.'''
 
|}
 
|}
 
{|
 
{|
|style="padding: 0px 0px 20px 25px;"|[[File:R3_2.png]]
+
|style="padding: 0px 0px 20px 25px;"|[[File:PHP56_72.png]]
 
|}
 
|}
 
{|
 
{|
Line 252: Line 72:
 
|}
 
|}
 
{|
 
{|
|style="padding: 0px 0px 20px 25px;"|[[File:R3_2_1.png]]
+
|style="padding: 0px 0px 20px 25px;"|[[File:drfere.png]]
 
|}
 
|}
 
{|
 
{|
|style="padding: 0px 0px 15px 15px;"|'''4. When you install Resellers Center For WHMCS for the first time you have to rename '' '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 />
File is located in '' 'modules/addons/ResellersCenter/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:R_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 a 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 quotation marks as presented on the following screen.<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' ''.
You can find your license key in your client area '' 'My Products'. ''
+
 
|}
 
|}
 
{|
 
{|
|style="padding: 0px 0px 20px 25px;"|[[File:R_4.png]]
+
|style="padding: 0px 0px 30px 25px;"|[[File:HQN_4.png]]
|}
+
{|
+
|style="padding: 0px 0px 15px 15px;"|'''6. The next step is setting up '' 'storage' '' folder as writable.'''<br />
+
It is located in '' 'your_whmcs/modules/addons/ResellersCenter/'.''
+
|}
+
{|
+
|style="padding: 0px 0px 30px 25px;"|[[File:R_5.png]]
+
 
|}
 
|}
  
==Activation Of Addon==
+
==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. Click '' 'Setup' '' then choose '' 'Addon Modules'.''<br />
+
Log in to your WHMCS admin area. Go to '' 'Setup' '' '' 'Addon Modules' ''. Afterwards, find '' 'Hosting Quota Notifications' '' and press '' 'Activate' '' button.
Afterwards, find '' 'Resellers Center' '' and press '' 'Activate' '' button.
+
 
|}
 
|}
 
{|
 
{|
|style="padding: 0px 0px 20px 25px;"|[[File:R3_6_new.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 the 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, select the admin roles which should have access to the module.<br />
+
To do so click on '' 'Configure' '' button, tick '' 'Access Control' '' near required admin role groups and press '' 'Save Changes' ''.
You might as well enable hooks to ensure that all the module's functions work as intended.<br />
+
Optionally, choose whether you want to allow your reseller's end-clients to perform orders in your main store or to make them purchase products only through the reseller's store.<br/>
+
Press '' 'Save Changes' '' when ready.
+
 
|}
 
|}
 
{|
 
{|
|style="padding: 0px 0px 20px 25px;"|[[File:R3_7_new.png]]
+
|style="padding: 0px 0px 30px 25px;"|[[File:HQN_6.png]]
|}
+
<!--
+
{|
+
|style="padding: 0px 0px 15px 15px;"|'''9. It is required to disable auto applying credits.'''<br />
+
Otherwise, orders made by resellers' clients will be automatically paid using credits from the reseller's account.<br />
+
Go to '' 'Setup' '' → '' 'General Settings' '' → '' 'Invoices' '' and mark '' 'Disable Auto Credit Applying' '' checkbox.<br />
+
Afterwards, press '' 'Save Changes'.''
+
|}
+
{|
+
|style="padding: 0px 0px 20px 25px;"|[[File:R3_8.png]] 
+
|}
+
{|
+
|style="padding: 0px 0px 15px 15px;"|'''10. It is required to disable credit card storage. (optional)'''<br />
+
Otherwise, credit card details provided by one contact can be accessed by other contact of the same reseller.<br />
+
Go to '' 'Setup' '' → '' 'General settings' '' → '' 'Security' '' and mark '' 'Disable Credit Card Storage' '' checkbox.<br />
+
Next, press '' 'Save Changes'. ''
+
|}
+
{|
+
|style="padding: 0px 0px 20px 25px;"|[[File:R3_9.png]] 
+
|}
+
-->
+
{|
+
|style="padding: 0px 0px 20px 15px;"|'''9. Afterwards, go to '' 'Addons' '' → '' 'Resellers Center' '' → '' 'Integration Code' '' and follow the instructions.'''
+
|}
+
{|
+
|style="padding: 0px 0px 20px 25px;"|[[File:R3_10.png]]
+
|}
+
{|
+
|style="padding: 0px 0px 30px 15px;"|'''10. You have just successfully installed Resellers Center For WHMCS!'''
+
 
|}
 
|}
  
=Management and Configuration=
 
{|
 
|style="padding: 10px 0px 30px 15px;"|Management of Resellers Center For WHMCS is very convenient. You can supervise everything from the addon.<br />
 
What is more, the module extends possibilities of both your resellers and their customers.<br />
 
Let us find out what our product can do!
 
|}
 
==Settings==
 
{|
 
|style="padding: 10px 0px 15px 15px;"|In this section you can find more information about global configuration.<br />
 
Additionally, here you can also read about the details of migration. 
 
<!-- Additionally, here you can find a direct link to module documentation as well as migration tool. -->
 
|}
 
===Configuration===
 
{|
 
|style="padding: 0px 0px 15px 15px;"|In '' 'Configuration' '' tab you can set up global settings of the module. You can define '' 'General', 'Billing' '' and '' 'Email Templates' '' settings.<br/>
 
''Please note that these settings are default for all resellers. Read this section through to find the details of configuration per each reseller.''
 
|}
 
====General Settings====
 
 
{|
 
{|
|style="padding: 0px 0px 15px 15px;"|
+
|style="padding: 0px 0px 15px 15px;"|'''8. You have just successfully installed Hosting Quota Notifications For WHMCS!'''<br />
*'''Enable Store Branding''' - Allows resellers to set up custom logo, company name and domain.
+
You can access your module in '' 'Addons' '' '' 'Hosting Quota Notifications' ''.
*'''Allow Products''' - If enabled, resellers will be able to sell properly configured products in their own stores.
+
*'''Allow Domains''' - Gives resellers possibility to sell domains in their own stores.
+
*'''Allow CNAME''' - It enables support for CNAME record pointing from customer domain.
+
*'''Allow Promotions''' - If enabled, then reseller's end-clients will be able to use the promo codes in reseller's store configured gloabally in the '' '[https://docs.whmcs.com/Promotions WHMCS Promotions]' '' section.
+
*'''Default Reseller Documentation''' - Select default documentation to show for new resellers.
+
*'''Ticket Departments''' -  Allows you to choose ticket departments available for end clients as they will contact resellers.
+
*'''Templates''' - Allows you to select client area templates of resellers store.
+
*'''Order Templates''' - Allows you to select order templates set for cart view in resellers store.
+
 
|}
 
|}
 
{|
 
{|
|style="padding: 0px 0px 20px 25px;"|[[File:R3_11.png]]
+
|style="padding: 0px 0px 30px 25px;"|[[File:HQN_7.png]]
 
|}
 
|}
  
====Billing Settings====
+
=Configuration and Management=
 
{|
 
{|
|style="padding: 0px 0px 15px 15px;"|
+
|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.'''
*'''PayPal Auto Transfer''' - Enables automatic transfers to reseller's account.
+
*'''Invoice Branding''' - If enabled, resellers can brand the number and basic information on the invoice.
+
*'''Reseller Invoice''' - If enabled, resellers can issue invoices for end clients directly (otherwise, invoices are generated by the administrator). <br/>This option also permits resellers to use their own configuration data in payment gateways settings (currently, 'PayPal', 'Stripe' and 'Bank Transfer' gateways are available). <br/>Once they do it, end clients are able to make payments directly to the reseller's account and the reseller settles debts with the administrator using prepaid WHMCS credits.<br/>'' '''Important:''' When you enable this option and any invoice is created in the meantime, you will not be able to disable it anymore!
+
*'''Sequential Invoice Number Format''' - Required if 'Reseller Invoice' is enabled.
+
*'''Gateways''' - Allows you to select gateways that resellers can enable in their own stores. This option is only available if 'Reseller Invoice' is disabled.
+
 
|}
 
|}
 +
==Configuration==
 
{|
 
{|
|style="padding: 0px 0px 20px 25px;"|[[File:R3_11_1_new.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.
 
|}
 
|}
 
====Email Templates Settings====
 
 
{|
 
{|
|style="padding: 0px 0px 15px 15px;"|Here you can enable/disable numerous options that a reseller can customize later on.<br/>These templates are related to emails regarding issues like:<br/>
+
|style="padding: 0px 0px 20px 25px;"|[[File:HQN_9.png]]
*'''General'''
+
*'''Product'''
+
*'''Domain'''
+
*'''Support'''
+
*'''Invoice'''
+
 
|}
 
|}
 
{|
 
{|
|style="padding: 0px 0px 20px 25px;"|[[File:R3_11_2.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;"|Each setting can be defined for particular resellers. Go to '' 'Resellers' '' tab and press the button.
+
|style="padding: 0px 0px 20px 25px;"|[[File:HQN_10.png]]
 
|}
 
|}
 
{|
 
{|
|style="padding: 0px 0px 20px 25px;"|[[File:R3_11_3.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;"|Here you will find the details related to the chosen reseller. In 'Configuration' section you can select preferred '' 'General', 'Billing' '' and '' 'Email Template' '' settings.
+
|style="padding: 0px 0px 30px 25px;"|[[File:HQN_11.png]]
 
|}
 
|}
 +
==Logs==
 
{|
 
{|
|style="padding: 0px 0px 30px 25px;"|[[File:R3_11_4_new.png]]
+
|style="padding: 10px 0px 15px 15px;"|Under '' 'Logs' '' page you can view information about sent notifications.
 
|}
 
|}
 
===Migration Tool===
 
 
{|
 
{|
|style="padding: 10px 0px 15px 15px;"|Migration tool allows you to upgrade Resellers Center For WHMCS module to the latest version.<br/>
+
|style="padding: 0px 0px 30px 25px;"|[[File:HQN_12.png]]
 
+
'' '''Note:''' Version 3.x currently supports migration from version 2.5.x module and it will only transfer data on resellers, resellers' clients and resellers' groups.<br/>Therefore, the other settings of the module need to be reconfigured manually.<br />
+
<br />
+
To perform the migration simply overwrite old files to the latest version of the module and refresh the addon page in the admin area.
+
|}
+
 
+
<!--
+
This step is required due to the completely new module's logic that includes new database tables.<br />
+
More information on that matter can be found [[#Migration_From_2.0.5_And_Earlier_To_2.5.0|here]].
+
 
|}
 
|}
 +
==Notifications==
 
{|
 
{|
|style="padding: 0px 0px 30px 25px;"|[[File:R3_13.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.
 
|}
 
|}
 
 
===Documentation===
 
 
{|
 
{|
|style="padding: 10px 0px 20px 15px;"|By pressing '' 'Documentation', '' you will be redirected to Wiki article of Resellers Center For WHMCS.
+
|style="padding: 0px 0px 30px 25px;"|[[File:HQN_13.png]]
 
|}
 
|}
{|
 
|style="padding: 0px 0px 30px 25px;"|[[File:R3_13_1.png]]
 
|}
 
-->
 
  
==Addon Management==
+
=Tips=
 
{|
 
{|
|style="padding: 10px 0px 30px 15px;"|In this section you can find more details about the management possibilities.<br />
+
|style="padding: 10px 0px 30px 15px;"|
We will show you how to set up key options to ease the module's handling processes. 
+
|}
+
===Pricing Groups===
+
{|
+
|style="padding: 10px 0px 15px 15px;"|In order to grant any of your clients resellers' rights, you need to configure a group first.<br />
+
To do so, proceed to '' 'Pricing Groups' '' tab and click the button as shown below.
+
|}
+
{|
+
|style="padding: 0px 0px 20px 25px;"|[[File:R3_14.png]]
+
|}
+
{|
+
|style="padding: 0px 0px 15px 15px;"|A popup window appears. Just fill in a group name and press '' 'Create'.''
+
|}
+
{|
+
|style="padding: 0px 0px 20px 25px;"|[[File:R3_14_1.png]]
+
|}
+
{|
+
|style="padding: 0px 0px 15px 15px;"|As you can see, a new group is visible on the list. It does not have any product configured.<br/>
+
To add a new product press the button as presented below.
+
|}
+
{|
+
|style="padding: 0px 0px 20px 25px;"|[[File:R3_15.png]]
+
|}
+
{|
+
|style="padding: 0px 0px 15px 15px;"|Choose a new product from '' 'Add Product To Group' '' dropdown menu and press '' 'Save'.''
+
|}
+
{|
+
|style="padding: 0px 0px 20px 25px;"|[[File:R3_16.png]]
+
|}
+
{|
+
|style="padding: 0px 0px 15px 15px;"|The product needs to be configured. Then, Resellers Center For WHMCS enables you to:
+
*'''Edit Pricing (1)
+
*'''Edit Calculation Method (2)
+
*'''Delete Product (3)
+
|}
+
{|
+
|style="padding: 0px 0px 20px 25px;"|[[File:R3_16_1.png]]
+
|}
+
====Product Pricing====
+
{|
+
|style="padding: 0px 0px 15px 15px;"|It is possible to set pricing (1) for different billing cycles and currencies.
+
You can define pricing using the below options:
+
*'''Admin Price''' - price set for a product (it may be lower than what reseller sets when this difference will be the basis to calculate profit)
+
*'''Highest Price''' - maximum price which can be set for a product
+
*'''Lowest Price''' - minimum price which can be set for a product
+
To confirm settings press '' 'Save' ''.
+
|}
+
{|
+
|style="padding: 0px 0px 30px 25px;"|[[File:R3_17.png]]
+
 
|}
 
|}
  
====Calculation Method====
+
=Update Instructions=
 
{|
 
{|
|style="padding: 0px 0px 15px 15px;"|Several methods for calculation (2) are available. Choose the one you want to use from dropdown menu.
+
|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/>
*'''Fixed Rate''' - profit that your reseller always gets
+
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/>
*'''Difference''' - between reseller's and admin's 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.<br/>
*'''Percent Rate''' - percentage of reseller's price
+
*'''Percent From Difference''' - a sum of reseller's price percentage and a difference between reseller's and admin's price
+
*'''Admin Percent With Fixed Rate''' - a sum of admin's price percentage and a fixed rate
+
*'''Reseller Percent With Fixed Rate''' -  a sum of reseller's price percentage and a fixed rate
+
<!--
+
*'''Percent Rate''' - (if calculation method uses it) percentage amount granted to reseller for selling this product
+
*'''Fixed Rate''' - (if calculation method uses it) fixed amount granted to reseller for selling this product
+
-->
+
To confirm settings press '' 'Save' '' next to the product you have configured
+
 
|}
 
|}
{|
 
|style="padding: 0px 0px 20px 25px;"|[[File:R3_17_1.png]]
 
|}
 
{|
 
|style="padding: 0px 0px 15px 15px;"|The procedure is quite similar when it comes to adding addons and domains.<br/>
 
Click a right button to add a new addon.
 
|}
 
{|
 
|style="padding: 0px 0px 20px 25px;"|[[File:R3_17_2.png]]
 
|}
 
{|
 
|style="padding: 0px 0px 20px 15px;"|From dropdown menu choose the one that will be added to the group.
 
|}
 
{|
 
|style="padding: 0px 0px 20px 25px;"|[[File:R3_17_2_1.png]]
 
|}
 
{|
 
|style="padding: 0px 0px 20px 15px;"|Now you can set 'Pricing' and 'Calculation Method' or delete this addon.
 
|}
 
{|
 
|style="padding: 0px 0px 20px 25px;"|[[File:R3_17_3.png]]
 
|}
 
{|
 
|style="padding: 0px 0px 20px 15px;"|In order to add a new domain click the right button, as shown below.
 
|}
 
{|
 
|style="padding: 0px 0px 20px 25px;"|[[File:R3_17_4.png]]
 
|}
 
{|
 
|style="padding: 0px 0px 20px 15px;"|From dropdown menu choose the one that will be added to the group.
 
|}
 
{|
 
|style="padding: 0px 0px 20px 25px;"|[[File:R3_17_4_1.png]]
 
|}
 
{|
 
|style="padding: 0px 0px 20px 15px;"|Now you can set 'Pricing' and 'Calculation Method' or delete this domain.
 
|}
 
{|
 
|style="padding: 0px 0px 30px 25px;"|[[File:R3_17_5.png]]
 
|}
 
 
===Resellers===
 
{|
 
|style="padding: 10px 0px 15px 15px;"|'' 'Resellers' '' tab displays all clients from your WHMCS system.<br />
 
You can use it to assign any client to a reseller's group, that will activate them as resellers.<br />
 
Click the button as shown below to create a new reseller.
 
|}
 
{|
 
|style="padding: 0px 0px 20px 25px;"|[[File:R3_19.png]]
 
|}
 
{|
 
|style="padding: 0px 0px 20px 15px;"|Assign the new reseller to the chosen group.
 
|}
 
{|
 
|style="padding: 0px 0px 30px 25px;"|[[File:R3_19_1.png]]
 
|}
 
 
===Clients===
 
{|
 
|style="padding: 10px 0px 20px 15px;"|To see resellers' clients go to '' 'Resellers' '' tab and click the button next to a selected reseller.
 
|}
 
{|
 
|style="padding: 0px 0px 20px 25px;"|[[File:R3_11_3.png]]
 
|}
 
{|
 
|style="padding: 0px 0px 20px 15px;"|Here you can obtain more details about your customers and their clients.<br/>
 
Apart from clients, you can manage here also invoices, transactions and services.
 
|}
 
{|
 
|style="padding: 0px 0px 20px 25px;"|[[File:R3_11_4_1.png]]
 
|}
 
{|
 
|style="padding: 0px 0px 20px 15px;"|You can also assign a new client to this reseller.
 
|}
 
{|
 
|style="padding: 0px 0px 30px 25px;"|[[File:R3_11_4_2.png]]
 
|}
 
 
<!--
 
{|
 
|style="padding: 0px 0px 20px 25px;"|[[File:R3_20.png]]
 
|}
 
{|
 
|style="padding: 0px 0px 20px 15px;"|Click on '' 'Manage' '' to view more information about contact's products and domains.
 
|}
 
{|
 
|style="padding: 0px 0px 20px 25px;"|[[File:R3_21.png]]
 
|}
 
{|
 
|style="padding: 0px 0px 15px 15px;"|As you can see, all products, services and domains assigned to the reseller account are visible here.<br />
 
Items assigned to chosen resellers' contact are highlighted in blue, items assigned to other contacts of the reseller are gray, products assigned to the reseller are black.<br />
 
This is the place to manage items assigned to end-client.
 
|}
 
{|
 
|style="padding: 0px 0px 20px 25px;"|[[File:R3_22.png]]
 
|}
 
{|
 
|style="padding: 0px 0px 20px 15px;"|To obtain more information about contacts, simply click on '' 'Contact Name'.''
 
|}
 
{|
 
|style="padding: 0px 0px 20px 25px;"|[[File:R3_23.png]]
 
|}
 
{|
 
|style="padding: 0px 0px 20px 15px;"|From here you can manage the contacts and modify their permission.
 
|}
 
{|
 
|style="padding: 0px 0px 30px 25px;"|[[File:R3_24.png]]
 
|}
 
-->
 
 
<!--
 
===Email Templates===
 
{|
 
|style="padding: 10px 0px 15px 15px;"|This section allows you to define which email templates can be edited by your resellers.<br />
 
Simply, mark checkboxes next to desired email templates to allow their branding and press '' 'Save Changes'.''<br />
 
'' 'Note: Email templates modified by resellers are stored separately and do no harm to your email templates'.''
 
|}
 
{|
 
|style="padding: 0px 0px 30px 25px;"|[[File:R3_24_1.png]]
 
|}
 
-->
 
 
===Payouts===
 
{|
 
|style="padding: 10px 0px 15px 15px;"|In '' 'Payouts' '' tab, you can view the list of all resellers' transactions and make profit payouts to them. Moreover, you can accept 'Mass Payments' for selected resellers here.<br/><br/>
 
''Please note - this tab is only used if the 'Reseller Invoice' configuration is set to 'Disabled'.<br/>Otherwise, the resellers settle debts with the administrator using prepaid WHMCS credits and payments made by end clients are credited to the reseller's account directly.<br/><br/>
 
{|
 
|style="padding: 0px 0px 20px 25px;"|[[File:R3_41_2.png]]
 
|}
 
 
In 'Payouts' section, apart from looking at the details it is also possible to perform the following actions: ''pay by PayPal (1)'' or ''WHMCS Credits (2)'' and ''mark the transaction as completed (3)''.<br/>
 
'Mass Payments' section enables you to make mass payouts to all selected resellers at once. You can choose from ''PayPal Payment (4), WHMCS Credits Payment (5)'' and set up proper<br/>PayPal ''Configuration (6)'' by providing PayPal Application Key and Secret - both found within your PayPal account.
 
|}
 
{|
 
|style="padding: 0px 0px 30px 25px;"|[[File:R3_42.png]]
 
|}
 
 
===Statistics===
 
{|
 
|style="padding: 10px 0px 20px 15px;"|'' 'Statistics' '' tab allows you to see the amount of sales and income, and the number of clients assigned to resellers.
 
|}
 
{|
 
|style="padding: 0px 0px 20px 25px;"|[[File:R3_18_1.png]]
 
|}
 
{|
 
|style="padding: 0px 0px 20px 15px;"|Information about sale is also visible in the '' 'Reseller' '' tab.
 
|}
 
{|
 
|style="padding: 0px 0px 30px 25px;"|[[File:R3_18.png]]
 
|}
 
===Logs===
 
{|
 
|style="padding: 10px 0px 20px 15px;"|'' 'Logs' '' tab allows you to see the details of the actions that have been already performed.
 
|}
 
{|
 
|style="padding: 0px 0px 30px 25px;"|[[File:R3_43.png]]
 
|}
 
===Integration Code===
 
{|
 
|style="padding: 10px 0px 20px 15px;"|In the '' 'Integration Code' '' tab you will find the instructions on how to allow your resellers to modify client area and invoice logo.
 
|}
 
{|
 
|style="padding: 0px 0px 30px 25px;"|[[File:R3_44.png]]
 
|}
 
 
===Reseller Documentation===
 
{|
 
|style="padding: 10px 0px 15px 15px;"|
 
The '' 'Reseller Documentation' '' tab enables you to create and modify documentation visible to specified resellers. The documentation provides guidelines to help resellers handle their panels with ease.<br/>
 
You can create documentation in multiple versions - to add a new one, simply click the '+' button. Press the appropriate button located at the 'Actions' column to manage already formed documentation:
 
|}
 
{|
 
|style="padding: 0px 0px 20px 25px;"|[[File:R3_44_2.png]]
 
|}
 
{|
 
|style="padding: 0px 0px 15px 15px;"|
 
Choose the resellers to whom the documentation will be visible, enter the name of the documentation and its content.<br/>
 
You can use HTML tags as well as attach a PDF version of your documentation.<br/>
 
Once ready, click 'Save' to save your documentation.
 
|}
 
{|
 
|style="padding: 0px 0px 20px 25px;"|[[File:R3_44_3.png]]
 
|}
 
{|
 
|style="padding: 0px 0px 15px 15px;"|
 
From now on, our resellers will be encouraged to read the documentation from the welcome page, when they enter the Reseller Area for the first time.<br/>
 
Reseller can hide the welcome page by pressing "Do not show again". Even then, the documentation is accessible from the menu:
 
|}
 
{|
 
|style="padding: 0px 0px 30px 25px;"|[[File:R3_44_4.png]]
 
|}
 
 
==Client Area - Reseller==
 
{|
 
|style="padding: 10px 0px 15px 15px;"|In the client area your can add new subclients and access Reseller Area.<br />
 
Access to the Reseller Area is granted only to those clients, to whom reseller's groups are assigned in Resellers Center For WHMCS module.
 
|}
 
{|
 
|style="padding: 0px 0px 30px 25px;"|[[File:R3_25.png]]
 
|}
 
<!--
 
===Adding a Contact===
 
{|
 
|style="padding: 10px 0px 20px 15px;"|In order to add a new contact, proceed to '' 'Contacts/Sub-Accounts' '' and choose '' 'Add New Contact'. ''
 
|}
 
{|
 
|style="padding: 0px 0px 20px 25px;"|[[File:R3_26.png]]
 
|}
 
{|
 
|style="padding: 0px 0px 15px 15px;"|Fill out contact details and tick '' 'Activate Sub-Account'. ''<br />
 
Afterwards, fill in a password field for your contact, define account permission and email preferences.
 
|}
 
{|
 
|style="padding: 0px 0px 30px 25px;"|[[File:R3_27.png]]
 
|}
 
-->
 
 
===Reseller Area===
 
{|
 
|style="padding: 10px 0px 30px 15px;"|In Reseller Area you can manage clients, define products prices, set up branding, customize email templates and open tickets.
 
|}
 
<!--
 
====Balance====
 
{|
 
|style="padding: 10px 0px 15px 15px;"|Under this tab, you can view your balance, profit made, credit balance and redeem your profit into credit balance.<br />
 
Besides that, it is the place to view the list of profits made by reselling to your contacts.
 
|}
 
{|
 
|style="padding: 0px 0px 30px 25px;"|[[File:R3_28.png]]
 
|}
 
-->
 
====Clients====
 
{|
 
|style="padding: 10px 0px 15px 15px;"|Under this tab, you can see a list of reseller's clients and perform various actions.<br/>
 
It is possible to log in as a client (1), make an order for a client (2), view client's details (3) and delete a client (4).
 
|}
 
{|
 
|style="padding: 0px 0px 20px 25px;"|[[File:R3_45.png]]
 
|}
 
{|
 
|style="padding: 0px 0px 20px 15px;"|To add a new client, press the button as presented below.
 
|}
 
{|
 
|style="padding: 0px 0px 20px 25px;"|[[File:R3_45_2.png]]
 
|}
 
{|
 
|style="padding: 0px 0px 15px 15px;"|Fill in all the necessary details in both '' 'General' '' and '' 'Address' '' sections.<br/>
 
Remember to save changes.
 
|}
 
{|
 
|style="padding: 0px 0px 20px 25px;"|[[File:R3_45_2_1.png]]
 
|}
 
{|
 
|style="padding: 0px 0px 20px 15px;"|When you enter client's details view (3), you will find here not only his personal details but also information about orders, invoices, services, addons and domains.
 
|}
 
{|
 
|style="padding: 0px 0px 20px 25px;"|[[File:R3_45_1.png]]
 
|}
 
<!--
 
{|
 
|style="padding: 0px 0px 20px 15px;"|Under 'Orders' tab there are this client's orders visible, which details you can (1) see or click the green button to accept them(2).
 
|}
 
{|
 
|style="padding: 0px 0px 30px 25px;"|[[File:R3_45_3.png]]
 
|}
 
-->
 
 
====Product Pricing====
 
{|
 
|style="padding: 10px 0px 15px 15px;"|'' 'Product Pricing' '' tab enables you to define prices for products, addons and domains you wish to offer to your clients.<br />
 
Remember, you can define prices only within limits shown as placeholders.<br />
 
If pricing is not provided, product, addon or domain will not be available for your clients.<br />
 
You can also get here a direct cart URL to products group that you can share directly with your customers.
 
|}
 
{|
 
|style="padding: 0px 0px 30px 25px;"|[[File:R3_29.png]]
 
|}
 
 
====Configuration====
 
{|
 
|style="padding: 10px 0px 0px 15px;"|In '' 'Configuration' '' tab you are allowed to define '' 'General Settings' '' such as your own company name, email signature and logo used across client's client area, emails and invoices.<br />
 
Please notice, that the available reseller configuration options may vary depending on the options you selected in the addon configuration and whether the 'Reseller Invoice' option was enabled for the reseller.<br/><br/>
 
 
'' '''Note:''' Once the configuration of your brand is complete, your reseller will still need to set up a CNAME DNS record if domain is used.''<br/>
 
''This record will point from the branded domain towards reseller main domain used by WHMCS.''
 
|}
 
{|
 
|style="padding: 0px 0px 20px 15px;"|
 
*For example: if ''' 'Reseller Invoice' ''' is '''disabled''' there will be an option to provide reseller PayPal email but reseller will not be able to configure available payment gateways on their own:
 
|}
 
{|
 
|style="padding: 0px 0px 20px 25px;"|[[File:R3_30_new.png]]
 
|}
 
{|
 
|style="padding: 0px 0px 20px 15px;"|
 
*However if ''' 'Reseller Invoice' ''' is '''enabled''' there will be an option to configure payment gateways by reseller or enable auto WHMCS invoice payments.
 
|}
 
{|
 
|style="padding: 0px 0px 20px 25px;"|[[File:R3_30_0.png]]
 
|}
 
{|
 
|style="padding: 0px 0px 15px 15px;"|'' 'Email Templates' '' is the place where you can view and edit email templates sent to your clients.<br />
 
To edit an email template, press '' 'Edit' '' button next to the template you wish to alter.
 
|}
 
{|
 
|style="padding: 0px 0px 20px 25px;"|[[File:R3_30_1_new.png]]
 
|}
 
{|
 
|style="padding: 0px 0px 15px 15px;"|Finally, edit the email template to suit your needs and press '' 'Save Changes' '' button.<br />
 
''Note: During this step you can easily add merge fields using dropdown menus marked on the following screen.
 
|}
 
{|
 
|style="padding: 0px 0px 20px 25px;"|[[File:R3_30_2.png]]
 
|}
 
{|
 
|style="padding: 0px 0px 15px 15px;"|'' 'Payment Gateways' '' - this tab is only available if the 'Reseller Invoice' option in the admin area is set to 'Enabled'.<br/>
 
In this section, the reseller can set up their own payment gateway ('PayPal', 'Stripe' and 'Bank Transfer' gateways are currently available).<br/>
 
Thanks to this, all payments made by end clients are transferred directly to the reseller's PayPal account or bank institution.<br/>
 
The payments between the reseller and the administrator are settled through the reseller's previously supplied credit balance.
 
|}
 
{|
 
|style="padding: 0px 0px 30px 25px;"|[[File:R3_30_3.png]]
 
|}
 
 
====Invoices====
 
{|
 
|style="padding: 10px 0px 15px 15px;"|Here is the detailed list of end clients' all invoices together with their status.
 
*If the 'Reseller Invoice' option in the admin area is 'Disabled', the listed invoices are generated between the end client and the site administrator.
 
*If the 'Reseller Invoice' option in the admin area is 'Enabled', the listed invoices are issued between the end client and the reseller directly.
 
|}
 
{|
 
|style="padding: 0px 0px 20px 25px;"|[[File:R3_46_new.png]]
 
|}
 
{|
 
|style="padding: 0px 0px 20px 15px;"|Using 'Action' button on invoices list reseller can also view and manage the invoice details, similarly to how it is done in the admin area.
 
|}
 
{|
 
|style="padding: 0px 0px 30px 25px;"|[[File:R3_46_2.png]]
 
|}
 
 
====Orders====
 
{|
 
|style="padding: 10px 0px 20px 15px;"|This section allows you to view all of the orders with their chosen payment method and status.
 
|}
 
{|
 
|style="padding: 0px 0px 30px 25px;"|[[File:R3_31.png]]
 
|}
 
 
===Ordering===
 
{|
 
|style="padding: 10px 0px 30px 15px;"|There are two ways to add a product to an end client account, we will show you both of them below.
 
|}
 
====Assign Product by Reseller====
 
{|
 
|style="padding: 10px 0px 20px 15px;"|Your resellers can place orders for their own customers as if the orders were for themselves.
 
<!-- The only difference is that they need to choose a client from '' 'Subclient' '' dropdown menu. And that is all! -->
 
|}
 
{|
 
|style="padding: 0px 0px 20px 25px;"|[[File:R3_34.png]]
 
|}
 
{|
 
|style="padding: 0px 0px 15px 15px;"|Both your reseller and the end client will receive an order confirmation email.<br />
 
Afterwards, when end client logs in to the WHMCS client area, he/she will be able to view and manage previously ordered products.<br />
 
End clients can also list and pay invoices or create tickets (if these options are checked in the addon module).
 
|}
 
{|
 
|style="padding: 0px 0px 30px 25px;"|[[File:R3_35.png]]
 
|}
 
<!--
 
====Access Order Through Link====
 
{|
 
|style="padding: 10px 0px 15px 15px;"|Your resellers can use branded links to the product on their websites.<br />
 
By using them, end-clients are forwarded directly to a product order form.<br />
 
''Note: CNAME record is required in order to allow this step. You can find instruction [[#Configuration|here]].''
 
|}
 
{|
 
|style="padding: 0px 0px 30px 25px;"|[[File:R3_36.png]]
 
|}
 
-->
 
 
====Access Order From The Client Area====
 
{|
 
|style="padding: 10px 0px 15px 15px;"|Your reseller's clients can view order form with the list of products configured by their resellers.<br />
 
Therefore, your reseller's clients can make orders on their own, using order forms in the client area.
 
|}
 
{|
 
|style="padding: 0px 0px 30px 25px;"|[[File:R3_37.png]]
 
|}
 
 
===Tickets Management===
 
{|
 
|style="padding: 10px 0px 15px 15px;"|If you have not disabled tickets in your addon, your resellers will be able to reply and forward tickets created by their clients.<br />
 
It is only available for tickets department set in Resellers Center For WHMCS configuration.
 
|}
 
{|
 
|style="padding: 0px 0px 20px 25px;"|[[File:R3_38.png]]
 
|}
 
{|
 
|style="padding: 0px 0px 20px 15px;"|On the screen below you can see a list of all the tickets created by a reseller's clients from the client area.
 
|}
 
{|
 
|style="padding: 0px 0px 20px 25px;"|[[File:R3_39.png]]
 
|}
 
{|
 
|style="padding: 0px 0px 20px 15px;"|You can easily reply to them.
 
|}
 
{|
 
|style="padding: 0px 0px 30px 25px;"|[[File:R3_39_1.png]]
 
|}
 
 
==Client Area - End Client==
 
{|
 
|style="padding: 10px 0px 15px 15px;"|End client sees branded client area.<br/>
 
Since version 3.x of the module end clients are treated as regular WHMCS clients.
 
|}
 
{|
 
|style="padding: 0px 0px 30px 25px;"|[[File:R3_40.png]]
 
|}
 
 
==General Relations==
 
{|
 
|style="padding: 10px 0px 20px 15px;"|'''Relations between Provider, Reseller and Client'''
 
|}
 
{|
 
|style="padding: 0px 0px 15px 15px;"|'''Payment system:'''<br/>
 
In general Reseller receives a product from the Provider and then provides it further to the End Client.<br/>
 
Since the release of v3.0.0 the payment between the Reseller and Provider will be regulated by WHMCS credits but it can be also regulated manually or automatically to Reseller's PayPal account.
 
|}
 
{|
 
|style="padding: 0px 0px 30px 15px;"|'''Invoicing system:'''
 
*If the ''' 'Reseller Invoice' ''' option in the admin area is '''Disabled''', the invoices are generated between the end client and the site administrator.
 
*If the ''' 'Reseller Invoice' ''' option in the admin area is '''Enabled''', the invoices are issued between the end client and the reseller directly.
 
|}
 
==Domains & CNAME Records Configuration==
 
{|
 
|style="padding: 10px 0px 15px 0px;"|In this section you will find guides on how to create a ''CNAME'' record in popular control panels.<br />
 
For instance, if reseller's branded domain is '' 'reseller.com' '' and the domain with your WHMCS is '' 'whmcs.domain.com' '', the ''CNAME'' needs to be '' 'www.reseller.com. CNAME whmcs.domain.com.'.''<br />
 
'' '''Note 1:''' As you can see above, each domain has to be closed with a full stop.''<br />
 
'' '''Note 2:''' To learn more about certificate requirements, visit the [https://www.docs.modulesgarden.com/Resellers_Center_For_WHMCS#SSL_Certificate SSL Certificate] section.''
 
|}
 
{|
 
|style="padding: 0px 0px 30px 0px;"|The domain used by each of the brands '''must be parked''' on the main domain.<br/>In case a domain cannot be parked or it is a subdomain, you must create the ''CNAME'' records that will redirect from the brand domain to the main domain.<br/>
 
Only when you have parked your domains can you move to setting the ''CNAME'' records on your panels. See the tips below.
 
|}
 
===cPanel===
 
{|
 
|style="padding: 10px 0px 10px 15px;"|1. Log in to your cPanel.
 
|}
 
{|
 
|style="padding: 0px 0px 10px 15px;"|2. Press '' 'Simple DNS Zone Editor' '' under the '' 'Domains' '' section.
 
|}
 
{|
 
|style="padding: 0px 0px 5px 15px;"|3. Select the domain you wish to manage from the menu.<br />
 
'' '''Note:''' This step is required only if you own more than one domain.''
 
|}
 
{|
 
|style="padding: 0px 0px 30px 15px;"|4. Fill in the '' 'Name' '' field and the '' 'CNAME' '' record and press '' 'Add CNAME Record'. ''<br />
 
'' '''Note:''' To define the record's TTL, you have to use '' 'Advanced DNS Zone Editor'.
 
|}
 
 
===DirectAdmin===
 
{|
 
|style="padding: 10px 0px 10px 15px;"|1. Log in to your DirectAdmin.
 
|}
 
{|
 
|style="padding: 0px 0px 10px 15px;"|2. Click '' 'DNS Administration' ''.
 
|}
 
{|
 
|style="padding: 0px 0px 10px 15px;"|3. Afterwards, select the desired domain.
 
|}
 
{|
 
|style="padding: 0px 0px 30px 15px;"|4. Fill in the full domain/subdomain into the CNAME record and press '' 'Add' '' next to it.<br />
 
'' '''Note:''' Do not forget to place a full stop at the end.''
 
|}
 
 
===Plesk===
 
{|
 
|style="padding: 10px 0px 10px 15px;"|1. Log in to your Plesk panel.
 
|}
 
{|
 
|style="padding: 0px 0px 10px 15px;"|2. Press '' 'Domains' '' under the '' 'Hosting Services' '' section.
 
|}
 
{|
 
|style="padding: 0px 0px 5px 15px;"|3. Find the domain to be edited, and click on the corresponding Control Panel link.<br />
 
Afterwards, proceed to the '' 'Websites & Domains' '' tab and press '' 'DNS Settings' ''.
 
|}
 
{|
 
|style="padding: 0px 0px 5px 15px;"|4. Find the domain to be edited and click on the corresponding Control Panel link.<br />
 
Afterwards, proceed to '' 'Websites & Domains' '' tab and press '' 'DNS Settings'.''
 
|}
 
{|
 
|style="padding: 0px 0px 10px 15px;"|5. Add a new record or edit the existing one.
 
|}
 
{|
 
|style="padding: 0px 0px 10px 15px;"|6. Now, change the record type to '' 'CNAME' '' and fill in both the '' 'Domain name' '' and the '' 'Canonical name'.''<br />
 
Finish by pressing '' 'OK'.''<br />
 
'' '''Note:''' The changes will take between 4 to 8 hours to update worldwide.''
 
|}
 
{|
 
|style="padding: 0px 0px 30px 15px;"|'''Remember to restart your server once it is configured.'''
 
|}
 
 
==SSL Certificate==
 
{|
 
|style="padding: 10px 0px 30px 15px;"|If resellers branded domain or your WHMCS main domain are using the SSL connection''', they should also support selected certificates.<br />
 
The supported types of certificates:
 
*'''Dedicated SSL Certificate''' - handled separately for each domain.
 
*'''Wildcard''' - if all brands and main WHMCS are using the same domain.
 
*'''SAN''' - if your brands and main WHMCS are using different domains.
 
This is the way WHMCS works. It is not the limitation of our module which is using '' 'WHMCS System URL' '' scheme.
 
|}
 
===cPanel===
 
{|
 
|style="padding: 10px 0px 10px 15px;"|Installing the SSL certificate for domains managed from cPanel consists of the following steps:
 
|}
 
{|
 
|style="padding: 0px 0px 10px 15px;"|1. Log in to your cPanel and press '' 'SSL/TSLS Manager' '' under the '' 'Security' '' section.
 
|}
 
{|
 
|style="padding: 0px 0px 10px 15px;"|2. Click on '' 'Manage SSL sites' '' under '' 'Install and Manage SSL for your site (HTTPS)'.''
 
|}
 
{|
 
|style="padding: 0px 0px 10px 15px;"|3. (installing the certificate) Select the domain, paste certificate and the private key, and save the settings.
 
|}
 
{|
 
|style="padding: 0px 0px 10px 15px;"|4. (using the already installed certificate) Select it from '' 'Browse Certificates' '', and save the settings.
 
|}
 
{|
 
|style="padding: 0px 0px 30px 15px;"|You can also consider enabling the '' '''[https://blog.cpanel.com/autossl/ AutoSSL]''' '' solution, which should automatically installs domain-validated SSL certificates. Go [https://documentation.cpanel.net/display/ALD/Manage+AutoSSL here] for more information.<br />
 
'' '''Note:''' AutoSSL function will rather not work for CNAME entries so you should use '''[https://documentation.cpanel.net/display/CKB/How+Your+Server+Handles+Domains+and+Virtual+Hosts virtual hosts (vhosts)]''' instead.''
 
|}
 
 
=Tips=
 
{|
 
|style="padding: 10px 0px 5px 15px;"|'''1. Currently, there is no possibility for reseller to sell products that are not visible in the main WHMCS system.'''<br />
 
Hiding a product or a group of products in the main WHMCS will also keep them hidden for reseller's end clients.<br />
 
We will work on making this feature appear in the future releases of the module.
 
|}
 
{|
 
|style="padding: 0px 0px 10px 15px;"|'''2. If your WHMCS is installed in a subdirectory, your resellers using CNAME record must provide their links with it.'''<br />
 
For example, '''reseller.com/main-whmcs-directory''' instead of '''reseller.com.'''.<br />
 
You can change that behavior through adding the below code to ''.htaccess'' file:
 
RewriteEngine on
 
RewriteCond %{HTTP_HOST} !^'''main-whmcs-domain.com'''$ [NC]
 
RewriteCond %{REQUEST_URI} !^/'''whmcs-directory'''/
 
RewriteRule ^(.*)$ /'''whmcs-directory'''/$1 [R=301,L]
 
''Result: If hostname is not '''main-whmcs-domain.com'' and path is not '''whmcs-directory''', then redirect to resellers domain with '''/whmcs-directory'''.''
 
|}
 
{|
 
|style="padding: 0px 0px 10px 15px;"|'''3. When it comes to our Resellers Center For WHMCS and Social Media Login For WHMCS modules, they are compatible and work faultlessly unless your reseller uses branded domain.'''
 
|}
 
{|
 
|style="padding: 0px 0px 30px 15px;"|'''4. If you enable the 'Reseller Invoice' option and any invoice is created in the meantime, you will no longer be able to disable this option.'''
 
|}
 
 
 
=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. When you use https on main WHMCS and your reseller passes non-https domain, the end client will see a warning message from browser that the certificates do not match.'''
+
|}
+
{|
+
|style="padding: 0px 0px 10px 15px;"|
+
'''3. Resellers Center For WHMCS is not compatible with our Multibrand For WHMCS module.'''<br/>
+
There is no integration between these modules and therefore we '''do not''' recommend using them together.
+
|}
+
{|
+
|style="padding: 0px 0px 30px 15px;"|
+
'''4. Please remember that Resellers Center For WHMCS works flawlessly with WHMCS V6 and V7 along with the officially supported ''Template 'Six' '' '''<br/>In case you are using some custom template, you must be aware that unexpected errors might occur and we cannot take the responsibility for solving them.
+
 
|}
 
|}

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.
Navigation
WHMCS Modules
WHMCS Widgets
Translations
cPanel Modules
General
FAQ
Community