Personal tools
Namespaces

Variants
Actions

Hosting Quota Notifications 1.X For WHMCS

From ModulesGarden Wiki
(Difference between revisions)
Jump to: navigation, search
Line 1: Line 1:
−
<meta name="keywords" content="websitepanel extended for whmcs, websitepanel extended configuration, whmcs websitepanel extended management, whmcs websitepanel extended installation, whmcs websitepanel extended common problems, about whmcs websitepanel extended, whmcs websitepanel extended documentation, whmcs websitepanel extended faq, whmcs websitepanel extended help, whmcs websitepanel extended guide, whmcs websitepanel extended wiki, whmcs websitepanel extended tutorial, whmcs websitepanel extended tips, whmcs websitepanel extended wiki"></meta>
+
<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 WebsitePanel Extended For WHMCS Module."></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/websitepanel_extended/features WebsitePanel Extended For WHMCS]=
+
=About [http://www.modulesgarden.com/products/whmcs/server_allocator/features Server Allocator For WHMCS]=
 
{|
 
{|
−
|style="padding: 10px 0px 10px 0px;"|'''WebsitePanel Extended For WHMCS''' automates provisioning and management of WebsitePanel accounts through your system.<br />
+
|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 />
−
The module enables your customers to order and manage their web hosting accounts straight in your WHMCS client area.
+
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 -->
 
<!-- fixed -->
 
*'''Admin Area Features:'''
 
*'''Admin Area Features:'''
 
{|
 
{|
−
|style="padding: 10px 0px 0px 30px;"|✔ Create/Suspend/Unsuspend/Terminate Account
+
|style="padding: 10px 0px 0px 30px;"|✔ Add/Edit/Remove Switching Rules
 
|}
 
|}
 
{|
 
{|
−
|style="padding: 0px 0px 0px 30px;"|✔ Change Package And Password Of Account
+
|style="padding: 0px 0px 0px 30px;"|✔ Add Multiple Conditions/Products/Servers To Switching Rule
 
|}
 
|}
 
{|
 
{|
−
|style="padding: 0px 0px 0px 30px;"|✔ Log In To Each WebsitePanel Account On Click
+
|style="padding: 0px 0px 0px 30px;"|✔ Assign Multiple Rules To Rules Group
 
|}
 
|}
 
{|
 
{|
−
|style="padding: 0px 0px 0px 30px;"|✔ Configure Client Area Features Per Product
+
|style="padding: 0px 0px 0px 30px;"|✔ Set Default Servers To Rules Group - Used If No Rule Is Applied
 
|}
 
|}
 
{|
 
{|
−
|style="padding: 0px 0px 0px 30px;"|✔ Define Hosting Plan To Limit Resource Per Product
+
|style="padding: 0px 0px 10px 30px;"|✔ Access Links To Order Form Of Products Configured According To Specified Rule
−
|}
+
−
{|
+
−
|style="padding: 0px 0px 0px 30px;"|✔ View All WebsitePanel And WebsitePanel Extended Products And Servers In One Place
+
−
|}
+
−
{|
+
−
|style="padding: 0px 0px 10px 30px;"|✔ Run API Connection Test
+
 
|}
 
|}
 
*'''Client Area Features:'''
 
*'''Client Area Features:'''
 
{|
 
{|
−
|style="padding: 10px 0px 0px 30px;"|✔ Remote Access And Management Of:
+
|style="padding: 10px 0px 10px 30px;"|✔ Switch Assigned Server Automatically During Ordering Product - Depending On Applied Rule
 
|}
 
|}
 +
*'''Supported Rule Definitions:'''
 
{|
 
{|
−
|style="padding: 0px 0px 0px 45px;"|✔ DNS Management - Requires DNS Manager For WHMCS
+
|style="padding: 10px 0px 0px 30px;"|✔ Configurable Options
 
|}
 
|}
 
{|
 
{|
−
|style="padding: 0px 0px 0px 45px;"|✔ DNS Records
+
|style="padding: 0px 0px 0px 30px;"|✔ Custom Fields
 
|}
 
|}
 
{|
 
{|
−
|style="padding: 0px 0px 0px 45px;"|✔ File Manager
+
|style="padding: 0px 0px 10px 30px;"|✔ Product Addons
−
|}
+
−
{|
+
−
|style="padding: 0px 0px 0px 45px;"|✔ FTP Accounts
+
−
|}
+
−
{|
+
−
|style="padding: 0px 0px 0px 45px;"|✔ Web Sites
+
−
|}
+
−
{|
+
−
|style="padding: 0px 0px 0px 45px;"|✔ Email Accounts
+
−
|}
+
−
{|
+
−
|style="padding: 0px 0px 0px 45px;"|✔ Email Aliases
+
−
|}
+
−
{|
+
−
|style="padding: 0px 0px 0px 45px;"|✔ Email Domains
+
−
|}
+
−
{|
+
−
|style="padding: 0px 0px 0px 45px;"|✔ Email Groups
+
−
|}
+
−
{|
+
−
|style="padding: 0px 0px 0px 45px;"|✔ Email Lists
+
−
|}
+
−
{|
+
−
|style="padding: 0px 0px 0px 30px;"|✔ One Click Login To WebsitePanel
+
−
|}
+
−
{|
+
−
|style="padding: 0px 0px 10px 30px;"|✔ Change Account Password
+
 
|}
 
|}
 
*'''General Info:'''
 
*'''General Info:'''
 
{|
 
{|
−
|style="padding: 10px 0px 0px 30px;"|✔ Integrated With <u>DNS Manager For WHMCS</u> - Manage DNS & rDNS Records [http://www.modulesgarden.com/products/whmcs/dns_manager/features (read more)]
+
|style="padding: 10px 0px 0px 30px;"|✔ Supports All Server Types
 
|}
 
|}
 
{|
 
{|
Line 78: Line 47:
 
|}
 
|}
 
{|
 
{|
−
|style="padding: 0px 0px 0px 30px;"|✔ Supports WHMCS Templates Five and Six
+
|style="padding: 0px 0px 30px 30px;"|✔ Supports WHMCS V5 and V6
−
|}
+
−
{|
+
−
|style="padding: 0px 0px 30px 30px;"|✔ Supports WHMCS V6 and Later
+
 
|}
 
|}
  
 
=Installation and Configuration=
 
=Installation and Configuration=
 
{|
 
{|
−
|style="padding: 10px 0px 30px 0px;"|'''This tutorial will show you how to successfully install and configure WebsitePanel Extended 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.
 
|}
 
|}
−
==Installation==
 
 
{|
 
{|
−
|style="padding: 10px 0px 15px 15px;"|'''1. Log in to your client area and download WebsitePanel Extended For WHMCS.'''<br />
+
|style="padding: 20px 0px 20px 15px;"|'''1. Log in to your client area and download Server Allocator For WHMCS.'''
−
'''Important:''' Before the installation of WebsitePanel Extended For WHMCS, install latest version of WebsitePanel For WHMCS.
+
 
|}
 
|}
 
{|
 
{|
−
|style="padding: 0px 0px 20px 25px;"|[[File:WPE_1.png]]
+
|style="padding: 0px 0px 20px 25px;"|[[File:SSW_1.png]]
 
|}
 
|}
 
{|
 
{|
−
|style="padding: 0px 0px 20px 15px;"|'''2. Upload and extract the module into the main WHMCS directory.'''
+
|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:WPE_2.png]]
+
|style="padding: 0px 0px 20px 25px;"|[[File:SSW_2.png]]
 
|}
 
|}
 
{|
 
{|
−
|style="padding: 0px 0px 15px 15px;"|'''3. When you install WebsitePanel Extended 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/servers/websitepanelextended/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' '' .
 
|}
 
|}
 
{|
 
{|
−
|style="padding: 0px 0px 20px 25px;"|[[File:WPE_3.png]]
+
|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 />
 
|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.<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' ''.  
−
You can find your license key at your client area → '' 'My Products' ''.
+
 
|}
 
|}
 
{|
 
{|
−
|style="padding: 0px 0px 30px 25px;"|[[File:WPE_4.png]]
+
|style="padding: 0px 0px 20px 25px;"|[[File:SSW_4.png]]
 
|}
 
|}
−
 
−
==Configuration of Server==
 
 
{|
 
{|
−
|style="padding: 10px 0px 15px 15px;"|'''5. Now, we will show you how to configure a new product.'''<br />
+
|style="padding: 0px 0px 15px 15px;"|'''5. Now you have to activate the module in your WHMCS system.'''<br />
−
Go to '' 'Setup' '' → '' 'Products/Services' '' → '' 'Servers' '' and press '' 'Add New Server' ''.
+
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:WPE_5.png]]
+
|style="padding: 0px 0px 20px 25px;"|[[File:SSW_5.png]]
 
|}
 
|}
 
{|
 
{|
−
|style="padding: 0px 0px 15px 15px;"|'''6. Next, enter your server name, IP address/hostname, API username and password.'''<br />
+
|style="padding: 0px 0px 15px 15px;"|'''6. In the next step you need to permit access to this module.'''<br />
−
Choose '' 'Websitepanelextended' '' from a dropdown menu and press '' 'Save Changes' ''.'''
+
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:WPE_6.png]]
+
|style="padding: 0px 0px 20px 25px;"|[[File:SSW_6.png]]
 
|}
 
|}
 
{|
 
{|
−
|style="padding: 0px 0px 20px 15px;"|'''7. It is time to create a server group. To do so, click on '' 'Create Server Group' ''.'''
+
|style="padding: 0px 0px 30px 15px;"|'''7. You have just successfully installed Server Allocator For WHMCS!'''
 
|}
 
|}
 +
 +
=Management=
 
{|
 
{|
−
|style="padding: 0px 0px 20px 25px;"|[[File:WPE_8.png]]
+
|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 20px 15px;"|'''8. Enter name, click on your previously created server, press '' 'Add' '' and afterwards '' 'Save Changes' ''.'''
+
|style="padding: 0px 0px 30px 25px;"|[[File:SSW_7.png]]
 
|}
 
|}
 +
==Add Group==
 
{|
 
{|
−
|style="padding: 0px 0px 30px 25px;"|[[File:WPE_9.png]]
+
|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.
 
|}
 
|}
−
==Configuration of Product==
 
 
{|
 
{|
−
|style="padding: 10px 0px 15px 15px;"|'''9. In order to create and configure a product, go to '' 'Setup' '' → '' 'Products/Services' '' → '' 'Products/Services' ''.'''<br />
+
|style="padding: 0px 0px 20px 25px;"|[[File:SSW_8.png]]
−
Click on '' 'Create a New Group' ''.
+
 
|}
 
|}
 
{|
 
{|
−
|style="padding: 0px 0px 20px 25px;"|[[File:WPE_10.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 20px 15px;"|'''10. Enter product group name and press '' 'Save Changes' ''.'''
+
|style="padding: 0px 0px 30px 25px;"|[[File:SSW_9.png]]
−
|}
+
−
{|
+
−
|style="padding: 0px 0px 20px 25px;"|[[File:WPE_11.png]]
+
−
|}
+
−
{|
+
−
|style="padding: 0px 0px 15px 15px;"|'''11. When you have a product group, you can create your product.'''<br />
+
−
To create a product click on '' 'Create a New Product' ''.
+
−
|}
+
−
{|
+
−
|style="padding: 0px 0px 20px 25px;"|[[File:WPE_12.png]]
+
−
|}
+
−
{|
+
−
|style="padding: 0px 0px 20px 15px;"|'''12. Afterwards, choose your product group and type from dropdown menus, enter your product name and press '' 'Continue' ''.'''
+
−
|}
+
−
{|
+
−
|style="padding: 0px 0px 20px 25px;"|[[File:WPE_13.png]]
+
−
|}
+
−
{|
+
−
|style="padding: 0px 0px 20px 15px;"|'''13. Now, go to the '' 'Module Settings' '' section, choose both '' 'Websitepanelextended' '' and your previously created server group from dropdown menus.'''
+
−
|}
+
−
{|
+
−
|style="padding: 0px 0px 20px 25px;"|[[File:WPE_14.png]]
+
−
|}
+
−
{|
+
−
|style="padding: 0px 0px 15px 15px;"|'''14. Fill in '' 'Parent Space ID' '', '' 'Plan ID' '', '' 'Enterprise Server Port' '' and '' 'Portal URL' ''  fields.'''<br />
+
−
Additionally, check '' 'Create Mail Account' '', '' 'Create Temporary Domain' '', '' 'Create Website' '', '' 'Create FTP Account' '', '' 'Count Bandwidth / Diskspace' '' and '' 'Create DNS Zone' ''.<br />
+
−
Confirm through pressing '' 'Save Changes' ''.
+
−
|}
+
−
{|
+
−
|style="padding: 0px 0px 30px 25px;"|[[File:WPE_15.png]]
+
−
|}
+
−
==Configuration Of Addon==
+
−
{|
+
−
|style="padding: 10px 0px 20px 15px;"|'''15. Now, proceed to '' 'Setup' '' → '' 'Module Addon' '' and press '' 'Activate' '' next to '' 'WebsitePanel Extended' ''.'''
+
−
|}
+
−
{|
+
−
|style="padding: 0px 0px 20px 25px;"|[[File:WPE_16.png]]
+
−
|}
+
−
{|
+
−
|style="padding: 0px 0px 20px 15px;"|'''16. Press '' 'Configure' '', define access to the module and press '' 'Save Changes' ''.'''
+
−
|}
+
−
{|
+
−
|style="padding: 0px 0px 20px 25px;"|[[File:WPE_16_1.png]]
+
−
|}
+
−
{|
+
−
|style="padding: 0px 0px 15px 15px;"|'''17. Now, proceed to the '' 'Addons' '' → '' 'WebsitePanel Extended' ''.'''<br />
+
−
Press '' 'Configure' '' next to the previously created product and  define which features will be available from your WHMCS client area.<br />
+
−
Mark checkbox next to the feature in order to enable them. Press '' 'Save Changes' '' to confirm those settings.
+
−
|}
+
−
{|
+
−
|style="padding: 0px 0px 30px 25px;"|[[File:WPE_16_2.png]]
+
 
|}
 
|}
  
−
=Management=
+
==Group Management==
 
{|
 
{|
−
|style="padding: 10px 0px 15px 15px;"|''' WebsitePanel Extended For WHMCS allows you to offer WebsitePanel for your clients.'''<br />
+
|style="padding: 10px 0px 15px 15px;"|Previously created group currently does not affect the system at all.<br />
−
In addition, your client can manage their WebsitePanel from their WHMCS client area.
+
Let's change that through adding a new rule. Press '' 'Add Rule' '' to proceed.
 
|}
 
|}
 
{|
 
{|
−
|style="padding: 0px 0px 30px 25px;"|[[File:WPE_17.png]]
+
|style="padding: 0px 0px 20px 25px;"|[[File:SSW_10.png]]
 
|}
 
|}
−
==Admin Area==
 
 
{|
 
{|
−
|style="padding: 10px 0px 15px 15px;"|In the admin area you can easily suspend/unsuspend service, create/terminate it and change its password.<br />
+
|style="padding: 0px 0px 15px 15px;"|In the next step select server type that the switch will apply to.<br />
−
Additionally, you can change its package and log into WebsitePanel with one click.
+
Press '' 'Next' ''.
 
|}
 
|}
 
{|
 
{|
−
|style="padding: 0px 0px 30px 25px;"|[[File:WPE_18.png]]
+
|style="padding: 0px 0px 20px 25px;"|[[File:SSW_11.png]]
 
|}
 
|}
−
==Client Area==
 
 
{|
 
{|
−
|style="padding: 10px 0px 15px 15px;"|Let's proceed to the client area. We will show you the possibilities of our module.<br />
+
|style="padding: 0px 0px 15px 15px;"|Each rule can have multiple rule definitions.<br />
−
As you can see on the following screen, besides management from the client area, module allows your client to log into WebsitePanel through one click.
+
'''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:WPE_19.png]]
+
|style="padding: 0px 0px 20px 25px;"|[[File:SSW_12.png]]
 
|}
 
|}
 
{|
 
{|
−
|style="padding: 0px 0px 20px 15px;"|They can also easily change password at the '' 'Change Password' '' page.  
+
|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 30px 25px;"|[[File:WPE_19_1.png]]
+
|style="padding: 0px 0px 20px 25px;"|[[File:SSW_13.png]]
 
|}
 
|}
−
===DNS Management===
 
 
{|
 
{|
−
|style="padding: 10px 0px 15px 15px;"|'' 'DNS Management' '' page allows your clients to view the list of DNS zones as well as quickly enable/disable them.<br />
+
|style="padding: 0px 0px 15px 15px;"|Let's add one more rule definition, which in this case will be using product addon.<br />
−
Additionally, they can edit DNS zones, press '' 'Edit' '' to proceed.
+
Press '' 'Add Definition' '' → '' 'Addon' '' and choose product addon.
 
|}
 
|}
 
{|
 
{|
−
|style="padding: 0px 0px 20px 25px;"|[[File:WPE_20.png]]
+
|style="padding: 0px 0px 20px 25px;"|[[File:SSW_14.png]]
 
|}
 
|}
 
{|
 
{|
−
|style="padding: 0px 0px 15px 15px;"|As you can see, the list of current DNS records is shown.<br />
+
|style="padding: 0px 0px 20px 15px;"|Now, select server you wish to switch to and press '' 'Save Changes' '' button.
−
To alter any of them, modify desired value and press '' 'Update' '' button.
+
 
|}
 
|}
 
{|
 
{|
−
|style="padding: 0px 0px 20px 25px;"|[[File:WPE_21.png]]
+
|style="padding: 0px 0px 30px 25px;"|[[File:SSW_15.png]]
−
|}
+
−
{|
+
−
|style="padding: 0px 0px 20px 15px;"|To add a new record, fill in its details and press '' 'Add' '' as shown on the following screen.
+
−
|}
+
−
{|
+
−
|style="padding: 0px 0px 30px 25px;"|[[File:WPE_22.png]]
+
 
|}
 
|}
  
−
===Web Sites===
+
==Rule Management==
 
{|
 
{|
−
|style="padding: 10px 0px 15px 15px;"|Your clients can also manage theirs sites and add subdomains to them at the '' 'Web Sites' '' page.<br />
+
|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.
−
To add subdomain, press '' 'Create' ''.
+
 
|}
 
|}
 
{|
 
{|
−
|style="padding: 0px 0px 20px 25px;"|[[File:WPE_22_1.png]]
+
|style="padding: 0px 0px 20px 25px;"|[[File:SSW_16.png]]
 
|}
 
|}
 
{|
 
{|
−
|style="padding: 0px 0px 20px 15px;"|Afterwards, fill in subdomain name and select domain to create it on.
+
|style="padding: 0px 0px 20px 15px;"|Press '' 'Links' '' next to desired rule to view the list of links.
−
|}
+
−
{|
+
−
|style="padding: 0px 0px 30px 25px;"|[[File:WPE_22_2.png]]
+
−
|}
+
−
 
+
−
===Email Manager===
+
−
{|
+
−
|style="padding: 10px 0px 15px 15px;"|In the '' 'Email Manager' '' page your clients are able to easily add, modify and remove mailboxes.<br />
+
−
To add a new mailbox, press '' 'Create' ''.
+
 
|}
 
|}
 
{|
 
{|
−
|style="padding: 0px 0px 20px 25px;"|[[File:WPE_23.png]]
+
|style="padding: 0px 0px 20px 25px;"|[[File:SSW_17.png]]
 
|}
 
|}
 
{|
 
{|
−
|style="padding: 0px 0px 15px 15px;"|Now, select domain for the new mailbox, fill in email address, password, owner name and email quota.<br />
+
|style="padding: 0px 0px 20px 15px;"|Each of them leads to the order form with product configured according to defined rule.<!--<br />
−
Additionally, you can set up the mailbox settings through using checkboxes marked on the following screen.<br />
+
''Note: Link to product will work properly only if addons/configurable options/custom fields used in rule are assigned to that product.''--->
−
Press '' 'Create' '' to save this mailbox.
+
 
|}
 
|}
 
{|
 
{|
−
|style="padding: 0px 0px 30px 25px;"|[[File:WPE_24.png]]
+
|style="padding: 0px 0px 20px 25px;"|[[File:SSW_18.png]]
 
|}
 
|}
  
−
===Email Aliases===
+
==Sample Orders==
 
{|
 
{|
−
|style="padding: 10px 0px 15px 15px;"|'' 'Email Manager' '' page allows your clients to set up email aliases.<br />
+
|style="padding: 10px 0px 20px 15px;"|In this section we will show you how our module works on an exemplary rule shown below.
−
Create one, start by press '' 'Create' '' button.
+
 
|}
 
|}
 
{|
 
{|
−
|style="padding: 0px 0px 20px 25px;"|[[File:WPE_25.png]]
+
|style="padding: 0px 0px 20px 25px;"|[[File:SSW_18_1.png]]
 
|}
 
|}
 +
===First Order===
 
{|
 
{|
−
|style="padding: 0px 0px 15px 15px;"|Now, fill in the address of one of your mailboxes and choose its domain.<br />
+
|style="padding: 10px 0px 20px 15px;"|Let us order a product fulfilling all conditions for receiving 'cPanel SSD - 99.9' server.<br />
−
Fill in the full list of email addresses to forward to and press '' 'Create' ''.
+
Using this configuration, client pays additionally for 'Based On SSD' addon.
 
|}
 
|}
 
{|
 
{|
−
|style="padding: 0px 0px 30px 25px;"|[[File:WPE_26.png]]
+
|style="padding: 0px 0px 20px 25px;"|[[File:SSW_19.png]]
 
|}
 
|}
−
===Email Domains===
 
 
{|
 
{|
−
|style="padding: 10px 0px 15px 15px;"|Our module allows even to view and remove email domains by your clients.<br />
+
|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:WPE_27.png]]
+
|style="padding: 0px 0px 30px 25px;"|[[File:SSW_20.png]]
 
|}
 
|}
  
−
===Email Groups===
+
===Second Order===
 
{|
 
{|
−
|style="padding: 10px 0px 20px 15px;"|Proceed to '' 'Email Groups' '' page and press '' 'Create' '' to add a new email group.
+
|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:WPE_29.png]]
+
|style="padding: 0px 0px 20px 25px;"|[[File:SSW_21.png]]
 
|}
 
|}
 
{|
 
{|
−
|style="padding: 0px 0px 15px 15px;"|Now, provide an email address which will be used as an email resender.<br />
+
|style="padding: 10px 0px 15px 15px;"|As displayed on the following screen, the switch has been made successfully.
−
Additionally, fill in the list of email addresses which should receive email and press '' 'Create' ''.
+
 
|}
 
|}
 
{|
 
{|
−
|style="padding: 0px 0px 30px 25px;"|[[File:WPE_30.png]]
+
|style="padding: 0px 0px 30px 25px;"|[[File:SSW_22.png]]
 
|}
 
|}
  
−
===Email List===
+
===Third Order===
 
{|
 
{|
−
|style="padding: 10px 0px 15px 15px;"|In the '' 'Email Groups' '' page your client can add mailing lists.<br />
+
|style="padding: 10px 0px 15px 15px;"|Let us order a product without 'Based On SSD' addon and with default uptime.<br />
−
Press '' 'Create' '' to add a new mailing list.
+
This should result in assigning default 'cPanel - 99.9' server.
 
|}
 
|}
 
{|
 
{|
−
|style="padding: 0px 0px 20px 25px;"|[[File:WPE_31.png]]
+
|style="padding: 0px 0px 20px 25px;"|[[File:SSW_23.png]]
 
|}
 
|}
 
{|
 
{|
−
|style="padding: 0px 0px 15px 15px;"|Now, fill in the mailing list of email address, its description and choose list moderator.<br />
+
|style="padding: 0px 0px 20px 15px;"|As you can see, switch has not been made and hosting is using default group server.
−
Additionally, you can set up password for mailing list by filling in password and checking '' 'Require Password' ''.<br />
+
−
You can also define who can send emails through this list by selecting desired option from the '' 'Who Can Post' '' dropdown menu.
+
−
|}
+
−
{|
+
−
|style="padding: 0px 0px 20px 25px;"|[[File:WPE_32.png]]
+
−
|}
+
  
−
{|
 
−
|style="padding: 0px 0px 15px 15px;"|If you wish to add prefix to messages from this list, fill in a desired prefix into '' 'Subject Prefix' '' and mark '' 'Require Subject Prefix' ''.<br />
 
−
Next, provide message size limit and fill in the list of email addresses into '' 'Mailing List Members' ''.<br />
 
−
Finish through selecting additional options and pressing '' 'Create' ''.
 
 
|}
 
|}
 
{|
 
{|
−
|style="padding: 0px 0px 30px 25px;"|[[File:WPE_33.png]]
+
|style="padding: 0px 0px 30px 25px;"|[[File:SSW_24.png]]
 
|}
 
|}
  
−
===FTP Accounts===
+
=Tips=
 
{|
 
{|
−
|style="padding: 10px 0px 15px 15px;"|All of the FTP accounts bounded to your client WebsitePanel Extended For WHMCS product are listed in the '' 'FTP Accounts' '' page.<br />
+
|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.
−
You can easily add a new FTP account, press '' 'Create' '' to proceed.
+
−
|}
+
−
{|
+
−
|style="padding: 0px 0px 20px 25px;"|[[File:WPE_34.png]]
+
−
|}
+
−
{|
+
−
|style="padding: 0px 0px 15px 15px;"|Now, fill in FTP account username, password and its home folder.<br />
+
−
Define account rights and press '' 'Create' ''.<br />
+
−
Account will be immediately created.
+
−
|}
+
−
{|
+
−
|style="padding: 0px 0px 30px 25px;"|[[File:WPE_35.png]]
+
 
|}
 
|}
  
−
===File Manager===
 
−
{|
 
−
|style="padding: 10px 0px 15px 15px;"|Your clients can access and modify directories related to their WebsitePanel Extended For WHMCS products in the '' 'File Manager' '' page.<br />
 
−
As you can see, they can use a wide variety of commands marked on the following screen.
 
−
|}
 
−
{|
 
−
|style="padding: 0px 0px 20px 25px;"|[[File:WPE_36.png]]
 
−
|}
 
−
{|
 
−
|style="padding: 0px 0px 20px 15px;"|Clients can also view the content of all folders inside of their home directories, set up permissions to folders and files and calculate disk space.
 
−
|}
 
−
{|
 
−
|style="padding: 0px 0px 30px 25px;"|[[File:WPE_37.png]]
 
−
|}
 
−
==Configuration Possibilities==
 
−
{|
 
−
|style="padding: 10px 0px 15px 15px;"|Our module allows you to offer a wide variety of products using WebsitePanel, like product with only email accounts or only access to '' 'File Manager' '' & FTP accounts.<br />
 
−
All of that can be done owing to configuration of product → '' 'Module Settings' '' and defining client area features in the  WebsitePanel Extended addon.<br />
 
−
Sample configuration of product offering only email accounts is shown on the screens below.
 
−
|}
 
−
{|
 
−
|style="padding: 0px 0px 20px 25px;"|[[File:WPE_38.png]]
 
−
|}
 
−
 
−
{|
 
−
|style="padding: 0px 0px 30px 25px;"|[[File:WPE_39.png]]
 
−
|}
 
−
 
−
=Tips=
 
−
{|
 
−
|style="padding: 10px 0px 30px 15px;"|
 
−
|}
 
 
=Common Problems=
 
=Common Problems=
 
{|
 
{|
Line 411: Line 254:
 
|}
 
|}
 
{|
 
{|
−
|style="padding: 0px 0px 30px 15px;"|2. If you encounter any problem related to our module, make sure to install latest version of WebsitePanel For WHMCS.
+
|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:11, 1 September 2016

Contents

About Server Allocator For WHMCS

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.

  • Admin Area Features:
✔ 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
  • Client Area Features:
✔ Switch Assigned Server Automatically During Ordering Product - Depending On Applied Rule
  • Supported Rule Definitions:
✔ Configurable Options
✔ Custom Fields
✔ Product Addons
  • General Info:
✔ Supports All Server Types
✔ Multi-Language Support
✔ 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.
File:SSW 1.png
2. Upload and extract the module into the main WHMCS directory.

Files in your WHMCS directory should look like this.

File:SSW 2.png
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' .

File:SSW 3.png
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' .

File:SSW 4.png
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 Allocator' and press 'Activate' button.

File:SSW 5.png
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' .

File:SSW 6.png
7. You have just successfully installed Server Allocator For WHMCS!

Management

Server Allocator For WHMCS allows you to automatically switch to wanted server upon specific product configuration.
File:SSW 7.png

Add Group

In order to configure switching rules, proceed with creating of a new group.

Press 'Add Group' to proceed.

File:SSW 8.png
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.

File:SSW 9.png

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.

File:SSW 10.png
In the next step select server type that the switch will apply to.

Press 'Next' .

File:SSW 11.png
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.

File:SSW 12.png
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.

File:SSW 13.png
Let's add one more rule definition, which in this case will be using product addon.

Press 'Add Definition' → 'Addon' and choose product addon.

File:SSW 14.png
Now, select server you wish to switch to and press 'Save Changes' button.
File:SSW 15.png

Rule Management

Each group and rule can be modified and removed at any time through using buttons marked on the following screen.
File:SSW 16.png
Press 'Links' next to desired rule to view the list of links.
File:SSW 17.png
Each of them leads to the order form with product configured according to defined rule.
File:SSW 18.png

Sample Orders

In this section we will show you how our module works on an exemplary rule shown below.
File:SSW 18 1.png

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.

File:SSW 19.png
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.

File:SSW 20.png

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.

File:SSW 21.png
As displayed on the following screen, the switch has been made successfully.
File:SSW 22.png

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.

File:SSW 23.png
As you can see, switch has not been made and hosting is using default group server.
File:SSW 24.png

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.

Retrieved from "https://www.docs.modulesgarden.com/index.php?title=Hosting_Quota_Notifications_1.X_For_WHMCS&oldid=27764"
Navigation
WHMCS Modules
WHMCS Widgets
Tools And Applications
Translations
General
FAQ
Community