|
|
| (507 intermediate revisions by 5 users not shown) |
| Line 1: |
Line 1: |
| − | <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="keywords" content="hosting quota notifications for whmcs, hosting quota notifications configuration, whmcs hosting quota notifications management, whmcs hosting quota notifications installation, whmcs hosting quota notifications common problems, about whmcs hosting quota notifications, whmcs hosting quota notifications documentation, whmcs hosting quota notifications faq, whmcs hosting quota notifications help, whmcs hosting quota notifications guide, whmcs hosting quota notifications wiki, whmcs hosting quota notifications tutorial, whmcs hosting quota notifications tips, whmcs hosting quota notifications wiki"></meta> |
| − | <meta name="description" content="ModulesGarden Wiki Contains All The Information You Need About The Product Linker For WHMCS Module."></meta> | + | <meta name="description" content="ModulesGarden Wiki Contains All The Information You Need About The Hosting Quota Notifications For WHMCS Module."></meta> |
| | | | |
| − | =About [https://www.modulesgarden.com/products/whmcs/product-linker Product Linker For WHMCS]= | + | =About [https://www.modulesgarden.com/products/whmcs/hosting-quota-notifications Hosting Quota Notifications For WHMCS]= |
| | {| | | {| |
| − | |style="padding: 10px 0px 5px 0px;"|'''Product Linker For WHMCS''' allows you to create relations between your products, addons and configurable options. <br/> | + | |style="padding: 10px 0px 10px 0px;"|'''Hosting Quota Notifications For WHMCS''' allows you to send automatic notifications to your clients whenever they exceed previously set bandwidth or disk usage. |
| − | Consequently, clients may buy products in bundles along with flexible promo codes.<br />
| + | Notifications can be sent in two ways: upon exceeding given resource tier or after exceeding given resource limit in a specified time period.<br /> |
| − | Module will also allow you to view, filter and delete existing connections used by your customers.
| + | You can also define email templates and view details of each sent notification owing to logs. |
| | |} | | |} |
| − | <!--fix by comment, awesome--> | + | <!--a comment maybe? --> |
| − | *'''Automation Features:''' | + | *'''Admin Area Features:''' |
| | {| | | {| |
| − | |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: 10px 0px 0px 30px;"|✔ Automatically Notify Your Clients Upon Exceeding Defined Limits Of Bandwidth And Disk Usage |
| | |} | | |} |
| | {| | | {| |
| − | |style="padding: 0px 0px 0px 30px;"|✔ Enable Product Updates With Automatic Email Notifications Sent To Administrators | + | |style="padding: 0px 0px 0px 30px;"|✔ Configure Notification Groups |
| | |} | | |} |
| | {| | | {| |
| − | |style="padding: 0px 0px 10px 30px;"|✔ Copy Configurable Options From Parent To Child Product | + | |style="padding: 0px 0px 0px 30px;"|✔ Choose Between Two Types Of Group Counting: |
| | |} | | |} |
| − | *'''Admin Area Features:'''
| |
| | {| | | {| |
| − | |style="padding: 10px 0px 0px 30px;"|✔ Define Relations Between Chosen Product, Addons, Configurable Options And Linked Products | + | |style="padding: 0px 0px 0px 45px;"|✔ Tiered - Define Tiers Of Usage |
| | |} | | |} |
| | {| | | {| |
| − | |style="padding: 0px 0px 0px 30px;"|✔ Define If Addon Price Should Be Switched With Linked Product Price | + | |style="padding: 0px 0px 0px 45px;"|✔ Fixed - Define Usage Grow Over Time |
| | |} | | |} |
| | {| | | {| |
| − | |style="padding: 0px 0px 0px 30px;"|✔ Assign Custom Promo Codes To Relations | + | |style="padding: 0px 0px 0px 30px;"|✔ Assign Multiple Products To Single Notification Group |
| | |} | | |} |
| | {| | | {| |
| − | |style="padding: 0px 0px 0px 30px;"|✔ View, Filter And Delete Existing Connections | + | |style="padding: 0px 0px 0px 30px;"|✔ Assign Email Templates Per Notification Group |
| | |} | | |} |
| | {| | | {| |
| − | |style="padding: 0px 0px 10px 30px;"|✔ View Error Logs | + | |style="padding: 0px 0px 0px 30px;"|✔ Enable/Disable Notification Groups |
| | |} | | |} |
| − | *'''Client Area Features:'''
| |
| | {| | | {| |
| − | |style="padding: 10px 0px 0px 30px;"|✔ Buy Multiple Products, Addons And Configurable Options By Ordering At Least One Of Them | + | |style="padding: 0px 0px 10px 30px;"|✔ View Logs Of Sent Notifications |
| | |} | | |} |
| − | {|
| |
| − | |style="padding: 0px 0px 10px 30px;"|✔ View Linked Product Added To Order By Triggering Relation
| |
| − | |}
| |
| − |
| |
| | *'''General Info:''' | | *'''General Info:''' |
| | {| | | {| |
| − | |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: 10px 0px 0px 30px;"|✔ Multi-Language Support |
| | |} | | |} |
| | {| | | {| |
| − | |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 30px;"|✔ Supports PHP 5.6 Up To PHP 7.2 |
| | |} | | |} |
| | {| | | {| |
| − | |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 30px 30px;"|✔ Supports WHMCS V7 |
| − | |}
| + | |
| − | {|
| + | |
| − | |style="padding: 0px 0px 0px 30px;"|✔ Multi-Language Support
| + | |
| − | |}
| + | |
| − | {|
| + | |
| − | |style="padding: 0px 0px 0px 30px;"|✔ Supports PHP 5.3 Up To PHP 7
| + | |
| − | |}
| + | |
| − | {|
| + | |
| − | |style="padding: 0px 0px 30px 30px;"|✔ Supports WHMCS V6 and V7 | + | |
| | |} | | |} |
| | | | |
| | =Installation= | | =Installation= |
| | {| | | {| |
| − | |style="padding: 10px 0px 0px 0px;"|'''This tutorial will show you how to successfully install Product Linker For WHMCS.''' <br /> | + | |style="padding: 10px 0px 30px 15px;"|'''This tutorial will show you how to successfully install and configure Hosting Quota Notifications For WHMCS.''' <br /> |
| − | We will guide you step by step through the whole installation and configuration process. <br /> | + | We will guide you step by step through the whole installation and configuration process. |
| | |} | | |} |
| | + | ==Installation== |
| | {| | | {| |
| − | |style="padding: 20px 0px 20px 15px;"|'''1. Log in to your client area and download the module.''' | + | |style="padding: 10px 0px 20px 15px;"|'''1. Log in to our client area and download the module.''' |
| | |} | | |} |
| | {| | | {| |
| − | |style="padding: 0px 0px 20px 25px;"|[[File:PL1.png]] | + | |style="padding: 0px 0px 20px 25px;"|[[File:HQN_1.png]] |
| | |} | | |} |
| | {| | | {| |
| − | |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 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 5.6 up to PHP 7.0, while the second one is aimed at PHP 7.1 up to PHP 7.2.<br/>It does not apply to open source versions.<br/> |
| − | '' '''Note''': You can check current PHP version in your WHMCS. To do so proceed to ''' 'Utilities' → 'System' → 'PHP Info'.''' | + | '' '''Note''': You can check the current PHP version in your WHMCS. To do so, proceed to ''' 'Utilities' › 'System' › 'PHP Info'.''' |
| | |} | | |} |
| | {| | | {| |
| − | |style="padding: 0px 0px 20px 25px;"|[[File:PL2.png]] | + | |style="padding: 0px 0px 20px 25px;"|[[File:PHP56_72.png]] |
| | |} | | |} |
| | {| | | {| |
| Line 86: |
Line 72: |
| | |} | | |} |
| | {| | | {| |
| − | |style="padding: 0px 0px 20px 25px;"|[[File:gfhdr.png]] | + | |style="padding: 0px 0px 20px 25px;"|[[File:drfere.png]] |
| | |} | | |} |
| | {| | | {| |
| − | |style="padding: 0px 0px 15px 15px;"|'''4. When you install Product Linker For WHMCS for the first time you have to rename '' 'license_RENAME.php' '' file.'''<br /> | + | |style="padding: 0px 0px 15px 15px;"|'''4. When you install Hosting Quota Notifications For WHMCS 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'. '' | + | File is located in '' 'modules/addons/hosting_quota_notifications/license_RENAME.php' '' . Rename it from '' 'license_RENAME.php' '' to '' 'license.php' '' . |
| | |} | | |} |
| | {| | | {| |
| − | |style="padding: 0px 0px 20px 25px;"|[[File:PL3.png]] | + | |style="padding: 0px 0px 20px 25px;"|[[File:HQN_3.png]] |
| | |} | | |} |
| | {| | | {| |
| − | |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 15px 15px;"|'''5. 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'. '' | + | Enter your license key between quotation marks as presented on the following screen. You can find your license key in our client area'' → 'My Products' ''. |
| | |} | | |} |
| | {| | | {| |
| − | |style="padding: 0px 0px 20px 25px;"|[[File:PL4.png]] | + | |style="padding: 0px 0px 30px 25px;"|[[File:HQN_4.png]] |
| | |} | | |} |
| | + | |
| | + | ==Configuration of Addon== |
| | {| | | {| |
| − | |style="padding: 0px 0px 15px 15px;"|'''6. Now you have to activate the module in your WHMCS system.'''<br /> | + | |style="padding: 10px 0px 15px 15px;"|'''6. 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. | + | Log in to your WHMCS admin area. Go to '' 'Setup' '' → '' 'Addon Modules' ''. Afterwards, find '' 'Hosting Quota Notifications' '' and press '' 'Activate' '' button. |
| | |} | | |} |
| | {| | | {| |
| − | |style="padding: 0px 0px 20px 25px;"|[[File:PL2_5.png]] | + | |style="padding: 0px 0px 20px 25px;"|[[File:HQN_5.png]] |
| | |} | | |} |
| | {| | | {| |
| | |style="padding: 0px 0px 15px 15px;"|'''7. In the next step you need to permit access to this module.'''<br /> | | |style="padding: 0px 0px 15px 15px;"|'''7. 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'. '' | + | To do so click on '' 'Configure' '' button, tick '' 'Access Control' '' near required admin role groups and press '' 'Save Changes' ''. |
| | |} | | |} |
| | {| | | {| |
| − | |style="padding: 0px 0px 20px 25px;"|[[File:PL2_6.png]] | + | |style="padding: 0px 0px 30px 25px;"|[[File:HQN_6.png]] |
| − | |}
| + | |
| − | {|
| + | |
| − | |style="padding: 0px 0px 15px 15px;"|'''8. To enable logs from failed actions, go to '' 'Utilities' '' → '' 'Logs' '' → '' 'Module Log'. '' '''<br />
| + | |
| − | There, press '' 'Enable Debug Logging'. ''
| + | |
| − | |}
| + | |
| − | {|
| + | |
| − | |style="padding: 0px 0px 20px 25px;"|[[File:PL2_7.png]]
| + | |
| | |} | | |} |
| | + | |
| | {| | | {| |
| − | |style="padding: 0px 0px 15px 15px;"|'''9. You have just successfully installed Product Linker For WHMCS!'''<br /> | + | |style="padding: 0px 0px 15px 15px;"|'''8. You have just successfully installed Hosting Quota Notifications For WHMCS!'''<br /> |
| − | You can access your module at '' 'Addons' '' → '' 'Product Linker'. '' | + | You can access your module in '' 'Addons' '' → '' 'Hosting Quota Notifications' ''. |
| | |} | | |} |
| | {| | | {| |
| − | |style="padding: 0px 0px 30px 25px;"|[[File:PL2_8.png]] | + | |style="padding: 0px 0px 30px 25px;"|[[File:HQN_7.png]] |
| | |} | | |} |
| | | | |
| | =Configuration and Management= | | =Configuration and Management= |
| | {| | | {| |
| − | |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 /> | + | |style="padding: 10px 0px 30px 15px;"|'''In this section we will show you how to properly set up and use Hosting Quota Notifications For WHMCS.''' |
| − | 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 />
| + | |
| | |} | | |} |
| − | ==Basic Relations== | + | ==Configuration== |
| | {| | | {| |
| − | |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 15px 15px;"|In '' 'Configuration' '' page you can find the list of configured notification groups.<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 />
| + | You can enable/disable any of them, as well as alter or completely remove them.<br /> |
| − | Additionally, you can define a promo code added to the order by triggering the relation.
| + | Press '' 'Create New Group' '' to proceed. |
| | |} | | |} |
| − | ===Add Relation===
| |
| | {| | | {| |
| − | |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/> | + | |style="padding: 0px 0px 20px 25px;"|[[File:HQN_9.png]] |
| − | ''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 20px 25px;"|[[File:PL2_9.png]] | + | |style="padding: 0px 0px 15px 15px;"|Now, you can define all products related to this configuration and email template which will be used to notify your clients.<br /> |
| | + | You can choose between two types of resource usage counting:<br /> |
| | + | *Fixed - define amount of resources over specific time period. If client usage growth has exceeded the given limit in specified time, a notification will be sent. |
| | + | *Tiered - defines amount of resources. If client exceeds given limit, a notification will be sent. |
| | |} | | |} |
| | {| | | {| |
| − | |style="padding: 0px 0px 15px 15px;"|Next, select product addon or configurable option name from '' 'Product Addon/Configurable Option' '' dropdown menu.<br /> | + | |style="padding: 0px 0px 20px 25px;"|[[File:HQN_10.png]] |
| − | If you have chosen '' 'Configurable option' '' relation type, additionally you have to select a configurable option value.
| + | |
| | |} | | |} |
| | {| | | {| |
| − | |style="padding: 0px 0px 20px 25px;"|[[File:PL2_10.png]] | + | |style="padding: 0px 0px 15px 15px;"|For example, shown below module uses fixed counting type.<br /> |
| | + | As you can see, we have defined limits for both bandwidth and disk.<br /> |
| | + | Settings shown below result in sending notification to client upon: |
| | + | *bandwidth usage growth by 5GB during 21 days. |
| | + | *disk usage growth by 100GB over period of 14 days. |
| | |} | | |} |
| | {| | | {| |
| − | |style="padding: 0px 0px 15px 15px;"|Finish through selecting child product which will be linked after triggering the relation.<br /> | + | |style="padding: 0px 0px 30px 25px;"|[[File:HQN_11.png]] |
| − | 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.''
| + | |
| | |} | | |} |
| | + | ==Logs== |
| | {| | | {| |
| − | |style="padding: 0px 0px 30px 25px;"|[[File:PL2_11.png]] | + | |style="padding: 10px 0px 15px 15px;"|Under '' 'Logs' '' page you can view information about sent notifications. |
| | |} | | |} |
| − |
| |
| − | ===Edit Relation===
| |
| | {| | | {| |
| − | |style="padding: 10px 0px 15px 15px;"|Editing relations is quite easy, go to '' 'Basic Relations' '' tab and start making changes.<br /> | + | |style="padding: 0px 0px 30px 25px;"|[[File:HQN_12.png]] |
| − | 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).
| + | |
| | |} | | |} |
| | + | ==Notifications== |
| | {| | | {| |
| − | |style="padding: 0px 0px 30px 25px;"|[[File:PL2_12.png]] | + | |style="padding: 10px 0px 15px 15px;"|You can create as many notifications as you wish.<br /> |
| | + | The only requirement is their type being set to '' 'Product/Service' ''.<br /> |
| | + | Additionally, you can use {if} statement, as shown below: |
| | + | {if $bw_over} Your bandwidth usage is over {$bw_over}MB{if $bw_current} (current: {$bw_current}MB){/if}.{/if} |
| | + | {if $disk_over}Your disks usage is over {$disk_over}MB{if $disk_current} (current: {$disk_current}MB){/if}.{/if} |
| | + | It will allow you to use this email template for bandwidth and disk notifications at the same time. |
| | |} | | |} |
| − |
| |
| − | ==Product Relations==
| |
| | {| | | {| |
| − | |style="padding: 10px 0px 15px 15px;"|At '' 'Product Relations' '' tab you can set up relation linking one product with another.<br />
| + | |style="padding: 0px 0px 30px 25px;"|[[File:HQN_13.png]] |
| − | 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 20px 25px;"|[[File:PL2_12_1.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 25px;"|[[File:PL2_12_2.png]] | + | |
| | |} | | |} |
| | | | |
| − | ==Existing Connections== | + | =Tips= |
| | {| | | {| |
| − | |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 30px 15px;"| |
| − | 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:PL2_13.png]]
| + | |
| − | |}
| + | |
| − | {|
| + | |
| − | |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 />
| + | |
| − | For example, to order by client name, press on '' 'Client Name' '' column header as shown on the following screen.
| + | |
| − | |}
| + | |
| − | {|
| + | |
| − | |style="padding: 0px 0px 20px 25px;"|[[File:PL2_14.png]]
| + | |
| − | |}
| + | |
| − | {|
| + | |
| − | |style="padding: 0px 0px 15px 15px;"|You can use filters to display only specific records.<br />
| + | |
| − | To open filters form, press '' 'Toggle Filters'. ''
| + | |
| − | |}
| + | |
| − | {|
| + | |
| − | |style="padding: 0px 0px 20px 25px;"|[[File:PL2_15.png]]
| + | |
| − | |}
| + | |
| − | {|
| + | |
| − | |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:PL2_16.png]]
| + | |
| | |} | | |} |
| | | | |
| − | ==Module Logs== | + | =Update Instructions= |
| | {| | | {| |
| − | |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 /> | + | |style="padding: 10px 0px 30px 15px;"|Essential guidance through the process of updating the module is offered '''[https://www.docs.modulesgarden.com/How_To_Update_WHMCS_Module here]'''.<br/><br/> |
| − | Error message can be found at '' 'Clean Response' '' and '' 'Parsed Response' '' column.<br />
| + | Keep in mind there is a quick and easy option in our client area that will let you upgrade the license of your module to an open source version at any time - and at a lower price!<br/> |
| − | To locate products for which error occurred, you can use data at '' 'Request Parameters' '' column.<br />
| + | To take advantage of it, simply use the '''License Upgrade''' button located on the product's page and a discounted invoice will be generated automatically.<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:PL2_17.png]]
| |
| − | |}
| |
| − | {|
| |
| − | |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: 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 25px;"|[[File:PL2_17_1.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 30px 25px;"|[[File:PL2_17_2.png]]
| |
| − | |}
| |
| − |
| |
| − | ==Exemplary Connections==
| |
| − | {|
| |
| − | |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: 10px 0px 15px 15px;"|In these steps we will show you how to link cPanel Manage2 with cPanel Extended through the product addon.<br />
| |
| − | ''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 20px 25px;"|[[File:PL2_18.png]]
| |
| − | |}
| |
| − |
| |
| − | {|
| |
| − | |style="padding: 0px 0px 15px 15px;"|2. Open '' 'Custom Fields' '' tab, enter '' 'IP' '' into '' 'Field Name' '' and mark '' 'Show on Order Form' '' checkbox.<br />
| |
| − | Confirm changes through pressing '' 'Save Changes'. ''
| |
| − | |}
| |
| − | {|
| |
| − | |style="padding: 0px 0px 20px 25px;"|[[File:PL2_19.png]]
| |
| − | |}
| |
| − | {|
| |
| − | |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:PL2_20.png]]
| |
| − | |}
| |
| − | {|
| |
| − | |style="padding: 0px 0px 15px 15px;"|4. Enter addon name, its description and recurring price. Choose billing cycle from '' 'Billing Cycle' '' dropdown menu.<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 />
| |
| − | Next, press '' 'Save Changes'. ''
| |
| − | |}
| |
| − | {|
| |
| − | |style="padding: 0px 0px 20px 25px;"|[[File:PL2_21.png]]
| |
| − | |}
| |
| − | {|
| |
| − | |style="padding: 0px 0px 20px 15px;"|5. Now, create relation at your '' 'Product Linker' '' → '' 'Basic Relations'. ''
| |
| − | |}
| |
| − | {|
| |
| − | |style="padding: 0px 0px 20px 25px;"|[[File:PL2_22.png]]
| |
| − | |}
| |
| − | {|
| |
| − | |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 the domain and IP address. Afterwards, press '' 'Submit Order'. ''
| |
| − | |}
| |
| − | {|
| |
| − | |style="padding: 0px 0px 20px 25px;"|[[File:PL2_23.png]]
| |
| − | |}
| |
| − | {|
| |
| − | |style="padding: 0px 0px 20px 15px;"|Select '' 'Run Module Create' '' and press '' 'Accept Order'. ''
| |
| − | |}
| |
| − | {|
| |
| − | |style="padding: 0px 0px 20px 25px;"|[[File:PL2_24.png]]
| |
| − | |}
| |
| − | {|
| |
| − | |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:PL2_25.png]]
| |
| − | |}
| |
| − |
| |
| − | ===DirectAdmin Extended + DirectAdmin Licenses===
| |
| − | {|
| |
| − | |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 />
| |
| − | 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.
| |
| − | |}
| |
| − | {|
| |
| − | |style="padding: 0px 0px 20px 25px;"|[[File:PL2_26.png]]
| |
| − | |}
| |
| − |
| |
| − | {|
| |
| − | |style="padding: 0px 0px 15px 15px;"|2. Open '' 'Custom Fields' '' tab, enter '' 'IP' '' into '' 'Field Name' '' and mark '' 'Show on Order Form' '' checkbox.<br />
| |
| − | Confirm changes through pressing '' 'Save Changes'. ''
| |
| − | |}
| |
| − | {|
| |
| − | |style="padding: 0px 0px 20px 25px;"|[[File:PL2_27.png]]
| |
| − | |}
| |
| − | {|
| |
| − | |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:PL2_28.png]]
| |
| − | |}
| |
| − | {|
| |
| − | |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:PL2_29.png]]
| |
| − | |}
| |
| − | {|
| |
| − | |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.
| |
| − | |}
| |
| − | {|
| |
| − | |style="padding: 0px 0px 20px 25px;"|[[File:PL2_30.png]]
| |
| − | |}
| |
| − | {|
| |
| − | |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:PL2_31.png]]
| |
| − | |}
| |
| − | {|
| |
| − | |style="padding: 0px 0px 20px 15px;"|Select '' 'Run Module Create' '' and press '' 'Accept Order'. ''
| |
| − | |}
| |
| − | {|
| |
| − | |style="padding: 0px 0px 20px 25px;"|[[File:PL2_32.png]]
| |
| − | |}
| |
| − | {|
| |
| − | |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 30px 25px;"|[[File:PL2_33.png]]
| |
| − | |}
| |
| − |
| |
| − | ===Virtuozzo VPS + Odin Key Administrator===
| |
| − | {|
| |
| − | |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 20px 25px;"|[[File:PL2_34.png]]
| |
| − | |}
| |
| − | {|
| |
| − | |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 20px 25px;"|[[File:PL2_35.png]]
| |
| − | |}
| |
| − | {|
| |
| − | |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 20px 25px;"|[[File:PL2_36.png]]
| |
| − | |}
| |
| − | {|
| |
| − | |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:PL2_37.png]]
| |
| − | |}
| |
| − | {|
| |
| − | |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 20px 25px;"|[[File:PL2_38.png]]
| |
| − | |}
| |
| − | {|
| |
| − | |style="padding: 0px 0px 20px 15px;"|5. Now, create a relation at your '' 'Product Linker' '' → '' 'Basic Relations'. ''
| |
| − | |}
| |
| − | {|
| |
| − | |style="padding: 0px 0px 20px 25px;"|[[File:PL2_39.png]]
| |
| − | |}
| |
| − | {|
| |
| − | |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 IP address. Afterwards, press '' 'Submit Order'. ''
| |
| − | |}
| |
| − | {|
| |
| − | |style="padding: 0px 0px 20px 25px;"|[[File:PL2_40.png]]
| |
| − | |}
| |
| − | {|
| |
| − | |style="padding: 0px 0px 20px 15px;"|Select '' 'Run Module Create' '' and press '' 'Accept Order'. ''
| |
| − | |}
| |
| − | {|
| |
| − | |style="padding: 0px 0px 20px 25px;"|[[File:PL2_41.png]]
| |
| − | |}
| |
| − | {|
| |
| − | |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 30px 25px;"|[[File:PL2_42.png]]
| |
| − | |}
| |
| − |
| |
| − | ===Plesk Extended + Odin Key Administrator===
| |
| − | {|
| |
| − | |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 />
| |
| − | 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 20px 25px;"|[[File:PL2_43.png]]
| |
| − | |}
| |
| − | {|
| |
| − | |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 />
| |
| − | Go to '' 'Setup' '' → '' 'Products/Services' '' → '' 'Products/Services' '' and edit your Plesk Extended product.
| |
| − | |}
| |
| − | {|
| |
| − | |style="padding: 0px 0px 20px 25px;"|[[File:PL2_44.png]]
| |
| − | |}
| |
| − | {|
| |
| − | |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 20px 25px;"|[[File:PL2_45.png]]
| |
| − | |}
| |
| − | {|
| |
| − | |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:PL2_46.png]]
| |
| − | |}
| |
| − | {|
| |
| − | |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 />
| |
| − | 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 />
| |
| − | Next, press '' 'Save Changes'. ''
| |
| − | |}
| |
| − | {|
| |
| − | |style="padding: 0px 0px 20px 25px;"|[[File:PL2_47.png]]
| |
| − | |}
| |
| − | {|
| |
| − | |style="padding: 0px 0px 20px 15px;"|5. Now, create a relation at your '' 'Product Linker' '' → '' 'Basic Relations'. ''
| |
| − | |}
| |
| − | {|
| |
| − | |style="padding: 0px 0px 20px 25px;"|[[File:PL2_48.png]]
| |
| − | |}
| |
| − | {|
| |
| − | |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:PL2_49.png]]
| |
| − | |}
| |
| − | {|
| |
| − | |style="padding: 0px 0px 20px 15px;"|Select '' 'Run Module Create' '' and press '' 'Accept Order'. ''
| |
| − | |}
| |
| − | {|
| |
| − | |style="padding: 0px 0px 20px 25px;"|[[File:PL2_50.png]]
| |
| − | |}
| |
| − | {|
| |
| − | |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 30px 25px;"|[[File:PL2_51.png]]
| |
| − | |}
| |
| − | ==Client Area==
| |
| − | {|
| |
| − | |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/>
| |
| − | Let's take a look at an exemplary situation.
| |
| − | |}
| |
| − | {|
| |
| − | |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 20px 25px;"|[[File:PL2_52.png]]
| |
| − | |}
| |
| − | {|
| |
| − | |style="padding: 0px 0px 20px 15px;"|When items are activated, client may see their pricing on the products list.
| |
| − | |}
| |
| − | {|
| |
| − | |style="padding: 0px 0px 30px 25px;"|[[File:PL2_53.png]]
| |
| − | |}
| |
| − |
| |
| − | =Tips=
| |
| − | {|
| |
| − | |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 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 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.''
| |
| − | |}
| |
| − | {|
| |
| − | |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.
| |
| − | |}
| |
| − |
| |
| | =Common Problems= | | =Common Problems= |
| | {| | | {| |
| − | |style="padding: 10px 0px 10px 15px;"|'''1. When you have problems with connection, check whether your SELinux or firewall does not block ports.''' | + | |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;"|
| + | |
| | |} | | |} |
