Personal tools
Namespaces

Variants
Actions

Hosting Quota Notifications 1.X For WHMCS

From ModulesGarden Wiki
(Difference between revisions)
Jump to: navigation, search
(Blanked the page)
Line 1: Line 1:
<meta name="keywords" content="server allocator for whmcs, server allocator configuration, whmcs server allocator management, whmcs server allocator installation, whmcs server allocator common problems, about whmcs server allocator, whmcs server allocator documentation, whmcs server allocator faq, whmcs server allocator help, whmcs server allocator guide, whmcs server allocator wiki, whmcs server allocator tutorial, whmcs server allocator tips, whmcs server allocator wiki"></meta>
 
<meta name="description" content="ModulesGarden Wiki Contains All The Information You Need About The Server Allocator For WHMCS Module."></meta>
 
  
=About [http://www.modulesgarden.com/products/whmcs/server_allocator/features Server Allocator For WHMCS]=
 
{|
 
|style="padding: 10px 0px 10px 0px;"|'''Server Allocator For WHMCS''' will allow to automatically switch servers when placing an order depending on previously set rules.<br />
 
Module lets you create and configure your own switch rules, split them into groups and assign to them specified servers and product groups.<br />
 
Rules are very flexible because they are based on chosen configurable options, product addons and custom fields.
 
|}
 
<!-- fixed -->
 
*'''Admin Area Features:'''
 
{|
 
|style="padding: 10px 0px 0px 30px;"|✔ Add/Edit/Remove Switching Rules
 
|}
 
{|
 
|style="padding: 0px 0px 0px 30px;"|✔ Add Multiple Conditions/Products/Servers To Switching Rule
 
|}
 
{|
 
|style="padding: 0px 0px 0px 30px;"|✔ Assign Multiple Rules To Rules Group
 
|}
 
{|
 
|style="padding: 0px 0px 0px 30px;"|✔ Set Default Servers To Rules Group - Used If No Rule Is Applied
 
|}
 
{|
 
|style="padding: 0px 0px 10px 30px;"|✔ Access Links To Order Form Of Products Configured According To Specified Rule
 
|}
 
*'''Client Area Features:'''
 
{|
 
|style="padding: 10px 0px 10px 30px;"|✔ Switch Assigned Server Automatically During Ordering Product - Depending On Applied Rule
 
|}
 
*'''Supported Rule Definitions:'''
 
{|
 
|style="padding: 10px 0px 0px 30px;"|✔ Configurable Options
 
|}
 
{|
 
|style="padding: 0px 0px 0px 30px;"|✔ Custom Fields
 
|}
 
{|
 
|style="padding: 0px 0px 10px 30px;"|✔ Product Addons
 
|}
 
*'''General Info:'''
 
{|
 
|style="padding: 10px 0px 0px 30px;"|✔ Supports All Server Types
 
|}
 
{|
 
|style="padding: 0px 0px 0px 30px;"|✔ Multi-Language Support
 
|}
 
{|
 
|style="padding: 0px 0px 30px 30px;"|✔ Supports WHMCS V5 and V6
 
|}
 
 
=Installation and Configuration=
 
{|
 
|style="padding: 10px 0px 0px 15px;"|'''This tutorial will show you how to successfully install and configure Server Allocator For WHMCS.''' <br />
 
We will guide you step by step through the whole installation and configuration process.
 
|}
 
{|
 
|style="padding: 20px 0px 20px 15px;"|'''1. Log in to your client area and download Server Allocator For WHMCS.'''
 
|}
 
{|
 
|style="padding: 0px 0px 20px 25px;"|[[File:SSW_1.png]]
 
|}
 
{|
 
|style="padding: 0px 0px 15px 15px;"|'''2. Upload and extract the module into the main WHMCS directory.'''<br />
 
Files in your WHMCS directory should look like this.
 
|}
 
{|
 
|style="padding: 0px 0px 20px 25px;"|[[File:SSW_2.png]]
 
|}
 
{|
 
|style="padding: 0px 0px 15px 15px;"|'''3. When you install Server Allocator for the first time you have to rename '' 'license_RENAME.php' '' file.'''<br />
 
File is located in '' 'modules/addons/serverswitcher/license_RENAME.php' '' . Rename it from '' 'license_RENAME.php' '' to '' 'license.php' '' .
 
|}
 
{|
 
|style="padding: 0px 0px 20px 25px;"|[[File:SSW_3.png]]
 
|}
 
{|
 
|style="padding: 0px 0px 15px 15px;"|'''4. In order to configure your license key, you have to edit a previously renamed '' 'license.php' '' file.'''<br />
 
Enter your license key between quotation marks as presented on the following screen. You can find your license key at your client area'' → 'My Products' ''.
 
|}
 
{|
 
|style="padding: 0px 0px 20px 25px;"|[[File:SSW_4.png]]
 
|}
 
{|
 
|style="padding: 0px 0px 15px 15px;"|'''5. Now you have to activate the module in your WHMCS system.'''<br />
 
Log in to your WHMCS admin area. Go to the '' 'Setup' '' → '' 'Addon Modules' ''. Afterwards, find '' 'Server Allocator' '' and press '' 'Activate' '' button.
 
|}
 
{|
 
|style="padding: 0px 0px 20px 25px;"|[[File:SSW_5.png]]
 
|}
 
{|
 
|style="padding: 0px 0px 15px 15px;"|'''6. In the next step you need to permit access to this module.'''<br />
 
To do so click on '' 'Configure' '' button, tick '' 'Access Control' '' near desired admin role groups and press '' 'Save Changes' ''.
 
|}
 
{|
 
|style="padding: 0px 0px 20px 25px;"|[[File:SSW_6.png]]
 
|}
 
{|
 
|style="padding: 0px 0px 30px 15px;"|'''7. You have just successfully installed Server Allocator For WHMCS!'''
 
|}
 
 
=Management=
 
{|
 
|style="padding: 10px 0px 15px 15px;"|Server Allocator For WHMCS allows you to automatically switch to wanted server upon specific product configuration.
 
|}
 
{|
 
|style="padding: 0px 0px 30px 25px;"|[[File:SSW_7.png]]
 
|}
 
==Add Group==
 
{|
 
|style="padding: 10px 0px 15px 15px;"|In order to configure switching rules, proceed with creating of a new group.<br />
 
Press '' 'Add Group' '' to proceed.
 
|}
 
{|
 
|style="padding: 0px 0px 20px 25px;"|[[File:SSW_8.png]]
 
|}
 
{|
 
|style="padding: 0px 0px 15px 15px;"|Fill in group name and select desired product groups.<br />
 
Additionally, select default servers (Ctrl+mouse click for multi select) if you wish to redefine default servers.<br />
 
Press '' 'Save' '' to create group.
 
|}
 
{|
 
|style="padding: 0px 0px 30px 25px;"|[[File:SSW_9.png]]
 
|}
 
 
==Group Management==
 
{|
 
|style="padding: 10px 0px 15px 15px;"|Previously created group currently does not affect the system at all.<br />
 
Let's change that through adding a new rule. Press '' 'Add Rule' '' to proceed.
 
|}
 
{|
 
|style="padding: 0px 0px 20px 25px;"|[[File:SSW_10.png]]
 
|}
 
{|
 
|style="padding: 0px 0px 15px 15px;"|In the next step select server type that the switch will apply to.<br />
 
Press '' 'Next' ''.
 
|}
 
{|
 
|style="padding: 0px 0px 20px 25px;"|[[File:SSW_11.png]]
 
|}
 
{|
 
|style="padding: 0px 0px 15px 15px;"|Each rule can have multiple rule definitions.<br />
 
'''Important:''' Switch will be made only if all of the rule definitions are met.<br />
 
Let's add first rule definitions, adding it starts with selecting rule definitions type.<br />
 
To do so, press '' 'Add Definition' '' and choose desired one.
 
|}
 
{|
 
|style="padding: 0px 0px 20px 25px;"|[[File:SSW_12.png]]
 
|}
 
{|
 
|style="padding: 0px 0px 15px 15px;"|For the purpose of this documentation, we have chosen configurable option rule definition.<br />
 
Now, we have to select specific configurable option and its value which needs to be chosen.
 
|}
 
{|
 
|style="padding: 0px 0px 20px 25px;"|[[File:SSW_13.png]]
 
|}
 
{|
 
|style="padding: 0px 0px 15px 15px;"|Let's add one more rule definition, which in this case will be using product addon.<br />
 
Press '' 'Add Definition' '' → '' 'Addon' '' and choose product addon.
 
|}
 
{|
 
|style="padding: 0px 0px 20px 25px;"|[[File:SSW_14.png]]
 
|}
 
{|
 
|style="padding: 0px 0px 20px 15px;"|Now, select server you wish to switch to and press '' 'Save Changes' '' button.
 
|}
 
{|
 
|style="padding: 0px 0px 30px 25px;"|[[File:SSW_15.png]]
 
|}
 
 
==Rule Management==
 
{|
 
|style="padding: 10px 0px 20px 15px;"|Each group and rule can be modified and removed at any time through using buttons marked on the following screen.
 
|}
 
{|
 
|style="padding: 0px 0px 20px 25px;"|[[File:SSW_16.png]]
 
|}
 
{|
 
|style="padding: 0px 0px 20px 15px;"|Press '' 'Links' '' next to desired rule to view the list of links.
 
|}
 
{|
 
|style="padding: 0px 0px 20px 25px;"|[[File:SSW_17.png]]
 
|}
 
{|
 
|style="padding: 0px 0px 20px 15px;"|Each of them leads to the order form with product configured according to defined rule.<!--<br />
 
''Note: Link to product will work properly only if addons/configurable options/custom fields used in rule are assigned to that product.''--->
 
|}
 
{|
 
|style="padding: 0px 0px 20px 25px;"|[[File:SSW_18.png]]
 
|}
 
 
==Sample Orders==
 
{|
 
|style="padding: 10px 0px 20px 15px;"|In this section we will show you how our module works on an exemplary rule shown below.
 
|}
 
{|
 
|style="padding: 0px 0px 20px 25px;"|[[File:SSW_18_1.png]]
 
|}
 
===First Order===
 
{|
 
|style="padding: 10px 0px 20px 15px;"|Let us order a product fulfilling all conditions for receiving 'cPanel SSD - 99.9' server.<br />
 
Using this configuration, client pays additionally for 'Based On SSD' addon.
 
|}
 
{|
 
|style="padding: 0px 0px 20px 25px;"|[[File:SSW_19.png]]
 
|}
 
{|
 
|style="padding: 10px 0px 15px 15px;"|The switch will be made upon ordering the product (order made from the client area) or accepting the order (order made from the admin area).<br />
 
Hosting with a switched server is displayed on the following screen.
 
|}
 
{|
 
|style="padding: 0px 0px 30px 25px;"|[[File:SSW_20.png]]
 
|}
 
 
===Second Order===
 
{|
 
|style="padding: 10px 0px 20px 15px;"|Let us order a product fulfilling all conditions for receiving 'cPanel SSD - 99.99' server.<br />
 
Client must pay for 'Based On SSD' as well as for higher guaranteed uptime.
 
|}
 
{|
 
|style="padding: 0px 0px 20px 25px;"|[[File:SSW_21.png]]
 
|}
 
{|
 
|style="padding: 10px 0px 15px 15px;"|As displayed on the following screen, the switch has been made successfully.
 
|}
 
{|
 
|style="padding: 0px 0px 30px 25px;"|[[File:SSW_22.png]]
 
|}
 
 
===Third Order===
 
{|
 
|style="padding: 10px 0px 15px 15px;"|Let us order a product without 'Based On SSD' addon and with default uptime.<br />
 
This should result in assigning default 'cPanel - 99.9' server.
 
|}
 
{|
 
|style="padding: 0px 0px 20px 25px;"|[[File:SSW_23.png]]
 
|}
 
{|
 
|style="padding: 0px 0px 20px 15px;"|As you can see, switch has not been made and hosting is using default group server.
 
 
|}
 
{|
 
|style="padding: 0px 0px 30px 25px;"|[[File:SSW_24.png]]
 
|}
 
 
=Tips=
 
{|
 
|style="padding: 10px 0px 30px 15px;"|1. In case none of the configuration settings meet any rule, the product will be assigned to a default server.
 
|}
 
 
=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: 0px 0px 30px 15px;"|2. You are unable to add a product addon/configurable option/custom field to the rule.<br />
 
'''Reason:''' An item has to be assigned to a product which:
 
*Is assigned to a product group included into the switching group.
 
*Product is of a type selected during adding a new rule.
 
'''Solution:''' Ensure that an item you are trying to add is assigned to a correct product.
 
|}
 

Revision as of 10:16, 1 September 2016

Navigation
WHMCS Modules
WHMCS Widgets
Translations
cPanel Modules
General
FAQ
Community