Personal tools
Namespaces

Variants
Actions

CPanel Manage2 For WHMCS

From ModulesGarden Wiki
(Difference between revisions)
Jump to: navigation, search
(Configuration Of Product)
(Configuration Of Product)
Line 178: Line 178:
 
** '' 'Tiered' '' - you will additionally bill your WHMCS client for the closes tier number of accounts assigned to license. <br/> E.g. if the client uses '' '5 accounts' '', but you configured your configurable options to bill client only for '' '1', '3', '7' '' or '' '10' '' accounts, then your client will be billed for ''7 accounts'', beacuse that is the closest highest number to already used '' '5 accounts' ''.  
 
** '' 'Tiered' '' - you will additionally bill your WHMCS client for the closes tier number of accounts assigned to license. <br/> E.g. if the client uses '' '5 accounts' '', but you configured your configurable options to bill client only for '' '1', '3', '7' '' or '' '10' '' accounts, then your client will be billed for ''7 accounts'', beacuse that is the closest highest number to already used '' '5 accounts' ''.  
 
* '' 'Accunts Number Update' —  if you chose the '' 'Flexible' '' or '' 'Tiered' '' billing type, enter here the day of the month in which you want to synchronize the configurable options in your WHMCS with the number of accounts assigned to the license. <br/>This synchronization will take place on the provided day during the execution of the main WHMCS cron.
 
* '' 'Accunts Number Update' —  if you chose the '' 'Flexible' '' or '' 'Tiered' '' billing type, enter here the day of the month in which you want to synchronize the configurable options in your WHMCS with the number of accounts assigned to the license. <br/>This synchronization will take place on the provided day during the execution of the main WHMCS cron.
'' '''Note:''' To use 'Billing Type' you will have to create an additional 'accounts' configurable option which you can read in point XX.''
+
'' '''Note:''' To use 'Billing Type' you will have to create an additional 'accounts' configurable option which you can read in point 16.''
  
 
Save Changes when you are ready.  
 
Save Changes when you are ready.  
Line 192: Line 192:
 
{|
 
{|
 
|style="padding: 0px 0px 20px 25px;"|[[File:CM7.png]]
 
|style="padding: 0px 0px 20px 25px;"|[[File:CM7.png]]
 +
|}
 +
{|
 +
|style="padding: 0px 0px 15px 15px;"|'''16. Finally if you want to use '' 'Billing Type'' ' option you will have to create a new configurable option. '''''<br />
 +
First go to the '' 'Setup' → 'Products/Services' → 'Configurable Options' '' and '' 'Create a New Group' '' with any custom name. <br/>
 +
Next press '' 'Add New Configurable Option' '' button.
 +
|}
 +
{|
 +
|style="padding: 0px 0px 20px 25px;"|[[File:CM7_2.png]]
 +
|}
 +
{|
 +
|style="padding: 0px 0px 15px 15px;"|New window will open. No you have to create a new cnfigurable option with the '''accounts''' variable name.<br />
 +
It is important to use that name exactly, but you can setup next to it any friendly name you want.<br/>
 +
Now provide the accounts numbers assigned to license and their pricing you want to bill you clients. <br/>
 +
You may use '' 'Dropdown' '' or '' 'Quantity' '' billing type. Save changes when ready.<br/>
 +
 +
'' '''Note: ''' Please reffer [https://docs.whmcs.com/Addons_and_Configurable_Options#Configurable_Options this article] to find more information about configurable options.''
 +
|}
 +
{|
 +
|style="padding: 0px 0px 20px 25px;"|[[File:CM7_2.png]]
 +
|}
 +
{|
 +
|style="padding: 0px 0px 15px 15px;"|After creation new configurable option remember to also assign it to your cPanel Manage2 license product.<br/>
 +
You may also hide this billing option from your clients. Do not forget to save.
 +
|}
 +
{|
 +
|style="padding: 0px 0px 20px 25px;"|[[File:CM7_3.png]]
 
|}
 
|}
 
{|
 
{|

Revision as of 15:04, 21 August 2019

Article update is ongoing on this page, watch out for broken links, unclear descriptions and images!
We are sorry for the inconvenience caused.


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, Group ID And Expiration Reason
  • 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)
✔ Integrated With Server Allocator For WHMCS - Automatic Assignment Of Most Suitable Servers To Products (read more)
✔ Multi-Language Support
✔ Supports PHP 5.6 Up To PHP 7.2
✔ Supports WHMCS Template Six
✔ Supports WHMCS V7
✔ Easy Module Upgrade To Open Source Version

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 our client area and download the module.
CM1.png
2. In the downloaded file you might find one or two packages that support different PHP versions.

In the most recent versions of the module, you will find only one package that supports PHP 7.1 and later.
If you need a package for the previous versions of PHP, please contact our support.

PHP71 73.png
Previous updates of the module may contain two packages dedicated to various PHP versions.

The first one that supports PHP 5.6 up to PHP 7.0, and the second one addressed to PHP 7.1 up to PHP 7.3.
Note: Keep in mind that PHP versions 5.6 up to 7.0 are no longer officially supported and their security issues are not fixed or released any more. Find more info here.

PHP56 73.png
Important: This situation does not affect the open source version of this module which can be applied to any PHP from version 5.6 and later.
Note: You can check the current PHP version in your WHMCS. To do so, proceed to 'Utilities' → 'System' → 'PHP Info'.
3. Once you have chosen the package with the right PHP version, extract it and upload its content into the main WHMCS directory.

The content of the chosen PHP version files to upload should look like this.

Dsrter.png
4. When you install cPanel Manage2 For WHMCS 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
5. 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 our client area → 'My Products'.

CM4.png
6. 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
7. Next enter your server 'Name', 'Username' and 'Password'.

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

CM5.png
8. 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
9. Enter name, click on your previously created server, press 'Add' then press 'Save Changes'.
SO11.png

Configuration Of Product

10. 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
11. Enter product group name and press 'Create Group'.
SO13.png
12. 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
13. Afterwards, choose your product type and product group from dropdown menus, enter your product name and press 'Continue'.
SO15.png
14. Now go to 'Module Settings' section, choose both 'CpanelManagetwo' and your previously created server group from dropdown menus.
  • 'Force License' - you can force adding license to a specified IP address.
  • 'Package' - it is the package that the new license will use. In previous versions of the module you have to provide it's ID.
  • 'Group' — it is the group which the new license will belong to. In previous versions of the module you have to provide it's ID.
  • 'Expiration Reason' — a parameter required for distributors
  • 'Billing Type' - specify how you can bill your clients for the number of accounts assigned to the single license.
    • 'Default' - you will bill your WHMCS client only for bought license regardless of accounts number assigned to it.
      E.g. if the client bought license and create '5 accounts' that use it, the amount of your charge will not change
    • 'Flexible' - you will additionally bill your WHMCS client for exact number of accounts assigned to license.
      E.g. if the client uses '5 accounts' , there must exist a configurable option corresponding to that exactly number of accounts that client can be billed.
    • 'Tiered' - you will additionally bill your WHMCS client for the closes tier number of accounts assigned to license.
      E.g. if the client uses '5 accounts' , but you configured your configurable options to bill client only for '1', '3', '7' or '10' accounts, then your client will be billed for 7 accounts, beacuse that is the closest highest number to already used '5 accounts' .
  • 'Accunts Number Update' — if you chose the 'Flexible' or 'Tiered' billing type, enter here the day of the month in which you want to synchronize the configurable options in your WHMCS with the number of accounts assigned to the license.
    This synchronization will take place on the provided day during the execution of the main WHMCS cron.

Note: To use 'Billing Type' you will have to create an additional 'accounts' configurable option which you can read in point 16.

Save Changes when you are ready.

CM6.png
15. 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/
CM7.png
16. Finally if you want to use 'Billing Type ' option you will have to create a new configurable option.

First go to the 'Setup' → 'Products/Services' → 'Configurable Options' and 'Create a New Group' with any custom name.
Next press 'Add New Configurable Option' button.

CM7 2.png
New window will open. No you have to create a new cnfigurable option with the accounts variable name.

It is important to use that name exactly, but you can setup next to it any friendly name you want.
Now provide the accounts numbers assigned to license and their pricing you want to bill you clients.
You may use 'Dropdown' or 'Quantity' billing type. Save changes when ready.

Note: Please reffer this article to find more information about configurable options.

CM7 2.png
After creation new configurable option remember to also assign it to your cPanel Manage2 license product.

You may also hide this billing option from your clients. Do not forget to save.

CM7 3.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

Configuration Of Addon

This module can be also alternatively configured as to become a 'Product Addon' that can be bought additionally next to a given product.

More information concerning 'Product Addons' in WHMCS can be found here. In order to configure your addon follow the steps explained below.

1. Proceed to 'Setup' 'Products/Services' 'Product Addons' 'Add New' .

Enter a name and desired description. Then move to the 'Module Settings' tab.

CM10.png
2. Now, as your 'Module Name' choose 'CpanelManagetwo' and select your previously created server group from the 'Server Group' dropdown menu.

Then configure the addon in the similar way as the product.

CM11.png
3. In the next step of settings move to 'Custom Fields'.

In 'Field Name' enter 'IP' , choose 'Text Box' from the 'Field Type' dropdown menu, enter a description and set up the following validation:

/\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 single line command, do not split it into two lines.
Mark the 'Show on Order Form' checkbox and press the 'Save Changes' button.

CM12.png
You have just successfully configured a new cPanel Manage2 For WHMCS addon. It can be assigned to other products of your choice.

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 area 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.

Update Instructions

Essential guidance through the process of updating the module is offered here.

Keep in mind there is a quick and easy option in our client area that will let you upgrade the license of your module to an open source version at any time - and at a lower price!
To take advantage of it, simply use the License Upgrade button located on the product's page and a discounted invoice will be generated automatically.

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
CPanel Manage2 For WHMCS