Personal tools
Namespaces

Variants
Actions

Hosting Quota Notifications 1.X For WHMCS

From ModulesGarden Wiki
(Difference between revisions)
Jump to: navigation, search
(Installation)
Line 1: Line 1:
<meta name="keywords" content="interworx extended for whmcs, interworx extended configuration, interworx extended management, interworx extended installation, interworx extended common problems, about interworx extended, interworx extended documentation, interworx extended faq, interworx extended help, interworx extended guide, modulesgarden interworx extended, interworx extended wiki, interworx extended tutorial, interworx extended tips, interworx module wiki"></meta>
+
<meta name="keywords" content="product linker for whmcs, product linker configuration, whmcs product linker management, whmcs product linker installation, whmcs product linker common problems, about whmcs product linker, whmcs product linker documentation, whmcs product linker faq, whmcs product linker help, whmcs product linker guide, whmcs product linker wiki, whmcs product linker tutorial, whmcs product linker tips, whmcs product linker wiki"></meta>
<meta name="description" content="ModulesGarden Wiki Contains All The Information You Need About The InterWorx Extended For WHMCS Module."></meta>
+
<meta name="description" content="ModulesGarden Wiki Contains All The Information You Need About The Product Linker For WHMCS Module."></meta>
=About [https://www.modulesgarden.com/products/whmcs/interworx-extended InterWorx Extended For WHMCS] =
+
 
 +
=About [http://www.modulesgarden.com/products/whmcs/product_linker/features Product Linker For WHMCS]=
 
{|
 
{|
|style="padding: 10px 0px 10px 0px;"|'''InterWorx Extended For WHMCS''' will allow you to automate the process of web hosting accounts provisioning and management in your WHMCS.<br />
+
|style="padding: 10px 0px 5px 0px;"|'''Product Linker For WHMCS''' allows you to create relations between your products, addons and configurable options. <br/>
All relevant hosting features will be gathered in your client area: FTP accounts, emails, domains and more. Your clients will be also able to choose from numerous applications.<br/ >
+
Consequently, clients may buy products in bundles along with flexible promo codes.<br />
The module will allow you to configure each product handily and define which features should be available for your clients' use.
+
Module will also allow you to view, filter and delete existing connections used by your customers.
 
|}
 
|}
<!--a comment maybe? -->
+
<!--fix by comment, awesome-->
*'''Admin Area Features:'''
+
*'''Automation Features:'''
 
{|
 
{|
|style="padding: 10px 0px 0px 30px;"|✔ Create/Suspend/Unsuspend/Terminate Account
+
|style="padding: 10px 0px 0px 30px;"|✔ Handle Dependencies Between Module Actions - Each Create/Terminate/Suspend/Unsuspend Action Called On Main Product Triggers Such Action On Child Products
 
|}
 
|}
 
{|
 
{|
|style="padding: 0px 0px 0px 30px;"|✔ Change Package And Password Of Account
+
|style="padding: 0px 0px 0px 30px;"|✔ Enable Product Updates With Automatic Email Notifications Sent To Administrators
 
|}
 
|}
 
{|
 
{|
|style="padding: 0px 0px 0px 30px;"|✔ Automatically Unban Client IP Address Upon Logging In
+
|style="padding: 0px 0px 10px 30px;"|✔ Copy Configurable Options From Parent To Child Product
 
|}
 
|}
 +
*'''Admin Area Features:'''
 
{|
 
{|
|style="padding: 0px 0px 0px 30px;"|✔ Configure Client Area Features And Template Per Product
+
|style="padding: 10px 0px 0px 30px;"|✔ Define Relations Between Chosen Product, Addons, Configurable Options And Linked Products
 
|}
 
|}
 
{|
 
{|
|style="padding: 0px 0px 0px 30px;"|✔ Choose And Configure Application Auto Installer To Use Per Product - Softaculous
+
|style="padding: 0px 0px 0px 30px;"|✔ Define If Addon Price Should Be Switched With Linked Product Price
 
|}
 
|}
 
{|
 
{|
|style="padding: 0px 0px 10px 30px;"|✔ View All InterWorx And InterWorx Extended Products And Servers In One Place
+
|style="padding: 0px 0px 0px 30px;"|✔ Assign Custom Promo Codes To Relations
 
|}
 
|}
*'''Client Area Features:'''
 
 
{|
 
{|
|style="padding: 10px 0px 0px 30px;"|✔ Remote Access And Management Of:
+
|style="padding: 0px 0px 0px 30px;"|✔ View, Filter And Delete Existing Connections
 
|}
 
|}
 
{|
 
{|
|style="padding: 0px 0px 0px 45px;"|✔ Applications And Their Backups
+
|style="padding: 0px 0px 10px 30px;"|✔ View Error Logs
 
|}
 
|}
 +
*'''Client Area Features:'''
 
{|
 
{|
|style="padding: 0px 0px 0px 45px;"|✔ FTP Accounts
+
|style="padding: 10px 0px 0px 30px;"|✔ Buy Multiple Products, Addons And Configurable Options By Ordering At Least One Of Them
 
|}
 
|}
 
{|
 
{|
|style="padding: 0px 0px 0px 45px;"|✔ Email Accounts
+
|style="padding: 0px 0px 10px 30px;"|✔ View Linked Product Added To Order By Triggering Relation
 
|}
 
|}
 +
 +
*'''General Info:'''
 
{|
 
{|
|style="padding: 0px 0px 0px 45px;"|✔ Email Forwarders
+
|style="padding: 10px 0px 0px 30px;"|✔ Integrated With <u>cPanel Manage2 For WHMCS</u> - Easy Reselling Of cPanel Licenses [http://www.modulesgarden.com/products/whmcs/cpanel_manage2/features (read more)]
 
|}
 
|}
 
{|
 
{|
|style="padding: 0px 0px 0px 45px;"|✔ MySQL Databases
+
|style="padding: 0px 0px 0px 30px;"|✔ Integrated With <u>DirectAdmin Licenses For WHMCS</u> - Easy DirectAdmin Licenses Reselling [http://www.modulesgarden.com/products/whmcs/directadmin_licenses/features (read more)]
 
|}
 
|}
 
{|
 
{|
|style="padding: 0px 0px 0px 45px;"|✔ Cron Jobs
+
|style="padding: 0px 0px 0px 30px;"|✔ Integrated With <u>Odin Key Administrator For WHMCS</u> - Easy Odin Licenses Reselling [http://www.modulesgarden.com/products/whmcs/odin_key_administrator/features (read more)]
 
|}
 
|}
 
{|
 
{|
|style="padding: 0px 0px 0px 45px;"|✔ Subdomains
+
|style="padding: 0px 0px 0px 30px;"|✔ Multi-Language Support
 
|}
 
|}
 
{|
 
{|
|style="padding: 0px 0px 0px 45px;"|✔ Domain Redirects
+
|style="padding: 0px 0px 0px 30px;"|✔ Supports PHP 5.3 Up To PHP 7
 
|}
 
|}
 
{|
 
{|
|style="padding: 0px 0px 0px 45px;"|✔ Domain Aliases
+
|style="padding: 0px 0px 30px 30px;"|✔ Supports WHMCS V6 and V7
 
|}
 
|}
 +
 +
=Installation=
 
{|
 
{|
|style="padding: 0px 0px 0px 45px;"|✔ Backups - Manual And Automatic
+
|style="padding: 10px 0px 0px 0px;"|'''This tutorial will show you how to successfully install Product Linker For WHMCS.''' <br />
 +
We will guide you step by step through the whole installation and configuration process. <br />
 
|}
 
|}
 
{|
 
{|
|style="padding: 0px 0px 0px 45px;"|✔ Unban IP Addresses
+
|style="padding: 20px 0px 20px 15px;"|'''1. Log in to your client area and download Product Linker For WHMCS.'''
 
|}
 
|}
 
{|
 
{|
|style="padding: 0px 0px 0px 30px;"|✔ One Click Login To InterWorx
+
|style="padding: 0px 0px 20px 25px;"|[[File:PL1.png]]
 
|}
 
|}
 
{|
 
{|
|style="padding: 0px 0px 10px 30px;"|✔ Change Account Password
+
|style="padding: 0px 0px 15px 15px;"|'''2. Upload and extract the module into the main WHMCS directory.'''<br />
 +
Files in your WHMCS directory should look like these.
 
|}
 
|}
*'''Application Auto Installer Features:'''
 
 
{|
 
{|
|style="padding: 10px 0px 0px 30px;"|✔ Ordering Process:
+
|style="padding: 0px 0px 20px 25px;"|[[File:PL2.png]]
 
|}
 
|}
 
{|
 
{|
|style="padding: 0px 0px 0px 45px;"|✔ Auto Install Chosen Application After Account Creation
+
|style="padding: 0px 0px 15px 15px;"|'''3. When you install Product Linker for the first time you have to rename '' 'license_RENAME.php' '' file.'''<br />
 +
File is located in '' 'modules/addons/productlinker/license_RENAME.php'. '' Rename it from '' 'license_RENAME.php' '' to '' 'license.php'. ''
 
|}
 
|}
 
{|
 
{|
|style="padding: 0px 0px 0px 45px;"|✔ Auto Install Application Chosen By Client During Order - Owing To Configurable Options
+
|style="padding: 0px 0px 20px 25px;"|[[File:PL3.png]]
 
|}
 
|}
 
{|
 
{|
|style="padding: 0px 0px 0px 45px;"|✔ Allow Custom Settings Of Auto Installed Application - Owing To Custom Fields
+
|style="padding: 0px 0px 15px 15px;"|'''4. In order to configure your license key, you have to edit a previously renamed '' 'license.php' file.' '' '''<br />
 +
Enter your license key between quotation marks as presented on the following screen. You can find your license key in your client area → '' 'My Products'. ''
 
|}
 
|}
 
{|
 
{|
|style="padding: 0px 0px 0px 30px;"|✔ Client Area:
+
|style="padding: 0px 0px 20px 25px;"|[[File:PL4.png]]
 
|}
 
|}
 
{|
 
{|
|style="padding: 0px 0px 0px 45px;"|✔ Install New Applications With Softaculous
+
|style="padding: 0px 0px 15px 15px;"|'''5. Now you have to activate the module in your WHMCS system.'''<br />
 +
Log in to your WHMCS admin area. Go to '' 'Setup' '' → '' 'Addon Modules'. '' Afterwards, find '' 'Product Linker' '' and press '' 'Activate' '' button.
 
|}
 
|}
 
{|
 
{|
|style="padding: 0px 0px 0px 45px;"|✔ View And Manage Installed Applications
+
|style="padding: 0px 0px 20px 25px;"|[[File:PL2_5.png]]
 
|}
 
|}
 
{|
 
{|
|style="padding: 0px 0px 0px 45px;"|✔ Backup Installed Applications
+
|style="padding: 0px 0px 15px 15px;"|'''6. In the next step you need to permit access to this module.'''<br />
 +
To do so, click on '' 'Configure' '' button, select administrator groups which should have access to this addon and press '' 'Save Changes'. ''
 
|}
 
|}
 
{|
 
{|
|style="padding: 0px 0px 0px 45px;"|✔ View And Manage Created Backups
+
|style="padding: 0px 0px 20px 25px;"|[[File:PL2_6.png]]
 
|}
 
|}
 
{|
 
{|
|style="padding: 0px 0px 0px 45px;"|✔ Restore Applications From Backups
+
|style="padding: 0px 0px 15px 15px;"|'''7. To enable logs from failed actions, go to '' 'Utilities' '' → '' 'Logs' '' → '' 'Module Log'. '' '''<br />
 +
There, press '' 'Enable Debug Logging'. ''
 
|}
 
|}
 
{|
 
{|
|style="padding: 0px 0px 10px 45px;"|✔ Delete Applications Along With Their Backups
+
|style="padding: 0px 0px 20px 25px;"|[[File:PL2_7.png]]
 
|}
 
|}
*'''General Info:'''
 
 
{|
 
{|
|style="padding: 10px 0px 0px 30px;"|✔ Utilizes Ajax Loaded Pages
+
|style="padding: 0px 0px 15px 15px;"|'''8. You have just successfully installed Product Linker For WHMCS!'''<br />
 +
You can access your module at '' 'Addons' '' → '' 'Product Linker'. ''
 
|}
 
|}
 
{|
 
{|
|style="padding: 0px 0px 0px 30px;"|✔ Multi-Language Support
+
|style="padding: 0px 0px 30px 25px;"|[[File:PL2_8.png]]
|}
+
{|
+
|style="padding: 0px 0px 0px 30px;"|✔ Supports PHP 5.3 Up To PHP 7
+
|}
+
{|
+
|style="padding: 0px 0px 0px 30px;"|✔ Supports WHMCS Templates Five and Six
+
|}
+
{|
+
|style="padding: 0px 0px 30px 30px;"|✔ Supports WHMCS V6 and V7
+
 
|}
 
|}
  
=Installation and Configuration=
+
=Configuration and Management=
 
{|
 
{|
|style="padding: 10px 0px 30px 15px;"|'''Read the below instructions to learn how to install and then configure InterWorx Extended For WHMCS properly.'''<br />
+
|style="padding: 10px 0px 30px 15px;"|'''Product Linker For WHMCS allows to sell bundles of products through ordering one product with specific product addons and configurable options.'''<br />
We will guide you step by step through the installation procedures.
+
It also automatically forwards basic commands from the main product to all child products.<br />
 +
You can define relation between products through product addon or configurable option. You will find more information about it in '' 'Add Relation' '' section.<br />
 
|}
 
|}
==Installation==
+
==Basic Relations==
 
{|
 
{|
|style="padding: 10px 0px 20px 15px;"|'''1. Log in to your client area and download the module.'''
+
|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 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.
 
|}
 
|}
 +
===Add Relation===
 
{|
 
{|
|style="padding: 0px 0px 20px 25px;"|[[File:IWE_1.png]]
+
|style="padding: 10px 0px 15px 15px;"|To add a new relation, go to '' 'Product Linker' '' → '' 'Basic Relations'. ''<br /> Now, select relation type from '' 'Type' '' dropdown menu, you can choose between relation triggered by product addon or configurable option.<br/>
 +
''Note: For '' 'Addon' '' type there is also '' 'Swap Price' '' option available. If you select it, the price of the linked hosting/product will be overwritten with the addon price.''
 
|}
 
|}
 
{|
 
{|
|style="padding: 0px 0px 10px 15px;"|'''2. In the downloaded file you will find two packages that support different PHP versions.'''<br/>As presented on the screen below, the first one is dedicated to PHP 7, while the second one is aimed at PHP 5.3 up to PHP 5.6.<br/>It does not apply to open source versions.<br/>
+
|style="padding: 0px 0px 20px 25px;"|[[File:PL2_9.png]]
'' '''Note''': You can check current PHP version in your WHMCS. To do so proceed to ''' 'Utilities' → 'System' → 'PHP Info'.'''
+
 
|}
 
|}
 
{|
 
{|
|style="padding: 0px 0px 20px 25px;"|[[File:IWE_2.png]]
+
|style="padding: 0px 0px 15px 15px;"|Next, select product addon or configurable option name from '' 'Product Addon/Configurable Option' '' dropdown menu.<br />
 +
If you have chosen '' 'Configurable option' '' relation type, additionally you have to select a configurable option value.
 
|}
 
|}
 
{|
 
{|
|style="padding: 0px 0px 15px 15px;"|'''3. Extract the downloaded file and choose the one with the right PHP version. Upload and extract the PHP file into the main WHMCS directory.'''<br />
+
|style="padding: 0px 0px 20px 25px;"|[[File:PL2_10.png]]
The content of PHP version files should look like this.  
+
 
|}
 
|}
 
{|
 
{|
|style="padding: 0px 0px 20px 25px;"|[[File:fhtyht.png]]
+
|style="padding: 0px 0px 15px 15px;"|Finish through selecting child product which will be linked after triggering the relation.<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 the assignment of promo code at the '' 'Settings' '' page.''
 
|}
 
|}
 
{|
 
{|
|style="padding: 0px 0px 15px 15px;"|'''4. When you install InterWorx Extended For WHMCS for the first time you have to rename '' 'license_RENAME.php' '' file.'''<br />
+
|style="padding: 0px 0px 30px 25px;"|[[File:PL2_11.png]]
File is located in '' 'modules/servers/interworxExtended/license_RENAME.php'. '' Rename it from '' 'license_RENAME.php' '' to '' 'license.php'. ''
+
 
|}
 
|}
 +
 +
===Edit Relation===
 
{|
 
{|
|style="padding: 0px 0px 20px 25px;"|[[File:IWE_3.png]]
+
|style="padding: 10px 0px 15px 15px;"|Editing relations is quite easy, go to '' 'Basic Relations' '' tab and start making changes.<br />
 +
You can alter one relation or multiple relations simultaneously, the only difference is button used to save changes.<br />
 +
If you are making changes in only one relation, press '' 'Save Changes' '' button next to it, otherwise use '' 'Save Changes' '' at the bottom of the page (pointed with a green arrow).
 
|}
 
|}
 
{|
 
{|
|style="padding: 0px 0px 15px 15px;"|'''5. In order to configure your license key you have to edit a previously renamed '' 'license.php' '' file.'''<br />
+
|style="padding: 0px 0px 30px 25px;"|[[File:PL2_12.png]]
Enter your license key between quotation marks as presented on the following screen. You can find your license key in your client area → '' 'My Products'. ''
+
|}
+
{|
+
|style="padding: 0px 0px 20px 25px;"|[[File:IWE_4.png]]
+
|}
+
{|
+
|style="padding: 0px 0px 30px 15px;"|'''6. Set file ''softaculous_scripts.txt'' located in '' 'whmcs_root/modules/addons/interworx_extended_center' '' as writable.
+
 
|}
 
|}
  
==Activation of Addon==
+
==Product Relations==
{|
+
|style="padding: 10px 0px 15px 15px;"|'''7. Now you have to activate the module in your WHMCS system.'''<br />
+
Log in to your WHMCS admin area. Click '' 'Setup' '' and find '' 'Addon Modules'. ''<br />
+
Afterwards, find '' 'InterWorx Extended Center' '' and press '' 'Activate' '' button.
+
|}
+
 
{|
 
{|
|style="padding: 0px 0px 20px 25px;"|[[File:IWE_5.png]]
+
|style="padding: 10px 0px 15px 15px;"|At '' 'Product Relations' '' tab you can set up relation linking one product with another.<br />
 +
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' ''<br /> dropdown menu.
 +
Optionally, assign promo code and enable configurable option copying (if possible). Press '' 'Add Relation' '' to save relation.
 
|}
 
|}
 
{|
 
{|
|style="padding: 0px 0px 15px 15px;"|'''8. In the next step, you need to permit access to this module.'''<br />
+
|style="padding: 0px 0px 20px 25px;"|[[File:PL2_12_1.png]]
To do so, click on '' 'Configure' '' button, tick desired admin roles and press '' 'Save Changes'. ''<br />
+
''Note: Here you can also define which client area template are you using, based on '''Six''' or '''Five'''.''
+
 
|}
 
|}
 
{|
 
{|
|style="padding: 0px 0px 20px 25px;"|[[File:IWE_6.png]]
+
|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 />
 +
''Note: You can enable configurable option copying only if configurable option is assigned to both products.''
 
|}
 
|}
 
{|
 
{|
|style="padding: 0px 0px 30px 15px;"|'''9. InterWorx Extended For WHMCS is now successfully installed!'''<br />
+
|style="padding: 0px 0px 30px 25px;"|[[File:PL2_12_2.png]]
Access the addon under '' 'Addons' '' → '' 'InterWorx Extended Center'. ''
+
 
|}
 
|}
  
==Configuration of Server==
+
==Existing Connections==
 
{|
 
{|
|style="padding: 10px 0px 15px 15px;"|'''10. First of all, you must configure a new product.'''<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 />
Go to '' 'Setup' '' → '' 'Products/Services' '' → '' 'Servers' '' and press '' 'Add New Server'. ''
+
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 their products by simply clicking on client/product name.
 
|}
 
|}
 
{|
 
{|
|style="padding: 0px 0px 20px 25px;"|[[File:IWE_8.png]]
+
|style="padding: 0px 0px 20px 25px;"|[[File:PL2_13.png]]
 
|}
 
|}
 
{|
 
{|
|style="padding: 0px 0px 15px 15px;"|'''11. Enter your server name, IP address, username and a password. Choose '' 'interworxExtended' '' from a dropdown menu and press '' 'Save Changes'. '''''<br />
+
|style="padding: 0px 0px 15px 15px;"|Module also allows you to order records on the list by selected column through pressing on its headline.<br />
If you connect with your InterWorx server via SSL, then make sure that you checked '' 'Secure' '' located at the bottom of the page.<br />
+
For example, to order by client name, press on '' 'Client Name' '' column header as shown on the following screen.
''Note: Keep in mind that 'Login to InterWorx' button URL, located in the client area, derive from 'Hostname' or 'IP Address' fields input.''
+
 
|}
 
|}
 
{|
 
{|
|style="padding: 0px 0px 20px 25px;"|[[File:IWE_9.png]]
+
|style="padding: 0px 0px 20px 25px;"|[[File:PL2_14.png]]
 
|}
 
|}
 
{|
 
{|
|style="padding: 0px 0px 15px 15px;"|'''12. Once your server has been configured correctly, you will see a following screen.'''<br />
+
|style="padding: 0px 0px 15px 15px;"|You can use filters to display only specific records.<br />
Create a new group for your server.  Press '' 'Create New Group' '' to follow.
+
To open filters form, press '' 'Toggle Filters'. ''
 
|}
 
|}
 
{|
 
{|
|style="padding: 0px 0px 20px 25px;"|[[File:IWE_10.png]]
+
|style="padding: 0px 0px 20px 25px;"|[[File:PL2_15.png]]
 
|}
 
|}
 
{|
 
{|
|style="padding: 0px 0px 20px 15px;"|'''13. Enter name, click on your previously created server, press '' 'Add' '' then '' 'Save Changes'. '''''
+
|style="padding: 0px 0px 15px 15px;"|You are able to set up filtering by client name, both main and linked products and domain.<br />
 +
When you select values you desire, click '' 'Filter Results' '' button (red arrow).<br />
 +
If you decide to clear filters you have set up earlier, open filters form and press '' 'Clear Filter' '' (green arrow).
 
|}
 
|}
 
{|
 
{|
|style="padding: 0px 0px 30px 25px;"|[[File:IWE_11.png]]
+
|style="padding: 0px 0px 30px 25px;"|[[File:PL2_16.png]]
 
|}
 
|}
  
==Configuration of Product==
+
==Module Logs==
 
{|
 
{|
|style="padding: 10px 0px 15px 15px;"|'''14. In order to create a product, go to '' 'Setup' '' '' 'Products/Services' '' '' 'Products/Services' ''.'''<br />
+
|style="padding: 10px 0px 15px 15px;"|If there was any trouble with linked products, information about error will be displayed at '' 'Module Logs' '' page.<br />
If you do not have a product group, click on '' 'Create a New Group' ''. If you do, simply skip step 13.
+
Error message can be found at '' 'Clean Response' '' and '' 'Parsed Response' '' 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 />
 +
''Note: Module also checks if the module log is turned on and provides a link to it.''
 
|}
 
|}
 
{|
 
{|
|style="padding: 0px 0px 20px 25px;"|[[File:IWE_12.png]]
+
|style="padding: 0px 0px 20px 25px;"|[[File:PL2_17.png]]
 
|}
 
|}
 
{|
 
{|
|style="padding: 0px 0px 20px 15px;"|'''15. Fill in a product group name and press '' 'Create Group'. '' '''
+
|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 />
 +
your_whmcs/admin/clientsservices.php?id=account_id<br />
 +
To confirm if you are looking at right product, check if domain in the product matches domain you found in the error log.
 
|}
 
|}
 +
 +
==Settings==
 
{|
 
{|
|style="padding: 0px 0px 20px 25px;"|[[File:IWE_13.png]]
+
|style="padding: 10px 0px 15px 15px;"|In '' 'Settings' '' section you may manage the promo codes assignment to linked products and add some information to the order form.<br/>
 +
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, <br/>therefore only one promo code has to be chosen.<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, a promo code giving the closest discount to the value provided will be chosen.<br />
 +
Discount has to be greater than the value provided.<br />
 
|}
 
|}
 
{|
 
{|
|style="padding: 0px 0px 20px 15px;"|'''16. When you have a product group added, you can create your product and assign it to InterWorx Extended module.
+
|style="padding: 0px 0px 20px 25px;"|[[File:PL2_17_1.png]]
 
|}
 
|}
 
{|
 
{|
|style="padding: 0px 0px 20px 25px;"|[[File:IWE_14.png]]
+
|style="padding: 0px 0px 20px 15px;"|3. Display Product Info - if this option is selected in '' 'Settings' '' section, there is information visible on the linked product on the order form.
 
|}
 
|}
 
{|
 
{|
|style="padding: 0px 0px 20px 15px;"|'''17. Afterwards, choose your product type and product group from dropdown menus, enter your product name and press '' 'Continue'. '''''
+
|style="padding: 0px 0px 30px 25px;"|[[File:PL2_17_2.png]]
 
|}
 
|}
 +
 +
==Exemplary Connections==
 
{|
 
{|
|style="padding: 0px 0px 20px 25px;"|[[File:IWE_15.png]]
+
|style="padding: 10px 0px 15px 15px;"|At '' 'Exemplary Connections' '' section we will show you how to set up relations between specific products.<br />
 +
One of the many possibilities is connecting [http://www.docs.modulesgarden.com/CPanel_Manage2_For_WHMCS cPanel Manage2 For WHMCS], [http://www.docs.modulesgarden.com/DirectAdmin_Licenses_For_WHMCS DirectAdmin Licenses For WHMCS] and [http://www.docs.modulesgarden.com/Odin_Key_Administrator_For_WHMCS Odin Key Administrator For WHMCS] with other products.<br />
 +
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.<br />
 +
''Note: Before following any of exemplary configurations below, make sure that both products you will be using in the configuration are set up correctly.''<br />
 +
''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===
 
{|
 
{|
|style="padding: 0px 0px 15px 15px;"|'''18. Now, go to '' 'Module Settings' '' section, choose both '' 'InterWorxExtended' '' and a previously created server group from dropdown menus and press'' 'Save Changes'. '''''<br />
+
|style="padding: 10px 0px 15px 15px;"|In these steps we will show you how to link cPanel Manage2 with cPanel Extended through the product addon.<br />
Additionally, choose InterWorx package and theme.
+
''Note: You can also link them using configurable options.''<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.
 
|}
 
|}
 
{|
 
{|
|style="padding: 0px 0px 30px 25px;"|[[File:IWE_16.png]]
+
|style="padding: 0px 0px 20px 25px;"|[[File:PL2_18.png]]
 
|}
 
|}
  
==Configuration of Addon==
 
 
{|
 
{|
|style="padding: 10px 0px 15px 15px;"|'''19. You have just correctly created and customized a new product.'''<br /> <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 />
Go to '' 'Addons' '' '' 'InterWorx Extended Center' '' in your WHMCS.<br />
+
Confirm changes through pressing '' 'Save Changes'. ''
You will find there InterWorx Extended dashboard with precise data on products and servers:
+
*see the number of ''active/suspended/terminated'' products
+
*check the number of active accounts
+
*connect with WHM here ''(if configured in 'Module Settings')''
+
*press '' 'Documentation' '' tab to be moved to this very site!
+
 
|}
 
|}
 
{|
 
{|
|style="padding: 0px 0px 20px 25px;"|[[File:IWE_17.png]]
+
|style="padding: 0px 0px 20px 25px;"|[[File:PL2_19.png]]
 
|}
 
|}
 
{|
 
{|
|style="padding: 0px 0px 20px 15px;"|'''20. Proceed to '' 'Features' '' section and find the product you are interested in and press '' 'Configuration' '' button next to it.'''
+
|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'. ''
 
|}
 
|}
 
{|
 
{|
|style="padding: 0px 0px 20px 25px;"|[[File:IWE_17_1.png]]
+
|style="padding: 0px 0px 20px 25px;"|[[File:PL2_20.png]]
 
|}
 
|}
 
{|
 
{|
|style="padding: 0px 0px 15px 15px;"|'''21. You should find there boxes dedicated to '' 'Features', 'Applications', 'Client Area Template'. ''<br />
+
|style="padding: 0px 0px 15px 15px;"|4. Enter addon name, its description and recurring price. Choose billing cycle from '' 'Billing Cycle' '' dropdown menu.<br />
If you have already another product configured, you may copy its configuration now. Find one more box '' 'Copy Configuration' '' and choose product from dropdown menu. <br/> To show you an example, we will set the configuration from the beginning, we will not use other product's configuration.<br/> <br />
+
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.<br/> In this example it will be '' 'cPanel - cPanel Extended'. ''<br />
Select the features you would like to activate for your customers.
+
Next, press '' 'Save Changes'. ''
 
|}
 
|}
 
{|
 
{|
|style="padding: 0px 0px 20px 25px;"|[[File:IWE_18.png]]
+
|style="padding: 0px 0px 20px 25px;"|[[File:PL2_21.png]]
 
|}
 
|}
 
{|
 
{|
|style="padding: 0px 0px 15px 15px;"|'''22. Choose whether to activate '' 'Install Applications' '' option.'''<br />
+
|style="padding: 0px 0px 20px 15px;"|5. Now, create relation at your '' 'Product Linker' '' '' 'Basic Relations'. ''
In case you wish to activate this option, you will have to select '' 'Auto Installer' '' from a dropdown menu. Afterwards activate '' 'Install Button' '' and '' 'Backup Button'. ''<br />
+
You can also choose desired language of the applications by typing in its two letter code into the '' 'Language' '' field. A complete list of language codes can be found [http://softaculous.com/docs/Scripts_Language_Codes  here].<br />
+
If the field is left blank, a default value, which is '' 'en' '' (english) will be used.<br />
+
''Note: You can also create a configurable option with app to be installed, you can find the instruction to do that [http://www.docs.modulesgarden.com/InterWorx_Extended_For_WHMCS#Assignment_of_Custom_Fields_To_Application_Auto_Install here].''
+
 
|}
 
|}
 
{|
 
{|
|style="padding: 0px 0px 20px 25px;"|[[File:IWE_20.png]]
+
|style="padding: 0px 0px 20px 25px;"|[[File:PL2_22.png]]
 
|}
 
|}
 
{|
 
{|
|style="padding: 0px 0px 15px 15px;"|'''23. Finally, select from the available which client area template shall be used for this product.''' <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 />
''Note that by default only one template is available. If you have more templates prepared, they will also appear here to choose from.''<br />
+
Do not forget to type the domain and IP address. Afterwards, press '' 'Submit Order'. ''
'''Do not forget to '' 'Save' '' changes once product configuration is ready!'''
+
 
|}
 
|}
 
{|
 
{|
|style="padding: 0px 0px 20px 25px;"|[[File:IWE_19.png]]
+
|style="padding: 0px 0px 20px 25px;"|[[File:PL2_23.png]]
 
|}
 
|}
 
{|
 
{|
|style="padding: 0px 0px 15px 15px;"|'''24. From now on, all your clients who ordered a previously created product will be able to manage their InterWorx accounts via your WHMCS system.'''<br />
+
|style="padding: 0px 0px 20px 15px;"|Select '' 'Run Module Create' '' and press '' 'Accept Order'. ''
Here a view of the ordered product summary in admin area. Available actions:
+
*Log In To SiteWorx
+
*Use Module Commands: '' 'Create', 'Suspend', 'Unsuspend', 'Terminate' '' the product; '' 'Change Package' and 'Change Password' ''
+
 
|}
 
|}
 
{|
 
{|
|style="padding: 0px 0px 20px 25px;"|[[File:IWE_00.png]]
+
|style="padding: 0px 0px 20px 25px;"|[[File:PL2_24.png]]
 
|}
 
|}
 
{|
 
{|
|style="padding: 0px 0px 15px 15px;"|This is what your customers should see in their client area.
+
|style="padding: 0px 0px 20px 15px;"|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.
 
|}
 
|}
 
{|
 
{|
|style="padding: 0px 0px 30px 25px;"|[[File:IWE_21.png]]
+
|style="padding: 0px 0px 30px 25px;"|[[File:PL2_25.png]]
 
|}
 
|}
  
=Management=
+
===DirectAdmin Extended + DirectAdmin Licenses===
 
{|
 
{|
|style="padding: 10px 0px 30px 15px;"|'''InterWorx Extended allows your customers to manage their InterWorx accounts without being logged into the server.'''<br />
+
|style="padding: 10px 0px 15px 15px;"|In these steps we will show you linking DirectAdmin Licenses to DirectAdmin Extended through product addon.<br />
Read the below descriptions to become familiarized with all of the InterWorx Extended functionalities.  
+
''Note: You can also link them using configurable options.''<br />
 +
1. Start by 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.
 
|}
 
|}
==Client Area==
 
 
{|
 
{|
|style="padding: 10px 0px 30px 15px;"|In the following section, features available in the client area will be thoroughly discussed.
+
|style="padding: 0px 0px 20px 25px;"|[[File:PL2_26.png]]
 
|}
 
|}
===Applications===
+
 
 
{|
 
{|
|style="padding: 10px 0px 15px 15px;"|Install your favorite applications in a few seconds without even accessing InterWorx!<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 />
Use InterWorx Extended Fro WHMCS to:
+
Confirm changes through pressing '' 'Save Changes'. ''
*Install applications
+
*Edit/delete applications
+
*Create and restore Backups<br/>
+
To start, simply proceed to '' 'Applications' '' then find '' 'Install New' '' section.
+
 
|}
 
|}
 
{|
 
{|
|style="padding: 0px 0px 20px 25px;"|[[File:IWE_41.png]]
+
|style="padding: 0px 0px 20px 25px;"|[[File:PL2_27.png]]
 
|}
 
|}
 
{|
 
{|
|style="padding: 0px 0px 20px 15px;"|Afterwards, you will see an extensive menu of application categories. For presentation purposes we will install '' 'Piwigo' '' located in '' 'Galleries'. ''<br />Find '' 'Piwigo' '' and press it.
+
|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'. ''
 
|}
 
|}
 
{|
 
{|
|style="padding: 0px 0px 20px 25px;"|[[File:IWE_42.png]]
+
|style="padding: 0px 0px 20px 25px;"|[[File:PL2_28.png]]
 
|}
 
|}
 
{|
 
{|
|style="padding: 0px 0px 20px 15px;"|Now, you have to enter necessary installation details and then press '' 'Install Application' '' to follow. Wait for '' 'Success' '' message.
+
|style="padding: 0px 0px 15px 15px;"|4. Enter addon name, its description and recurring price. Choose a billing cycle from '' 'Billing Cycle' '' dropdown menu.<br />
 +
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.<br />
 +
In this example it will be '' 'DirectAdmin - DirectAdmin Extended'. ''<br />
 +
Next, press '' 'Save Changes'. ''
 
|}
 
|}
 
{|
 
{|
|style="padding: 0px 0px 20px 25px;"|[[File:IWE_44.png]]
+
|style="padding: 0px 0px 20px 25px;"|[[File:PL2_29.png]]
 
|}
 
|}
 
{|
 
{|
|style="padding: 0px 0px 20px 15px;"|View the list of your installed applications by clicking '' 'Installed Applications' '' tab and manage the application.<br/>
+
|style="padding: 0px 0px 20px 15px;"|5. Now, create a relation at your '' 'Product Linker' '' → '' 'Basic Relations'. ''<br/> Note that '' 'Swap Price' '' option has been also marked here. Consequently, the price for the addon will be changed with the price for the linked product/hosting.
You will find there the name of the application, its path, size and available actions:
+
*create backup
+
*delete application
+
 
|}
 
|}
 
{|
 
{|
|style="padding: 0px 0px 30px 25px;"|[[File:IWE_46.png]]
+
|style="padding: 0px 0px 20px 25px;"|[[File:PL2_30.png]]
 
|}
 
|}
====Backups====
 
 
{|
 
{|
|style="padding: 10px 0px 20px 15px;"|You can also create a backup of your installation. It's very easy! To do so, press '' 'Create Backup' '' button next to an installed application.
+
|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 in the domain and IP address. Afterwards, press '' 'Submit Order'. ''
 
|}
 
|}
 
{|
 
{|
|style="padding: 0px 0px 20px 25px;"|[[File:IWE_47.png]]
+
|style="padding: 0px 0px 20px 25px;"|[[File:PL2_31.png]]
 
|}
 
|}
 
{|
 
{|
|style="padding: 0px 0px 20px 15px;"|Confirm the action and backup creation will start immediately.
+
|style="padding: 0px 0px 20px 15px;"|Select '' 'Run Module Create' '' and press '' 'Accept Order'. ''
 
|}
 
|}
 
{|
 
{|
|style="padding: 0px 0px 20px 25px;"|[[File:IWE_48.png]]
+
|style="padding: 0px 0px 20px 25px;"|[[File:PL2_32.png]]
 
|}
 
|}
 
{|
 
{|
|style="padding: 0px 0px 20px 15px;"|After a moment you should see '' 'Backup created successfully' '' message as a confirmation of the operation performed.
+
|style="padding: 0px 0px 20px 15px;"|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.
 
|}
 
|}
 
{|
 
{|
|style="padding: 0px 0px 20px 25px;"|[[File:IWE_49.png]]
+
|style="padding: 0px 0px 30px 25px;"|[[File:PL2_33.png]]
|}
+
{|
+
|style="padding: 0px 0px 20px 15px;"|When you have created a backup of your application, proceed to '' 'Backups' '' tab.<br/>There is a lit of created application backups along with the date when they were created.<br/> Use action buttons marked on the screen to restore and delete a chosen backup.
+
|}
+
{|
+
|style="padding: 0px 0px 30px 25px;"|[[File:IWE_49_1.png]]
+
 
|}
 
|}
  
===FTP Accounts===
+
===Virtuozzo VPS + Odin Key Administrator===
 
{|
 
{|
|style="padding: 10px 0px 20px 15px;"|Add and configure FTP Accounts in the easiest way possible. Just type in login, generate a totally secure password, provide directory and declare Quota.<br/> Manage the accounts to be able to access your website files through an FTP protocol.
+
|style="padding: 10px 0px 15px 15px;"|In these steps we will show you how to link Odin Key Administrator with Virtuozzo VPS through a product addon.<br />
 +
It is required to set a key type in your '' 'Odin Key Administrator' → 'Module Settings' '' to '' 'VIRTUOZZO'. ''<br />
 +
Only in this way a linked product will create a license for Virtuozzo VPS product.<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.''
 
|}
 
|}
 
{|
 
{|
|style="padding: 0px 0px 30px 25px;"|[[File:IWE_22.png]]
+
|style="padding: 0px 0px 20px 25px;"|[[File:PL2_34.png]]
 
|}
 
|}
===Email Accounts===
 
 
{|
 
{|
|style="padding: 10px 0px 20px 15px;"|Create and edit email accounts that are associated with your domains. Use filter to find required email address, preview its selected quota and manage the account.
+
|style="padding: 0px 0px 15px 15px;"|1. Start by creating '' 'IP' '' custom field at the main product which will be visible on the order form.<br />
 +
To do so, go to '' 'Setup' '' → '' 'Products/Services' '' → '' 'Products/Services' '' and edit your VirtuozzoVPS product.
 
|}
 
|}
 
{|
 
{|
|style="padding: 0px 0px 30px 25px;"|[[File:IWE_23.png]]
+
|style="padding: 0px 0px 20px 25px;"|[[File:PL2_35.png]]
 
|}
 
|}
===Email Forwarders===
 
 
{|
 
{|
|style="padding: 10px 0px 20px 15px;"|Set up email forwarders, choose from several destination options to adjust mail forwarding perfectly to your needs.<br/>Add email domain forwarders to forward email form one domain to another.
+
|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 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 />
 +
\.(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 />
 +
Confirm changes through pressing '' 'Save Changes'. ''
 
|}
 
|}
 
{|
 
{|
|style="padding: 0px 0px 30px 25px;"|[[File:IWE_24.png]]
+
|style="padding: 0px 0px 20px 25px;"|[[File:PL2_36.png]]
 
|}
 
|}
===MySQL Databases===
 
 
{|
 
{|
|style="padding: 10px 0px 20px 15px;"|MySQL Databases and Users allow easy and fast management of online applications, systems, shopping carts etc.<br/> Create database, add new users and then combine the users with particular databases.
+
|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'. ''
 
|}
 
|}
 
{|
 
{|
|style="padding: 0px 0px 30px 25px;"|[[File:IWE_25.png]]
+
|style="padding: 0px 0px 20px 25px;"|[[File:PL2_37.png]]
 
|}
 
|}
===Cron Jobs===
 
 
{|
 
{|
|style="padding: 10px 0px 20px 15px;"|Select cron jobs settings to fully automate commands and scripts on your site.<br/> Choose its specific timing and type in the command to be executed.  
+
|style="padding: 0px 0px 15px 15px;"|4. Enter addon name, its description and recurring price.<br />
 +
Choose billing cycle from '' 'Billing Cycle' '' dropdown menu. It is advised to set up the same billing cycle as in the main product.<br />
 +
Additionally, you have to mark '' 'Show on Order' '' checkbox and checkbox next to the main product. In this example it will be '' 'Odin Group - VirtuozzoVPS'. ''<br />
 +
Next, press '' 'Save Changes'. ''
 
|}
 
|}
 
{|
 
{|
|style="padding: 0px 0px 30px 25px;"|[[File:IWE_26.png]]
+
|style="padding: 0px 0px 20px 25px;"|[[File:PL2_38.png]]
 
|}
 
|}
===Subdomains===
 
 
{|
 
{|
|style="padding: 10px 0px 20px 15px;"|Create subdomains for different parts of your website. Choose domain from your list of available, provide document root.<br/>
+
|style="padding: 0px 0px 20px 15px;"|5. Now, create a relation at your '' 'Product Linker' '' → '' 'Basic Relations'. ''
Once created, redirect or delete the subdomain if needed.  
+
 
|}
 
|}
 
{|
 
{|
|style="padding: 0px 0px 30px 25px;"|[[File:IWE_27.png]]
+
|style="padding: 0px 0px 20px 25px;"|[[File:PL2_39.png]]
 
|}
 
|}
 
===Domain Redirects===
 
 
{|
 
{|
|style="padding: 10px 0px 15px 15px;"|Easy access to domain redirection options is very useful.<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 />
This option allows you to redirect a specific web page to another one and display the contents of that page.<br />
+
Do not forget to type IP address. Afterwards, press '' 'Submit Order'. ''
For example, if your main domain is '''mytestingdomain.com''', you can make such forward:<br />
+
'''mytestingdomain.com/redirect''' '''adomainwithlongname-averylongname.com'''<br />
+
Choose type: permanent or temporary; decide whether to use '' 'www' '' redirection or not; select '' 'Wild Card Redirect' '' if you need.
+
 
|}
 
|}
 
{|
 
{|
|style="padding: 0px 0px 30px 25px;"|[[File:IWE_30.png]]
+
|style="padding: 0px 0px 20px 25px;"|[[File:PL2_40.png]]
 
|}
 
|}
 
===Domain Aliases===
 
 
{|
 
{|
|style="padding: 10px 0px 15px 15px;"|You can add and manage your domains' aliases.<br />
+
|style="padding: 0px 0px 20px 15px;"|Select '' 'Run Module Create' '' and press '' 'Accept Order'. ''
This option allows you to read content of one domain from another domain name.<br />
+
''Note: domains must be registered with a valid registrar and point to your DNS server.''
+
 
|}
 
|}
 
{|
 
{|
|style="padding: 0px 0px 30px 25px;"|[[File:IWE_29.png]]
+
|style="padding: 0px 0px 20px 25px;"|[[File:PL2_41.png]]
 
|}
 
|}
 
===Backups===
 
 
{|
 
{|
|style="padding: 10px 0px 15px 15px;"|All backups made are displayed on this page under '' 'Available Restore Points' '' section.<br />
+
|style="padding: 0px 0px 20px 15px;"|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.
All backup jobs are displayed under '' 'Scheduled Backups' ''.
+
 
|}
 
|}
 
{|
 
{|
|style="padding: 0px 0px 20px 25px;"|[[File:IWE_31_1.png]]
+
|style="padding: 0px 0px 30px 25px;"|[[File:PL2_42.png]]
|}
+
{|
+
|style="padding: 0px 0px 15px 15px;"|You can make backups of your whole InterWorx settings or only a part of them.<br />
+
To generate a full backup, choose '' 'Full' '' backup, specify e-mail for notification and press '' 'Create' ''.
+
|}
+
{|
+
|style="padding: 0px 0px 20px 25px;"|[[File:IWE_32.png]]
+
|}
+
{|
+
|style="padding: 0px 0px 15px 15px;"|You can also define recurring backups. Simply choose when to run backup.<br />
+
Additionally, define backup type and email for notifications.<br />
+
Confirm by pressing '' 'Create' ''.
+
|}
+
{|
+
|style="padding: 0px 0px 30px 25px;"|[[File:IWE_33.png]]
+
 
|}
 
|}
  
===Unban IP Address===
+
===Plesk Extended + Odin Key Administrator===
 
{|
 
{|
|style="padding: 10px 0px 15px 15px;"|Unban IP addresses banned by the system.<br />
+
|style="padding: 10px 0px 15px 15px;"|In these steps we will show you how to link Odin Key Administrator with Plesk Extended through a product addon.<br />
Your IP is automatically filled in in the field to unban.  
+
There are a few key types in your Odin Key Administrator that are licenses for Plesk Extended.<br />
 +
In this example we will use '' 'PLESK_10_AND_LATER' '' key type.<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.''<br />
 
|}
 
|}
 
{|
 
{|
|style="padding: 0px 0px 30px 25px;"|[[File:IWE_36.png]]
+
|style="padding: 0px 0px 20px 25px;"|[[File:PL2_43.png]]
 
|}
 
|}
===Log In To InterWorx===
 
 
{|
 
{|
|style="padding: 10px 0px 15px 15px;"|You can easily log in to your InterWorx by clicking '' 'Log In To InterWorx'. ''<br />
+
|style="padding: 10px 0px 15px 15px;"|1. Start by creating '' 'IP' '' custom field at the main product which will be visible on the order form.<br />
You don't need to enter your access details!
+
Go to '' 'Setup' '' → '' 'Products/Services' '' → '' 'Products/Services' '' and edit your Plesk Extended product.
 
|}
 
|}
 
{|
 
{|
|style="padding: 0px 0px 30px 25px;"|[[File:IWE_38.png]]
+
|style="padding: 0px 0px 20px 25px;"|[[File:PL2_44.png]]
 
|}
 
|}
 
===Change Password===
 
 
{|
 
{|
|style="padding: 10px 0px 20px 15px;"|Through changing the password you can change both, your InterWorx account and FTP account passwords at the same time.
+
|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 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 />
 +
\.(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 />
 +
Confirm changes through pressing '' 'Save Changes'. ''
 
|}
 
|}
 
{|
 
{|
|style="padding: 0px 0px 30px 25px;"|[[File:IWE_49_2.png]]
+
|style="padding: 0px 0px 20px 25px;"|[[File:PL2_45.png]]
 
|}
 
|}
 
==Applications Configuration==
 
 
===Configurable Options For Application Auto Install===
 
 
{|
 
{|
|style="padding: 10px 0px 15px 15px;"|Let your clients decide which application they would like to install on their new InterWorx account.<br />
+
|style="padding: 0px 0px 15px 15px;"|3. It is time to create a product addon which will trigger the relation.<br />
While placing an order your customer chooses an application and along with account creation this very application will be installed on the account.<br />
+
Go to '' 'Setup' '' '' 'Products/Services' '' '' 'Products Addons' '' and press '' 'Add New Addon'. ''
There is nothing else you need to do. Application will be instantly ready to use!<br />
+
To set up this feature, come back to your product's configuration, find '' 'Applications' '' section, activate '' 'Install Applications' '', choose '' 'Auto Installer' '' and activate '' 'Use Configurable Options'. ''<br />
+
Click on a download icon to view the list of applications.
+
 
|}
 
|}
 
{|
 
{|
|style="padding: 0px 0px 20px 25px;"|[[File:IWE_52.png]]
+
|style="padding: 0px 0px 20px 25px;"|[[File:PL2_46.png]]
 
|}
 
|}
 
{|
 
{|
|style="padding: 0px 0px 15px 15px;"|These are the names of values that you can enter in configurable options' fields, we will configure them in the next step.<br />
+
|style="padding: 0px 0px 15px 15px;"|4. Enter addon name, its description and recurring price.<br />
For example, if you would like to set up '' '4images' '' in your applications list, you will need to enter value '' '4images 1.7.11' '' or '' '4images'. ''<br />
+
Choose billing cycle from '' 'Billing Cycle' '' dropdown menu. It is advised to set up the same billing cycle as in the main product.<br />
'''1. If you have made a mistake with the application name, the auto installer will not work.'''<br />
+
You also have to mark '' 'Show on Order' '' checkbox and checkbox next to the main product. In this example it will be '' 'Odin Group - Plesk Extended'. ''<br />
'''2. If you do not enter version number, the auto installer will install the latest version of the application.'''<br />
+
Next, press '' 'Save Changes'. ''
Now, when you know what values should be entered in configurable options for particular applications, we can proceed further.
+
 
|}
 
|}
 
{|
 
{|
|style="padding: 0px 0px 20px 25px;"|[[File:IWE_53.png]]
+
|style="padding: 0px 0px 20px 25px;"|[[File:PL2_47.png]]
 
|}
 
|}
 
{|
 
{|
|style="padding: 0px 0px 20px 15px;"|Go to your '' 'WHMCS' '' → '' 'Setup' '' → '' 'Products/Services' '' → '' 'Configurable Options' '' and press '' 'Create a New Group'. ''
+
|style="padding: 0px 0px 20px 15px;"|5. Now, create a relation at your '' 'Product Linker' '' → '' 'Basic Relations'. ''
 
|}
 
|}
 
{|
 
{|
|style="padding: 0px 0px 20px 25px;"|[[File:IWE_54.png]]
+
|style="padding: 0px 0px 20px 25px;"|[[File:PL2_48.png]]
 
|}
 
|}
 
{|
 
{|
|style="padding: 0px 0px 20px 15px;"|Enter '' 'Group Name' '' of your choice, select product you want to assign configurable options to, then press '' 'Save Changes'. ''
+
|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 addon triggering the relation.<br />
 +
Do not forget to type IP address. Afterwards, press '' 'Submit Order'. ''
 
|}
 
|}
 
{|
 
{|
|style="padding: 0px 0px 20px 25px;"|[[File:IWE_55.png]]
+
|style="padding: 0px 0px 20px 25px;"|[[File:PL2_49.png]]
 
|}
 
|}
 
{|
 
{|
|style="padding: 0px 0px 20px 15px;"|Now click on '' 'Add New Configurable Option'. ''
+
|style="padding: 0px 0px 20px 15px;"|Select '' 'Run Module Create' '' and press '' 'Accept Order'. ''
 
|}
 
|}
 
{|
 
{|
|style="padding: 0px 0px 20px 25px;"|[[File:IWE_56.png]]  
+
|style="padding: 0px 0px 20px 25px;"|[[File:PL2_50.png]]
 
|}
 
|}
 
{|
 
{|
|style="padding: 0px 0px 15px 15px;"|This moment is very important. As '' 'Option Name' '', you have to enter '' 'Installation App' ''. '''In other case the entire functionality will not work.'''<br />
+
|style="padding: 0px 0px 20px 15px;"|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.
Here you can set up as many applications as you want. To do so, enter a value name e.g. '' 'Wordpress 3.7.1' '' and press '' 'Save Changes' ''.<br />
+
Repeat this as many times as you need and do not forget to set '' 'Option Type' '' to '' 'Dropdown' ''.<br/><br />
+
Remember that you are not obliged to type in the application version number! If not provided, the latest version will be installed.
+
 
|}
 
|}
 
{|
 
{|
|style="padding: 0px 0px 20px 25px;"|[[File:IWE_57.png]]  
+
|style="padding: 0px 0px 30px 25px;"|[[File:PL2_51.png]]
 
|}
 
|}
 +
==Client Area==
 
{|
 
{|
|style="padding: 0px 0px 15px 15px;"|As you can see on the following screen we decided to offer our customers 5 applications.<br />
+
|style="padding: 10px 0px 5px 15px;"|At this section we will try to visualize how a client may benefit from the connections made between certain products.<br/>
When you finish adding applications, press '' 'Save Changes' '' and '' 'Close Window'. ''
+
Let's take a look at an exemplary situation.
 
|}
 
|}
 
{|
 
{|
|style="padding: 0px 0px 20px 25px;"|[[File:IWE_58.png]]
+
|style="padding: 0px 0px 15px 15px;"|Administrator has created a connection between a VPS product: '''VPS 2x2.4GHz 16 GB RAM, 1TB HDD'''<br/>
 +
and allowed to purchase two addons along with it:<br/>
 +
- cPanel License<br/>
 +
- Direct Admin License<br/>
 +
Our Test Tester client decided to add cPanel License to the cart next to the VPS product.<br/>
 +
Thanks to the connection created in Product Linker addon, the final price is lower than as if the two items were ordered separately.
 
|}
 
|}
 
{|
 
{|
|style="padding: 0px 0px 15px 15px;"|Afterwards, come back to '' 'InterWorx Extended Features' '' → '' 'Configuration' '' → '' 'Applications' '', activate '' 'Use Configurable Options' '' and choose '' 'Apps/Configurable Options' '' from a dropdown menu.<br />
+
|style="padding: 0px 0px 20px 25px;"|[[File:PL2_52.png]]
Please note that you can have more configurable options groups. Press '' 'Save' '' and that's it. You have just successfully assigned configurable options to application autoinstall.
+
 
|}
 
|}
 
{|
 
{|
|style="padding: 0px 0px 20px 25px;"|[[File:IWE_59.png]]
+
|style="padding: 0px 0px 20px 15px;"|When items are activated, client may see their pricing on the products list.
 
|}
 
|}
 
{|
 
{|
|style="padding: 0px 0px 15px 15px;"|Let's check out what your customers are going to see in their client area while placing the order.<br/>
+
|style="padding: 0px 0px 30px 25px;"|[[File:PL2_53.png]]
As you can see, a dropdown menu with previously configured applications has shown up.
+
|}
+
{|
+
|style="padding: 0px 0px 30px 25px;"|[[File:IWE_60.png]]  
+
 
|}
 
|}
  
===Assignment of Custom Fields To Application Autoinstall===
+
=Tips=
 
{|
 
{|
|style="padding: 10px 0px 15px 15px;"|Now, when you know how to allow your customers to choose which application they would like to install on their account, we can proceed one step further.<br />
+
|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.
Until that moment applications had been installed with use of default details like e.g. directory names or database name.<br />
+
Those details are sent to each customer's email.<br />
+
Allowing your customers to choose their own installation paths, usernames and others is a safer and recommended solution. Let's see how to do that.<br />
+
In the beginning, go to '' 'Product/Services', '' find your product using'' 'InterWorx Extended' '' module and enter '' 'Custom Fields' '' category.<br />
+
You will need to add 12 custom fields, the first 8 are:
+
*'''Directory'''
+
*'''Database Name'''
+
*'''Database Username'''
+
*'''Database Password'''
+
*'''Table Prefix'''
+
*'''Site Name'''
+
*'''Site Description'''
+
*'''Language'''
+
Remember to set each field type as '' 'Text Box', '' tick '' 'Required Field ' '' and '' 'Show on Order Form'. ''<br />
+
Everything is shown on the screen below.
+
 
|}
 
|}
 
{|
 
{|
|style="padding: 0px 0px 20px 25px;"|[[File:IWE_61.png]]
+
|style="padding: 0px 0px 10px 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 an old linked product and a main product in an addon, and terminate old linked product manually.
 
|}
 
|}
 
{|
 
{|
|style="padding: 0px 0px 20px 15px;"|The next 3 fields are:
+
|style="padding: 0px 0px 10px 15px;"|3. If a child product is at the same time a parent product in the other relation, changes made on its parent will be also commanded on its child.''
*'''Admin Username'''
+
*'''Admin Password'''
+
*'''Admin Email'''
+
Set them as '' 'Text Box' '' and tick '' 'Show on Order Form'. ''
+
 
|}
 
|}
 
{|
 
{|
|style="padding: 0px 0px 20px 25px;"|[[File:IWE_61_1.png]]
+
|style="padding: 0px 0px 30px 15px;"|4. Keep in mind that the second product, linked by the module, is never visible in the cart. It is automatically added once the first one is activated.
|}
+
{|
+
|style="padding: 0px 0px 20px 15px;"|The last field is:
+
*'''Auto Update'''
+
Set it as '' 'Drop Down', '' enter '' 'Yes, No' '' into '' 'Select Options', '' tick '' 'Required Field ' '' and '' 'Show on Order Form'. ''
+
|}
+
{|
+
|style="padding: 0px 0px 20px 25px;"|[[File:IWE_61_2.png]]
+
|}
+
{|
+
|style="padding: 0px 0px 15px 15px;"|Once you add all the custom fields, they will appear while placing an order.<br />
+
Voila! Now your customers can personalize each application without the necessity of installing it later.<br />
+
Client can place one of the following [http://softaculous.com/docs/Scripts_Language_Codes language codes].
+
|}
+
{|
+
|style="padding: 0px 0px 30px 25px;"|[[File:IWE_62.png]]
+
 
|}
 
|}
  
==Management of Existing Products==
+
=Common Problems=
 
{|
 
{|
|style="padding: 10px 0px 30px 15px;"|'''You can easily use InterWorx Extended module with your already configured InterWorx products.<br />
+
|style="padding: 10px 0px 10px 15px;"|'''1. When you have problems with connection, check whether your SELinux or firewall does not block ports.'''
To do so, change the type of servers and module names of products from '' 'InterWorx' '' to '' 'InterWorxExtended' ''.<br />
+
Additional information about how to correctly configure your servers and products can be found in points 9-17 in '' 'Installation and Configuration' '' section.
+
 
|}
 
|}
 
==How To Update==
 
{|
 
|style="padding: 10px 0px 30px 15px;"|1. Updating InterWorx Extended goes alike updating any other MG product, for more information visit [http://www.docs.modulesgarden.com/Modules_Update Modules Update] page.
 
|}
 
=Tips=
 
{|
 
|style="padding: 10px 0px 30px 15px;"|1. As this module supports templates system, any changes made in the module's templates files will be saved after the upgrade process.
 
|}
 
 
=Common Problems=
 
 
{|
 
{|
|style="padding: 10px 0px 30px 15px;"|'''1. When you have problems with connection, check whether your SELinux or firewall does not block ports.'''
+
|style="padding: 0px 0px 30px 15px;"|
 
|}
 
|}

Revision as of 14:52, 6 June 2017

Contents

About Product Linker For WHMCS

Product Linker For WHMCS allows you to create relations between your products, addons and configurable options.

Consequently, clients may buy products in bundles along with flexible promo codes.
Module will also allow you to view, filter and delete existing connections used by your customers.

  • Automation Features:
✔ Handle Dependencies Between Module Actions - Each Create/Terminate/Suspend/Unsuspend Action Called On Main Product Triggers Such Action On Child Products
✔ Enable Product Updates With Automatic Email Notifications Sent To Administrators
✔ Copy Configurable Options From Parent To Child Product
  • Admin Area Features:
✔ Define Relations Between Chosen Product, Addons, Configurable Options And Linked Products
✔ Define If Addon Price Should Be Switched With Linked Product Price
✔ Assign Custom Promo Codes To Relations
✔ View, Filter And Delete Existing Connections
✔ View Error Logs
  • Client Area Features:
✔ Buy Multiple Products, Addons And Configurable Options By Ordering At Least One Of Them
✔ View Linked Product Added To Order By Triggering Relation
  • 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 Odin Key Administrator For WHMCS - Easy Odin Licenses Reselling (read more)
✔ Multi-Language Support
✔ Supports PHP 5.3 Up To PHP 7
✔ Supports WHMCS V6 and V7

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

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

File is located in '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 in 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.

PL2 5.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'.

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

There, press 'Enable Debug Logging'.

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

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

PL2 8.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.

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.

Note: For 'Addon' type there is also 'Swap Price' option available. If you select it, the price of the linked hosting/product will be overwritten with the addon price.

PL2 9.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.

PL2 10.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.

PL2 11.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, otherwise use 'Save Changes' at the bottom of the page (pointed with a green arrow).

PL2 12.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 copying (if possible). Press 'Add Relation' to save relation.

PL2 12 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.

PL2 12 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.

PL2 13.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.

PL2 14.png
You can use filters to display only specific records.

To open filters form, press 'Toggle Filters'.

PL2 15.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).

PL2 16.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.

PL2 17.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

In 'Settings' section you may manage the promo codes assignment to linked products and add some information to the order form.

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

PL2 17 1.png
3. Display Product Info - if this option is selected in 'Settings' section, there is information visible on the linked product on the order form.
PL2 17 2.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 Odin 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.
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 cPanel Manage2 with 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.

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

Confirm changes through pressing 'Save Changes'.

PL2 19.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'.

PL2 20.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'.

PL2 21.png
5. Now, create relation at your 'Product Linker' 'Basic Relations'.
PL2 22.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'.

PL2 23.png
Select 'Run Module Create' and press 'Accept Order'.
PL2 24.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.
PL2 25.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 by 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.

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

Confirm changes through pressing 'Save Changes'.

PL2 27.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'.

PL2 28.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'.

PL2 29.png
5. Now, create a relation at your 'Product Linker' 'Basic Relations'.
Note that 'Swap Price' option has been also marked here. Consequently, the price for the addon will be changed with the price for the linked product/hosting.
PL2 30.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 in the domain and IP address. Afterwards, press 'Submit Order'.

PL2 31.png
Select 'Run Module Create' and press 'Accept Order'.
PL2 32.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.
PL2 33.png

Virtuozzo VPS + Odin Key Administrator

In these steps we will show you how to link Odin Key Administrator with Virtuozzo VPS through a product addon.

It is required to set a key type in your 'Odin Key Administrator' → 'Module Settings' to 'VIRTUOZZO'.
Only in this way a linked product will create a license for Virtuozzo VPS 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.

PL2 34.png
1. Start by 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 VirtuozzoVPS product.

PL2 35.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'.

PL2 36.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'.

PL2 37.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 'Odin Group - VirtuozzoVPS'.
Next, press 'Save Changes'.

PL2 38.png
5. Now, create a relation at your 'Product Linker' 'Basic Relations'.
PL2 39.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'.

PL2 40.png
Select 'Run Module Create' and press 'Accept Order'.
PL2 41.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.
PL2 42.png

Plesk Extended + Odin Key Administrator

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

There are a few key types in your Odin Key Administrator that are licenses for Plesk 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.

PL2 43.png
1. Start by 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 Plesk Extended product.

PL2 44.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'.

PL2 45.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'.

PL2 46.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.
You also have to mark 'Show on Order' checkbox and checkbox next to the main product. In this example it will be 'Odin Group - Plesk Extended'.
Next, press 'Save Changes'.

PL2 47.png
5. Now, create a relation at your 'Product Linker' 'Basic Relations'.
PL2 48.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'.

PL2 49.png
Select 'Run Module Create' and press 'Accept Order'.
PL2 50.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.
PL2 51.png

Client Area

At this section we will try to visualize how a client may benefit from the connections made between certain products.

Let's take a look at an exemplary situation.

Administrator has created a connection between a VPS product: VPS 2x2.4GHz 16 GB RAM, 1TB HDD

and allowed to purchase two addons along with it:
- cPanel License
- Direct Admin License
Our Test Tester client decided to add cPanel License to the cart next to the VPS product.
Thanks to the connection created in Product Linker addon, the final price is lower than as if the two items were ordered separately.

PL2 52.png
When items are activated, client may see their pricing on the products list.
PL2 53.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.
3. If a child product is at the same time a parent product in the other relation, changes made on its parent will be also commanded on its child.
4. Keep in mind that the second product, linked by the module, is never visible in the cart. It is automatically added once the first one is activated.

Common Problems

1. When you have problems with connection, check whether your SELinux or firewall does not block ports.
Navigation
WHMCS Modules
WHMCS Widgets
Tools And Applications
Translations
General
FAQ
Community