Difference between revisions of "WHMCS cPanel Licensing Module Getting Started Guide"

From WHMCS Documentation

(Created page with "Coming soon...")
 
Line 1: Line 1:
−
Coming soon...
+
This guide covers the basics of the cPanel Licensing module; starting with installation and activating the module, importing existing configurable options, configuring the imported options further, and then what to do next.
 +
 
 +
This page aims to provide a brief overview and will signpost you to the relevant sections in our documentation for full details on everything covered.
 +
 
 +
__TOC__
 +
 
 +
==Installation==
 +
 
 +
To install the cPanel Licensing addon module, follow the steps below.
 +
 
 +
# Download the latest version of the addon module from https://marketplace.whmcs.com/product/4993
 +
# Unzip the zip file download to a directory on your computer
 +
# Upload the "cpanellicensing" directory to the ''~/modules/addons/'' directory within your WHMCS installation
 +
 
 +
Installation Documentation: [[WHMCS cPanel Licensing Module#Activation & Module Permissions|Installation]]
 +
 
 +
==Activation & Configuration==
 +
 
 +
To activate and configure the module, perform the following steps within the WHMCS Admin Area.
 +
 
 +
#Navigate to ''Setup > Addon Modules''
 +
#Click the ''Activate'' button next to the ''cPanel Licensing'' entry
 +
#Click on the ''Configure'' button
 +
#In the ''Master Admin Users'' section, select the ''Allow Access to Settings for Full Administrator users'' option
 +
#In the ''Access Control'' section, select the ''Full Administrator'' option
 +
#Click on the ''Save Changes'' button
 +
 
 +
Activation & Configuration Documentation: [[WHMCS cPanel Licensing Module#Activation & Module Permissions|Activation & Module Permissions]]
 +
 
 +
==Manage2 Authentication==
 +
 
 +
Following the initial activation and configuration of the module, you will need to authenticate into Manage2. This can be done by taking the following actions within the WHMCS Admin Area.
 +
 
 +
#Navigate to ''Addons > cPanel Licensing''
 +
#Enter your Manage2 Username and Password into their respective fields
 +
#Click on the ''Login'' button
 +
 
 +
After successful authentication, the Manage2 data will begin to be imported into WHMCS. This may take several minutes depending on the amount of licenses associated with the Manage2 account.
 +
 
 +
Once the import has completed, you will be redirected to the primary interface for the cPanel Licensing addon where you will immediately see a list of licenses associated with your Manage2 account.
 +
 
 +
Authentication Documentation: [[WHMCS cPanel Licensing Module#Authenticating into Manage2|Authenticating into Manage2]]
 +
 
 +
==Importing Existing cPanel License Offerings==
 +
 
 +
If you have an existing Configurable Option Group and Configurable Options that you would like to be used for the provisioning and billing of cPanel licenses, then these can be imported for use with the cPanel Licensing addon. To achieve this perform the following steps from the cPanel Licensing page in the WHMCS Admin Area.
 +
 +
#Click on the ''Pricing'' tab
 +
#Click on the ''Import'' button
 +
#Select the existing Configurable Option to be used from the ''Option Name'' drop-down menu
 +
#Click on the ''Continue'' button
 +
#For each selectable option, select a cPanel Package that it relates to from its associated drop-down menu
 +
#Click on the ''Import'' button
 +
 +
This will import the configurable options into the module, and make them available for further configuration via the ''Pricing'' tab.
 +
 
 +
<div class="docs-alert-warning">Only Configurable Options of the type Dropdown or Radio are supported for import. Other option types will not be available for import.</div>
 +
 
 +
Import Documentation: [[WHMCS cPanel Licensing Module#Import Existing Option|Import Existing Option]]
 +
 
 +
==Review Pricing Configuration==
 +
 
 +
After an existing configurable option has been imported, the next step would be to review the pricing configuration. This can be done via the cPanel Licensing page in the WHMCS Admin Area.
 +
 
 +
#Click on the ''Pricing'' tab
 +
#Locate the newly imported Configurable Option from the list
 +
#Click the ''Manage'' button associated with the list entry
 +
#Review the ''Type'', ''Visibility'', and ''Autoscale Option'' selections
 +
#In the ''Options'' section, select each option and review the data displayed on the right
 +
#Should any data be incorrect, then alter the data, and click the ''Save'' button
 +
#Once completed, click on the ''Close'' button
 +
 
 +
Option & Price Management Documentation: [[WHMCS cPanel Licensing Module#Authenticating into Manage2|Option & Price Management]]
 +
 
 +
==Link Services to Existing Licenses==
 +
 
 +
After any existing options have been imported and reviewed, the next step is to manually associate existing services with their existing cPanel license. To achieve this, perform the following actions from the WHMCS Admin Area.
 +
 
 +
#Navigate to ''Clients > Products/Services''
 +
#Locate the service that you would like to associate with an existing cPanel license.
 +
#Click on the Service ID to be taken to the Service Page
 +
#Locate the imported Configurable Option, and select the option that you would like the customer to be charged for
 +
#Enable the ''Auto Select cPanel License'' option if you would like the Configurable Option to dynamically adjust based on the license's user count
 +
#Locate the ''cPanel Licensing'' panel, and click on the ''Link to Existing License'' button
 +
#From the ''Choose license to link with service'' drop-down, select the license that you would like to associate with the service
 +
#Click on the ''Assign'' button
 +
 
 +
After successfully assigning the license to the service you will see the relevant licensing data displayed within the ''cPanel Licensing'' panel as well as buttons to manage that license as needed.
 +
 
 +
Service Management Documentation: [[WHMCS cPanel Licensing Module#Authenticating into Manage2|Service Management]]

Revision as of 18:01, 22 August 2019

This guide covers the basics of the cPanel Licensing module; starting with installation and activating the module, importing existing configurable options, configuring the imported options further, and then what to do next.

This page aims to provide a brief overview and will signpost you to the relevant sections in our documentation for full details on everything covered.

Installation

To install the cPanel Licensing addon module, follow the steps below.

  1. Download the latest version of the addon module from https://marketplace.whmcs.com/product/4993
  2. Unzip the zip file download to a directory on your computer
  3. Upload the "cpanellicensing" directory to the ~/modules/addons/ directory within your WHMCS installation
Installation Documentation: Installation

Activation & Configuration

To activate and configure the module, perform the following steps within the WHMCS Admin Area.

  1. Navigate to Setup > Addon Modules
  2. Click the Activate button next to the cPanel Licensing entry
  3. Click on the Configure button
  4. In the Master Admin Users section, select the Allow Access to Settings for Full Administrator users option
  5. In the Access Control section, select the Full Administrator option
  6. Click on the Save Changes button
Activation & Configuration Documentation: Activation & Module Permissions

Manage2 Authentication

Following the initial activation and configuration of the module, you will need to authenticate into Manage2. This can be done by taking the following actions within the WHMCS Admin Area.

  1. Navigate to Addons > cPanel Licensing
  2. Enter your Manage2 Username and Password into their respective fields
  3. Click on the Login button

After successful authentication, the Manage2 data will begin to be imported into WHMCS. This may take several minutes depending on the amount of licenses associated with the Manage2 account.

Once the import has completed, you will be redirected to the primary interface for the cPanel Licensing addon where you will immediately see a list of licenses associated with your Manage2 account. 

Authentication Documentation: Authenticating into Manage2

Importing Existing cPanel License Offerings

If you have an existing Configurable Option Group and Configurable Options that you would like to be used for the provisioning and billing of cPanel licenses, then these can be imported for use with the cPanel Licensing addon. To achieve this perform the following steps from the cPanel Licensing page in the WHMCS Admin Area.

  1. Click on the Pricing tab
  2. Click on the Import button
  3. Select the existing Configurable Option to be used from the Option Name drop-down menu
  4. Click on the Continue button
  5. For each selectable option, select a cPanel Package that it relates to from its associated drop-down menu
  6. Click on the Import button

This will import the configurable options into the module, and make them available for further configuration via the Pricing tab.

Only Configurable Options of the type Dropdown or Radio are supported for import. Other option types will not be available for import.
Import Documentation: Import Existing Option

Review Pricing Configuration

After an existing configurable option has been imported, the next step would be to review the pricing configuration. This can be done via the cPanel Licensing page in the WHMCS Admin Area.

  1. Click on the Pricing tab
  2. Locate the newly imported Configurable Option from the list
  3. Click the Manage button associated with the list entry
  4. Review the Type, Visibility, and Autoscale Option selections
  5. In the Options section, select each option and review the data displayed on the right
  6. Should any data be incorrect, then alter the data, and click the Save button
  7. Once completed, click on the Close button
Option & Price Management Documentation: Option & Price Management

Link Services to Existing Licenses

After any existing options have been imported and reviewed, the next step is to manually associate existing services with their existing cPanel license. To achieve this, perform the following actions from the WHMCS Admin Area.

  1. Navigate to Clients > Products/Services
  2. Locate the service that you would like to associate with an existing cPanel license.
  3. Click on the Service ID to be taken to the Service Page
  4. Locate the imported Configurable Option, and select the option that you would like the customer to be charged for
  5. Enable the Auto Select cPanel License option if you would like the Configurable Option to dynamically adjust based on the license's user count
  6. Locate the cPanel Licensing panel, and click on the Link to Existing License button
  7. From the Choose license to link with service drop-down, select the license that you would like to associate with the service
  8. Click on the Assign button

After successfully assigning the license to the service you will see the relevant licensing data displayed within the cPanel Licensing panel as well as buttons to manage that license as needed. 

Service Management Documentation: Service Management
Retrieved from "http://3.17.75.209/index.php?title=WHMCS_cPanel_Licensing_Module_Getting_Started_Guide&oldid=27521"