Personal tools
Namespaces

Variants
Actions

Product Linker For WHMCS

From ModulesGarden Wiki
(Difference between revisions)
Jump to: navigation, search
(→‎Settings)
Line 17: Line 17:
 
|}
 
|}
 
{|
 
{|
−
|style="padding: 0px 0px 0px 30px;"|✔ Dependencies Between Module Actions - Every Action: Create, Terminate, Suspend Or Unsuspend Called On The Main Product Will Result With The Same Action Performed On The Child Products
+
|style="padding: 0px 0px 0px 30px;"|✔ Dependencies Between Module Actions - Every Action: Create, Terminate, Suspend Or Unsuspend Called On The Main Product Will Result In The Same Action Performed On The Child Products
 
|}
 
|}
 
{|
 
{|
Line 122: Line 122:
 
{|
 
{|
 
|style="padding: 10px 0px 20px 15px;"|At '' 'Basic Relations' '' tab you can define links between products through product addons and configurable options.<br />
 
|style="padding: 10px 0px 20px 15px;"|At '' 'Basic Relations' '' tab you can define links between products through product addons and configurable options.<br />
−
They will be triggered as soon as your client make an order for product with product addon/configurable option chosen at the relation.<br />
+
They will be triggered as soon as your client makes an order for product with product addon/configurable option chosen at the relation.<br />
 
Additionally, you can define a promo code added to the order by triggering the relation.
 
Additionally, you can define a promo code added to the order by triggering the relation.
 
|}
 
|}
Line 141: Line 141:
 
|}
 
|}
 
{|
 
{|
−
|style="padding: 0px 0px 15px 15px;"|Finish through selecting child product which will be linked by triggering this relation.<br />
+
|style="padding: 0px 0px 15px 15px;"|Finish through selecting child product which will be linked after triggering the relation.<br />
−
Choose promo code added to order and save relation through pressing '' 'Add Relation' '' button.<br />
+
Choose a promo code that will be added to the order and save relation through pressing '' 'Add Relation' '' button.<br />
−
''Note: Only one promo code can be assigned to the order, you can specify assignment of promo code at the '' 'Settings' '' page.''
+
''Note: Only one promo code can be assigned to the order, you can specify the assignment of promo code at the '' 'Settings' '' page.''
 
|}
 
|}
 
{|
 
{|
Line 171: Line 171:
 
|}
 
|}
 
{|
 
{|
−
|style="padding: 10px 0px 15px 15px;"|Our module allows you to enable copying parent's product configurable options to the children product upon ordering them.<br />
+
|style="padding: 10px 0px 15px 15px;"|Our module allows you to enable copying parent's product configurable options to the child product upon ordering them.<br />
 
To enable copying, mark checkbox next to configurable options and press '' 'Save Changes' '' as shown on the screen below.<br />
 
To enable copying, mark checkbox next to configurable options and press '' 'Save Changes' '' as shown on the screen below.<br />
 
''Note: You can enable configurable option copying only if configurable option is assigned to both products.''
 
''Note: You can enable configurable option copying only if configurable option is assigned to both products.''
Line 182: Line 182:
 
{|
 
{|
 
|style="padding: 10px 0px 15px 15px;"|'' 'Existing Connections' '' tab allows you to view the list of all products ordered by your clients for which relations exist.<br />
 
|style="padding: 10px 0px 15px 15px;"|'' 'Existing Connections' '' tab allows you to view the list of all products ordered by your clients for which relations exist.<br />
−
You can find all information about relation, like for example main product, linked product, their owner or domain used by both products.<br />
+
You can find all information about the relation, like main product, linked product, their owner or domain used by both products.<br />
−
You can quickly move to the customer or any of his product by simply clicking on client/product name.
+
You can quickly move to the customer or any of their products by simply clicking on client/product name.
 
|}
 
|}
 
{|
 
{|
Line 217: Line 217:
 
To locate products for which error occurred, you can use data at '' 'Request Parameters' '' column.<br />
 
To locate products for which error occurred, you can use data at '' 'Request Parameters' '' column.<br />
 
For example, '' '[accountid]' '' and '' '[domain]' '' should be enough to quickly localize products.<br />
 
For example, '' '[accountid]' '' and '' '[domain]' '' should be enough to quickly localize products.<br />
−
''Note: Module also checks if the module log is turn on and provides link to it.''
+
''Note: Module also checks if the module log is turned on and provides a link to it.''
 
|}
 
|}
 
{|
 
{|
Line 223: Line 223:
 
|}
 
|}
 
{|
 
{|
−
|style="padding: 0px 0px 30px 15px;"|You can look for product with details you found in previous step, but way quicker way is to use a link.<br />
+
|style="padding: 0px 0px 30px 15px;"|You can look for the product with details you found in the previous step, but a way faster method is to use a link.<br />
 
All you have to do is enter value of '' '[accountid]' '' in place of account_id in the link below.<br />
 
All you have to do is enter value of '' '[accountid]' '' in place of account_id in the link below.<br />
 
  your_whmcs/admin/clientsservices.php?id=account_id<br />
 
  your_whmcs/admin/clientsservices.php?id=account_id<br />
Line 230: Line 230:
 
==Settings==
 
==Settings==
 
{|
 
{|
−
|style="padding: 10px 0px 15px 15px;"|Due to assignment of promo codes to the relation, it may happen that multiple promo codes will be assigned with one order form.<br />
+
|style="padding: 10px 0px 15px 15px;"|Due to assignment of promo codes to the relation, it may happen that multiple promo codes will be assigned to one order form.<br />
 
WHMCS doesn't support such actions, therefore only one promo code has to be chosen.<br />
 
WHMCS doesn't support such actions, therefore only one promo code has to be chosen.<br />
 
'' 'Settings' '' page allows you to define promotion code assignment.<br />
 
'' 'Settings' '' page allows you to define promotion code assignment.<br />
−
1. '' 'Highest Discount Available' '' - if checked, a promo codes giving the highest discount to your clients will be chosen at the order form.<br />
+
1. '' 'Highest Discount Available' '' - if checked, a promo code giving the highest discount to your clients will be chosen at the order form.<br />
−
2. '' 'Discount Limit' '' - if '' 'Highest Discount Available' '' is disabled, the promo codes giving closest discount to the value provided will be chosen.<br />
+
2. '' 'Discount Limit' '' - if '' 'Highest Discount Available' '' is disabled, a promo code giving the closest discount to the value provided will be chosen.<br />
−
Discount have to be greater than the value provided.
+
Discount has to be greater than the value provided.
 
|}
 
|}
 
{|
 
{|
Line 253: Line 253:
 
|style="padding: 10px 0px 15px 15px;"|In these steps we will show you how to link the cPanel Manage2 to the cPanel Extended through the product addon.<br />
 
|style="padding: 10px 0px 15px 15px;"|In these steps we will show you how to link the cPanel Manage2 to the cPanel Extended through the product addon.<br />
 
''Note: You can also link them using configurable options.''<br />
 
''Note: You can also link them using configurable options.''<br />
−
1. Start from creating '' 'IP' '' custom field at main product visible on order form.<br />
+
1. Start from creating '' 'IP' '' custom field at the main product visible on order form.<br />
 
To do so, go to '' 'Setup' '' → '' 'Products/Services' '' → '' 'Products/Services' '' and edit your cPanel Extended product.
 
To do so, go to '' 'Setup' '' → '' 'Products/Services' '' → '' 'Products/Services' '' and edit your cPanel Extended product.
 
|}
 
|}
Line 268: Line 268:
 
|}
 
|}
 
{|
 
{|
−
|style="padding: 0px 0px 15px 15px;"|3. Afterwards, it is time to create a product addon which will trigger the relation.<br />
+
|style="padding: 0px 0px 15px 15px;"|3. It is time to create a product addon which will trigger the relation.<br />
 
Go to '' 'Setup' '' → '' 'Products/Services' '' → '' 'Products Addons' '' and press '' 'Add New Addon' ''.
 
Go to '' 'Setup' '' → '' 'Products/Services' '' → '' 'Products Addons' '' and press '' 'Add New Addon' ''.
 
|}
 
|}
Line 291: Line 291:
 
|}
 
|}
 
{|
 
{|
−
|style="padding: 0px 0px 15px 15px;"|To check if relation works as it should, place an order from the admin area for the main product with the product addon triggering the relation.<br />
+
|style="padding: 0px 0px 15px 15px;"|To check if the relation works as it should, place an order from the admin area for the main product with the product addon triggering the relation.<br />
−
Do not forget to type domain and IP address. Afterwards, press '' 'Submit Order' ''.
+
Do not forget to type the domain and IP address. Afterwards, press '' 'Submit Order' ''.
 
|}
 
|}
 
{|
 
{|
Line 314: Line 314:
 
|style="padding: 10px 0px 15px 15px;"|In these steps we will show you linking DirectAdmin Licenses to DirectAdmin Extended through product addon.<br />
 
|style="padding: 10px 0px 15px 15px;"|In these steps we will show you linking DirectAdmin Licenses to DirectAdmin Extended through product addon.<br />
 
''Note: You can also link them using configurable options.''<br />
 
''Note: You can also link them using configurable options.''<br />
−
1. Start from creating '' 'IP' '' custom field at main product visible on order form.<br />
+
1. Start from creating '' 'IP' '' custom field at the main product visible on order form.<br />
 
To do so, go to '' 'Setup' '' → '' 'Products/Services' '' → '' 'Products/Services' '' and edit your DirectAdmin Extended product.
 
To do so, go to '' 'Setup' '' → '' 'Products/Services' '' → '' 'Products/Services' '' and edit your DirectAdmin Extended product.
 
|}
 
|}
Line 329: Line 329:
 
|}
 
|}
 
{|
 
{|
−
|style="padding: 0px 0px 15px 15px;"|3. Afterwards, it is time to create a product addon which will trigger the relation.<br />
+
|style="padding: 0px 0px 15px 15px;"|3. It is time to create a product addon which will trigger the relation.<br />
 
Go to '' 'Setup' '' → '' 'Products/Services' '' → '' 'Products Addons' '' and press '' 'Add New Addon' ''.
 
Go to '' 'Setup' '' → '' 'Products/Services' '' → '' 'Products Addons' '' and press '' 'Add New Addon' ''.
 
|}
 
|}
Line 354: Line 354:
 
{|
 
{|
 
|style="padding: 0px 0px 15px 15px;"|To check if the relation works as it should, place an order from the admin area for the main product with the product addon triggering the relation.<br />
 
|style="padding: 0px 0px 15px 15px;"|To check if the relation works as it should, place an order from the admin area for the main product with the product addon triggering the relation.<br />
−
Do not forget to type domain and IP address. Afterwards, press '' 'Submit Order' ''.
+
Do not forget to type the domain and IP address. Afterwards, press '' 'Submit Order' ''.
 
|}
 
|}
 
{|
 
{|
Line 375: Line 375:
 
|style="padding: 10px 0px 15px 15px;"|In these steps we will show you how to link Parallels Key Administrator to Parallels Cloud Server through a product addon.<br />
 
|style="padding: 10px 0px 15px 15px;"|In these steps we will show you how to link Parallels Key Administrator to Parallels Cloud Server through a product addon.<br />
 
It is required to set a key type in your Parallels Key Administrator to '' 'PARALLELS-CLOUD-SERVER' ''.<br />
 
It is required to set a key type in your Parallels Key Administrator to '' 'PARALLELS-CLOUD-SERVER' ''.<br />
−
Only in this way linked product will create a license for Parallels Cloud Server product.<br />
+
Only in this way a linked product will create the license for Parallels Cloud Server product.<br />
 
''Note 1: You can also link these products using configurable options.''<br />
 
''Note 1: You can also link these products using configurable options.''<br />
 
''Note 2: In order to create a license successfully, you have to select at least one feature from a dropdown menu.''
 
''Note 2: In order to create a license successfully, you have to select at least one feature from a dropdown menu.''
Line 391: Line 391:
 
{|
 
{|
 
|style="padding: 0px 0px 15px 15px;"|2. Open '' 'Custom Fields' '' tab, enter '' 'IP' '' into '' 'Field Name' '' and mark '' 'Show on Order Form' '' checkbox.<br />
 
|style="padding: 0px 0px 15px 15px;"|2. Open '' 'Custom Fields' '' tab, enter '' 'IP' '' into '' 'Field Name' '' and mark '' 'Show on Order Form' '' checkbox.<br />
−
Additionally, you can enter description of this custom field and set up field validation (it is one line validation, do not split it into two line):<br />
+
Additionally, you can enter a description of this custom field and set up field validation (it is one line validation, do not split it into two lines):<br />
 
  /\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 />
 
  /\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 />
 
  \.(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 />
Line 400: Line 400:
 
|}
 
|}
 
{|
 
{|
−
|style="padding: 0px 0px 15px 15px;"|3. Afterwards, it is time to create a product addon which will trigger the relation.<br />
+
|style="padding: 0px 0px 15px 15px;"|3. It is time to create a product addon which will trigger the relation.<br />
 
Go to '' 'Setup' '' → '' 'Products/Services' '' → '' 'Products Addons' '' and press '' 'Add New Addon' ''.
 
Go to '' 'Setup' '' → '' 'Products/Services' '' → '' 'Products Addons' '' and press '' 'Add New Addon' ''.
 
|}
 
|}
Line 461: Line 461:
 
{|
 
{|
 
|style="padding: 0px 0px 15px 15px;"|2. Open '' 'Custom Fields' '' tab, enter '' 'IP' '' into '' 'Field Name' '' and mark '' 'Show on Order Form' '' checkbox.<br />
 
|style="padding: 0px 0px 15px 15px;"|2. Open '' 'Custom Fields' '' tab, enter '' 'IP' '' into '' 'Field Name' '' and mark '' 'Show on Order Form' '' checkbox.<br />
−
Additionally, you can enter description of this custom field and set up field validation (it is one line validation, do not split it into two line):<br />
+
Additionally, you can enter a description of this custom field and set up field validation (it is one line validation, do not split it into two lines):<br />
 
  /\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 />
 
  /\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 />
 
  \.(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 />
Line 470: Line 470:
 
|}
 
|}
 
{|
 
{|
−
|style="padding: 0px 0px 15px 15px;"|3. Afterwards, it is time to create a product addon which will trigger the relation.<br />
+
|style="padding: 0px 0px 15px 15px;"|3. It is time to create a product addon which will trigger the relation.<br />
 
Go to '' 'Setup' '' → '' 'Products/Services' '' → '' 'Products Addons' '' and press '' 'Add New Addon' ''.
 
Go to '' 'Setup' '' → '' 'Products/Services' '' → '' 'Products Addons' '' and press '' 'Add New Addon' ''.
 
|}
 
|}
Line 513: Line 513:
 
=Tips=
 
=Tips=
 
{|
 
{|
−
|style="padding: 10px 0px 10px 15px;"|1. If your client orders a product with settings triggering two relations to the same product, only one product will be created.
+
|style="padding: 10px 0px 10px 15px;"|1. If your client orders a product with settings triggering two relations with the same product, only one product will be created.
 
|}
 
|}
 
{|
 
{|
 
|style="padding: 0px 0px 30px 15px;"|2. If your client orders product configurable options upgrade/downgrade, old linked product bound by previous configurable option will stay active.<br />
 
|style="padding: 0px 0px 30px 15px;"|2. If your client orders product configurable options upgrade/downgrade, old linked product bound by previous configurable option will stay active.<br />
−
You need to remove the link between old linked product and main product in addon, and terminate old linked product manually.
+
You need to remove the link between an old linked product and a main product in an addon, and terminate old linked product manually.
 
|}
 
|}
  

Revision as of 12:03, 24 September 2014

Contents

About Product Linker For WHMCS

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

Product Linker For WHMCS allows you to sell your products in bundles.

Product bundles content is defined by clients through chosen addons or configurable options.
Module will also allow you to view, filter and delete existing connections used by your customers.

*Features:
✔ Create A Single Or Multiple Relations Between Your WHMCS Products, Addons And Configurable Options
✔ Allow Your Clients To Purchase Multiple Products, Addons And Configurable Options Through Ordering Just One Of Them
✔ Dependencies Between Module Actions - Every Action: Create, Terminate, Suspend Or Unsuspend Called On The Main Product Will Result In The Same Action Performed On The Child Products
✔ Product Updates With Automatic Email Notifications To Admin
✔ View And Delete Existing Connections
✔ Flexible Filtering Of Existing Connections
✔ Advanced Module Logs
  • General Info:
✔ Integrated With cPanel Manage2 For WHMCS - Easy Reselling Of cPanel Licenses (read more)
✔ Integrated With DirectAdmin Licenses For WHMCS - Easy DirectAdmin Licenses Reselling (read more)
✔ Integrated With Parallels Key Administrator For WHMCS - Easy Parallels Licenses Reselling (read more)
✔ Improved Update Of Products
✔ Multi-Language Support
✔ Supports WHMCS V5 and Later

Installation

This tutorial will show you how to successfully install Product Linker For WHMCS.

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

1. Log in to your client area and download Product Linker For WHMCS.
PL1.png
2. Upload and extract the module into the main WHMCS directory.

Files in your WHMCS directory should look like this.

PL2.png
3. When you install Product Linker for the first time you have to rename 'license_RENAME.php' file.

File is located at 'modules/addons/productlinker/license_RENAME.php' . Rename it from 'license_RENAME.php' to 'license.php' .

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

PL4.png
5. Now you have to activate the module in your WHMCS system.

Log in to your WHMCS admin area. Go to 'Setup' → 'Addon Modules' . Afterwards, find 'Product Linker' and press 'Activate' button.

PL5.png
6. In the next step you need to permit access to this module.

To do so, click on 'Configure' button, select administrator groups which should have access to this addon and press 'Save Changes' .

PL6.png
7. To enable logs from failed actions, go to 'Utilities' → 'Logs' → 'Module Log' .

Afterwards, press 'Enable Debug Logging' .

PL7.png
8. You have just successfully installed Product Linker For WHMCS!

You can access your module at 'Addons' → 'Product Linker' .

PL8.png

Configuration and Management

Product Linker For WHMCS allows to sell bundles of products through ordering one product with specific product addons and configurable options.

It also automatically forwards basic commands from the main product to all child products.
You can define relation between products through product addon or configurable option. You will find more information about it in 'Add Relation' section.
Note: If the child product is a parent product in the other relation, changes made on its parent will be also commanded on its child.

Basic Relations

At 'Basic Relations' tab you can define links between products through product addons and configurable options.

They will be triggered as soon as your client makes an order for product with product addon/configurable option chosen at the relation.
Additionally, you can define a promo code added to the order by triggering the relation.

Add Relation

To add a new relation, go to 'Product Linker' → 'Basic Relations' .

Now, select relation type from 'Type' dropdown menu, you can choose between relation triggered by product addon or configurable option.

PL9.png
Next, select product addon or configurable option name from 'Product Addon/Configurable Option' dropdown menu.

If you have chosen 'Configurable option' relation type, additionally you have to select a configurable option value.

PL10.png
Finish through selecting child product which will be linked after triggering the relation.

Choose a promo code that will be added to the order and save relation through pressing 'Add Relation' button.
Note: Only one promo code can be assigned to the order, you can specify the assignment of promo code at the 'Settings' page.

PL11.png

Edit Relation

Editing relations is quite easy, go to 'Basic Relations' tab and start making changes.

You can alter one relation or multiple relations simultaneously, the only difference is button used to save changes.
If you are making changes in only one relation, press 'Save Changes' button next to it (green arrow), otherwise use 'Save Changes' at the bottom of the page (red arrow).

PL12.png

Product Relations

At 'Product Relations' tab you can set up relation linking one product with another.

To create a new configuration simply choose product which will trigger relation from 'Product' dropdown menu.
Next, select product which will be added from 'Linked Product' dropdown menu.
Optionally, assign promo code and enable configurable option mimicking.
Press 'Add Relation' to save relation.

PL12 1.png
Our module allows you to enable copying parent's product configurable options to the child product upon ordering them.

To enable copying, mark checkbox next to configurable options and press 'Save Changes' as shown on the screen below.
Note: You can enable configurable option copying only if configurable option is assigned to both products.

PL12 2.png

Existing Connections

'Existing Connections' tab allows you to view the list of all products ordered by your clients for which relations exist.

You can find all information about the relation, like main product, linked product, their owner or domain used by both products.
You can quickly move to the customer or any of their products by simply clicking on client/product name.

PL13.png
Module also allows you to order records on the list by selected column through pressing on its headline.

For example, to order by client name, press on 'Client Name' column header as shown on the following screen.

PL14.png
You can use filters to display only specific records.

To open filters form, press 'Toggle Filters' .

PL15.png
You are able to set up filtering by client name, both main and linked products and domain.

When you select values you desire, click 'Filter Results' button (red arrow).
If you decide to clear filters you have set up earlier, open filters form and press 'Clear Filter' (green arrow).

PL16.png

Module Logs

If there was any trouble with linked products, information about error will be displayed at 'Module Logs' page.

Error message can be found at 'Clean Response' and 'Parsed Response' column.
To locate products for which error occurred, you can use data at 'Request Parameters' column.
For example, '[accountid]' and '[domain]' should be enough to quickly localize products.
Note: Module also checks if the module log is turned on and provides a link to it.

PL17.png
You can look for the product with details you found in the previous step, but a way faster method is to use a link.

All you have to do is enter value of '[accountid]' in place of account_id in the link below.

your_whmcs/admin/clientsservices.php?id=account_id

To confirm if you are looking at right product, check if domain in the product matches domain you found in the error log.

Settings

Due to assignment of promo codes to the relation, it may happen that multiple promo codes will be assigned to one order form.

WHMCS doesn't support such actions, therefore only one promo code has to be chosen.
'Settings' page allows you to define promotion code assignment.
1. 'Highest Discount Available' - if checked, a promo code giving the highest discount to your clients will be chosen at the order form.
2. 'Discount Limit' - if 'Highest Discount Available' is disabled, a promo code giving the closest discount to the value provided will be chosen.
Discount has to be greater than the value provided.

PL17 1.png

Exemplary Connections

At 'Exemplary Connections' section we will show you how to set up relations between specific products.

One of the many possibilities is connecting cPanel Manage2 For WHMCS, DirectAdmin Licenses For WHMCS and Parallels Key Administrator For WHMCS with other products.
This will allow you to automatically provision ready to use licenses for clients once they order a product of your choice, e.g. a VPS server. This is a great convenience!
Note: Before following any of exemplary configurations below, make sure that both products you will be using in the configuration are set up correctly.
Additionally, product linked to the main product should be set to hidden and free. You will be able to set its price at the product addon.

cPanel Extended + cPanel Manage2

In these steps we will show you how to link the cPanel Manage2 to the cPanel Extended through the product addon.

Note: You can also link them using configurable options.
1. Start from creating 'IP' custom field at the main product visible on order form.
To do so, go to 'Setup' → 'Products/Services' → 'Products/Services' and edit your cPanel Extended product.

PL18.png
2. Open 'Custom Fields' tab, enter 'IP' into 'Field Name' and mark 'Show on Order Form' checkbox.

Confirm changes through pressing 'Save Changes' .

PL19.png
3. It is time to create a product addon which will trigger the relation.

Go to 'Setup' → 'Products/Services' → 'Products Addons' and press 'Add New Addon' .

PL20.png
4. Enter addon name, its description and recurring price.

Choose billing cycle from 'Billing Cycle' dropdown menu.
It is advised to set up the same billing cycle as in the main product.
Additionally, you have to mark 'Show on Order' checkbox and checkbox next to the main product. In this example it will be 'Cpanel - cPanel Extended' .
Next, press 'Save Changes' .

PL21.png
5. Now, create relation at your 'Product Linker' → 'Basic Relations' .
PL22.png
To check if the relation works as it should, place an order from the admin area for the main product with the product addon triggering the relation.

Do not forget to type the domain and IP address. Afterwards, press 'Submit Order' .

PL23.png
Select 'Run Module Create' and press 'Accept Order' .
PL24.png
If a new entry appeared as the one marked on the following screen, you have successfully configured both products and linked them through the addon.
PL25.png

DirectAdmin Extended + DirectAdmin Licenses

In these steps we will show you linking DirectAdmin Licenses to DirectAdmin Extended through product addon.

Note: You can also link them using configurable options.
1. Start from creating 'IP' custom field at the main product visible on order form.
To do so, go to 'Setup' → 'Products/Services' → 'Products/Services' and edit your DirectAdmin Extended product.

PL26.png
2. Open 'Custom Fields' tab, enter 'IP' into 'Field Name' and mark 'Show on Order Form' checkbox.

Confirm changes through pressing 'Save Changes' .

PL27.png
3. It is time to create a product addon which will trigger the relation.

Go to 'Setup' → 'Products/Services' → 'Products Addons' and press 'Add New Addon' .

PL28.png
4. Enter addon name, its description and recurring price.

Choose a billing cycle from 'Billing Cycle' dropdown menu.
It is advised to set up the same billing cycle as in the main product.
You also have to mark 'Show on Order' checkbox and checkbox next to the main product.
In this example it will be 'DirectAdmin - DirectAdmin Extended' .
Next, press 'Save Changes' .

PL29.png
5. Now, create a relation at your 'Product Linker' → 'Basic Relations' .
PL30.png
To check if the relation works as it should, place an order from the admin area for the main product with the product addon triggering the relation.

Do not forget to type the domain and IP address. Afterwards, press 'Submit Order' .

PL31.png
Select 'Run Module Create' and press 'Accept Order' .
PL32.png
If a new entry appeared as the one marked on the following screen, you have successfully configured both products and linked them through the product addon.
PL33.png

Parallels Cloud Server + Parallels Key Administrator

In these steps we will show you how to link Parallels Key Administrator to Parallels Cloud Server through a product addon.

It is required to set a key type in your Parallels Key Administrator to 'PARALLELS-CLOUD-SERVER' .
Only in this way a linked product will create the license for Parallels Cloud Server product.
Note 1: You can also link these products using configurable options.
Note 2: In order to create a license successfully, you have to select at least one feature from a dropdown menu.

PL34.png
1. Start from creating 'IP' custom field at the main product which will be visible on the order form.

To do so, go to 'Setup' → 'Products/Services' → 'Products/Services' and edit your Parallels Cloud Server product.

PL35.png
2. Open 'Custom Fields' tab, enter 'IP' into 'Field Name' and mark 'Show on Order Form' checkbox.

Additionally, you can enter a description of this custom field and set up field validation (it is one line validation, do not split it into two lines):

/\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/

Confirm changes through pressing 'Save Changes' .

PL36.png
3. It is time to create a product addon which will trigger the relation.

Go to 'Setup' → 'Products/Services' → 'Products Addons' and press 'Add New Addon' .

PL37.png
4. Enter addon name, its description and recurring price.

Choose billing cycle from 'Billing Cycle' dropdown menu. It is advised to set up the same billing cycle as in the main product.
Additionally, you have to mark 'Show on Order' checkbox and checkbox next to the main product. In this example it will be 'Parallels - Parallels Cloud Server' .
Next, press 'Save Changes' .

PL38.png
5. Now, create a relation at your 'Product Linker' → 'Basic Relations' .
PL39.png
To check if the relation works as it should, place an order from the admin area for the main product with the product addon triggering the relation.

Do not forget to type IP address. Afterwards, press 'Submit Order' .

PL40.png
Select 'Run Module Create' and press 'Accept Order' .
PL41.png
If a new entry appeared as the one marked on the following screen, you have successfully configured both products and linked them through the product addon.
PL42.png

Parallels Plesk Panel Extended + Parallels Key Administrator

In these steps we will show you how to link Parallels Key Administrator to Parallels Plesk Panel Extended through a product addon.

There are a few key types in your Parallels Key Administrator that are licenses for Parallels Plesk Panel Extended.
In this example we will use 'PLESK_10_AND_LATER' key type.
Note 1: You can also link these products using configurable options.
Note 2: In order to create a license successfully, you have to select at least one feature from a dropdown menu.

PL43.png
1. Start from creating 'IP' custom field at the main product which will be visible on the order form.

Go to 'Setup' → 'Products/Services' → 'Products/Services' and edit your Parallels Plesk Panel Extended product.

PL44.png
2. Open 'Custom Fields' tab, enter 'IP' into 'Field Name' and mark 'Show on Order Form' checkbox.

Additionally, you can enter a description of this custom field and set up field validation (it is one line validation, do not split it into two lines):

/\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/

Confirm changes through pressing 'Save Changes' .

PL45.png
3. It is time to create a product addon which will trigger the relation.

Go to 'Setup' → 'Products/Services' → 'Products Addons' and press 'Add New Addon' .

PL46.png
4. Enter addon name, its description and recurring price.

Choose billing cycle from 'Billing Cycle' dropdown menu. It is adviced to set up the same billing cycle as in the main product.
You also have to mark 'Show on Order' checkbox and checkbox next to the main product. In this example it will be 'Parallels - Parallels Plesk Panel Extended' .
Next, press 'Save Changes' .

PL47.png
5. Now, create a relation at your 'Product Linker' → 'Basic Relations' .
PL48.png
To check if the relation works as it should, place an order from the admin area for the main product with the addon triggering the relation.

Do not forget to type IP address. Afterwards, press 'Submit Order' .

PL49.png
Select 'Run Module Create' and press 'Accept Order' .
PL50.png
If a new entry appeared as the one marked on the following screen, you have successfully configured both products and linked them through the product addon.
PL51.png

Tips

1. If your client orders a product with settings triggering two relations with the same product, only one product will be created.
2. If your client orders product configurable options upgrade/downgrade, old linked product bound by previous configurable option will stay active.

You need to remove the link between an old linked product and a main product in an addon, and terminate old linked product manually.

Common Problems

1. When you have problems with connection, check whether your SELinux or firewall is not blocking ports.
Retrieved from "https://www.docs.modulesgarden.com/index.php?title=Product_Linker_For_WHMCS&oldid=14327"
Navigation
WHMCS Modules
WHMCS Widgets
Tools And Applications
Translations
cPanel Modules
General
FAQ
Community
Product Linker For WHMCS