WHMCS cPanel Licensing Module - Revision history

Lawrence at 13:06, 7 February 2024

2024-02-07T13:06:14Z

JoshQ: Add steps to follow after changing Manage2 credentials.

2024-01-29T16:07:43Z

Add steps to follow after changing Manage2 credentials.

JoshQ: Add steps for manually cancelling a license

2024-01-17T14:59:55Z

Add steps for manually cancelling a license

SarahK at 17:08, 28 December 2022

2022-12-28T17:08:01Z

SarahK: /* Option & Price Management */

2022-04-19T18:17:09Z

‎Option & Price Management

SarahK at 18:14, 19 April 2022

2022-04-19T18:14:39Z

Show changes

SarahK at 20:53, 17 March 2022

2022-03-17T20:53:12Z

Show changes

SarahK at 18:28, 17 December 2021

2021-12-17T18:28:02Z

SarahK: /* Introduction */

2021-04-28T19:01:11Z

‎Introduction

SarahK: /* Introduction */

2021-04-28T19:00:51Z

‎Introduction

@@ Line 328: / Line 328: @@
 # Upload the 'cpanellicensing' directory to the '/modules/addons' folder of your WHMCS installation.
-====Troubleshooting====
+==Troubleshooting==
 This section covers the error messages which may be encountered during license assignment.
-=====A license was deactivated on the same IP last month before billing could occur=====
+===A license was deactivated on the same IP last month before billing could occur===
 This response indicates that the previous cPanel license associated with the service's IP address accrued usage, and was deactivated before billing could occur within Manage2.
 A reactivation fee must be paid before a new license can be provisioned for that IP address. This must be done via Manage2 directly.
-=====This license is already assigned to another service=====
+===This license is already assigned to another service===
 Review the '''Addons > cPanel Licensing''' page to see the current service to which the license is assigned in WHMCS.
 Click the ''Assign'' button a second time to remove the current assignment and assign to the current service.
-=====You cannot assign a license to this service=====
+===You cannot assign a license to this service===
 '''You cannot assign a license to this service as the product to which it is assigned does not have a configurable option for a cPanel license'''
@@ Line 356: / Line 356: @@
 # Use the '''Assign''' or '''Link''' buttons again to complete the task successfully.
-=====cPanel Licensing options of product are not set for this service=====
+===cPanel Licensing options of product are not set for this service===
 '''cPanel Licensing options of product are not set for this service. Review and save the cPanel licensing options for this service and try again'''

← Older revision		Revision as of 16:07, 29 January 2024
Line 307:		Line 307:

	Additionally, only a singular active license can be assigned to a service. Using the ''Link to Existing License'' or ''Assign License'' functionality to assign a new license to a service already in possession of an active license will result in the replacement of that active license. In this instance, a prompt will appear to confirm this action.		Additionally, only a singular active license can be assigned to a service. Using the ''Link to Existing License'' or ''Assign License'' functionality to assign a new license to a service already in possession of an active license will result in the replacement of that active license. In this instance, a prompt will appear to confirm this action.
		+
		+	===Updating Manage2 Account Credentials===
		+
		+	The cPanel Licensing Addon uses your Manage2 username and password to authenticate with the Manage2 API. To facilitate this, the system encrypts and stores your Manage2 credentials in WHMCS's database. Because updating your credentials in Manage2 does not automatically trigger an update in WHMCS, the system will no longer be able to successfully authenticate requests.
		+
		+	After updating your Manage2 credentials, ensure that the system can communicate with Manage2:
		+
		+	# In the Admin Area, go to '''Addons > cPanel Licensing''' and click on the '''Settings''' tab.
		+	# In the '''Manage2 Account''' section, click '''Logout'''.
		+	# Log in using your Manage2 account credentials.
		+
		+	After successfully logging in, the system will store your new Manage2 login details in the database.

	== Upgrading ==		== Upgrading ==

@@ Line 282: / Line 282: @@
 *'''Provision New cPanel License''' - Automatically provision a new license from Manage2 using the package displayed in the cPanel Licensing configurable option and the IP address displayed in the ''Dedicated IP'' field or ''IP Address'' custom field.
 *'''Link to Existing License''' - Display a modal that allows for the search of existing licenses to be assigned to the service. More information can be found in the [[WHMCS cPanel Licensing Module#Assign License & Link to Existing License|Assign License & Link to Existing License]] section.
 ===Assign License & Link to Existing License===

@@ Line 48: / Line 48: @@
 After configuring the module, you will need to authenticate into Manage2.
-To do this, navigate to '''Addons > cPanel Licensing''' and log in using your Manage2 username and password. The system will import your Manage2 data into WHMCS.
+To do this, navigate to '''Addons > cPanel Licensing''' and log in using your Manage2 username and password. The system will import your Manage2 data into WHMCS. This may take several minutes depending on the amount of licenses associated with the Manage2 account.
 === Settings ===
@@ Line 127: / Line 141: @@
 [[File:CPLic_ImportExistingOption.png|thumb|Import Existing Option Modal]]
 Clicking on the ''Import'' button will bring up the ''Import Existing Option'' modal. It is within this modal that you can import an existing configurable option to be used for the provisioning and billing of cPanel licenses via this module.

@@ Line 144: / Line 144: @@
 This modal is made up of three elements: the ''Configurable Option Settings'' section in the top-left, the ''Selectable Options'' section in the bottom-left, and the ''Selectable Option Content'' panel on the right.
-----
+===== Configurable Option Settings =====
 The '''Configurable Option Settings''' section provides the ability to alter the ''Configurable Option Type'', and toggle both the ''Visibility'' and ''Autoscale'' Option.
@@ Line 152: / Line 152: @@
 All changes made in this section are automatically saved.
-----
+===== Selectable Options =====
 The '''Selectable Options''' section displays the full list of existing configurable options, and offers the ability to create new options via the ''Add Option'' button. Clicking on an option from this list will display that option's content within the ''Selectable Option Content'' panel.
@@ Line 158: / Line 158: @@
 Additionally, in Version 7.7 and later, dragging the options allow you to rearrange their order as desired. All changes made in this section are automatically saved.
-----
+===== Selectable Option Content =====
 The '''Selectable Option Content''' section provides both an overview of that option, as well as the ability to configure it further. The ''Name'', ''Visibility'', and ''Package'' details are immediately displayed at the top, and can all be altered as desired. Additionally, the ''Configurable Option ID'' is displayed in the top-left corner.
@@ Line 168: / Line 168: @@
 Changes to this section are not automatically saved, and clicking on the ''Save'' button will commit the changes. Inversely, clicking on the ''Delete'' button will delete the configurable option.
-----
+===== Metric: cPanel Accounts =====
 The '''Metric: cPanel Accounts''' setting is displayed when configuring pricing for packages that offer an unlimited number of cPanel accounts. This setting provides the ability to set a per-account value that the customer will be billed for, as well as a threshold to define the number of accounts a customer must have before they are billed on a per-account basis.

@@ Line 177: / Line 177: @@
 ====Standalone Product====
-#Navigate to '''Setup > Products/Services > Products/Services''[[File:Cpanel standalone2.png|thumb|Configure Pricing]]
+To present a standalone product that provisions a cPanel license, use the cPanel licensing module with the Auto Release provisioning module:
 #Click ''Create a New Product''
 #Select the '''Product Type''' value ''Other''
@@ Line 186: / Line 187: @@
 #Click '''Continue''' and select the '''Pricing''' tab
 #Choose the '''Payment Type''' value ''Recurring''[[File:Cpanel standalone3.png|thumb|Configure the Auto Release Module]]
-#Tick the checkboxes in the ''One Time/Monthly'' column
+# Check the checkboxes in the '''One Time/Monthly''' column.
 #Specify Setup and Price values of 0.00
 #Select the '''Module Settings''' tab

← Older revision		Revision as of 19:01, 28 April 2021
Line 8:		Line 8:

	A Getting Started guide, which covers the basics of the cPanel Licensing Automation module, can be found on the [[WHMCS cPanel Licensing Module Getting Started Guide]] documentation page.		A Getting Started guide, which covers the basics of the cPanel Licensing Automation module, can be found on the [[WHMCS cPanel Licensing Module Getting Started Guide]] documentation page.
−
−	~~----~~

	This module is intended for use by cPanel Partners. If you are not yet a partner, visit https://www.cpanel.net/partners/ to learn more.		This module is intended for use by cPanel Partners. If you are not yet a partner, visit https://www.cpanel.net/partners/ to learn more.

@@ Line 1: / Line 1: @@
 ==Introduction==
 The cPanel Licensing Automation module for WHMCS is a tool that utilizes the cPanel Manage2 API to provide an automated solution for cPanel Partners to provision, manage and bill for cPanel & WHM licenses.
 A Getting Started guide, which covers the basics of the cPanel Licensing Automation module, can be found on the [[WHMCS cPanel Licensing Module Getting Started Guide]] documentation page.