Personal tools
Namespaces

Variants
Actions

Hosting Quota Notifications 1.X For WHMCS

From ModulesGarden Wiki
(Difference between revisions)
Jump to: navigation, search
(Membership)
Line 1: Line 1:
<meta name="keywords" content="multibrand for whmcs, multibrand configuration, whmcs multibrand management, whmcs multibrand installation, whmcs multibrand common problems, about whmcs multibrand, whmcs multibrand documentation, whmcs multibrand faq, whmcs multibrand help, whmcs multibrand guide, whmcs multibrand wiki, whmcs multibrand tutorial, whmcs multibrand tips, whmcs multibrand wiki"></meta>
+
<meta name="keywords" content="product auto upgrade for whmcs, product auto upgrade configuration, product auto upgrade  management, product auto upgrade installation, product auto upgrade guide, modulesgarden product auto upgrade, product auto upgrade  wiki, product auto upgrade  tutorial, product auto upgrade tips, whmcs billing module wiki, product auto upgrade common problems, about product auto upgrade, product auto upgrade documentation, product auto upgrade faq, product auto upgrade help"></meta>
<meta name="description" content="ModulesGarden Wiki Contains All The Information You Need About The Multibrand For WHMCS Module."></meta>
+
<meta name="description" content="ModulesGarden Wiki Contains All The Information You Need About The Product Auto Upgrade For WHMCS Module."></meta>
  
=About [https://www.modulesgarden.com/products/whmcs/multibrand Multibrand For WHMCS]=
+
=About [https://www.modulesgarden.com/products/whmcs/product-auto-upgrade Product Auto Upgrade For WHMCS]=
 
{|
 
{|
|style="padding: 10px 0px 10px 0px;"|'''Multibrand For WHMCS''' will allow you to manage multiple brands on multiple websites while using just one WHMCS license.
+
|style="padding: 10px 0px 10px 0px;"|'''Product Auto Upgrade For WHMCS''' permits to automatically shift products on the basis of the server resource usage tracked with Advanced Billing For WHMCS module.<br/>It will allow you to set rules related to the server resource usage according to which the module will upgrade/downgrade products and their configurable options at the right time.<br/>You will be also able to let your clients decide if they want their products to be modified as well as enable them to set the rules on their own.
The module will allow you to easily personalize each brand by adjusting its client area template, logo, language and many other elements.<br />
+
You will be able to assign clients to brands and migrate them, as well as assign products and ticket departments to every brand.<br />
+
Moreover, you will be able to configure payments gateways, customize invoices, add relations to knowledgebase articles, downloads and more - each action can be taken per brand.
+
 
+
 
|}
 
|}
<!--a comment maybe? -->
+
<!--Comment-->
*'''Addon Features:'''
+
*'''Admin Area Features:'''
 
{|
 
{|
|style="padding: 10px 0px 0px 30px;"|✔ User-Friendly Management Of Multiple Brands
+
|style="padding: 10px 0px 0px 30px;"|✔ Define Product Auto Upgrade Groups
 
|}
 
|}
 
{|
 
{|
|style="padding: 0px 0px 0px 30px;"|✔ Easy Modification Of Existing Brands
+
|style="padding: 0px 0px 0px 30px;"|✔ Enable/Disable Product Auto Upgrade Groups
 
|}
 
|}
 
{|
 
{|
|style="padding: 0px 0px 0px 30px;"|✔ Assign Ticket Departments To Brands
+
|style="padding: 0px 0px 0px 30px;"|✔ Create Product Auto Upgrade Options
 
|}
 
|}
 
{|
 
{|
|style="padding: 0px 0px 0px 30px;"|✔ Configure Payment Gateways For Each Brand
+
|style="padding: 0px 0px 0px 30px;"|✔ Assign Product To An Option - Configurable Option Support
 
|}
 
|}
 
{|
 
{|
|style="padding: 0px 0px 0px 30px;"|✔ Configure Email Templates For Each Brand
+
|style="padding: 0px 0px 0px 30px;"|✔ Define Options Upgrade/Downgrade Rules
 
|}
 
|}
 
{|
 
{|
|style="padding: 0px 0px 0px 30px;"|✔ Configure SMTP Mailboxes For Each Brand
+
|style="padding: 0px 0px 0px 30px;"|✔ Set Up Minimal Upgrade/Downgrade Interval
 
|}
 
|}
 
{|
 
{|
|style="padding: 0px 0px 0px 30px;"|✔ Set Up Products, Addons And Domain Pricing For Each Brand
+
|style="padding: 0px 0px 0px 30px;"|✔ Enable/Disable Any Product Auto Upgrade Option
 
|}
 
|}
 
{|
 
{|
|style="padding: 0px 0px 0px 30px;"|✔ Display And Migrate Clients Between Brands
+
|style="padding: 0px 0px 0px 30px;"|✔ Drag & Drop To Reorder Options
 
|}
 
|}
 
{|
 
{|
|style="padding: 0px 0px 0px 30px;"|✔ Display And Manage Relations Of Services, Invoices, Tickets, Knowledgebase, Downloads And Announcements Assigned To Brands
+
|style="padding: 0px 0px 0px 30px;"|✔ Define Client Area Features
|}
+
{|
+
|style="padding: 0px 0px 0px 30px;"|✔ Toggle Invoice Branding
+
|}
+
{|
+
|style="padding: 0px 0px 0px 30px;"|✔ Toggle Brand Status On Click
+
|}
+
{|
+
|style="padding: 0px 0px 0px 30px;"|✔ Toggle Auto Client Assign
+
|}
+
{|
+
|style="padding: 0px 0px 0px 30px;"|✔ Monthly And Total Sale Amount Per Brand
+
|}
+
{|
+
|style="padding: 0px 0px 0px 30px;"|✔ View Dynamic Statistics On Each Brand
+
|}
+
{|
+
|style="padding: 0px 0px 10px 30px;"|✔ View Logs
+
|}
+
*'''Admin Area Features:'''
+
{|
+
|style="padding: 10px 0px 0px 30px;"|✔ Order Branded Products
+
 
|}
 
|}
 
{|
 
{|
|style="padding: 0px 0px 0px 30px;"|✔ Create Branded Invoices
+
|style="padding: 0px 0px 0px 30px;"|✔ View List Of All Hostings Affected By Product Auto Upgrade
 
|}
 
|}
 
{|
 
{|
|style="padding: 0px 0px 10px 30px;"|✔ Display Brand Labels On The Lists Of Clients And Invoices
+
|style="padding: 0px 0px 10px 30px;"|✔ Access Product Auto Upgrade History Of Any Hosting
 
|}
 
|}
 
*'''Client Area Features:'''
 
*'''Client Area Features:'''
 
{|
 
{|
|style="padding: 10px 0px 0px 30px;"|✔ Display Client Area Template And Default Language Depending On Brand
+
|style="padding: 10px 0px 0px 30px;"|✔ Enable/Disable Product Auto Upgrade And Product Auto Upgrade Options
 
|}
 
|}
 
{|
 
{|
|style="padding: 0px 0px 0px 30px;"|✔ Access Services, Invoices, Downloads, Ticket Departments and Payment Gateways Assigned To Brand
+
|style="padding: 0px 0px 0px 30px;"|✔ Manage Rules Of Product Auto Upgrade Options
 
|}
 
|}
 
{|
 
{|
|style="padding: 0px 0px 0px 30px;"|✔ View Knowledgebase Articles And Announcements Assigned To Brand
+
|style="padding: 0px 0px 0px 30px;"|✔ Set Up Minimal Upgrade/Downgrade Interval
 
|}
 
|}
 
{|
 
{|
|style="padding: 0px 0px 0px 30px;"|✔ Receive Branded Emails And Invoices
+
|style="padding: 0px 0px 0px 30px;"|✔ View Products' Product Auto Upgrade History
 
|}
 
|}
 
{|
 
{|
|style="padding: 0px 0px 0px 30px;"|✔ Clients Registering Into A Brand May Be Automatically Assigned To It
+
|style="padding: 0px 0px 0px 30px;"|✔ Set Up Rules Of Notifications
 
|}
 
|}
 
{|
 
{|
|style="padding: 0px 0px 10px 30px;"|✔ Clients Logging Into Another Brand May Be Automatically Assigned To It With The Same Access Details
+
|style="padding: 0px 0px 10px 30px;"|✔ Define Minimal Notification Interval
 
|}
 
|}
*'''Brand Configuration:'''
+
*'''General Info:'''
 
{|
 
{|
|style="padding: 10px 0px 0px 30px;"|✔ Set Up Brand Name
+
|style="padding: 10px 0px 0px 30px;"|✔ Requires <u>Advanced Billing For WHMCS</u> - Server Resource Usage Billing [http://www.modulesgarden.com/products/whmcs/advanced_billing/features (read more)]
 
|}
 
|}
 
{|
 
{|
|style="padding: 0px 0px 0px 30px;"|✔ Brand Company Name
+
|style="padding: 0px 0px 0px 30px;"|✔ Multi-Language Support
|}
+
{|
+
|style="padding: 0px 0px 0px 30px;"|✔ Brand Domain Address
+
|}
+
{|
+
|style="padding: 0px 0px 0px 30px;"|✔ Brand Logo
+
|}
+
{|
+
|style="padding: 0px 0px 0px 30px;"|✔ Brand Default Language
+
|}
+
{|
+
|style="padding: 0px 0px 0px 30px;"|✔ Brand Template
+
|}
+
{|
+
|style="padding: 0px 0px 0px 30px;"|✔ Brand Order Template
+
|}
+
{|
+
|style="padding: 0px 0px 0px 30px;"|✔ Brand Address
+
|}
+
{|
+
|style="padding: 0px 0px 0px 30px;"|✔ Brand Signature
+
|}
+
{|
+
|style="padding: 0px 0px 0px 30px;"|✔ Brand Email Address
+
|}
+
{|
+
|style="padding: 0px 0px 0px 30px;"|✔ Brand Ticket Departments
+
|}
+
{|
+
|style="padding: 0px 0px 0px 30px;"|✔ Brand Graph Color
+
|}
+
{|
+
|style="padding: 0px 0px 0px 30px;"|✔ Brand Terms Of Service URL
+
|}
+
{|
+
|style="padding: 0px 0px 0px 30px;"|✔ Brand Invoice Sequential Number, Format And Pay To Text
+
|}
+
{|
+
|style="padding: 0px 0px 0px 30px;"|✔ Set Up Branded Or Normal Payment Gateways
+
|}
+
{|
+
|style="padding: 0px 0px 0px 30px;"|✔ Brand Email CSS Styling And Content
+
|}
+
{|
+
|style="padding: 0px 0px 10px 30px;"|✔ Brand Email Templates In Various Languages
+
|}
+
*'''Branded Payment Gateways:'''
+
{|
+
|style="padding: 10px 0px 0px 30px;"|✔ 2Checkout
+
|}
+
{|
+
|style="padding: 0px 0px 0px 30px;"|✔ Authorize.Net
+
|}
+
{|
+
|style="padding: 0px 0px 0px 30px;"|✔ Checkout.com
+
|}
+
{|
+
|style="padding: 0px 0px 0px 30px;"|✔ PayPal REST
+
|}
+
{|
+
|style="padding: 0px 0px 10px 30px;"|✔ Stripe
+
|}
+
*'''General Info:'''
+
{|
+
|style="padding: 10px 0px 0px 30px;"|✔ Multi-Language Support
+
 
|}
 
|}
 
{|
 
{|
|style="padding: 0px 0px 0px 30px;"|✔ Supports PHP 5.4 Up To PHP 7
+
|style="padding: 0px 0px 0px 30px;"|✔ Supports PHP 5.3 Up To PHP 7
 
|}
 
|}
 
{|
 
{|
|style="padding: 0px 0px 0px 30px;"|✔ Supports WHMCS Template Six
+
|style="padding: 0px 0px 0px 30px;"|✔ Supports WHMCS Templates Five and Six
 
|}
 
|}
 
{|
 
{|
|style="padding: 0px 0px 10px 30px;"|✔ Supports WHMCS V7
+
|style="padding: 0px 0px 30px 30px;"|✔ Supports WHMCS V6 and V7
 
|}
 
|}
  
=Installation=
+
=Installation and Configuration=
 
{|
 
{|
|style="padding: 10px 0px 30px 15px;"|'''This tutorial will show you how to successfully install and configure Multibrand For WHMCS.''' <br />
+
|style="padding: 10px 0px 0px 0px;"|'''In this tutorial we will show you how to successfully install and manage Product Auto Upgrade For WHMCS.'''<br />
We will guide you step by step through the whole installation and configuration 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 Multibrand For WHMCS  previous versions '''prior to v2.x''', [https://www.docs.modulesgarden.com/Multibrand_1.X_For_WHMCS read about it here].''
+
 
|}
 
|}
==Installation==
 
 
{|
 
{|
|style="padding: 10px 0px 20px 15px;"|'''1. Log in to your client area and download the module.'''
+
|style="padding: 20px 0px 20px 15px;"|'''1. Log in to your client area and download the module.'''
 
|}
 
|}
 
{|
 
{|
|style="padding: 0px 0px 20px 25px;"|[[File:MB2_1.png]]
+
|style="padding: 0px 0px 20px 25px;"|[[File:AB2_AS_1.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 7, while the second one is aimed at PHP 5.4 up to PHP 5.6.<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 7, while the second one is aimed at PHP 5.3 up to PHP 5.6.<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 current PHP version in your WHMCS. To do so proceed to ''' 'Utilities' → 'System' → 'PHP Info'.'''
 
|}
 
|}
 
{|
 
{|
|style="padding: 0px 0px 20px 25px;"|[[File:MB2_2.png]]
+
|style="padding: 0px 0px 30px 25px;"|[[File:AB2_AS_2.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 />
 
|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.  
+
Files in your WHMCS directory should look like this.
 
|}
 
|}
 
{|
 
{|
|style="padding: 0px 0px 20px 25px;"|[[File:MB2_2_2.png]]
+
|style="padding: 0px 0px 30px 25px;"|[[File:drte4.png]]
|}
+
{|
+
|style="padding: 0px 0px 15px 15px;"|'''4. When you install Multibrand For WHMCS for the first time you have to rename '' 'license_RENAME.php' '' file.'''<br />
+
File is located in '' 'modules/addons/MultibrandFunctionality/license_RENAME.php'.''  Rename it from '' 'license_RENAME.php' '' to '' 'license.php'.''
+
|}
+
{|
+
|style="padding: 0px 0px 20px 25px;"|[[File:MB2_3.png]]
+
|}
+
{|
+
|style="padding: 0px 0px 15px 15px;"|'''5. In order to configure your license key, you have to edit the previously renamed '' 'license.php' '' file.'''<br />
+
Enter your license key between quotation marks as presented on the following screen. You can find your license key in your client area'' → 'My Products'.''
+
|}
+
{|
+
|style="padding: 0px 0px 30px 25px;"|[[File:MB2_4.png]]
+
 
|}
 
|}
  
==Activating Addon Module==
+
==Module Configuration==
 
{|
 
{|
|style="padding: 10px 0px 15px 15px;"|'''6. Now you have to activate the module in your WHMCS system.'''<br />
+
|style="padding: 10px 0px 15px 15px;"|'''4. Now you have to activate the module in your WHMCS system.'''<br/>
Log in to your WHMCS admin area. Go to '' 'Setup' '' → '' 'Addon Modules'. '' Afterwards, find '' 'Multibrand' '' and press '' 'Activate' '' button.
+
Move to '' 'Setup' → 'Addon Modules', '' find '' 'Advanced Billing' '' and press '' 'Activate' '' button.<br/>
 +
''Note: Skip this subsection, if you have Advanced Billing For WHMCS already installed.''
 
|}
 
|}
 
{|
 
{|
|style="padding: 0px 0px 20px 25px;"|[[File:MB2_5.png]]
+
|style="padding: 0px 0px 20px 25px;"|[[File:PAU_5.png]]
 
|}
 
|}
 
{|
 
{|
|style="padding: 0px 0px 15px 15px;"|'''7. In the next step you need to enable the hooks and grant access to this module.'''<br />
+
|style="padding: 0px 0px 15px 15px;"|'''5. In the next step you need to permit access to the module.'''<br/>
To do so, click on '' 'Configure' '' button, go to '' 'Access Control' '' area and check the required group of administrators. Press '' 'Save Changes'.''
+
To do so, press '' 'Configure', '' choose desired admin roles and press '' 'Save Changes'. ''
 
|}
 
|}
 
{|
 
{|
|style="padding: 0px 0px 30px 25px;"|[[File:MB2_6.png]]
+
|style="padding: 0px 0px 20px 25px;"|[[File:PAU_6.png]]
 
|}
 
|}
 
==Additional Settings==
 
 
{|
 
{|
|style="padding: 10px 0px 15px 15px;"|'''8. Now, set up the  '' 'storage' '' folder with its subfolders as recursively writable.'''<br />
+
|style="padding: 0px 0px 20px 15px;"|'''6. Now, set up a cron job, you can find it in your WHMCS → '' 'Addons' → 'Advanced Billing' '' as shown on the following screen.'''
This folder are located in '' 'your_whmcs/modules/addons/Multibrand/' '' location.
+
 
|}
 
|}
 
{|
 
{|
|style="padding: 0px 0px 20px 25px;"|[[File:MB2_7.png]]
+
|style="padding: 0px 0px 30px 25px;"|[[File:PAU_7.png]]
|}
+
{|
+
|style="padding: 10px 0px 15px 15px;"|'''9. You will also need to set up  '' 'gateways' '' and '' 'callback' '' folders as writable.'''<br />
+
The '' 'gateways' '' folder is located in '' 'your_whmcs/modules/' '' and the '' 'callback' '' folder in '' 'your_whmcs/modules/gateways' '' (do '''NOT''' mistake the folders with those in the Multibrand addon location)''
+
|}
+
{|
+
|style="padding: 0px 0px 20px 25px;"|[[File:MB2_7_0.png]]
+
|}
+
{|
+
|style="padding: 0px 0px 15px 15px;"|'''10. The next step is replacing '' 'invoicepdf.tpl' '' file with '' 'invoicepdf_rename.tpl' '' for each of the templates used.'''<br />
+
The '' 'invoicepdf_rename.tpl' '' file is located in the '' 'your_whmcs/templates/six/' '' folder.<br />
+
Just remove the default '' 'invoicepdf.tpl' '' file from the template folder and rename the'' 'invoicepdf_rename.tpl' '' file to '' 'invoicepdf.tpl' '' in the same folder.
+
|}
+
{|
+
|style="padding: 0px 0px 20px 25px;"|[[File:MB2_7_1.png]]
+
 
|}
 
|}
  
==Integration Code==
+
==Extension Configuration==
 
{|
 
{|
|style="padding: 10px 0px 15px 15px;"|'''11. Now you can access your Multibrand For WHMCS module.'''<br />
+
|style="padding: 10px 0px 15px 15px;"|'''7. Now, you have to activate the extension in your Advanced Billing For WHMCS.'''<br/>
Simply go to '' 'Addons' '' → '' 'Multibrand'.'' But, before you can start using the module, you still need to set up the '' 'Integration Code'. '' It is required for the correct logo branding and it should be done for all brand templates that you want to use.<br/>
+
Log in to your WHMCS admin area and proceed to '' 'Addons' '' → '' 'Advanced Billing' '' '' 'Settings' '' → '' 'Extensions'. ''<br/>
It is very easy. Go to '' 'Utilities' '' → '' 'Integration Code' ''and follow the instructions given there, depending on the version of your WHMCS and the templates you are using.
+
Afterwards, find '' 'Product Auto Upgrade' '' and enable the extension.
 
|}
 
|}
 
{|
 
{|
|style="padding: 0px 0px 20px 25px;"|[[File:MB2_8.png]]
+
|style="padding: 0px 0px 20px 25px;"|[[File:PAU_8.png]]
 
|}
 
|}
 
{|
 
{|
|style="padding: 0px 0px 30px 15px;"|'''12. And that is all! You have now completed the installation of the module.'''<br />
+
|style="padding: 0px 0px 15px 15px;"|'''8. Next, you have to provide your license key.'''<br/>
 +
Press '' 'Configure' '' next to the extension.
 
|}
 
|}
 
==Migration==
 
 
{|
 
{|
|style="padding: 10px 0px 30px 15px;"|'''In the current beta 2.0.0 version it is not possible to easily migrate data from 1.8.X to the 2.X module version. <br/>
+
|style="padding: 0px 0px 20px 25px;"|[[File:PAU_8_1.png]]
Such a migration functionality will be added in the future stable version. We are sorry for the inconvenience.
+
 
|}
 
|}
 
=Configuration and Management=
 
 
{|
 
{|
|style="padding: 10px 0px 30px 15px;"|'''In this section we will show you how to properly set up and use Multibrand For WHMCS.'''
+
|style="padding: 0px 0px 20px 15px;"|'''9. Paste your license here and then confirm the changes.'''
 
|}
 
|}
==Brands==
 
 
{|
 
{|
|style="padding: 10px 0px 30px 15px;"|In the '' 'Brands' '' tab you can create and manage your brands using a single instance of WHMCS solution.<br/>
+
|style="padding: 0px 0px 20px 25px;"|[[File:PAU_9.png]]
'' '''Important:''' Due to the module beta limitations, configuration of one of the brands must be manually set to your '''main WHMCS domain'''. Simplification of this process will be solved in the future editions.''
+
 
|}
 
|}
===New Brand===
 
 
{|
 
{|
|style="padding: 10px 0px 20px 15px;"|Let us start by creating a new brand. For that purpose go to the '' 'Brands' '' tab and press '' 'Add a new brand' '' [[File:MB2_Plus.png|frameless]] button.
+
|style="padding: 0px 0px 30px 15px;"|'''Your Product Auto Upgrade For WHMCS is ready to use! '''
|}
+
{|
+
|style="padding: 0px 0px 20px 25px;"|[[File:MB2_10.png]]
+
|}
+
{|
+
|style="padding: 0px 0px 20px 15px;"|Fill in the brands's '' 'Name' ''  and '' 'Domain' '' with desired values and press '' 'Save' '' button.
+
|}
+
{|
+
|style="padding: 0px 0px 20px 25px;"|[[File:MB2_11.png]]
+
|}
+
{|
+
|style="padding: 0px 0px 20px 15px;"|Your first brand is created. Next, press '' 'Edit' ' '' [[File:MB2_Edit.png|frameless]] action button.
+
|}
+
{|
+
|style="padding: 0px 0px 20px 25px;"|[[File:MB2_11_1.png]]
+
|}
+
{|
+
|style="padding: 0px 0px 20px 15px;"|You will be moved to the brand configuration area, where you can manage your brand's information and settings.
+
|}
+
{|
+
|style="padding: 0px 0px 30px 25px;"|[[File:MB2_11_2.png]]
+
|}
+
{|
+
|style="padding: 0px 0px 30px 15px;"|
+
'' '''Note:''' Once the configuration of your brand is complete, you will still need to set up a CNAME DNS record before the brand is published (status - enabled).''<br/>
+
''This record will point from the branded domain towards your main domain used by WHMCS. To learn more about setting up the CNAME records, proceed to the [[Multibrand_For_WHMCS#Creating_CNAME_Records|Creating CNAME Records]] section.''<br />
+
''Do not forget to publish the brand as soon as the CNAME record is spread worldwide.''
+
 
|}
 
|}
  
===Brand Information===
+
=Management=
 
{|
 
{|
|style="padding: 10px 0px 15px 15px;"|In the Brand Information window you can edit the brand name, domain name and custom logo. <br/>
+
|style="padding: 10px 0px 10px 15px;"|'''To combine any product with Product Auto Upgrade For WHMCS, you need to firstly enable and then configure it in Advanced Billing For WHMCS.'''<br/>
In addition, you can see the current month's revenue, total sales and the last brand update.
+
Advanced Billing For WHMCS is used to collect information about hosting's resource usage.<br/>
 +
'''Important:''' Product Auto Upgrade For WHMCS uses '' 'Change Package' '' functionality to switch the products.<br/>Therefore it is required that the products also support this feature.
 
|}
 
|}
 +
==Admin Area==
 
{|
 
{|
|style="padding: 0px 0px 30px 25px;"|[[File:MB2_9.png]]
+
|style="padding: 0px 0px 20px 15px;"|Before you can do anything you must enable the products you want to work with for Advanced Billing.  
 
|}
 
|}
 
===Settings===
 
 
{|
 
{|
|style="padding: 10px 0px 20px 15px;"|In this window you will be able to configure all the most important settings of your brand including billing, payment gateways, SMTP and email templates configuration.
+
|style="padding: 0px 0px 20px 25px;"|[[File:PAU_10.png]]
 
|}
 
|}
 
====General====
 
 
{|
 
{|
|style="padding: 10px 0px 15px 15px;"|In the general settings you will configure the main brand options. <br/>
+
|style="padding: 0px 0px 15px 15px;"|Only then you have to enable the extension Product Auto Upgrade For WHMCS for each of the products.<br/>Move to '' 'Settings', '' find appropriate section and enable the extension.
First, fill out the brand's '' 'Email Address', 'Company Name' '' and '' 'TOS URL' ''. Next, choose the brand's '' 'Color', 'Ticket Departments' , 'Default Language',  'Template' '' and '' 'Order Template' ''.<br />
+
Make sure that the chosen template is integrated with Multibrand correctly (see the [https://www.docs.modulesgarden.com/Multibrand_For_WHMCS#Integration_Code Integration Code] section). Finally, toggle '' 'Auto Client Assign' '' if you wish to. <br/>
+
Here you can also manage your current brand's status, but you should change it to '' 'Enabled' '' only after you have configured the rest of the settings. <br/>
+
Do not forget to press '' 'Save Configuration' ''.
+
<br/><br/>
+
'' '''Note:''' Currently all new users added by admin or through API will not be assigned to any brand by default. This feature will be included in the next releases.''
+
<!--
+
'' '''Note:''' Only published brands can be set as default. New users added by admin or through API will be assigned to the default brand.''
+
-->
+
 
|}
 
|}
 
{|
 
{|
|style="padding: 0px 0px 30px 25px;"|[[File:MB2_11_3.png]]
+
|style="padding: 0px 0px 30px 25px;"|[[File:PAU_10_1.png]]  
 
|}
 
|}
 +
===Groups of Rules===
 
{|
 
{|
 
+
|style="padding: 10px 0px 15px 15px;"|As you might have already noticed, a new tab dedicated to the extension appeared on your Advanced Billing For WHMCS module main menu.<br/>Under this section there is located the whole management of the extension.<br/>
====Billings====
+
Let's move to '' 'Configuration' '' firstly.
{|
+
|style="padding: 10px 0px 15px 15px;"| In the '' 'Billing' '' settings you can configure the design of your invoices.
+
*'''Invoice Branding''' - if enabled, the invoices will be branded with the number and basic information
+
*'''Invoice Pay To Text''' - address that is displayed on the invoice as the 'Pay To' details.
+
*'''Sequential Invoice Number Format''' - if invoice branding is enabled, the provided sequential invoice number format will be used
+
*'''Next Sequential Number''' - change this option only if you want to reset the automatic sequential numbering. Otherwise leave empty
+
'' '''Note:''' Remember to do the '[https://www.docs.modulesgarden.com/Multibrand_For_WHMCS#Additional_Settings Additional Settings]' step during module installation to make the PDF invoices also branded.''
+
 
|}
 
|}
 
{|
 
{|
|style="padding: 0px 0px 30px 25px;"|[[File:MB2_12.png]]
+
|style="padding: 0px 0px 20px 25px;"|[[File:PAU_11.png]]  
 
|}
 
|}
 
====Payment Gateways====
 
 
{|
 
{|
|style="padding: 10px 0px 15px 15px;"| This tab allows you to configure a payment gateway for the brand which will work independently from the one configured in WHMCS.<br />
+
|style="padding: 10px 0px 15px 15px;"|What you will find there is a full list of autoscaling groups displayed.<br/>
You can check the list of the currently available gates in the [https://www.docs.modulesgarden.com/Multibrand_For_WHMCS#About_Multibrand_For_WHMCS Feature List].<br/>
+
Here you can find information such as status of a group, its name and used submodule.<br/>What is more, you can manage groups through using buttons in '' 'Actions' '' column to prepare rules for scaling services.
If in the future releases you would like to see a payment gateway that is not yet available, please contact our [https://www.modulesgarden.com/support support].
+
<br/><br/>
+
To add a new payment gateway configuration, press '' 'Add' '' [[File:MB2_Plus.png|frameless]] button.
+
 
|}
 
|}
 
{|
 
{|
|style="padding: 0px 0px 20px 25px;"|[[File:MB2_13.png]]
+
|style="padding: 0px 0px 20px 25px;"|[[File:PAU_11_1.png]]  
 
|}
 
|}
 
{|
 
{|
|style="padding: 0px 0px 20px 15px;"|Next, choose the desired gate from the list and press '' 'Confirm' '' button.
+
|style="padding: 10px 0px 15px 15px;"|Let's see now how to create a new group.<br/>
 +
Press '' 'Create New Group' '' button and a short formula will appear.
 
|}
 
|}
 
{|
 
{|
|style="padding: 0px 0px 20px 25px;"|[[File:MB2_14.png]]
+
|style="padding: 0px 0px 20px 25px;"|[[File:PAU_12.png]]
 
|}
 
|}
 
{|
 
{|
|style="padding: 0px 0px 15px 15px;"|Finally, fill in the payment gateway settings according to the details received from the provider. <br/>
+
|style="padding: 0px 0px 15px 15px;"|You can add products and define rules inside of the group which will result in upgrading/downgrading client's hosting.<br/>
Save the configuration and activate the gateway.
+
Name your new group - this name is only for your information and convenience. Then select the product that can be automatically upgraded or downgraded according to resource usage count.<br/>Optionally, you can enable and choose configurable option group that will be used to define products options.<br/>
 +
Save the group when it is ready.
 
|}
 
|}
 
{|
 
{|
|style="padding: 0px 0px 20px 25px;"|[[File:MB2_15.png]]
+
|style="padding: 0px 0px 20px 25px;"|[[File:PAU_13.png]]
 
|}
 
|}
 
{|
 
{|
|style="padding: 0px 0px 15px 15px;"|'' '''Note:''' You may still use any other payment gateway which is active in your WHMCS system. These gates will have a ''' (WHMCS) ''' label.''<br/>
+
|style="padding: 0px 0px 20px 15px;"|Your newly created group appeared on the list. Now you can configure it according to your specific needs.
''Multibrand For WHMCS can work with any gateway that works within your WHMCS. The only limitation is that these payment gateways use the same settings for all brands.''
+
 
|}
 
|}
 
{|
 
{|
|style="padding: 0px 0px 30px 25px;"|[[File:MB2_15_2.png]]
+
|style="padding: 0px 0px 30px 25px;"|[[File:PAU_13_1.png]]
 
|}
 
|}
 
+
====Group Configuration====
<br/><br/>
+
 
+
====SMTP====
+
 
{|
 
{|
|style="padding: 10px 0px 15px 15px;"| If you would like to use for your brand an outgoing mail configuration which is different from the one in the main WHMCS settings, you can do so in this tab.<br/>
+
|style="padding: 10px 0px 15px 15px;"|There are two main sections where a group can be configured.  
In addition, you can set your custom CSS email styling as well as the header and footer content.
+
#'' 'Settings' '' - a place where general and client area configuration is set up.
 +
#'' 'Options' '' - detailed configuration of rules to scale services automatically.
 
|}
 
|}
 
{|
 
{|
|style="padding: 0px 0px 30px 25px;"|[[File:MB2_16.png]]
+
|style="padding: 0px 0px 30px 25px;"|[[File:PAU_14.png]]
 
|}
 
|}
 
+
=====Group Settings=====
====Email Templates====
+
 
{|
 
{|
|style="padding: 10px 0px 15px 15px;"| In this window you can set up each branded email template in five available categories.<br/>
+
|style="padding: 10px 0px 15px 15px;"|'''General Configuration'''
*If '''enabled''', the template configured here will be sent to the clients using the branded SMTP settings instead of the ones configured in the main WHMCS template and configuration.
+
*'''Group Name''' - name of a group, can be changed at any time and is visible only to the admin.
*If '''enabled''', but not configured yet, the main WHMCS template will be sent with branding applied to it.
+
*'''Server Type''' - module type of the product allowed in the group.
*If '''disabled''', the main WHMCS template will be sent using the main WHMCS SMTP configuration without any branding applied.
+
*'''Time Interval''' - minimum time period between the two products changes that can be made on a single hosting.
To start editing a branded template, simply press '' 'Edit' '' [[File:MB2_Edit.png|frameless]] button.
+
*'''Notifications Time Interval''' - defines time between notifications sent to a client.
 
|}
 
|}
 
{|
 
{|
|style="padding: 0px 0px 20px 25px;"|[[File:MB2_17.png]]
+
|style="padding: 0px 0px 20px 25px;"|[[File:PAU_14_1.png]]  
 
|}
 
|}
 
{|
 
{|
|style="padding: 0px 0px 15px 15px;"| Next, enter the desired subject and message content. You can also create more versions, in several languages. <br/>
+
|style="padding: 0px 0px 15px 15px;"|'''Client Area Configuration'''
IAdditionally, you can use the available merge fields tags just like in the standard email templates. Save the changes after finishing.
+
*'''Display Client Rules Configuration''' - shows rules of this group for clients with products configured in the group.
 +
*'''Modify Rules Configuration''' - client can modify group rules, changes will affect their product only.
 +
*'''Modify Time Interval''' - client can modify the minimum time between two switches on a single hosting.
 +
*'''Allowed Time Interval Values''' - specifies what time interval a client can use (they will be displayed in the form of a dropdown menu or a textbox with a limited range).
 +
*'''Enable Notifications''' - allows the client to enable/disable notifications.
 +
*'''Modify Notifications Time Interval''' - allows the client to modify minimum time between two notifications.
 +
*'''Allowed Notifications Time Interval Values''' - defines values which can be used by client.<br/>
 +
Do not forget to save the configuration when it is ready.
 
|}
 
|}
 
{|
 
{|
|style="padding: 0px 0px 20px 25px;"|[[File:MB2_18.png]]
+
|style="padding: 0px 0px 30px 25px;"|[[File:PAU_14_2.png]]  
|}
+
{|
+
|style="padding: 10px 0px 15px 15px;"| Finally, toggle the edited template to enabled and save the configuration. Next to the edited template you will see the '' 'Branded' '' label. <br/>
+
If you would like to restore the default template, simply return to editing it and click the '' 'Delete Template' '' button.
+
|}
+
{|
+
|style="padding: 0px 0px 30px 25px;"|[[File:MB2_19.png]]
+
 
|}
 
|}
  
===Services Pricing===
+
=====Group Options=====
 
{|
 
{|
|style="padding: 10px 0px 20px 15px;"|In this section you can configure separate prices for '' '''products''', '''addons''' '' and '' '''domains''' ''.<br/><br/>
+
|style="padding: 10px 0px 15px 15px;"|The second place where the group rules are configured is '''Options''' section.<br/>
To start, select the product, addon or domain tab and click on the '' 'Add' '' [[File:MB2_Plus.png|frameless]] button. In the following example you will see how to add branding for product pricing.
+
These rules will be used by the extension to determine which service should be changed.<br/>Service will be changed according to the parameters set in rules options if the condition of either downgrade rules or upgrade rules has been met.  
 
|}
 
|}
 
{|
 
{|
|style="padding: 0px 0px 20px 25px;"|[[File:MB2_20.png]]
+
|style="padding: 0px 0px 20px 25px;"|[[File:PAU_15.png]]  
 
|}
 
|}
 
{|
 
{|
|style="padding: 0px 0px 20px 15px;"|Select the product for which you want to set branded prices and click '' 'Save' ''.
+
|style="padding: 0px 0px 15px 15px;"|Every group has already some predefined basic options - disabled at the start.<br/>You can base your rules configuration on them or add your own ones in case they are not sufficient.<br/>Let us show how to set the autoscaling rules on the basis of these options.<br/>
 +
Before you can do anything, you must configure the upgrade and downgarade rules.
 
|}
 
|}
 
{|
 
{|
|style="padding: 0px 0px 20px 25px;"|[[File:MB2_21.png]]
+
|style="padding: 0px 0px 20px 25px;"|[[File:PAU_16.png]]  
 
|}
 
|}
 
{|
 
{|
|style="padding: 0px 0px 20px 15px;"|Next, open the pricing editor for the chosen product.
+
|style="padding: 0px 0px 15px 15px;"|'' 'Upgrade Rules'/'Downgrade Rules' '' can have multiple rules defined.<br/>
 +
To add a new rule, select it from a dropdown menu marked on the following screen and press '' 'Add'.''
 
|}
 
|}
 
{|
 
{|
|style="padding: 0px 0px 20px 25px;"|[[File:MB2_22.png]]
+
|style="padding: 0px 0px 20px 25px;"|[[File:PAU_17.png]]  
 
|}
 
|}
 
{|
 
{|
|style="padding: 0px 0px 20px 15px;"|Here you can configure the desired prices in selected billing cycles and currencies. <br/>
+
|style="padding: 0px 0px 15px 15px;"|You can define comparison type and threshold of any added rule.<br/>
You can also automatically fill in the amounts from the main product and update them, refreshing the currencies rate.<br/><br/>
+
To add a rule which will be fulfilled when the product has more or equal than 3 FTP accounts, choose '' '' '' from '' 'Comparison Type' '' and type '' '3' '' into '' 'Threshold' '' field.<br/>
 
+
This example can be seen on the following screen.
'' '''Note:''' Availability of billing cycles, prices and currencies to be edited depends on their main configuration in WHMCS.''<br/>
+
''If one of them is not available for branding, it means that there is no corresponding configuration in the main WHMCS.''
+
 
|}
 
|}
 
{|
 
{|
|style="padding: 0px 0px 20px 25px;"|[[File:MB2_23.png]]
+
|style="padding: 0px 0px 20px 25px;"|[[File:PAU_18.png]]  
 
|}
 
|}
 
{|
 
{|
|style="padding: 0px 0px 30px 15px;"|From now on, the pricing for this product will be branded. In the same way, you can also configure pricing for addons and domains.
+
|style="padding: 0px 0px 15px 15px;"|You also have to define a product for each package that will be used when upgrading/downgrading.<br/>Press button marked on the screen to go on.
 
|}
 
|}
 
===Relations===
 
 
{|
 
{|
|style="padding: 10px 0px 30px 15px;"|In this section you can see which '' '''Clients, Services, Invoices, Knowledgebase, Downloads''' '' and ''' ''Announcements'' ''' are assigned to this brand. <br/>
+
|style="padding: 0px 0px 20px 25px;"|[[File:PAU_18_1.png]]  
In addition, you can manually manage, assign and unassign selected items to the brand.<br/>
+
Do not forget to check the '' '[https://www.docs.modulesgarden.com/Multibrand_For_WHMCS#Branded_Admin_Area_Functionalities Branded Admin Area Functionalities]' '' section, where you will find more brand relation management functionality outside the Multibrand addon.<br/><br/>
+
 
+
'' '''Note:''' Currently there is no possibility of mass management, assigning and unassigning selected items to the brand. This functionality will be implemented in future releases.
+
 
|}
 
|}
 
====Clients====
 
 
{|
 
{|
|style="padding: 10px 0px 15px 15px;"|In the clients tab you can see customers who are assigned to the brand and the date on which they were assigned.<br/>
+
|style="padding: 0px 0px 15px 15px;"|Select the product you need from the available in the dropdown menu.<br/>  
Assignment takes place at the moment of client's registration for the branded domain. You can also manually assign the already existing customers to the brand or migrate them to another.
+
Then select option you wish to be used by clients and add it. Save the changes.<br/>
 
+
'''Important!''' Options selection is available only if a supported configurable options group has been enabled for the group of rules on its creation.
'' '''Note:''' If 'Auto Client Assign' option is enabled, then the customers who are already registered in one of the brands and try to log in to another brand,will also be automatically assigned to it.''<br/>
+
Therefore, one customer can be assigned to several brands at the same time.  
+
 
|}
 
|}
 
{|
 
{|
|style="padding: 0px 0px 20px 25px;"|[[File:MB2_24.png]]
+
|style="padding: 0px 0px 20px 25px;"|[[File:PAU_18_2.png]]  
 
|}
 
|}
 
{|
 
{|
|style="padding: 0px 0px 15px 15px;"| To assign an existing client to the brand, press '' 'Add' '' [[File:MB2_Plus.png|frameless]] button. <br/>
+
|style="padding: 0px 0px 20px 15px;"|Every selected option appears in the box above. Here you can specify available selection under '' 'Setting' '' or delete it.
In the pop-up select the customer you want to add to the brand and press '' 'Save' ''.
+
 
|}
 
|}
 
{|
 
{|
|style="padding: 0px 0px 20px 25px;"|[[File:MB2_25.png]]
+
|style="padding: 0px 0px 30px 25px;"|[[File:PAU_18_3.png]]  
 
|}
 
|}
 
{|
 
{|
|style="padding: 0px 0px 15px 15px;"| You can also migrate the customers from this brand to another one. <br/>
+
|style="padding: 0px 0px 15px 15px;"|Repeat that for all packages that you want to enable.<br/>
Click '' 'Migrate' '' [[File:MB2_Migrate.png|frameless]] button next to the client and then select the brand to which you want to assign the client.
+
Note that only packages with selected products can be enabled!
 
|}
 
|}
 
{|
 
{|
|style="padding: 0px 0px 20px 25px;"|[[File:MB2_26.png]]
+
|style="padding: 0px 0px 20px 25px;"|[[File:PAU_19.png]]  
 
|}
 
|}
 
{|
 
{|
|style="padding: 0px 0px 30px 15px;"| And finally, if you want to delete a customer's relationship with this brand, press the '' 'Delete' '' [[File:MB2_Delete.png|frameless]]  button and confirm the action.
+
|style="padding: 0px 0px 20px 15px;"|Additionally, you can change the order the rules are displayed, simply drag and drop a rule and make a previously downgrade rule an upgrade.
 
|}
 
|}
 
====Services====
 
 
{|
 
{|
|style="padding: 10px 0px 15px 15px;"|In the Services tab you can see which '' '''Products, Addons''' '' and '' '''Domains''' '' have a relation with this brand.<br/>
+
|style="padding: 0px 0px 20px 25px;"|[[File:PAU_20.png]]
These services are automatically added to the brand while ordering from the branded domain.
+
 
|}
 
|}
 
{|
 
{|
|style="padding: 0px 0px 20px 25px;"|[[File:MB2_27.png]]
+
|style="padding: 0px 0px 20px 15px;"|Add new option, just type in its name, press '' 'Add New Option' '' and then configure it like the previous ones.
 
|}
 
|}
 
{|
 
{|
|style="padding: 0px 0px 15px 15px;"|You can also manually add a relation for a service that is not yet branded.<br/>
+
|style="padding: 0px 0px 20px 25px;"|[[File:PAU_21.png]]  
Press '' 'Add' '' [[File:MB2_Plus.png|frameless]] button and then select the type and service you want to assign to the brand.
+
 
|}
 
|}
 
{|
 
{|
|style="padding: 0px 0px 20px 25px;"|[[File:MB2_28.png]]
+
|style="padding: 0px 0px 15px 15px;"|Finally, you can describe shortly each option. Press ' ''Description' '' and a text area will appear.<br/>Type in your description there. As you can see you can prepare a few language versions of the description.
 
|}
 
|}
 
{|
 
{|
|style="padding: 0px 0px 30px 15px;"|Again, if you want to delete a service relation with the brand, press '' 'Delete' '' [[File:MB2_Delete.png|frameless]] button and confirm the action.
+
|style="padding: 0px 0px 30px 25px;"|[[File:PAU_22.png]]  
 
|}
 
|}
  
====Invoices====
+
===Accounts===
 
{|
 
{|
|style="padding: 10px 0px 15px 15px;"|In this tab you can see which invoices have a relation with your brand.<br/>
+
|style="padding: 10px 0px 15px 15px;"|To access the list of hostings affected by the autoscaling groups proceed to '' 'Product Auto Upgrade' '' → '' 'Accounts'. ''<br/>
These invoices are automatically added to the brand after the order has been created from the branded domain.
+
Information about each hosting can be found here along with access to the hosting history.<br/>
 +
Press '' 'View History' '' near desired hosting to view its history of changes.
 
|}
 
|}
 
{|
 
{|
|style="padding: 0px 0px 20px 25px;"|[[File:MB2_29.png]]
+
|style="padding: 0px 0px 20px 25px;"|[[File:PAU_23.png]]  
 
|}
 
|}
 
{|
 
{|
|style="padding: 0px 0px 15px 15px;"|You can also manually add a relation for the invoice that is not yet branded.<br/>
+
|style="padding: 0px 0px 20px 15px;"|Hosting history contains the list of changes ever made for the hosting.
Press '' 'Add' '' [[File:MB2_Plus.png|frameless]] button and select the invoice you want to assign to the brand.
+
 
|}
 
|}
 
{|
 
{|
|style="padding: 0px 0px 20px 25px;"|[[File:MB2_30.png]]
+
|style="padding: 0px 0px 30px 25px;"|[[File:PAU_24.png]]  
|}
+
{|
+
|style="padding: 0px 0px 30px 15px;"|If you want to delete an invoice relation with the brand, press '' 'Delete' '' [[File:MB2_Delete.png|frameless]] button and confirm the action.
+
 
|}
 
|}
  
====Tickets====
+
==Client Area==
 
{|
 
{|
|style="padding: 10px 0px 15px 15px;"|In this tab you can see which tickets have a relation with the brand.<br/>
+
|style="padding: 10px 0px 15px 15px;"|In the following section we will show you client area with all autoscaling features enabled.<br/>
These tickets are automatically branded after a ticket has been opened in one of the [https://www.docs.modulesgarden.com//Multibrand_For_WHMCS#General earlier branded departments].
+
As you can see, autoscaling is displayed on the main page of a product right below the Advanced Billing For WHMCS usage records.<br/>
 +
Press '' 'Show' '' to view details.
 
|}
 
|}
 
{|
 
{|
|style="padding: 0px 0px 20px 25px;"|[[File:MB2_31.png]]
+
|style="padding: 0px 0px 20px 25px;"|[[File:PAU_25.png]]  
 
|}
 
|}
 
{|
 
{|
|style="padding: 0px 0px 15px 15px;"|You can also manually add a relation for the ticket that is not yet branded.<br/>
+
|style="padding: 0px 0px 15px 15px;"|You can easily enable/disable autoscaling (red) or a selected option (blue) through pressing '' 'Enabled'/'Disabled' '' button and saving the changes.<br/>
Press '' 'Add' '' [[File:MB2_Plus.png|frameless]] button and select the ticket you want to assign to the brand.
+
To browse other options, use their names marked on the following screen.  
 
|}
 
|}
 
{|
 
{|
|style="padding: 0px 0px 20px 25px;"|[[File:MB2_32.png]]
+
|style="padding: 0px 0px 20px 25px;"|[[File:PAU_26.png]]  
 
|}
 
|}
 
{|
 
{|
|style="padding: 0px 0px 30px 15px;"|If you want to delete a ticket relation with the brand, press '' 'Delete' '' [[File:MB2_Delete.png|frameless]] button and confirm the action.
+
|style="padding: 0px 0px 15px 15px;"|Through pressing '' 'Show Rules' '' you can manage switching rules of currently displayed option.<br/>
 +
Additionally, you can change the minimum interval between the changes through using marked field.
 
|}
 
|}
 
====Knowledgebase====
 
 
{|
 
{|
|style="padding: 10px 0px 15px 15px;"|In this tab you can see which of your knowledgebase articles have a relation with the brand.<br/>
+
|style="padding: 0px 0px 20px 25px;"|[[File:PAU_27.png]]
In addition, here you can find statistics of views, useful points, number of votes and the date of assignment to the brand.
+
 
|}
 
|}
 
{|
 
{|
|style="padding: 0px 0px 20px 25px;"|[[File:MB2_33.png]]
+
|style="padding: 0px 0px 15px 15px;"|Rules are displayed in a table, press pencil icon next to the rule you wish to change.<br/>
 +
Do not forget to save changes when you finish.
 
|}
 
|}
 
{|
 
{|
|style="padding: 0px 0px 20px 15px;"|To add a relation for the knowledgebase articles, press '' 'Add' '' [[File:MB2_Plus.png|frameless]] button and select the article you want to assign to the brand.
+
|style="padding: 0px 0px 20px 25px;"|[[File:PAU_28.png]]  
 
|}
 
|}
 
{|
 
{|
|style="padding: 0px 0px 20px 25px;"|[[File:MB2_34.png]]
+
|style="padding: 0px 0px 20px 15px;"|Besides the management of autoscaling, you can view the history of switches made on a hosting through pressing '' 'History'. ''
 
|}
 
|}
 
{|
 
{|
|style="padding: 0px 0px 30px 15px;"|If you want to delete a knowledgebase article relation with the brand, press '' 'Delete' '' [[File:MB2_Delete.png|frameless]] button and confirm the action.
+
|style="padding: 0px 0px 30px 25px;"|[[File:PAU_29.png]]  
 
|}
 
|}
 
+
===Notifications===
====Downloads====
+
 
{|
 
{|
|style="padding: 10px 0px 15px 15px;"|In this tab you can see which of your files available for download have a relation with the brand.<br/>
+
|style="padding: 10px 0px 15px 15px;"|Client can also set up notifications, they will be sent when requirements defined by a client are met.<br/>
In addition, here you can find a download category, type, number of downloads and the date of assignment to the brand.
+
For the settings shown on the following screen, notification will be sent once in ten minutes if the following rules are met.<br/>
 +
The product number of Installed applications is equal or higher than 10.
 
|}
 
|}
 
{|
 
{|
|style="padding: 0px 0px 20px 25px;"|[[File:MB2_35.png]]
+
|style="padding: 0px 0px 30px 25px;"|[[File:PAU_30.png]]  
|}
+
{|
+
|style="padding: 0px 0px 20px 15px;"|To add a relation for the download, press '' 'Add' '' [[File:MB2_Plus.png|frameless]] button and select the file you want to assign to the brand.
+
|}
+
{|
+
|style="padding: 0px 0px 20px 25px;"|[[File:MB2_36.png]]
+
|}
+
{|
+
|style="padding: 0px 0px 30px 15px;"|If you want to delete a download relation with the brand, press '' 'Delete' '' [[File:MB2_Delete.png|frameless]] button and confirm the action.
+
 
|}
 
|}
  
====Announcements====
+
==Sample Usage==
 
{|
 
{|
|style="padding: 10px 0px 15px 15px;"|In this tab you can see which of your announcements have a relation with the brand.<br/>
+
|style="padding: 10px 0px 5px 15px;"|In this section we will show you a sample situation when Product Auto Upgrade For WHMCS is used simultaneously with another built-in extension to Advanced Billing - [[Advanced_Billing_For_WHMCS#Recurring_Billing|Recurring Billing]].
In addition, here you can find the date of announcement creation, assignment to the brand and the published status.
+
 
|}
 
|}
 
{|
 
{|
|style="padding: 0px 0px 20px 25px;"|[[File:MB2_37.png]]
+
|style="padding: 0px 0px 20px 15px;"|Let's say you have configured 3 cPanel Extended products enabled for Advanced Billing.
 
|}
 
|}
 
{|
 
{|
|style="padding: 0px 0px 20px 15px;"|To add a relation for the announcement, press '' 'Add' '' [[File:MB2_Plus.png|frameless]] button and select the article you want to assign to the brand.
+
|style="padding: 0px 0px 20px 25px;"|[[File:PAU_31.png]]
 
|}
 
|}
 
{|
 
{|
|style="padding: 0px 0px 20px 25px;"|[[File:MB2_38.png]]
+
|style="padding: 0px 0px 15px 15px;"|Each of the products has different limits set:<br />
 +
*'''Product A''': Max 4 FTP accounts and 500 MB storage.
 +
*'''Product B''': Max 10 FTP accounts and 1 GB storage.
 +
*'''Product C''': Max 20 FTP accounts and 5 GB storage.<br/>
 +
Afterwards, you have created an autoscaling group, added products listed above to it and defined them with following rules.
 
|}
 
|}
 
{|
 
{|
|style="padding: 0px 0px 30px 15px;"|If you want to delete a announcement relation with the brand, press '' 'Delete' '' [[File:MB2_Delete.png|frameless]] button and confirm the action.
+
|style="padding: 0px 0px 20px 25px;"|[[File:PAU_32.png]]  
 
|}
 
|}
 
==Statistics==
 
 
{|
 
{|
|style="padding: 10px 0px 15px 15px;"|In the statistics section you will find sales charts of selected brands.<br/>
+
|style="padding: 0px 0px 15px 15px;"|
You can filter them by the date period and selected brands.
+
*'''Product A - Lowest'''
 +
**Upgrade Rule: &ge; 3 FTP accounts & &ge; 400 MB storage
 +
*'''Product B - Middle'''
 +
**Upgrade Rule: &ge; 9 FTP accounts & &ge; 8 GB storage
 +
**Downgrade Rule: &le; 3 FTP accounts & &le; 300 MB storage
 +
*'''Product C - Highest'''
 +
**Downgrade Rule: &le; 8 FTP accounts & &le; 7 GB storage
 
|}
 
|}
 
{|
 
{|
|style="padding: 0px 0px 30px 25px;"|[[File:MB2_39.png]]
+
|style="padding: 0px 0px 20px 25px;"|[[File:PAU_33.png]]  
 
|}
 
|}
 
==Logs==
 
 
{|
 
{|
|style="padding: 10px 0px 20px 15px;"|Logs section allows you to view warnings and errors related to your brands.
+
|style="padding: 0px 0px 10px 15px;"|Now, this is which is going to happen:<br />
 +
1. A client, John orders product C and creates 3 FTP accounts in it.<br />
 +
2. Advanced Billing cron job changes product C to product B with the first run, and further to product A in the second run (if provided minimum time interval has passed).<br />
 +
3. John  uploads 450 MB of files, so now his product meets product A top rule requirement.<br />
 +
4. Cron runs again, and changes his product to product B.<br />
 +
5. John creates additional 7 FTP accounts and uploads files with total size of 550 MB.<br />
 +
6. Now, his product meets product B upgrade rules only partially, therefore cron run does nothing.<br />
 +
7. Some time passes and total amount of storage used by John reaches 8 GB.<br />
 +
8. This time his product meets product B upgrade rules completely and is updated to product C.<br />
 +
9. John removes 4 of his FTP accounts and 1 GB of files.<br />
 +
10. Therefore his product meets product C bottom rules requirements and is downgraded to product B.<br />
 
|}
 
|}
 
{|
 
{|
|style="padding: 0px 0px 30px 25px;"|[[File:MB2_40.png]]
+
|style="padding: 0px 0px 30px 15px;"|
|}
+
That was all about upgrading/downgrading the products, but let us now see how the payments look like.<br/>  
 
+
If your client orders product C and their product gets downgraded to product B, they will be billed with product C price.<br/>
==Branded Admin Area Functionalities==
+
However, if the prices and free limits are set per resources, you will help your clients to avoid additional payments if their resource usage is low.<br/>
{|
+
If you do it this way, clients will pay fixed price each month, but additional payment will depend on the resource they use.<br/>
|style="padding: 10px 0px 30px 15px;"|Due to the beta version, not all sections available in the previous module versions provide the direct actions with the brand relations yet. <br/>
+
In case you own only limited amount of resources, Product Auto Upgrade For WHMCS extension will allow you to use them more efficiently.<br/> Whereas the core Advanced Billing For WHMCS features will let you bill your clients adequately.  
See the [https://www.docs.modulesgarden.com/Multibrand_For_WHMCS#Beta_Version_2.0.0 Branding Limitations] section for more information. More admin area integrations are coming coon.
+
|}
+
===Membership===
+
{|
+
|style="padding: 10px 0px 15px 15px;"|Multibrand For WHMCS makes the management of WHMCS easier through the introduction of '' 'Brand Details' '' column.<br />
+
'' 'Brand Details' '' column informs you about the membership of clients and invoices to a certain brand (more details will be added soon).<br />
+
Let's see how it looks in the '' 'Client List'.''
+
|}
+
{|
+
|style="padding: 0px 0px 20px 25px;"|[[File:MB2_48.png]]
+
|}
+
{|
+
|style="padding: 0px 0px 15px 15px;"|It looks similar in the '' 'Invoice List'. ''
+
|}
+
{|
+
|style="padding: 0px 0px 30px 25px;"|[[File:MB2_49.png]]
+
|}
+
 
+
===Order Creation===
+
{|
+
|style="padding: 10px 0px 15px 15px;"|If the administrator wants to manually create an order for a client, he/she can directly create a relation with the selected brand (provided that the client belongs to it). <br.> Additionally, they can also assign a payment gateway available in the given brand.
+
|}
+
{|
+
|style="padding: 0px 0px 30px 25px;"|[[File:MB2_42.png]]
+
|}
+
 
+
===Invoices===
+
{|
+
|style="padding: 10px 0px 20px 15px;"|If the administrator creates a new invoice for a customer, he/she has the possibility to select a direct relationship with the given brand.
+
|}
+
{|
+
|style="padding: 0px 0px 20px 25px;"|[[File:MB2_43.png]]
+
|}
+
{|
+
|style="padding: 10px 0px 20px 15px;"|Additionally, there is also a possibility of changing the brand relation directly for the previously created invoices.
+
|}
+
{|
+
|style="padding: 0px 0px 30px 25px;"|[[File:MB2_44.png]]
+
|}
+
<!--
+
===Announcements===
+
===Downloads===
+
===Knowledgebase===
+
-->
+
 
+
==Branded Client Area==
+
{|
+
|style="padding: 10px 0px 20px 15px;"|Multibrand For WHMCS offers multiple client areas in one solution and allows you to have your clients assigned to them.<br/>
+
For example, each brand domain can have a separate template, logo, language, services and invoices. <br/>
+
You can find more information about what other functionalities can be branded in the [https://www.docs.modulesgarden.com/Multibrand_For_WHMCS#About_Multibrand_For_WHMCS Features] list.
+
|}
+
{|
+
|style="padding: 0px 0px 20px 25px;"|[[File:MB2_45.png]]
+
|}
+
{|
+
|style="padding: 0px 0px 20px 15px;"|On the following screen you can see invoices generated for a brand.
+
|}
+
{|
+
|style="padding: 0px 0px 30px 25px;"|[[File:MB2_46.png]]
+
|}
+
 
+
==Branded Emails==
+
{|
+
|style="padding: 10px 0px 15px 15px;"|Brand configuration applys also to emails sent to clients.<br />
+
If you have enabled branding of a given template, the email sent to the client will be sent using the mailbox specified in the SMTP settings of the given brand.<br />
+
Additionally, the subject, logo, content and signature will branded accordingly too. Here you can see an example of an order email.
+
|}
+
{|
+
|style="padding: 0px 0px 20px 25px;"|[[File:MB2_47.png]]
+
|}
+
{|
+
|style="padding: 0px 0px 20px 15px;"|You will find more information in the branded [https://www.docs.modulesgarden.com/Multibrand_For_WHMCS#Email_Templates Email Templates] configuration.
+
|}
+
 
+
==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 your branded domain is '' 'reseller.com' '' and the domain with your WHMCS is '' 'whmcs.domain.com' '', your ''CNAME'' will 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 [[Multibrand_For_WHMCS#Common_Problems|Common Problems]] 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;"|In this section you will find all information related to the SSL certificate in WHMCS using Multibrand.<br />
+
If your branded domains or WHMCS domain are using the SSL connection''', all of them need to have the same certificate.<br />
+
Certificate type required:
+
*'''Wildcard''' - if all brands and main WHMCS are using the same domain.<br />
+
*'''SAN''' - if your brands and main WHMCS are using different domains.<br />
+
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 30px 15px;"|4. (using the already installed certificate) Select it from '' 'Browse Certificates' '', and save the settings.
+
|}
+
 
+
==Branding Limitations==
+
 
+
===Beta Version 2.0.0===
+
{|
+
|style="padding: 10px 0px 20px 15px;"|For better stability and support for future improvements, Multibrand For WHMCS in version 2.0.0 has been completely rewritten. <br>
+
For this reason, some of the functionalities in the previous versions are not yet available, or are operating in a limited way. <br/>
+
These features will be successively restored in the future versions. Here are some of the features that are not currently supported:
+
*'''Membership Details''' - a column with brands in the admin area displayed in the lists of tickets, orders or services. Currently, this feature is available only for the lists of clients and orders
+
*'''Log in as a Client to a Brand''' - action directly accessible from the client profile in the admin area
+
*'''Create Invoice/Quote/Ticket in a Brand''' - action directly accessible from the client profile in the admin area
+
*'''Choose Brand in particular WHMCS sections''' - feature enabling a direct brand selection on ''ticket, quote, announcement, download'' and ''knowledgebase'' view (currently only ''order'' and ''invoice'' view is supported)
+
*'''Product Bundle''' - not yet available for branding
+
*'''Brand Reports''' - the current statistics are limited
+
*'''Brand Previews''' - a preview of the brand in the client area is not yet implemented
+
*'''WHMCS V6''' - Multibrand For WHMCS V2 will no longer support ''WHMCS V6'' and template ''five''
+
|}
+
 
+
===WHMCS===
+
{|
+
|style="padding: 10px 0px 20px 15px;"|In this section we will list the parts of WHMCS which cannot be branded or may be working in an odd way.
+
*'''Bridges''' - Multibrand For WHMCS does not support any kind of bridges (WordPress, Jomla).
+
*'''Link replacement''' - currently links are replaced with their branded counterparts with a visible delay.<br/>This is the only way we could do that for the time being.<br />
+
*'''Clients Profile → Send Email''' - if you try to send an email template, of which a branded counterpart already exists, you will receive an error.<br/>This occurs when the default email is blocked and its branded counterpart is sent in the meantime.
+
*'''Branded Quote → Duplicate''' - duplicating a branded quote results in receiving an unbranded quote.
+
*'''Configurable Options Pricing''' - currently there is no possibility to set a different pricing per brand for configurable options
+
*'''Emails''' - not branded due to the lack of possibility to determine from which brand an email should be sent:
+
**'''Affiliate Monthly Referrals Report'''
+
**'''Clients Only Bounce Message'''
+
|}
+
 
+
===WHMCS Modules and Others===
+
{|
+
|style="padding: 10px 0px 20px 15px;"|In this section we will list the WHMCS modules and other services which do not support multibranding or do not cooperate with Multibrand For WHMCS at all.<br /><br />
+
 
+
*'''WHMCS Modules'''
+
**'''SMS Center For WHMCS''' - SMS sent to customers cannot be branded. Default set of SMS templates is sent to clients from all brands.<br />
+
**'''Resellers Center For WHMCS''' - this module is not yet compatible with our Multibrand For WHMCS module
+
<br />
+
*'''Others'''
+
**'''Cloudflare''' - it is a service that will [http://support.cloudflare.com/hc/en-us/articles/203322654-Why-is-my-domain-resolving-to-the-wrong-IP-when-I-do-a-DNS-lookup-or-ping mask your server IP address]. <br /> This is because they use their own DNS to resolve to one of their many reverse proxy servers and  will cause incompatibility with Multibrand module. <br />You may disallow the CloudFlare network to assume NS authority and not become the intermediary between a user and your server, but then your Cloudflare service may become useless.
+
 
|}
 
|}
  
 
=Tips=
 
=Tips=
 
{|
 
{|
|style="padding: 10px 0px 5px 15px;"|'''1. The logo image is usually hard coded into the WHMCS template files.'''<br />
+
|style="padding: 10px 0px 30px 15px;"|1. If you want to allow access to a certain product only through automatic upgrade/downgrade of another product, you may set such product as hidden.<br/>Product Auto Upgrade For WHMCS allows configuration of hidden products.  
In order to use the logo file provided in the '' 'Multibrand For WHMCS' '' module, find the proper line at the template file and replace it with '' '{$logo}' '' variable.<br />
+
The line responsible for a displayed logo is placed at the '' 'header.tpl' '' file located in a currently used template.
+
|}
+
{|
+
|style="padding: 0px 0px 10px 15px;"|2. If you want Captcha security option to be displayed in your client area for all branded domains, you need to configure each of those domains in your Google Account as well.
+
|}
+
{|
+
|style="padding: 0px 0px 30px 25px;"|[[File:MB2_41.png]]
+
 
|}
 
|}
  
Line 856: Line 445:
 
|}
 
|}
 
{|
 
{|
|style="padding: 0px 0px 5px 15px;"|'''2. If your CNAME record is not working''', remember that the first domain name in the CNAME record should be a branded domain.<br />
+
|style="padding: 0px 0px 30px 15px;"|2. In case you encounter any issues when enabling the extension, please make sure you are using Advanced Billing For WHMCS 3.1.3 or later.<br/> Product Auto Upgrade For WHMCS 2.0.0 is not supported by the previous versions of Advanced Billing.
The second one is the domain on which you have your WHMCS. The redirection goes from the first domain to the second. <br />
+
Full stops after domains are also important.<br />
+
Please note that there could be a delay with propagation of changes for DNS servers while using A type CNAME records.
+
|}
+
{|
+
|style="padding: 0px 0px 5px 15px;"|'''3. If your branded domain or WHMCS domain are using the SSL connection''', both of them need to have the same certificate.<br />
+
If both of them are using the same domain, you will need a wildcard certificate.<br />
+
If they are using different domains, secure them with the SAN certificate.<br />
+
This is just the way WHMCS works. It is not the limitation of our module.
+
|}
+
{|
+
|style="padding: 0px 0px 5px 15px;"|'''4. Please remember that Multibrand For WHMCS works flawlessly with the ''WHMCS V7'' and officially supported template '' 'Six' ''.<br/>
+
In case you are using some custom template, you must be aware of the fact that unexpected errors might occur and we cannot take the responsibility for solving them.
+
|}
+
{|
+
|style="padding: 0px 0px 30px 15px;"|
+
'''5. Multibrand For WHMCS module is not compatible with our Resellers Center For WHMCS.'''<br/>
+
There is no integration between these modules and we '''do not''' recommend using them together.
+
 
|}
 
|}

Revision as of 11:32, 13 November 2017

Contents

About Product Auto Upgrade For WHMCS

Product Auto Upgrade For WHMCS permits to automatically shift products on the basis of the server resource usage tracked with Advanced Billing For WHMCS module.
It will allow you to set rules related to the server resource usage according to which the module will upgrade/downgrade products and their configurable options at the right time.
You will be also able to let your clients decide if they want their products to be modified as well as enable them to set the rules on their own.
  • Admin Area Features:
✔ Define Product Auto Upgrade Groups
✔ Enable/Disable Product Auto Upgrade Groups
✔ Create Product Auto Upgrade Options
✔ Assign Product To An Option - Configurable Option Support
✔ Define Options Upgrade/Downgrade Rules
✔ Set Up Minimal Upgrade/Downgrade Interval
✔ Enable/Disable Any Product Auto Upgrade Option
✔ Drag & Drop To Reorder Options
✔ Define Client Area Features
✔ View List Of All Hostings Affected By Product Auto Upgrade
✔ Access Product Auto Upgrade History Of Any Hosting
  • Client Area Features:
✔ Enable/Disable Product Auto Upgrade And Product Auto Upgrade Options
✔ Manage Rules Of Product Auto Upgrade Options
✔ Set Up Minimal Upgrade/Downgrade Interval
✔ View Products' Product Auto Upgrade History
✔ Set Up Rules Of Notifications
✔ Define Minimal Notification Interval
  • General Info:
✔ Requires Advanced Billing For WHMCS - Server Resource Usage Billing (read more)
✔ Multi-Language Support
✔ Supports PHP 5.3 Up To PHP 7
✔ Supports WHMCS Templates Five and Six
✔ Supports WHMCS V6 and V7

Installation and Configuration

In this tutorial we will show you how to successfully install and manage Product Auto Upgrade For WHMCS.

We will guide you step by step through the whole installation and configuration process.

1. Log in to your client area and download the module.
AB2 AS 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 7, while the second one is aimed at PHP 5.3 up to PHP 5.6.
It does not apply to open source versions.

Note: You can check current PHP version in your WHMCS. To do so proceed to 'Utilities' → 'System' → 'PHP Info'.

AB2 AS 2.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.

Files in your WHMCS directory should look like this.

Drte4.png

Module Configuration

4. Now you have to activate the module in your WHMCS system.

Move to 'Setup' → 'Addon Modules', find 'Advanced Billing' and press 'Activate' button.
Note: Skip this subsection, if you have Advanced Billing For WHMCS already installed.

PAU 5.png
5. In the next step you need to permit access to the module.

To do so, press 'Configure', choose desired admin roles and press 'Save Changes'.

PAU 6.png
6. Now, set up a cron job, you can find it in your WHMCS → 'Addons' → 'Advanced Billing' as shown on the following screen.
PAU 7.png

Extension Configuration

7. Now, you have to activate the extension in your Advanced Billing For WHMCS.

Log in to your WHMCS admin area and proceed to 'Addons' 'Advanced Billing' 'Settings' 'Extensions'.
Afterwards, find 'Product Auto Upgrade' and enable the extension.

PAU 8.png
8. Next, you have to provide your license key.

Press 'Configure' next to the extension.

PAU 8 1.png
9. Paste your license here and then confirm the changes.
PAU 9.png
Your Product Auto Upgrade For WHMCS is ready to use!

Management

To combine any product with Product Auto Upgrade For WHMCS, you need to firstly enable and then configure it in Advanced Billing For WHMCS.

Advanced Billing For WHMCS is used to collect information about hosting's resource usage.
Important: Product Auto Upgrade For WHMCS uses 'Change Package' functionality to switch the products.
Therefore it is required that the products also support this feature.

Admin Area

Before you can do anything you must enable the products you want to work with for Advanced Billing.
PAU 10.png
Only then you have to enable the extension Product Auto Upgrade For WHMCS for each of the products.
Move to 'Settings', find appropriate section and enable the extension.
PAU 10 1.png

Groups of Rules

As you might have already noticed, a new tab dedicated to the extension appeared on your Advanced Billing For WHMCS module main menu.
Under this section there is located the whole management of the extension.

Let's move to 'Configuration' firstly.

PAU 11.png
What you will find there is a full list of autoscaling groups displayed.

Here you can find information such as status of a group, its name and used submodule.
What is more, you can manage groups through using buttons in 'Actions' column to prepare rules for scaling services.

PAU 11 1.png
Let's see now how to create a new group.

Press 'Create New Group' button and a short formula will appear.

PAU 12.png
You can add products and define rules inside of the group which will result in upgrading/downgrading client's hosting.

Name your new group - this name is only for your information and convenience. Then select the product that can be automatically upgraded or downgraded according to resource usage count.
Optionally, you can enable and choose configurable option group that will be used to define products options.
Save the group when it is ready.

PAU 13.png
Your newly created group appeared on the list. Now you can configure it according to your specific needs.
PAU 13 1.png

Group Configuration

There are two main sections where a group can be configured.
  1. 'Settings' - a place where general and client area configuration is set up.
  2. 'Options' - detailed configuration of rules to scale services automatically.
PAU 14.png
Group Settings
General Configuration
  • Group Name - name of a group, can be changed at any time and is visible only to the admin.
  • Server Type - module type of the product allowed in the group.
  • Time Interval - minimum time period between the two products changes that can be made on a single hosting.
  • Notifications Time Interval - defines time between notifications sent to a client.
PAU 14 1.png
Client Area Configuration
  • Display Client Rules Configuration - shows rules of this group for clients with products configured in the group.
  • Modify Rules Configuration - client can modify group rules, changes will affect their product only.
  • Modify Time Interval - client can modify the minimum time between two switches on a single hosting.
  • Allowed Time Interval Values - specifies what time interval a client can use (they will be displayed in the form of a dropdown menu or a textbox with a limited range).
  • Enable Notifications - allows the client to enable/disable notifications.
  • Modify Notifications Time Interval - allows the client to modify minimum time between two notifications.
  • Allowed Notifications Time Interval Values - defines values which can be used by client.

Do not forget to save the configuration when it is ready.

PAU 14 2.png
Group Options
The second place where the group rules are configured is Options section.

These rules will be used by the extension to determine which service should be changed.
Service will be changed according to the parameters set in rules options if the condition of either downgrade rules or upgrade rules has been met.

PAU 15.png
Every group has already some predefined basic options - disabled at the start.
You can base your rules configuration on them or add your own ones in case they are not sufficient.
Let us show how to set the autoscaling rules on the basis of these options.

Before you can do anything, you must configure the upgrade and downgarade rules.

PAU 16.png
'Upgrade Rules'/'Downgrade Rules' can have multiple rules defined.

To add a new rule, select it from a dropdown menu marked on the following screen and press 'Add'.

PAU 17.png
You can define comparison type and threshold of any added rule.

To add a rule which will be fulfilled when the product has more or equal than 3 FTP accounts, choose '≥' from 'Comparison Type' and type '3' into 'Threshold' field.
This example can be seen on the following screen.

PAU 18.png
You also have to define a product for each package that will be used when upgrading/downgrading.
Press button marked on the screen to go on.
PAU 18 1.png
Select the product you need from the available in the dropdown menu.

Then select option you wish to be used by clients and add it. Save the changes.
Important! Options selection is available only if a supported configurable options group has been enabled for the group of rules on its creation.

PAU 18 2.png
Every selected option appears in the box above. Here you can specify available selection under 'Setting' or delete it.
PAU 18 3.png
Repeat that for all packages that you want to enable.

Note that only packages with selected products can be enabled!

PAU 19.png
Additionally, you can change the order the rules are displayed, simply drag and drop a rule and make a previously downgrade rule an upgrade.
PAU 20.png
Add new option, just type in its name, press 'Add New Option' and then configure it like the previous ones.
PAU 21.png
Finally, you can describe shortly each option. Press ' Description' and a text area will appear.
Type in your description there. As you can see you can prepare a few language versions of the description.
PAU 22.png

Accounts

To access the list of hostings affected by the autoscaling groups proceed to 'Product Auto Upgrade' 'Accounts'.

Information about each hosting can be found here along with access to the hosting history.
Press 'View History' near desired hosting to view its history of changes.

PAU 23.png
Hosting history contains the list of changes ever made for the hosting.
PAU 24.png

Client Area

In the following section we will show you client area with all autoscaling features enabled.

As you can see, autoscaling is displayed on the main page of a product right below the Advanced Billing For WHMCS usage records.
Press 'Show' to view details.

PAU 25.png
You can easily enable/disable autoscaling (red) or a selected option (blue) through pressing 'Enabled'/'Disabled' button and saving the changes.

To browse other options, use their names marked on the following screen.

PAU 26.png
Through pressing 'Show Rules' you can manage switching rules of currently displayed option.

Additionally, you can change the minimum interval between the changes through using marked field.

PAU 27.png
Rules are displayed in a table, press pencil icon next to the rule you wish to change.

Do not forget to save changes when you finish.

PAU 28.png
Besides the management of autoscaling, you can view the history of switches made on a hosting through pressing 'History'.
PAU 29.png

Notifications

Client can also set up notifications, they will be sent when requirements defined by a client are met.

For the settings shown on the following screen, notification will be sent once in ten minutes if the following rules are met.
The product number of Installed applications is equal or higher than 10.

PAU 30.png

Sample Usage

In this section we will show you a sample situation when Product Auto Upgrade For WHMCS is used simultaneously with another built-in extension to Advanced Billing - Recurring Billing.
Let's say you have configured 3 cPanel Extended products enabled for Advanced Billing.
PAU 31.png
Each of the products has different limits set:
  • Product A: Max 4 FTP accounts and 500 MB storage.
  • Product B: Max 10 FTP accounts and 1 GB storage.
  • Product C: Max 20 FTP accounts and 5 GB storage.

Afterwards, you have created an autoscaling group, added products listed above to it and defined them with following rules.

PAU 32.png
  • Product A - Lowest
    • Upgrade Rule: ≥ 3 FTP accounts & ≥ 400 MB storage
  • Product B - Middle
    • Upgrade Rule: ≥ 9 FTP accounts & ≥ 8 GB storage
    • Downgrade Rule: ≤ 3 FTP accounts & ≤ 300 MB storage
  • Product C - Highest
    • Downgrade Rule: ≤ 8 FTP accounts & ≤ 7 GB storage
PAU 33.png
Now, this is which is going to happen:

1. A client, John orders product C and creates 3 FTP accounts in it.
2. Advanced Billing cron job changes product C to product B with the first run, and further to product A in the second run (if provided minimum time interval has passed).
3. John uploads 450 MB of files, so now his product meets product A top rule requirement.
4. Cron runs again, and changes his product to product B.
5. John creates additional 7 FTP accounts and uploads files with total size of 550 MB.
6. Now, his product meets product B upgrade rules only partially, therefore cron run does nothing.
7. Some time passes and total amount of storage used by John reaches 8 GB.
8. This time his product meets product B upgrade rules completely and is updated to product C.
9. John removes 4 of his FTP accounts and 1 GB of files.
10. Therefore his product meets product C bottom rules requirements and is downgraded to product B.

That was all about upgrading/downgrading the products, but let us now see how the payments look like.
If your client orders product C and their product gets downgraded to product B, they will be billed with product C price.
However, if the prices and free limits are set per resources, you will help your clients to avoid additional payments if their resource usage is low.
If you do it this way, clients will pay fixed price each month, but additional payment will depend on the resource they use.
In case you own only limited amount of resources, Product Auto Upgrade For WHMCS extension will allow you to use them more efficiently.
Whereas the core Advanced Billing For WHMCS features will let you bill your clients adequately.

Tips

1. If you want to allow access to a certain product only through automatic upgrade/downgrade of another product, you may set such product as hidden.
Product Auto Upgrade For WHMCS allows configuration of hidden products.

Common Problems

1. When you have problems with connection, check whether your SELinux or firewall does not block ports.
2. In case you encounter any issues when enabling the extension, please make sure you are using Advanced Billing For WHMCS 3.1.3 or later.
Product Auto Upgrade For WHMCS 2.0.0 is not supported by the previous versions of Advanced Billing.
Navigation
WHMCS Modules
WHMCS Widgets
Translations
cPanel Modules
General
FAQ
Community