Personal tools
Namespaces

Variants
Actions

Hosting Quota Notifications 1.X For WHMCS

From ModulesGarden Wiki
(Difference between revisions)
Jump to: navigation, search
(Installation)
Line 1: Line 1:
<meta name="keywords" content="client area designer for whmcs, client area designer configuration, whmcs client area designer management, whmcs client area designer installation, whmcs client area designer common problems, about whmcs client area designer, whmcs client client area designer documentation, whmcs client area designer faq, whmcs client area designer help, whmcs client area designer guide, whmcs client area designer wiki, whmcs client area designer tutorial, whmcs client area designer tips, whmcs client area designer wiki"></meta>
+
{{DISPLAYTITLE:cPanel Manage2 For WHMCS}}
<meta name="description" content="ModulesGarden Wiki Contains All The Information You Need About The Client Area Designer For WHMCS Module."></meta>
+
<meta name="keywords" content="cpanel manage2 for whmcs, cpanel manage2 guide, cpanel partner noc, modulesgarden cpanel manage2, cpanel manage2 wiki, cpanel manage2 tutorial, cpanel manage2 tips, cpanel module wiki, cpanel manage2 common problems, about cpanel manage2, cpanel manage2 documentation, cpanel manage2 faq, cpanel manage2 help, cpanel manage2 configuration, cpanel manage2 management, cpanel manage2 installation"></meta>
 +
<meta name="description" content="ModulesGarden Wiki Contains All The Information You Need About The cPanel Manage2 For WHMCS Module."></meta>
  
=About [https://www.modulesgarden.com/products/whmcs/client-area-designer Client Area Designer For WHMCS]=
+
=About [http://www.modulesgarden.com/products/whmcs/cpanel_manage2/features cPanel Manage2 For WHMCS]=
 
{|
 
{|
|style="padding: 10px 0px 10px 0px;"|'''Client Area Designer For WHMCS''' is a module that allows administrators to manage their client area final view.<br/>
+
|style="padding: 10px 0px 10px 0px;"|'''cPanel Manage2 For WHMCS''' is a module created to introduce and automate provisioning of cPanel licenses in your WHMCS.<br />
Change the order of displayed elements, add new ones or hide them if you do not want your clients to access them.<br/>
+
The module will enable your clients to view detailed information about their licenses in your WHMCS client area as well as assign IP addresses to their licenses.
Additionally, you may create new widgets and set up restrictions rules to show the widget to selected clients only.
+
 
|}
 
|}
<!-- fixed -->
+
<!--a comment maybe? -->
*'''Module Features:'''
+
*'''Admin Area Features:'''
 
{|
 
{|
|style="padding: 10px 0px 0px 30px;"|✔ Customize Your Client Area By Modifying:
+
|style="padding: 10px 0px 0px 30px;"|✔ Create/Suspend/Unsuspend/Terminate License
 
|}
 
|}
 
{|
 
{|
|style="padding: 0px 0px 0px 45px;"|✔ Navbar Elements
+
|style="padding: 0px 0px 0px 30px;"|✔ Change IP Address Assigned To License
 
|}
 
|}
 
{|
 
{|
|style="padding: 0px 0px 0px 45px;"|✔ Sidebar Elements
+
|style="padding: 0px 0px 0px 30px;"|✔ View License Details
 
|}
 
|}
 
{|
 
{|
|style="padding: 0px 0px 0px 45px;"|✔ Homepage Widgets
+
|style="padding: 0px 0px 0px 30px;"|✔ Toggle Automatic License Assignment To Specified IP Address
 
|}
 
|}
 
{|
 
{|
|style="padding: 0px 0px 0px 30px;"|✔ Add Your Own Elements And Widgets
+
|style="padding: 0px 0px 10px 30px;"|✔ Define Package ID And Group ID
 
|}
 
|}
 +
*'''Client Area Features:'''
 
{|
 
{|
|style="padding: 0px 0px 0px 30px;"|✔ Scan Your Client Area In Search Of Custom Elements And Widgets
+
|style="padding: 10px 0px 0px 30px;"|✔ Order License
 
|}
 
|}
 
{|
 
{|
|style="padding: 0px 0px 10px 30px;"|✔ View And Modify List Of Known Locations In Your Client Area
+
|style="padding: 0px 0px 0px 30px;"|✔ View License Details
 
|}
 
|}
*'''Navbar Element Features:'''
 
 
{|
 
{|
|style="padding: 10px 0px 0px 30px;"|✔ Define Name
+
|style="padding: 0px 0px 10px 30px;"|✔ Change IP Address Assigned To License
 
|}
 
|}
 +
*'''General Info:'''
 
{|
 
{|
|style="padding: 0px 0px 0px 30px;"|✔ Define URI
+
|style="padding: 10px 0px 0px 30px;"|✔ Integrated With <u>Product Linker For WHMCS</u> - Resell Licenses In Product Bundles [http://www.modulesgarden.com/products/whmcs/product_linker/features (read more)]
|}
+
{|
+
|style="padding: 0px 0px 0px 30px;"|✔ Define Icon
+
 
|}
 
|}
 
{|
 
{|
|style="padding: 0px 0px 0px 30px;"|✔ Define Display Rules:
+
|style="padding: 0px 0px 0px 30px;"|✔ Multi-Language Support
|}
+
{|
+
|style="padding: 0px 0px 0px 45px;"|✔ Client Owns Domain
+
 
|}
 
|}
 
{|
 
{|
|style="padding: 0px 0px 0px 45px;"|✔ Client Owns Product
+
|style="padding: 0px 0px 0px 30px;"|✔ Supports PHP 5.3 Up To PHP 7
 
|}
 
|}
 
{|
 
{|
|style="padding: 0px 0px 0px 45px;"|✔ Client Is In Location
+
|style="padding: 0px 0px 0px 30px;"|✔ Supports WHMCS Templates Five and Six
|}
+
{|
+
|style="padding: 0px 0px 10px 30px;"|✔ Add Multiple Links To Element
+
|}
+
 
+
*'''Sidebar Element Features:'''
+
{|
+
|style="padding: 10px 0px 0px 30px;"|✔ Define Name
+
|}
+
{|
+
|style="padding: 0px 0px 0px 30px;"|✔ Define Icon
+
|}
+
{|
+
|style="padding: 0px 0px 0px 30px;"|✔ Define Display Rules:
+
|}
+
{|
+
|style="padding: 0px 0px 0px 45px;"|✔ Client Owns Domain
+
|}
+
{|
+
|style="padding: 0px 0px 0px 45px;"|✔ Client Owns Product
+
|}
+
{|
+
|style="padding: 0px 0px 0px 45px;"|✔ Client Is In Location
+
|}
+
{|
+
|style="padding: 0px 0px 0px 45px;"|✔ Choose One Feature Per Element:
+
|}
+
{|
+
|style="padding: 0px 0px 0px 30px;"|✔ Add Multiple Links To Element
+
|}
+
{|
+
|style="padding: 0px 0px 10px 30px;"|✔ Define Custom Body And Footer Content - Support HTML, CSS And JavaScript
+
|}
+
 
+
*'''Homepage Widget Features:'''
+
{|
+
|style="padding: 10px 0px 0px 30px;"|✔ Define Name
+
|}
+
{|
+
|style="padding: 0px 0px 0px 30px;"|✔ Define Icon
+
|}
+
{|
+
|style="padding: 0px 0px 0px 30px;"|✔ Define Style Color
+
|}
+
{|
+
|style="padding: 0px 0px 0px 30px;"|✔ Define Widget Button
+
|}
+
{|
+
|style="padding: 0px 0px 0px 30px;"|✔ Choose One Feature Per Widget:
+
|}
+
{|
+
|style="padding: 0px 0px 0px 45px;"|✔ Add Multiple Links To Element
+
|}
+
{|
+
|style="padding: 0px 0px 10px 45px;"|✔ Define Custom Body And Footer Content - Support HTML, CSS And JavaScript
+
|}
+
*'''General Info:'''
+
{|
+
|style="padding: 10px 0px 0px 30px;"|✔ Multi-Language Support
+
|}
+
{|
+
|style="padding: 0px 0px 0px 30px;"|✔ Supports PHP 5.3 Up To PHP 7
+
 
|}
 
|}
 
{|
 
{|
Line 119: Line 52:
 
|}
 
|}
  
=Installation=
+
=Installation and Configuration=
 
{|
 
{|
|style="padding: 10px 0px 0px 0px;"|'''This tutorial will show you how to successfully install and configure Client Area Designer For WHMCS.''' <br/>
+
|style="padding: 10px 0px 0px 0px;"|'''In this tutorial we will show you how to quickly install and configure cPanel Manage2 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 process.
 
|}
 
|}
 
{|
 
{|
|style="padding: 20px 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 cPanel Manage2 For WHMCS.'''
 
|}
 
|}
 
{|
 
{|
|style="padding: 0px 0px 20px 25px;"|[[File:CAD_1.png]]
+
|style="padding: 0px 0px 20px 25px;"|[[File:CM1.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.3 up to PHP 5.6.<br/>It does not apply to open source versions.<br/>
+
|style="padding: 0px 0px 15px 15px;"|'''2. Upload and extract the module into the main WHMCS directory.'''<br />
'' '''Note''': You can check current PHP version in your WHMCS. To do so proceed to ''' 'Utilities' → 'System' → 'PHP Info'.'''
+
Files in your WHMCS directory should look like these.
 
|}
 
|}
 
{|
 
{|
|style="padding: 0px 0px 20px 25px;"|[[File:CAD_2.png]]
+
|style="padding: 0px 0px 20px 25px;"|[[File:CM2.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. When you install cPanel Manage2 for the first time you have to rename '' 'license_RENAME.php' '' file.'''<br />
The content of PHP version files should look like this.  
+
File is located in '' 'modules/servers/cpanelManagetwo/license_RENAME.php'. '' Rename it from '' 'license_RENAME.php' '' to '' 'license.php'. ''
 
|}
 
|}
 
{|
 
{|
|style="padding: 0px 0px 20px 25px;"|[[File:etrer.png]]
+
|style="padding: 0px 0px 20px 25px;"|[[File:CM3.png]]
 
|}
 
|}
 
{|
 
{|
|style="padding: 0px 0px 15px 15px;"|'''4. When you install Client Area Designer For WHMCS for the first time you have to rename '' 'license_RENAME.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 />
File is located in '' 'modules/addons/ClientAreaDesigner/license_RENAME.php'. '' Rename it from '' 'license_RENAME.php' '' to '' 'license.php'. ''
+
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 20px 25px;"|[[File:CAD_3.png]]
+
|style="padding: 0px 0px 20px 25px;"|[[File:CM4.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/>
+
|style="padding: 0px 0px 15px 15px;"|'''5. Good job! You have just successfully installed cPanel Manage2 For WHMCS! Now, we will show you how to configure a new product.'''<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'.''
+
To do so, log in into your WHMCS. Now press '' 'Setup' '' → '' 'Products/Services' '' → '' 'Servers'. ''<br />
 +
Afterwards, press '' 'Add New Server'. ''
 
|}
 
|}
 
{|
 
{|
|style="padding: 0px 0px 20px 25px;"|[[File:CAD_4.png]]
+
|style="padding: 0px 0px 20px 25px;"|[[File:SO8.png]]
 
|}
 
|}
 
{|
 
{|
|style="padding: 0px 0px 15px 15px;"|'''6. Now you have to activate the module in your WHMCS system. '''<br/>
+
|style="padding: 0px 0px 15px 15px;"|'''6. Next enter your server '' 'Name', 'Username' '' and '' 'Password'. '' '''<br />
Log in to your WHMCS admin area. Go to '' 'Setup' '' '' 'Addon Modules'. '' Afterwards, find '' 'Client Area Designer' '' and press '' 'Activate' '' button.
+
Choose '' 'CpanelManagetwo' '' from a '' 'Type' '' dropdown menu and press '' 'Save Changes'. ''<br />
 
|}
 
|}
 
{|
 
{|
|style="padding: 0px 0px 20px 25px;"|[[File:CAD_5.png]]
+
|style="padding: 0px 0px 20px 25px;"|[[File:CM5.png]]
 
|}
 
|}
 
{|
 
{|
|style="padding: 0px 0px 15px 15px;"|'''7. In the next step you need to permit access to this module.'''<br/>
+
|style="padding: 0px 0px 15px 15px;"|'''7. After you configure your server correctly, you will see a following screen.'''<br />
To do so, click on '' 'Configure' '' button, tick '' 'Full Administrator' '' and press '' 'Save Changes'. ''
+
Now you need to create a new group for your server. For that purpose press '' 'Create New Group'. ''
 
|}
 
|}
 
{|
 
{|
|style="padding: 0px 0px 20px 25px;"|[[File:CAD_6.png]]
+
|style="padding: 0px 0px 20px 25px;"|[[File:CM5.5.png]]
 
|}
 
|}
 
{|
 
{|
|style="padding: 0px 0px 15px 15px;"|'''8. You have just successfully installed Client Area Designer For WHMCS!'''<br/>
+
|style="padding: 0px 0px 20px 15px;"|'''8. Enter name, click on your previously created server, press '' 'Add' '' then press '' 'Save Changes'. '''''
You can access your module under '' 'Addons' '' '' 'Client Area Designer'.''
+
 
|}
 
|}
 
{|
 
{|
|style="padding: 0px 0px 30px 25px;"|[[File:CAD_7.png]]
+
|style="padding: 0px 0px 20px 25px;"|[[File:SO11.png]]
 
|}
 
|}
 
=Configuration and Management=
 
 
{|
 
{|
|style="padding: 10px 0px 30px 15px;"|'''Client Area Designer For WHMCS is a module which allows you to adjust the layout of any panels available on your client area as well as add new widgets.'''<br/>
+
|style="padding: 0px 0px 15px 15px;"|'''9. In order to create and configure product, click on '' 'Setup' '' → '' 'Products/Services' '' → '' 'Products/Services' ''.'''<br />
The module does not require highly advanced configuration.<br/>That is why we will immediately move to the most crucial aspect, which is customizing the panels layout.
+
If you do not have a product group, click on '' 'Create a New Group'. '' If you do, simply go to step 11.
 
|}
 
|}
 
==Panels==
 
 
{|
 
{|
|style="padding: 10px 0px 30px 15px;"|Under '' 'Panels' '' tab you will find three sections dedicated to the visibility of different types of panels in your client area.
+
|style="padding: 0px 0px 20px 25px;"|[[File:SO12.png]]
*Navbars - Management of positions available on the navigation bar in your client area
+
*Sidebars - Management of panels available on the left sidebar in your client area
+
*Homepage Widgets - Modify and create new widgets available on your home page
+
 
|}
 
|}
===Navbars===
 
 
{|
 
{|
|style="padding: 10px 0px 15px 15px;"|On the first sight you will see two tables, each related to Primary Navbar Left or Right side.<br/>
+
|style="padding: 0px 0px 20px 15px;"|'''10. Enter product group name and press '' 'Create Group'. '''''
There are already all the predefined sections outlined with their official names and positions.<br/>
+
''Info:
+
If you already see that you have more elements than it is visible in the addon, then use '' 'Scanner' '' to search for them.<br/> Read more about scanning option [http://www.docs.modulesgarden.com/Client_Area_Designer_For_WHMCS#Scanner here].''
+
 
|}
 
|}
 
{|
 
{|
|style="padding: 0px 0px 20px 25px;"|[[File:CAD_8.png]]
+
|style="padding: 0px 0px 20px 25px;"|[[File:SO13.png]]
 
|}
 
|}
 
{|
 
{|
|style="padding: 0px 0px 20px 15px;"|Those are the below navbar panels visible in the client area.
+
|style="padding: 0px 0px 15px 15px;"|'''11. When you have a product group, create a new product. If you already have a product, go to step 13.'''<br />
 +
To create a product click on '' 'Create a New Product' ''.
 
|}
 
|}
 
{|
 
{|
|style="padding: 0px 0px 20px 25px;"|[[File:CAD_9.png]]
+
|style="padding: 0px 0px 20px 25px;"|[[File:SO14.png]]
 
|}
 
|}
 
{|
 
{|
|style="padding: 0px 0px 15px 15px;"|First of all, you may change the position of the elements.<br/>
+
|style="padding: 0px 0px 20px 15px;"|'''12. Afterwards, choose your product type and product group from dropdown menus, enter your product name and press '' 'Continue'. '''''
Drag one panel and drop it in the required place.
+
 
|}
 
|}
 
{|
 
{|
|style="padding: 0px 0px 20px 25px;"|[[File:CAD_10.png]]
+
|style="padding: 0px 0px 20px 25px;"|[[File:SO15.png]]
 
|}
 
|}
 
{|
 
{|
|style="padding: 0px 0px 15px 15px;"|Use action buttons to:
+
|style="padding: 0px 0px 15px 15px;"|'''13. Now go to '' 'Module Settings' '' section, choose both '' 'CpanelManagetwo' '' and your previously created server group from dropdown menus.'''<br />
*edit the section
+
Next, select '' 'Force License' ''- force adding license to a specified IP address.<br/>
*delete '''(only custom elements)'''
+
Enter '' 'Package ID' '' - the ID of the package that the new license will use.<br/>
*view child elements
+
Enter '' 'Group ID' '' — the ID of the group which the new license will belong to.<br/>
 +
'' 'Save Changes'! ''
 
|}
 
|}
 
{|
 
{|
|style="padding: 0px 0px 30px 25px;"|[[File:CAD_11.png]]
+
|style="padding: 0px 0px 20px 25px;"|[[File:CM6.png]]
 
|}
 
|}
====Edit Element====
 
 
{|
 
{|
|style="padding: 10px 0px 15px 15px;"|When you are editing an existing parent element, you may:
+
|style="padding: 0px 0px 15px 15px;"|'''14. Once module settings are ready move to '' 'Custom Fields'. '''''<br />
*provide a new display name
+
In '' 'Field Name' '' enter '' 'IP', '' choose '' 'Text Box' '' from a field type dropdown menu, enter description and set up validation as:<br />
*add icon
+
/\b(25[0-5]|2[0-4][0-9]|[01]?[0-9][0-9]?)\.(25[0-5]|2[0-4][0-9]|[01]?[0-9][0-9]?)<br/ >\.(25[0-5]|2[0-4][0-9]|[01]?[0-9][0-9]?)\.(25[0-5]|2[0-4][0-9]|[01]?[0-9][0-9]?)\b/<br />
*hide the element
+
Important! It is a one line command, do not split it into two lines.
 
|}
 
|}
 
{|
 
{|
|style="padding: 0px 0px 20px 25px;"|[[File:CAD_12.png]]
+
|style="padding: 0px 0px 20px 25px;"|[[File:CM7.png]]
 
|}
 
|}
 
{|
 
{|
|style="padding: 0px 0px 15px 15px;"|You may also provide some display rules, only clients who fulfill the rules will see the element.<br/>
+
|style="padding: 0px 0px 15px 15px;"|'''That's it. You have just successfully installed and configured cPanel Manage 2 For WHMCS!'''<br />  
If you leave this part empty, the element will be visible for all clients without limitations.
+
This is how a correctly configured product looks like.
*select domains a client must own
+
*point product that must be owned
+
*location a client must enter<br/>
+
Do not forget to save the changes when ready.
+
 
|}
 
|}
 
{|
 
{|
|style="padding: 0px 0px 30px 25px;"|[[File:CAD_13.png]]
+
|style="padding: 0px 0px 30px 25px;"|[[File:CM8.png]]
 
|}
 
|}
  
====New Parent Element====
+
=Management=
 
{|
 
{|
|style="padding: 10px 0px 15px 15px;"|It is possible add a completely new parent element either on left or right side.<br/>Press '' 'Add'.''
+
|style="padding: 10px 0px 20px 15px;"|From admin area you can manage your clients cPanel Manage2 products as well as view license's details.<br/>
 +
Actions:
 +
*Change IP - enter new IP address to change it.
 
|}
 
|}
 
{|
 
{|
|style="padding: 0px 0px 20px 25px;"|[[File:CAD_14.png]]
+
|style="padding: 0px 0px 20px 25px;"|[[File:CM9.png]]
 
|}
 
|}
 
{|
 
{|
|style="padding: 0px 0px 15px 15px;"|Then you will have to fill out all the general info, content and display rules.<br/>
+
|style="padding: 0px 0px 15px 15px;"|If you move to the client are page, you will see the same data on the license.  
Start with '' 'General'.'' Provide:
+
License IP address can be changed here as well.
*name visible for clients
+
*unique for the system identifier
+
*URI
+
*select icon from available
+
*finally select '' 'Display' '' to make the panel visible
+
 
|}
 
|}
 
{|
 
{|
|style="padding: 0px 0px 20px 25px;"|[[File:CAD_15.png]]
+
|style="padding: 0px 0px 30px 25px;"|[[File:CM8.png]]
 
|}
 
|}
 +
=Tips=
 
{|
 
{|
|style="padding: 0px 0px 15px 15px;"|If you want only some of the clients to see the panel, then set up the '' 'Display Rules'.''<br/>
+
|style="padding: 10px 0px 10px 15px;"|1. You have to unlock your WHMCS System IP in the cPanel Manage2 to access the API.'''
In our case we have decided to select products a client must own to get access to '' 'Support Chat'.''<br/>
+
Save the changes in the end.
+
|}
+
{|
+
|style="padding: 0px 0px 20px 25px;"|[[File:CAD_16.png]]
+
|}
+
{|
+
|style="padding: 0px 0px 20px 15px;"|This is how our new panel looks like in the client area:
+
|}
+
{|
+
|style="padding: 0px 0px 30px 25px;"|[[File:CAD_17.png]]
+
 
|}
 
|}
  
====New Child Element====
+
=Common Problems=
 
{|
 
{|
|style="padding: 10px 0px 20px 15px;"|Let's now add one more element to the already existing '' 'Support' '' panel.
+
|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 20px 25px;"|[[File:CAD_18.png]]
+
|style="padding: 0px 0px 10px 15px;"|2. Make sure that your custom field is named '' 'IP'. '' In any other case, the module will not work properly.
 
|}
 
|}
 
{|
 
{|
|style="padding: 0px 0px 15px 15px;"|You have to fill out the same data as in case of parent element:<br/>
+
|style="padding: 0px 0px 30px 15px;"|3. If after installation you get an ionCube encoder problem (wrong version), please open a support ticket.<br />
*name
+
We will provide you with a different version of the module encrypted with the older version of ionCube.
*identifier
+
*URI
+
*icon
+
*finally select '' 'Display' '' to make it visible<br/>
+
This time we want all the clients to have access to our FAQ site, so we do no set any '' 'Display Rules'. ''
+
 
|}
 
|}
{|
 
|style="padding: 0px 0px 20px 25px;"|[[File:CAD_19.png]]
 
|}
 
{|
 
|style="padding: 0px 0px 20px 15px;"|As a custom element, you may delete it completely or edit.
 
|}
 
{|
 
|style="padding: 0px 0px 20px 25px;"|[[File:CAD_20.png]]
 
|}
 
{|
 
|style="padding: 0px 0px 20px 15px;"|Let's take a look at the new position in the client area:
 
|}
 
{|
 
|style="padding: 0px 0px 30px 25px;"|[[File:CAD_21.png]]
 
|}
 
 
===Sidebar Panels===
 
{|
 
|style="padding: 10px 0px 15px 15px;"|Sidebar panels section refers to the elements located on the left side of your client area.<br/>
 
Generally, management of sidebars is very similar to the Navbar panels described in the previous section.
 
|}
 
{|
 
|style="padding: 0px 0px 20px 25px;"|[[File:CAD_24.png]]
 
|}
 
{|
 
|style="padding: 0px 0px 15px 15px;"|Available actions:
 
*change positioning by dragging and dropping the element in required place
 
*edit the section - change name, icon, content (if possible) and display rules
 
*delete elements - this option is available for custom entries only
 
*view child elements
 
|}
 
{|
 
|style="padding: 0px 0px 20px 25px;"|[[File:CAD_23.png]]
 
|}
 
 
====Edit Element====
 
{|
 
|style="padding: 10px 0px 15px 15px;"|'''General''' section:
 
*provide a new display name
 
*add icon
 
*hide the element
 
|}
 
{|
 
|style="padding: 0px 0px 20px 25px;"|[[File:CAD_25.png]]
 
|}
 
{|
 
|style="padding: 0px 0px 15px 15px;"|'''Content:'''
 
*change the Body or Footer content.<br/>
 
Note that it is possible only if the element has no child elements.
 
|}
 
{|
 
|style="padding: 0px 0px 20px 25px;"|[[File:CAD_26.png]]
 
|}
 
{|
 
|style="padding: 0px 0px 15px 15px;"|'''Display rules''' - only clients who fulfill the rules will see the element.<br/>
 
If you leave this part empty, the element will be visible for all clients without limitations.
 
Do not forget to save the changes when ready.
 
|}
 
{|
 
|style="padding: 0px 0px 30px 25px;"|[[File:CAD_27.png]]
 
|}
 
 
====New Parent Element====
 
{|
 
|style="padding: 10px 0px 15px 15px;"|You may add a completely new parent element either on left or right side.<br/>Press '' 'Add'.''
 
|}
 
{|
 
|style="padding: 0px 0px 20px 25px;"|[[File:CAD_28.png]]
 
|}
 
{|
 
|style="padding: 0px 0px 15px 15px;"|Then you will have to fill out all the general info, content and display rules.<br/>
 
Start with '' 'General'.'' Provide:
 
*name visible for clients
 
*unique for the system identifier
 
*select icon from available
 
*finally select '' 'Display' '' to make the panel visible
 
|}
 
{|
 
|style="padding: 0px 0px 20px 25px;"|[[File:CAD_29.png]]
 
|}
 
{|
 
|style="padding: 0px 0px 15px 15px;"|Define Body and Footer content.<br/>
 
Note that if you provide the content here, you will not be able to add child elements to this item.
 
|}
 
{|
 
|style="padding: 0px 0px 20px 25px;"|[[File:CAD_30.png]]
 
|}
 
{|
 
|style="padding: 0px 0px 15px 15px;"|If you want only some of the clients to see the panel, then set up the '' 'Display Rules'.''<br/>
 
Save the changes in the end.
 
|}
 
{|
 
|style="padding: 0px 0px 20px 25px;"|[[File:CAD_31.png]]
 
|}
 
{|
 
|style="padding: 0px 0px 20px 15px;"|This is how our new panel looks like in the client area:
 
|}
 
{|
 
|style="padding: 0px 0px 30px 25px;"|[[File:CAD_32.png]]
 
|}
 
 
====New Child Element====
 
{|
 
|style="padding: 10px 0px 20px 15px;"|Let's now add one child element to client's '' 'Shortcuts'.''
 
|}
 
{|
 
|style="padding: 0px 0px 20px 25px;"|[[File:CAD_33.png]]
 
|}
 
{|
 
|style="padding: 0px 0px 15px 15px;"|Fill out all the required data to crate a correct link:<br/>
 
*name
 
*identifier
 
*URI
 
*icon
 
*select '' 'Display' ''
 
|}
 
{|
 
|style="padding: 0px 0px 20px 25px;"|[[File:CAD_34.png]]
 
|}
 
{|
 
|style="padding: 0px 0px 20px 15px;"|Any custom element can be deleted. In contrast to the default ones which may be only edited and hidden.
 
|}
 
{|
 
|style="padding: 0px 0px 20px 25px;"|[[File:CAD_35.png]]
 
|}
 
{|
 
|style="padding: 0px 0px 20px 15px;"|Now, you see an additional link under '' 'Shortcuts'.''
 
|}
 
{|
 
|style="padding: 0px 0px 30px 25px;"|[[File:CAD_36.png]]
 
|}
 
 
===Homepage Widgets===
 
{|
 
|style="padding: 10px 0px 15px 15px;"|The last type of panels are homepage widgets.<br/>
 
Available actions:
 
*change positioning by dragging and dropping the elements in required place
 
*edit the widget
 
*view child elements if there are any
 
*delete custom widgets
 
|}
 
{|
 
|style="padding: 0px 0px 20px 25px;"|[[File:CAD_37.png]]
 
|}
 
{|
 
|style="padding: 0px 0px 20px 15px;"|To visualize, these are the client area widgets we are going to alter in a moment:
 
|}
 
{|
 
|style="padding: 0px 0px 30px 25px;"|[[File:CAD_38.png]]
 
|}
 
 
====Edit widget====
 
{|
 
|style="padding: 10px 0px 15px 15px;"|'''General:'''
 
*provide a new display name
 
*change icon
 
*hide the element
 
|}
 
{|
 
|style="padding: 0px 0px 20px 25px;"|[[File:CAD_39.png]]
 
|}
 
{|
 
|style="padding: 0px 0px 15px 15px;"|Under '' 'Content' '' section you can overwrite the default text.<br/>
 
We will leave it empty as we do not want to change the content, just the look and feel of the widget.
 
|}
 
{|
 
|style="padding: 0px 0px 20px 25px;"|[[File:CAD_39_1.png]]
 
|}
 
{|
 
|style="padding: 0px 0px 15px 15px;"|'''Extras''' - here you can change the visual parts:
 
*widget color
 
*button name, URI and icon
 
|}
 
{|
 
|style="padding: 0px 0px 20px 25px;"|[[File:CAD_40.png]]
 
|}
 
{|
 
|style="padding: 0px 0px 20px 15px;"|That is how our adjusted widget looks like now:
 
|}
 
{|
 
|style="padding: 0px 0px 30px 25px;"|[[File:CAD_41.png]]
 
|}
 
====Add New Widget====
 
{|
 
|style="padding: 10px 0px 15px 15px;"|For presentation purposes we will create now a completely new widget.<br/>It will include a button redirection to our Knowledgebase and two links to FAQ and Upload Files form.<br/>
 
To start, simply press '' 'Add' '' button.
 
|}
 
{|
 
|style="padding: 0px 0px 20px 25px;"|[[File:CAD_42.png]]
 
|}
 
{|
 
|style="padding: 0px 0px 15px 15px;"|Then fill out all the general info, content and extras.<br/>
 
Start with '' 'General','' provide:
 
*widget name
 
*unique for the system identifier
 
*select icon from available
 
*finally select '' 'Display' '' to make the panel visible
 
|}
 
{|
 
|style="padding: 0px 0px 20px 25px;"|[[File:CAD_43.png]]
 
|}
 
{|
 
|style="padding: 0px 0px 15px 15px;"|As we are going to add two links inside the widget, so we have to skip this section.
 
|}
 
{|
 
|style="padding: 0px 0px 20px 25px;"|[[File:CAD_44.png]]
 
|}
 
{|
 
|style="padding: 0px 0px 15px 15px;"|Finally, customize your widget by defining color and button details.
 
Save the changes in the end.
 
|}
 
{|
 
|style="padding: 0px 0px 30px 25px;"|[[File:CAD_45.png]]
 
|}
 
 
====New Child Widget====
 
{|
 
|style="padding: 10px 0px 15px 15px;"|Let's now add a child element to the just created '' 'Knowledgebase'.''
 
|}
 
{|
 
|style="padding: 0px 0px 20px 25px;"|[[File:CAD_46.png]]
 
|}
 
{|
 
|style="padding: 0px 0px 15px 15px;"|Fill out the required data:<br/>
 
*name
 
*identifier
 
*URI
 
*icon
 
*select '' 'Display' ''
 
|}
 
{|
 
|style="padding: 0px 0px 20px 25px;"|[[File:CAD_47.png]]
 
|}
 
{|
 
|style="padding: 0px 0px 15px 15px;"|As you can see, we added two new entries under '' 'Knowledgebase' '' widget.<br/>
 
Surely, you can edit each one of them or delete.
 
|}
 
{|
 
|style="padding: 0px 0px 20px 25px;"|[[File:CAD_48.png]]
 
|}
 
{|
 
|style="padding: 0px 0px 20px 15px;"|Here is a final view of our customized client area with new elements:
 
|}
 
{|
 
|style="padding: 0px 0px 30px 25px;"|[[File:CAD_49.png]]
 
|}
 
 
==Locations==
 
{|
 
|style="padding: 10px 0px 15px 15px;"|In this you will find an extended list of all standard locations in your client area with its common name and URI.<br/>
 
These locations are searched through by the module scanner in search of custom panels and are available in '' 'Locations' '' field when setting up '' 'Display Rules'. ''
 
|}
 
{|
 
|style="padding: 0px 0px 20px 25px;"|[[File:CAD_50.png]]
 
|}
 
{|
 
|style="padding: 0px 0px 20px 15px;"|Press button with pencil icon next to location you are interested in to edit it.
 
|}
 
{|
 
|style="padding: 0px 0px 20px 25px;"|[[File:CAD_51.png]]
 
|}
 
{|
 
|style="padding: 0px 0px 20px 15px;"|There you can edit the name of existing location and its URI.
 
|}
 
{|
 
|style="padding: 0px 0px 30px 25px;"|[[File:CAD_52.png]]
 
|}
 
===New Location===
 
{|
 
|style="padding: 10px 0px 15px 15px;"|You may also add new if you have some custom locations and you wish to use them in our module.<br/>
 
Please note that your locations must be manageable by WHMCS.
 
|}
 
{|
 
|style="padding: 0px 0px 20px 25px;"|[[File:CAD_53.png]]
 
|}
 
{|
 
|style="padding: 0px 0px 15px 15px;"|Provide location name and URI.<br/>
 
When ready, your new location will be from now on used by Client Area Designer module.
 
|}
 
{|
 
|style="padding: 0px 0px 30px 25px;"|[[File:CAD_54.png]]
 
|}
 
 
==Scanner==
 
{|
 
|style="padding: 10px 0px 15px 15px;"|Scanner is a tool that allows our module to carefully browse through a chosen client's client area in search of any elements in known locations.<br/>
 
Select a client to log in as one and run the scanner.
 
|}
 
{|
 
|style="padding: 0px 0px 20px 25px;"|[[File:CAD_59.png]]
 
|}
 
{|
 
|style="padding: 0px 0px 15px 15px;"|You will see a preview of all locations. When the scan is finished, you will see a summary with the number of found panels.<br/> All newly found elements will be automatically added to proper positions in the addon.
 
|}
 
{|
 
|style="padding: 0px 0px 30px 25px;"|[[File:CAD_60.png]]
 
|}
 
 
==Documentation==
 
{|
 
|style="padding: 10px 0px 20px 15px;"|The last position in your navigation menu, when pressed, redirects to the article you are currently reading.
 
|}
 
{|
 
|style="padding: 0px 0px 30px 25px;"|[[File:CAD_55.png]]
 
|}
 
 
=Tips=
 
{|
 
|style="padding: 10px 0px 5px 15px;"|1. When you area adding new element into your client area, you may add the langs used in the lang file to allow translations and changes.<br/>
 
To do so:<br/>
 
*open your english.php file
 
*type in a new line in format:
 
$_LANG['element name'] = 'Element Name';
 
*to change/translate it simply, change the content after the '' '=' '' sign.
 
|}
 
{|
 
|style="padding: 0px 0px 30px 15px;"|2. Client Area Designer module supports only WHMCS template Six and any custom documentation that is based on this template and has been customized according to this  [https://developers.whmcs.com/themes/ documentation]. 
 
|}
 
 
=Common Problems=
 
{|
 
|style="padding: 10px 0px 30px 15px;"|'''1. When you have problems with connection, check whether your SELinux or firewall does not block ports.'''
 
|}
 
<!--
 
{|
 
|style="padding: 0px 0px 10px 15px;"|2.
 
|}
 
 
-->
 

Revision as of 14:12, 7 June 2017

Contents

About cPanel Manage2 For WHMCS

cPanel Manage2 For WHMCS is a module created to introduce and automate provisioning of cPanel licenses in your WHMCS.

The module will enable your clients to view detailed information about their licenses in your WHMCS client area as well as assign IP addresses to their licenses.

  • Admin Area Features:
✔ Create/Suspend/Unsuspend/Terminate License
✔ Change IP Address Assigned To License
✔ View License Details
✔ Toggle Automatic License Assignment To Specified IP Address
✔ Define Package ID And Group ID
  • Client Area Features:
✔ Order License
✔ View License Details
✔ Change IP Address Assigned To License
  • General Info:
✔ Integrated With Product Linker For WHMCS - Resell Licenses In Product Bundles (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 quickly install and configure cPanel Manage2 For WHMCS.

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

1. Log in to your client area and download cPanel Manage2 For WHMCS.
CM1.png
2. Upload and extract the module into the main WHMCS directory.

Files in your WHMCS directory should look like these.

CM2.png
3. When you install cPanel Manage2 for the first time you have to rename 'license_RENAME.php' file.

File is located in 'modules/servers/cpanelManagetwo/license_RENAME.php'. Rename it from 'license_RENAME.php' to 'license.php'.

CM3.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 in your client area → 'My Products'.

CM4.png
5. Good job! You have just successfully installed cPanel Manage2 For WHMCS! Now, we will show you how to configure a new product.

To do so, log in into your WHMCS. Now press 'Setup' 'Products/Services' 'Servers'.
Afterwards, press 'Add New Server'.

SO8.png
6. Next enter your server 'Name', 'Username' and 'Password'.

Choose 'CpanelManagetwo' from a 'Type' dropdown menu and press 'Save Changes'.

CM5.png
7. After you configure your server correctly, you will see a following screen.

Now you need to create a new group for your server. For that purpose press 'Create New Group'.

CM5.5.png
8. Enter name, click on your previously created server, press 'Add' then press 'Save Changes'.
SO11.png
9. In order to create and configure product, click on 'Setup' 'Products/Services' 'Products/Services' .

If you do not have a product group, click on 'Create a New Group'. If you do, simply go to step 11.

SO12.png
10. Enter product group name and press 'Create Group'.
SO13.png
11. When you have a product group, create a new product. If you already have a product, go to step 13.

To create a product click on 'Create a New Product' .

SO14.png
12. Afterwards, choose your product type and product group from dropdown menus, enter your product name and press 'Continue'.
SO15.png
13. Now go to 'Module Settings' section, choose both 'CpanelManagetwo' and your previously created server group from dropdown menus.

Next, select 'Force License' - force adding license to a specified IP address.
Enter 'Package ID' - the ID of the package that the new license will use.
Enter 'Group ID' — the ID of the group which the new license will belong to.
'Save Changes'!

CM6.png
14. Once module settings are ready move to 'Custom Fields'.

In 'Field Name' enter 'IP', choose 'Text Box' from a field type dropdown menu, enter description and set up validation as:

/\b(25[0-5]|2[0-4][0-9]|[01]?[0-9][0-9]?)\.(25[0-5]|2[0-4][0-9]|[01]?[0-9][0-9]?)
\.(25[0-5]|2[0-4][0-9]|[01]?[0-9][0-9]?)\.(25[0-5]|2[0-4][0-9]|[01]?[0-9][0-9]?)\b/

Important! It is a one line command, do not split it into two lines.

CM7.png
That's it. You have just successfully installed and configured cPanel Manage 2 For WHMCS!

This is how a correctly configured product looks like.

CM8.png

Management

From admin area you can manage your clients cPanel Manage2 products as well as view license's details.

Actions:

  • Change IP - enter new IP address to change it.
CM9.png
If you move to the client are page, you will see the same data on the license.

License IP address can be changed here as well.

CM8.png

Tips

1. You have to unlock your WHMCS System IP in the cPanel Manage2 to access the API.

Common Problems

1. When you have problems with connection, check whether your SELinux or firewall does not block ports.
2. Make sure that your custom field is named 'IP'. In any other case, the module will not work properly.
3. If after installation you get an ionCube encoder problem (wrong version), please open a support ticket.

We will provide you with a different version of the module encrypted with the older version of ionCube.

Navigation
WHMCS Modules
WHMCS Widgets
Translations
cPanel Modules
General
FAQ
Community