Personal tools
Namespaces

Variants
Actions

cPanel Manage2 For WHMCS

From ModulesGarden Wiki
Jump to: navigation, search


Contents

About cPanel Manage2 For WHMCS

cPanel Manage2 For WHMCS is a module created to introduce and automate the 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, Group And Expiration Reason
✔ Choose Billing Type:
✔ Default - Bill Client Only For License Regardless Of Accounts Number
✔ Flexible - Bill Client For Exact Number Of Accounts Assigned To License
✔ Tiered - Bill Client For Closest Number Of Accounts Assigned To License
✔ Define Day Of Month To Synchronize Accounts Number For Billing
✔ Adjust Number Of Accounts Above Which Billing Will Start
  • Client Area Features:
✔ Order License
✔ View License Details
✔ View Number Of Accounts Assigned To License
✔ 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.6 And Later
✔ 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 the 'license_RENAME.php' file.

The 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 the previously renamed 'license.php' file.

Enter your license key in between the quotation marks as presented on the screen below. 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 to 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 the 'Type' dropdown menu and press 'Save Changes'.

CM5.png
8. If you configure your server correctly, you will see the 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 your group name, click on your previously created server, press 'Add' and then 'Save Changes'.
SO11.png

Configuration Of Product

10. In order to create and configure a product, go to 'Setup' 'Products/Services' 'Products/Services' .

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

SO12.png
11. Enter your product group name and press 'Create Group'.
SO13.png
12. Once 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 the dropdown menus, enter your product name and press 'Continue'.
SO15.png
14. Now, go to the 'Module Settings' section, choose both 'CpanelManagetwo' and your previously created server group from the dropdown menus.
  • Force License - allows you to force adding the license to the specified IP address.
  • Package - it is the package that the new license will use. In previous versions of the module you have to provide its ID.
  • Group - it is the group which the new license will belong to. In previous versions of the module you have to provide its ID.
  • Expiration Reason - a parameter required for distributors.
  • Billing Type - specifies how you can bill your clients for the number of accounts assigned to a single license.
    • Default - you will bill your WHMCS clients only for the purchased license regardless of accounts number assigned to it.
      E.g. if a client bought a license and created '5 accounts' that use this license, the amount of your charge will not change.
    • Flexible - you will additionally bill your WHMCS clients for the exact number of accounts assigned to the license.
      E.g. if a client uses '5 accounts' , there must exist a configurable option corresponding to that exact number of accounts that client can be billed for.
    • Tiered - you will additionally bill your WHMCS clients for the closest tier number of accounts assigned to the license.
      E.g. if a client uses '5 accounts' , but you set up your configurable options to bill your clients only for '1', '3', '7' or '10' accounts, then your client will be billed for 7 accounts, because that is the closest highest number to the already used '5 accounts' .
  • Accounts 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.
  • Adjust Accounts Number - here you can provide the number of license accounts after exceeding which you will start billing your clients. Leave this field empty if you want accounts billing to work as normal.
    E.g. if you provide '100' there, and your client has 101 accounts, then he will be charged for only 1 new account, while the first 100 will be ignored. If there are 105 license accounts, the client will be billed as if he had only 5 accounts and so on. This number also affects the value you set for a configurable option. It can be particularly useful when using the 'quantity' type, where you provide pricing based on the specified range. E.g. if you want to charge your clients from 101 to 110 new accounts, in our case, you can set quantity pricing as it would be from 1 to 10 for each new account.

Note: To use 'Billing Type' and other related options you will have to create an additional 'accounts' configurable option, which you can read about in point 16 of this setup guide.

Save Changes when you are ready.

CM6.png
15. Once the module settings are ready, move to 'Custom Fields'.

In 'Field Name' enter 'IP', choose 'Text Box' from the field type dropdown menu, enter a 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 the 'Billing Type ' option, you will have to create a new configurable option.

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

CM7 2.png
A new window will open. Now, you have to create a new configurable option with the accounts variable name.

It is important to use that exact name, but you can put any friendly name you want next to it.
Now, provide the number of accounts assigned to the license and their pricing you want to bill your clients.
You may use the Dropdown or Quantity configurable option type.
Save changes when ready.

Important: Remember that using the 'Adjust Accounts Number' product setting will affect the values of configurable options set during synchronization with the number of accounts assigned to the license.

Please also refer to this article to find more information about using configurable options in WHMCS.

CM7 3.png
After the creation of a new configurable option is done, remember to assign it to your cPanel Manage2 license product.

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

CM7 4.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 in the client area.

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.

Important: For now billing options for an additional number accounts for licenses are only available for products, not for product addons!

CM11.png
3. In the next step of configuration, 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 the admin area you can manage your clients' cPanel Manage2 products as well as view license's details.

Additionally, you can view the number of currently used accounts as well as the corresponding billing plan from configurable option.
Moreover, you can also change the license's IP address.

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 2.png

Tips

1. You have to unlock your WHMCS System IP in the cPanel Manage2 to access the API.
2. If you already have licenses in cPanel Manage2 and you would like to import them to WHMCS, you can match them with your products.

All you have to do is add/order a new WHMCS product to your customer without processing the 'Create' module command.
Then, find the added product in the 'Product/Services' tab of your customer profile and look for the custom IP field which you created in point 15. of this manual.
Next, enter the IP of the license you want to link, change the product status to 'active' and save settings.

Note: Be aware that the product's module settings in your WHMCS (point 14. of this manual) should correspond to the specifications of the linked license.

Update Instructions

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

Keep in mind that there is a quick and easy option in our client area that will let you upgrade the license of your module to the 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. If 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 you encounter the ionCube encoder problem (wrong version) after the installation process, 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 Translations
cPanel Modules
Magento Extensions
Magento Themes
PrestaShop Modules
Blesta Extensions
General
FAQ
Community
CPanel Manage2 For WHMCS