Server Allocator For WHMCS
From ModulesGarden Wiki
(Difference between revisions)
|
|
| Line 52: |
Line 52: |
| | =Installation and Configuration= | | =Installation and Configuration= |
| | {| | | {| |
| − | |style="padding: 10px 0px 0px 15px;"|'''This tutorial will show you how to successfully install and configure Server Switcher For WHMCS.''' <br /> | + | |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. | | 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 Switcher For WHMCS.''' | + | |style="padding: 20px 0px 20px 15px;"|'''1. Log in to your client area and download Server Allocator For WHMCS.''' |
| | |} | | |} |
| | {| | | {| |
| Line 69: |
Line 69: |
| | |} | | |} |
| | {| | | {| |
| − | |style="padding: 0px 0px 15px 15px;"|'''3. When you install Server Switcher for the first time you have to rename '' 'license_RENAME.php' '' file.'''<br /> | + | |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' '' . | | File is located in '' 'modules/addons/serverswitcher/license_RENAME.php' '' . Rename it from '' 'license_RENAME.php' '' to '' 'license.php' '' . |
| | |} | | |} |
| Line 97: |
Line 97: |
| | |} | | |} |
| | {| | | {| |
| − | |style="padding: 0px 0px 30px 15px;"|'''7. You have just successfully installed Server Switcher For WHMCS!''' | + | |style="padding: 0px 0px 30px 15px;"|'''7. You have just successfully installed Server Allocator For WHMCS!''' |
| | |} | | |} |
| | | | |
Revision as of 09:58, 9 June 2016
Server Allocator For WHMCS will allow to automatically switch servers when placing an order depending on previously set rules.
Module lets you create and configure your own switch rules, split them into groups and assign to them specified servers and product groups.
Rules are very flexible because they are based on chosen configurable options, product addons and custom fields.
|
| ✔ Add/Edit/Remove Switching Rules
|
| ✔ Add Multiple Conditions/Products/Servers To Switching Rule
|
| ✔ Assign Multiple Rules To Rules Group
|
| ✔ Set Default Servers To Rules Group - Used If No Rule Is Applied
|
| ✔ Access Links To Order Form Of Products Configured According To Specified Rule
|
| ✔ Switch Assigned Server Automatically During Ordering Product - Depending On Applied Rule
|
- Supported Rule Definitions:
| ✔ Supports All Server Types
|
| ✔ Supports WHMCS V5 and V6
|
Installation and Configuration
This tutorial will show you how to successfully install and configure Server Allocator 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 Server Allocator For WHMCS.
|
2. Upload and extract the module into the main WHMCS directory.
Files in your WHMCS directory should look like this.
|
3. When you install Server Allocator for the first time you have to rename 'license_RENAME.php' file.
File is located in 'modules/addons/serverswitcher/license_RENAME.php' . Rename it from 'license_RENAME.php' to 'license.php' .
|
4. 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 at your client area → 'My Products' .
|
5. Now you have to activate the module in your WHMCS system.
Log in to your WHMCS admin area. Go to the 'Setup' → 'Addon Modules' . Afterwards, find 'Server Switcher' and press 'Activate' button.
|
6. In the next step you need to permit access to this module.
To do so click on 'Configure' button, tick 'Access Control' near desired admin role groups and press 'Save Changes' .
|
| 7. You have just successfully installed Server Allocator For WHMCS!
|
Management
| Server Switcher For WHMCS allows you to automatically switch to wanted server upon specific product configuration.
|
Add Group
In order to configure switching rules, proceed with creating of a new group.
Press 'Add Group' to proceed.
|
Fill in group name and select desired product groups.
Additionally, select default servers (Ctrl+mouse click for multi select) if you wish to redefine default servers.
Press 'Save' to create group.
|
Group Management
Previously created group currently does not affect the system at all.
Let's change that through adding a new rule. Press 'Add Rule' to proceed.
|
In the next step select server type that the switch will apply to.
Press 'Next' .
|
Each rule can have multiple rule definitions.
Important: Switch will be made only if all of the rule definitions are met.
Let's add first rule definitions, adding it starts with selecting rule definitions type.
To do so, press 'Add Definition' and choose desired one.
|
For the purpose of this documentation, we have chosen configurable option rule definition.
Now, we have to select specific configurable option and its value which needs to be chosen.
|
Let's add one more rule definition, which in this case will be using product addon.
Press 'Add Definition' → 'Addon' and choose product addon.
|
| Now, select server you wish to switch to and press 'Save Changes' button.
|
Rule Management
| Each group and rule can be modified and removed at any time through using buttons marked on the following screen.
|
| Press 'Links' next to desired rule to view the list of links.
|
| Each of them leads to the order form with product configured according to defined rule.
|
Sample Orders
| In this section we will show you how our module works on an exemplary rule shown below.
|
First Order
Let us order a product fulfilling all conditions for receiving 'cPanel SSD - 99.9' server.
Using this configuration, client pays additionally for 'Based On SSD' addon.
|
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).
Hosting with a switched server is displayed on the following screen.
|
Second Order
Let us order a product fulfilling all conditions for receiving 'cPanel SSD - 99.99' server.
Client must pay for 'Based On SSD' as well as for higher guaranteed uptime.
|
| As displayed on the following screen, the switch has been made successfully.
|
Third Order
Let us order a product without 'Based On SSD' addon and with default uptime.
This should result in assigning default 'cPanel - 99.9' server.
|
| As you can see, switch has not been made and hosting is using default group server.
|
Tips
| 1. In case none of the configuration settings meet any rule, the product will be assigned to a default server.
|
Common Problems
| 1. When you have problems with connection, check whether your SELinux or firewall does not block ports.
|
2. You are unable to add a product addon/configurable option/custom field to the rule.
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.
|
