Premium Support Tickets For WHMCS
From ModulesGarden Wiki
(Difference between revisions)
(→About Premium Support Tickets For WHMCS) |
|||
| (24 intermediate revisions by 6 users not shown) | |||
| Line 4: | Line 4: | ||
=About [https://www.modulesgarden.com/products/whmcs/premium-support-tickets Premium Support Tickets For WHMCS]= | =About [https://www.modulesgarden.com/products/whmcs/premium-support-tickets Premium Support Tickets For WHMCS]= | ||
{| | {| | ||
| − | |style="padding: 10px 0px 10px 0px;"|'''Premium Support Tickets For WHMCS''' will allow you to control | + | |style="padding: 10px 0px 10px 0px;"|'''Premium Support Tickets For WHMCS''' will allow you to control access to your support services and charge fees for submitting tickets into certain departments.<br /> |
| − | The module enables your clients to purchase products and product addons containing | + | The module enables your clients to purchase products and product addons containing ''Support Credit Points'' used for opening support tickets in chosen departments.<br /> |
| + | At the same time, you will be free to establish rules for credit points application, and closely supervise each action taken by your customers. | ||
|} | |} | ||
<!-- fixed --> | <!-- fixed --> | ||
*'''Module Features:''' | *'''Module Features:''' | ||
{| | {| | ||
| − | |style="padding: 10px 0px 0px 30px;"|✔ | + | |style="padding: 10px 0px 0px 30px;"|✔ Store And Manage Support Credit Points: |
|} | |} | ||
{| | {| | ||
| − | |style="padding: 0px 0px 0px | + | |style="padding: 0px 0px 0px 45px;"|✔ Dedicated Points - Used Only For Specific Departments |
|} | |} | ||
{| | {| | ||
| − | |style="padding: 0px 0px 0px | + | |style="padding: 0px 0px 0px 45px;"|✔ Shared Points - Used Freely Among All Selected Departments |
|} | |} | ||
{| | {| | ||
| − | |style="padding: 0px 0px | + | |style="padding: 0px 0px 0px 30px;"|✔ Add Support Credit Points Upon Ordering Specified Product Or Addon - Depending On Applied Rule |
|} | |} | ||
| + | {| | ||
| + | |style="padding: 0px 0px 0px 30px;"|✔ Remove Fixed Number Of Support Credit Points Upon Ticket Opening | ||
| + | |} | ||
| + | {| | ||
| + | |style="padding: 0px 0px 10px 30px;"|✔ Block Ticket Opening If Client Has Insufficient Number Of Support Credit Points | ||
| + | |} | ||
| + | |||
*'''Admin Area Features:''' | *'''Admin Area Features:''' | ||
{| | {| | ||
|style="padding: 10px 0px 0px 30px;"|✔ Define Number Of Support Credit Points Required To Open Ticket - According To Chosen Department And Priority | |style="padding: 10px 0px 0px 30px;"|✔ Define Number Of Support Credit Points Required To Open Ticket - According To Chosen Department And Priority | ||
| + | |} | ||
| + | {| | ||
| + | |style="padding: 0px 0px 0px 30px;"|✔ Define Shared Points Departments | ||
|} | |} | ||
{| | {| | ||
| Line 52: | Line 63: | ||
|} | |} | ||
{| | {| | ||
| − | |style="padding: 0px 0px 0px 30px;"|✔ Define Items | + | |style="padding: 0px 0px 0px 30px;"|✔ Define Items That Shall Be Ordered By Client To Obtain Support Credit Points |
|} | |} | ||
{| | {| | ||
| − | |style="padding: 0px 0px 0px 30px;"|✔ Define Number Of | + | |style="padding: 0px 0px 0px 30px;"|✔ Define Number Of Dedicated Points And Select Departments They Should Be Added To |
|} | |} | ||
{| | {| | ||
| − | |style="padding: 0px 0px 0px 30px;"|✔ Define | + | |style="padding: 0px 0px 0px 30px;"|✔ Define Number Of Shared Points To Be Applied To Client's Account |
|} | |} | ||
{| | {| | ||
| − | |style="padding: 0px 0px 0px 30px;"|✔ Define | + | |style="padding: 0px 0px 0px 30px;"|✔ Define If Support Credit Points Are Added To Client's Account Once Or After Each Billing Cycle |
|} | |} | ||
{| | {| | ||
| Line 71: | Line 82: | ||
|} | |} | ||
{| | {| | ||
| − | |style="padding: 0px 0px 0px 30px;"|✔ Supports PHP | + | |style="padding: 0px 0px 0px 30px;"|✔ Supports PHP 8.1 Back To PHP 7.4 |
|} | |} | ||
{| | {| | ||
| − | |style="padding: 0px 0px 0px 30px;"|✔ Supports WHMCS | + | |style="padding: 0px 0px 0px 30px;"|✔ Supports WHMCS Themes "Six", "Twenty-One" And "Lagom WHMCS Client Theme" |
|} | |} | ||
{| | {| | ||
| − | |style="padding: 0px 0px | + | |style="padding: 0px 0px 0px 30px;"|✔ Supports WHMCS V8.10 Back To WHMCS V8.6 |
| + | |} | ||
| + | {| | ||
| + | |style="padding: 0px 0px 0px 30px;"|✔ Requires ionCube Loader V12 Or Later | ||
| + | |} | ||
| + | {| | ||
| + | |style="padding: 0px 0px 30px 30px;"|✔ Easy [https://www.docs.modulesgarden.com/How_To_Upgrade_WHMCS_Module Module Upgrade] To [https://www.modulesgarden.com/products/whmcs/premium-support-tickets#open-source-version Open Source Version] | ||
|} | |} | ||
=Installation= | =Installation= | ||
{| | {| | ||
| − | |style="padding: 10px | + | |style="padding: 10px 0px 15px 15px;"|'''This tutorial will show you how to successfully install and configure [https://www.modulesgarden.com/products/whmcs/premium-support-tickets Premium Support Tickets For WHMCS.]''' <br /> |
We will guide you step by step through the whole installation and configuration process. | We will guide you step by step through the whole installation and configuration process. | ||
|} | |} | ||
{| | {| | ||
| − | |style="padding: | + | |style="padding: 0px 0px 20px 15px;"|'''1. Log in to our client area and download the module.''' |
|} | |} | ||
{| | {| | ||
| Line 92: | Line 109: | ||
|} | |} | ||
{| | {| | ||
| − | |style="padding: 0px 0px | + | |style="padding: 0px 0px 15px 15px;"|'''2. In the downloaded file you might find one or two packages that support different PHP versions.'''<br/> |
| − | '' '''Note''' | + | In the most recent versions of the module, you will find only one package that supports PHP 7.2 and later.<br/> <!-- If you need a package for the previous versions of PHP, please [https://www.modulesgarden.com/support/ticket/general-support contact our support]. --> |
| + | |} | ||
| + | {| | ||
| + | |style="padding: 0px 0px 20px 25px;"|[[File:PHP72_74.png]] | ||
| + | |} | ||
| + | {| | ||
| + | |style="padding: 0px 0px 15px 15px;"|'''Previous updates of the module may contain two packages dedicated to various PHP versions.'''<br/> | ||
| + | The first one that supports PHP 5.6 up to PHP 7.1, and the second one addressed to PHP 7.2 up to PHP 7.4.<br/> | ||
| + | '''''Note:''' Keep in mind that PHP versions 5.6 up to 7.1 are no longer officially supported and their security issues are not fixed or released any more. Find more info [http://php.net/supported-versions.php here].'' | ||
| + | |} | ||
| + | {| | ||
| + | |style="padding: 0px 0px 20px 25px;"|[[File:PHP56_74.png]] | ||
|} | |} | ||
{| | {| | ||
| − | |style="padding: 0px 0px | + | |style="padding: 0px 0px 10px 15px;"| <!-- '' '''Important''': This situation does not affect [https://www.modulesgarden.com/products/whmcs/premium-support-tickets#open-source-version '''the open source version'''] of this module which can be applied to any PHP from version 5.6 and later.''<br/>'' --> '''Note''': You can check the current PHP version in your WHMCS. To do so, proceed to ''' 'Utilities' → 'System' → 'PHP Info'.''' |
|} | |} | ||
{| | {| | ||
| − | |style="padding: 0px 0px 15px 15px;"|'''3. Extract the | + | |style="padding: 0px 0px 15px 15px;"|'''3. Extract the package and upload its content into the main WHMCS directory. <br/> |
| − | The content of | + | The content of the package to upload should look like this. |
|} | |} | ||
{| | {| | ||
| − | |style="padding: 0px 0px 20px 25px;"|[[File: | + | |style="padding: 0px 0px 20px 25px;"|[[File:PST_2.png]] |
|} | |} | ||
{| | {| | ||
|style="padding: 0px 0px 15px 15px;"|'''4. When you install Premium Support Tickets 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 Premium Support Tickets For WHMCS for the first time you have to rename '' 'license_RENAME.php' '' file.'''<br /> | ||
| − | File is located in '' 'modules/addons/ | + | File is located in '' '/modules/addons/PremiumSupportTickets/license_RENAME.php'. '' Rename it from '' 'license_RENAME.php' '' to '' 'license.php' '' . |
|} | |} | ||
{| | {| | ||
| Line 134: | Line 162: | ||
|} | |} | ||
{| | {| | ||
| − | |style="padding: 0px 0px 15px 15px;"|'''8. Proceed to '' 'Addons' '' → '' 'Premium Support Tickets' '' → '' 'Integration Code' '' and follow steps listed there | + | |style="padding: 0px 0px 15px 15px;"|'''8. Proceed to '' 'Addons' '' → '' 'Premium Support Tickets' '' → '' 'Integration Code' '' and follow steps listed there to apply code snippets to the theme you are using'''<br/> |
| − | + | '''WHMCS theme 'Six':'''<br/> | |
| − | Find and open file '' 'supportticketsubmit-stepone.tpl' '' located in the | + | Find and open file '' 'supportticketsubmit-stepone.tpl' '' located in the theme directory, follow the steps described below: |
|} | |} | ||
{| | {| | ||
| Line 147: | Line 175: | ||
{| | {| | ||
|style="padding: 0px 0px 20px 25px;"|[[File:PST_8.png]] | |style="padding: 0px 0px 20px 25px;"|[[File:PST_8.png]] | ||
| + | |} | ||
| + | {| | ||
| + | |style="padding: 0px 0px 15px 15px;"|'''WHMCS theme 'Twenty-One':'''<br/> | ||
| + | Find and open file '' 'supportticketsubmit-stepone.tpl' '' located in the theme directory, follow the steps described below: | ||
| + | |} | ||
| + | {| | ||
| + | |style="padding: 0px 0px 20px 25px;"|[[File:PST_8_1.png]] | ||
| + | |} | ||
| + | {| | ||
| + | |style="padding: 0px 0px 15px 15px;"|Find and open file '' 'supportticketsubmit-steptwo.tpl' '' located in the theme directory and follow the below steps: <br/> | ||
| + | ''Please mind the lines numbers, they might differ in your files!'' | ||
| + | |} | ||
| + | {| | ||
| + | |style="padding: 0px 0px 20px 25px;"|[[File:PST_8_2.png]] | ||
|} | |} | ||
{| | {| | ||
| Line 155: | Line 197: | ||
{| | {| | ||
|style="padding: 10px 0px 30px 15px;"|'''At this section we will show you possibilities of Premium Support Tickets For WHMCS.'''<br /> | |style="padding: 10px 0px 30px 15px;"|'''At this section we will show you possibilities of Premium Support Tickets For WHMCS.'''<br /> | ||
| − | Our module allows you to limit the quantity of new support tickets through introducing Support Credit Points.<br /> | + | Our module allows you to limit the quantity of new support tickets through introducing ''Support Credit Points''.<br /> |
| − | Those Support Credit Points will be required to open new tickets.<br /> | + | Those ''Support Credit Points'' will be required to open new tickets.<br /> |
| − | The amount of Support Credit Points required to do so may vary depending on tickets' status and department they are created in.<br /> | + | The amount of ''Support Credit Points'' required to do so may vary depending on tickets' status and department they are created in.<br /> |
| − | Support Credit Points may be obtained along with your products or by ordering special products or product addons. | + | ''Support Credit Points'' may be obtained along with your products or by ordering special products or product addons. |
|} | |} | ||
==Rules List== | ==Rules List== | ||
{| | {| | ||
| − | |style="padding: 10px 0px 15px 15px;"|Rules section defines which products or product addons your clients can receive Support Credit Points for.<br /> | + | |style="padding: 10px 0px 15px 15px;"|Rules section defines which products or product addons your clients can receive ''Support Credit Points'' for.<br />Additionally, they define which department they can be spent in and if they are granted one time or with product's each billing cycle.<br /> |
| − | Additionally, they define which department they can be spent in and if they are granted one time or with product's each billing cycle.<br /> | + | |
As you can see, basic information related to the rules is listed under '' 'Rules' → 'Show Rules' '' tab. | As you can see, basic information related to the rules is listed under '' 'Rules' → 'Show Rules' '' tab. | ||
|} | |} | ||
| Line 170: | Line 211: | ||
|} | |} | ||
{| | {| | ||
| − | |style="padding: 0px 0px 20px 15px;"|You can view items assigned to the rule as well as departments, which Support Credit Points will be granted to, by pressing buttons marked on the following screen. | + | |style="padding: 0px 0px 20px 15px;"|You can view items assigned to the rule as well as departments, which ''Support Credit Points'' (''Dedicated'' and ''Shared'') will be granted to, by pressing buttons marked on the following screen. |
|} | |} | ||
{| | {| | ||
| Line 182: | Line 223: | ||
|} | |} | ||
| − | ==Add Rule== | + | ===Add Rule=== |
{| | {| | ||
| − | |style="padding: 10px 0px 20px 15px;"| | + | |style="padding: 10px 0px 20px 15px;"|Lets create a new rule by pressing '' 'Add Rule' '' to proceed. |
|} | |} | ||
{| | {| | ||
| Line 190: | Line 231: | ||
|} | |} | ||
{| | {| | ||
| − | |style="padding: 0px 0px 15px 15px;"|Step 1. Fill in rule name and | + | |style="padding: 0px 0px 15px 15px;"|'''Step 1.''' Fill in rule name and choose rule type through pressing '' 'Select' '' button next to the desired item.<br /> |
| − | Item type selected here defines the type of the item, for ordering which, your clients will receive Support Credit Points. | + | Item type selected here defines the type of the item, for ordering which, your clients will receive ''Support Credit Points''. |
|} | |} | ||
{| | {| | ||
| Line 197: | Line 238: | ||
|} | |} | ||
{| | {| | ||
| − | |style="padding: 0px 0px 15px 15px;"|Step 2. Select items the order and activation of which will result in receiving Support Credit Points.<br /> | + | |style="padding: 0px 0px 15px 15px;"|'''Step 2.''' Select items the order and activation of which will result in receiving ''Support Credit Points''.<br /> |
Alternatively, you can switch '' 'Select All' '' to '' 'On', '' then, this rule will be applied to all items in the selected items type.<br /> | Alternatively, you can switch '' 'Select All' '' to '' 'On', '' then, this rule will be applied to all items in the selected items type.<br /> | ||
Press '' 'Next' '' or '' 'Step 3' '' to continue. | Press '' 'Next' '' or '' 'Step 3' '' to continue. | ||
| Line 205: | Line 246: | ||
|} | |} | ||
{| | {| | ||
| − | |style="padding: 0px 0px 15px 15px;"|Step 3. Now, define departments to apply Support Credit Points to by selecting desired ones or switching '' 'Select All' '' to '' 'On'. ''<br /> | + | |style="padding: 0px 0px 15px 15px;"|'''Step 3.''' Now, define departments to apply ''Support Credit Points'' to by selecting desired ones or switching '' 'Select All' '' to '' 'On'. ''<br /> |
| − | Next, select billing options for this rule, fill in amount of | + | Next, select billing options for this rule, you can choose one time, for credits to be applied only for the fist bough of the product, or recurring, to apply them also every time the client renews it.<br/> |
| + | |||
| + | Finally fill in amount of '' 'Dedicated Points' '' and '' 'Points' '' which will be added by the rule to client's ''Support Credit Points'' and select the rule status.<br /> | ||
| + | '' '''Note:''' If you want points to be added only for one type (''Shared'' or ''Dedicated''), leave the second one to ''' '0' ''' value. <br/>Go to [[#Tips|Tips]] and [[#Shared_Points_Departments|Shared Points Departments]] section for more information on the differences between these types.''<br/> | ||
| + | |||
Confirm creation of this rule through pressing '' 'Finish' '' button. | Confirm creation of this rule through pressing '' 'Finish' '' button. | ||
|} | |} | ||
| Line 221: | Line 266: | ||
==Department Settings== | ==Department Settings== | ||
{| | {| | ||
| − | |style="padding: 10px 0px 15px 15px;"|By default, all tickets are free to open. | + | |style="padding: 10px 0px 15px 15px;"|By default, all tickets are free to open. In the '' 'Department Settings' '' tab you can define price per ticket.<br /> |
| − | In the '' 'Department Settings' '' tab you can define price per ticket.<br /> | + | Let's set up ''Support Credit Points'' required to open tickets in the '' 'General Support' '' department.<br /> |
| − | Let's set up | + | Press '' 'Show Details' '' next to the selected department as shown on the following screen to proceed. |
| − | Press '' 'Show Details' '' next to the | + | |
|} | |} | ||
{| | {| | ||
| Line 231: | Line 275: | ||
{| | {| | ||
|style="padding: 0px 0px 15px 15px;"|Now, start by defining base price per ticket, it will be added to the price per ticket status.<br /> | |style="padding: 0px 0px 15px 15px;"|Now, start by defining base price per ticket, it will be added to the price per ticket status.<br /> | ||
| − | Afterwards, fill in the prices for low, normal and high status tickets.<br /> | + | Afterwards, fill in the additional prices for low, normal and high status tickets. They will be sum up as '' 'Total' '' with the base price.<br /> |
Confirm those settings through pressing '' 'Save'. '' | Confirm those settings through pressing '' 'Save'. '' | ||
|} | |} | ||
{| | {| | ||
|style="padding: 0px 0px 30px 25px;"|[[File:PST_18.png]] | |style="padding: 0px 0px 30px 25px;"|[[File:PST_18.png]] | ||
| + | |} | ||
| + | |||
| + | ==Shared Points Departments== | ||
| + | {| | ||
| + | |style="padding: 10px 0px 15px 15px;"|''Shared Points'' are a common support credits that are assigned to a client's account, instead by a single support departments.<br /> Thanks to this, the clients can freely distribute their shared credits among any departments you have selected here.<br/>Once the departments are chosen, the ''Support Credit Points'' will be used from a shared balance to open a ticket.<br/> | ||
| + | |||
| + | '''Important:''' If you choose departments for ''Shared Points'', this does not mean that their ''Dedicated Points'' will no longer be applied.<br/> | ||
| + | If the customer still owns a ''Dedicated Points'' for the specific department, then these credits will be used '''first''' and only after they've been run out, the ''Shared Points'' will be applied.<br/> For this reason, the number of '' 'Support Credit Points' '' balance displayed next to the specific department is shown as the '''sum''' of the ''Dedicated Points'' and ''Shared Points''.<br/> | ||
| + | |||
| + | '' '''Note:''' If you want, you can also not configure any Dedicated Points credits in the module, so all clients will only use their Shared Points freely for all chosen departments.'' | ||
| + | |} | ||
| + | {| | ||
| + | |style="padding: 0px 0px 30px 25px;"|[[File:PST_37.png]] | ||
|} | |} | ||
==Clients== | ==Clients== | ||
{| | {| | ||
| − | |style="padding: 10px 0px 15px 15px;"|In the '' 'Clients' '' tab you can view the amount of Support Credit Points owned by your clients.<br /> | + | |style="padding: 10px 0px 15px 15px;"|In the '' 'Clients' '' tab you can view the amount of ''Support Credit Points'' owned by your clients.<br /> |
You can use filter to search for a specific client. | You can use filter to search for a specific client. | ||
|} | |} | ||
| Line 259: | Line 316: | ||
|} | |} | ||
{| | {| | ||
| − | |style="padding: 0px 0px 20px 15px;"|Now, fill in the amount of Support Credit Points to be added or removed and then press '' 'Save'. '' | + | |style="padding: 0px 0px 20px 15px;"|Now, fill in the amount of ''Support Credit Points'' to be added or removed and then press '' 'Save'. '' |
|} | |} | ||
{| | {| | ||
| Line 275: | Line 332: | ||
|} | |} | ||
{| | {| | ||
| − | |style="padding: 0px 0px 15px 15px;"|Clients can view their Support Credit Points for chosen department.<br /> | + | |style="padding: 0px 0px 15px 15px;"|Clients can view their ''Support Credit Points'' for chosen department.<br /> |
Additionally, they can see the price per each ticket priority as shown on the following screen. | Additionally, they can see the price per each ticket priority as shown on the following screen. | ||
|} | |} | ||
| Line 282: | Line 339: | ||
|} | |} | ||
{| | {| | ||
| − | |style="padding: 0px 0px 15px 15px;"|As you can see the number of client's points in the department has been reduced from | + | |style="padding: 0px 0px 15px 15px;"|As you can see the number of client's points in the department has been reduced from 200 to 100 once the ticket has been correctly submitted. |
|} | |} | ||
{| | {| | ||
| Line 310: | Line 367: | ||
===New Product Addon=== | ===New Product Addon=== | ||
{| | {| | ||
| − | |style="padding: 10px 0px 15px 15px;"|3. Now, let's create a rule, which will add Support Credit Points to the new department.<br /> | + | |style="padding: 10px 0px 15px 15px;"|3. Now, let's create a rule, which will add ''Support Credit Points'' to the new department.<br /> |
| − | In our case, Support Credit Points will be added through product addon.<br /> | + | In our case, ''Support Credit Points'' will be added through product addon.<br /> |
Therefore, we need to create the product addon first.<br /> | Therefore, we need to create the product addon first.<br /> | ||
Proceed to '' 'Setup' '' → '' 'Products/Services' '' → '' 'Product Addons' '' and press '' 'Add New Addon'. '' | Proceed to '' 'Setup' '' → '' 'Products/Services' '' → '' 'Product Addons' '' and press '' 'Add New Addon'. '' | ||
| Line 319: | Line 376: | ||
|} | |} | ||
{| | {| | ||
| − | |style="padding: 0px 0px | + | |style="padding: 0px 0px 20px 15px;"|4. Fill in addon name and description. Additionally mark '' 'Show on Order' '' option. |
| − | Additionally | + | |
| − | + | ||
|} | |} | ||
{| | {| | ||
| − | |style="padding: 0px 0px | + | |style="padding: 0px 0px 20px 25px;"|[[File:PST_29.png]] |
| + | |} | ||
| + | {| | ||
| + | |style="padding: 0px 0px 20px 15px;"|5. Move to the ''Pricing'' tab, choose ''one time'' billing type, and set the desired price. | ||
| + | |} | ||
| + | {| | ||
| + | |style="padding: 0px 0px 20px 25px;"|[[File:PST_29_1.png]] | ||
| + | |} | ||
| + | {| | ||
| + | |style="padding: 0px 0px 20px 15px;"|6. Finally in ''Applicable Products'', assign desired services and proceed through pressing '' 'Save Changes' ''. | ||
| + | |} | ||
| + | {| | ||
| + | |style="padding: 0px 0px 30px 25px;"|[[File:PST_29_2.png]] | ||
|} | |} | ||
===New Rule=== | ===New Rule=== | ||
{| | {| | ||
| − | |style="padding: 10px 0px 20px 15px;"| | + | |style="padding: 10px 0px 20px 15px;"|<ol start="7"> |
| − | + | <li>Go to '' 'Addons' '' → '' 'Premium Support Ticket' '' and press '' '[[#Add_Rule|Add Rule]]'. ''</li> | |
| − | + | <li>Fill in the rule name and select '' 'Product Addon' '' rule type.</li> | |
| − | + | <li>Now, select previously created product addon and press '' 'Next'. ''</li> | |
| − | + | <li>Set up previously created department and select '' 'One Time' '' from '' 'Support Credit Points Frequency' '' dropdown menu.<br /> | |
| − | Now, fill in 200 into '' ' | + | Now, fill in 200 into '' 'Dedicated Points' '' or '' 'Shared Points' '' field and press '' 'Finish'. ''</li> |
| − | + | <li>As you can see, rule appeared in rule list and is ready for use.</li> | |
| + | </ol> | ||
|} | |} | ||
{| | {| | ||
| Line 343: | Line 411: | ||
===Department Configuration=== | ===Department Configuration=== | ||
{| | {| | ||
| − | |style="padding: 10px 0px 15px 15px;"| | + | |style="padding: 10px 0px 15px 15px;"|12. Let us now set up amount of points required to open tickets in the previously created departments.<br /> |
| − | Proceed to the '' 'Department Settings' '' tab and press '' 'Show Details' '' next to the previously created department. | + | Proceed to the '' '[[#Department_Settings|Department Settings]]' '' tab and press '' 'Show Details' '' next to the previously created department. |
|} | |} | ||
{| | {| | ||
| − | |style="padding: 0px 0px 15px 15px;"| | + | |style="padding: 0px 0px 15px 15px;"|13. Leave '' 'Required Points' '' at ''0'', and fill in '' 'Low' '', '' 'Normal' '' and '' 'High' '' ticket statuses with ''30, 60'' and ''120'' values respectively.<br /> |
Press '' 'Save' '' to confirm changes. | Press '' 'Save' '' to confirm changes. | ||
|} | |} | ||
{| | {| | ||
| − | |style="padding: | + | |style="padding: 0px 0px 30px 15px;"|[[File:PST_31.png]] |
|} | |} | ||
===Example Order=== | ===Example Order=== | ||
{| | {| | ||
| − | |style="padding: 10px 0px 20px 15px;"| | + | |style="padding: 10px 0px 20px 15px;"|14. Log in to client account and order one of product with the previously created product addon. |
|} | |} | ||
{| | {| | ||
| Line 364: | Line 432: | ||
===New Ticket=== | ===New Ticket=== | ||
{| | {| | ||
| − | |style="padding: 10px 0px 15px 15px;"| | + | |style="padding: 10px 0px 15px 15px;"|15. After payment, both the product and product addon ordered along with it are now active.<br /> |
| − | 200 Support Credit Points were granted to this account and now can be spent in '' '24/7 Support' '' department.<br /> | + | ''200 Support Credit Points'' were granted to this account and now can be spent in the '' '24/7 Support' '' department.<br /> |
|} | |} | ||
{| | {| | ||
| Line 371: | Line 439: | ||
|} | |} | ||
{| | {| | ||
| − | |style="padding: 0px 0px 15px 15px;"| | + | |style="padding: 0px 0px 15px 15px;"|16. Let us use ''Support Credit Points'' by opening a new ticket in the '' '24/7 Support' '' department with the '' 'High' '' status.<br /> |
| − | It will cost 120 Support Credit Points | + | It will cost 120 Support Credit Points. There should be 200 points on your account so you can afford creating only one ticket with the '' 'High' '' status.<br /> |
|} | |} | ||
{| | {| | ||
| Line 378: | Line 446: | ||
|} | |} | ||
{| | {| | ||
| − | |style="padding: 0px 0px 20px 15px;"| | + | |style="padding: 0px 0px 20px 15px;"|17. As you can see on the following screen, the ticket was successfully created. |
|} | |} | ||
{| | {| | ||
| Line 384: | Line 452: | ||
|} | |} | ||
{| | {| | ||
| − | |style="padding: 0px 0px 20px 15px;"| | + | |style="padding: 0px 0px 20px 15px;"|18. Adequate number of ''Support Credit Points'' was removed from the '' '24/7 Support' '' department points bundle. |
|} | |} | ||
{| | {| | ||
| Line 392: | Line 460: | ||
=Tips= | =Tips= | ||
{| | {| | ||
| − | |style="padding: 10px 0px | + | |style="padding: 10px 0px 10px 15px;"|1. It is advised to set one of the departments as free of any charge. Remember to assign it the lowest priority of support to keep the other competitive. |
| + | |} | ||
| + | {| | ||
| + | |style="padding: 0px 0px 30px 15px;"|2. Since version 1.2.0 of the module, there are '''two''' types of ''Support Credit Points'': | ||
| + | *'''Dedicated Points''' - as in previous versions of the module, these credits are assigned to departments and can only be used for these specific ones when opening a ticket | ||
| + | *'''Shared Points''' - these credits are assigned to client's account and can be freely used among departments you previously enabled | ||
| + | However, if the client owns both types of support credits, they will be displayed as a '''sum''' under the ''Support Credits Points'' balance per department, with ''dedicated points'' being used first and ''shared points'' only afterwards. | ||
|} | |} | ||
=Update Instructions= | =Update Instructions= | ||
{| | {| | ||
| − | |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/> | + | |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/> |
| − | + | Ensure successful completion of the module update by carefully following each step, thereby preventing data loss or any unforeseen issues.<br/> Additionally, you will find a current list of supplementary actions necessary for a smooth update process there.<br/> | |
| − | + | If you are upgrading the module from a version '''prior to 1.2.0''', there are also some minor changes with the '''code integration''', so remember to apply it again. | |
| + | |} | ||
| + | =Upgrade Guide= | ||
| + | {| | ||
| + | |style="padding: 10px 0px 30px 15px;"|Seeking a solution that offers greater flexibility, customization tailored to your precise needs, and unrestricted availability?<br/> There is an option that not only proves to be cost-effective in the long run but also includes prioritized support services, making it a truly valuable investment.<br/> | ||
| + | |||
| + | Opt for the [https://www.modulesgarden.com/products/whmcs/premium-support-tickets#open-source-version Open Source version] of your Premium Support Tickets For WHMCS module to unlock these benefits.<br/> Simply click on either the '''Get Source Code''' or '''Upgrade To Lifetime''' button found on the product's page in our client area to complete the one-step upgrade process, with a '''dedicated discount''' already applied.<br/> | ||
| + | |||
| + | Follow a [https://www.docs.modulesgarden.com/How_To_Upgrade_WHMCS_Module comprehensive guide] covering the transition process, the advantages it brings, and step-by-step instructions on what to do next after the order has been successfully finalized. | ||
|} | |} | ||
Latest revision as of 13:59, 26 April 2024
Contents |
[edit] About Premium Support Tickets For WHMCS
| Premium Support Tickets For WHMCS will allow you to control access to your support services and charge fees for submitting tickets into certain departments. The module enables your clients to purchase products and product addons containing Support Credit Points used for opening support tickets in chosen departments. |
- Module Features:
| ✔ Store And Manage Support Credit Points: |
| ✔ Dedicated Points - Used Only For Specific Departments |
| ✔ Shared Points - Used Freely Among All Selected Departments |
| ✔ Add Support Credit Points Upon Ordering Specified Product Or Addon - Depending On Applied Rule |
| ✔ Remove Fixed Number Of Support Credit Points Upon Ticket Opening |
| ✔ Block Ticket Opening If Client Has Insufficient Number Of Support Credit Points |
- Admin Area Features:
| ✔ Define Number Of Support Credit Points Required To Open Ticket - According To Chosen Department And Priority |
| ✔ Define Shared Points Departments |
| ✔ Create/Edit/Remove Rules |
| ✔ Enable/Disable Rules |
| ✔ View Support Credit Points Owned By Clients |
| ✔ Modify Number Of Support Credit Points Owned By Clients |
- Client Area Features:
| ✔ Order Support Credit Points |
| ✔ View Available Support Credit Points Per Ticket Department |
| ✔ View Number Of Support Credit Points Required To Open Ticket - According To Chosen Department And Priority |
- Rules Configuration:
| ✔ Set Rule Type - Product/Product Group/Product Addon |
| ✔ Define Items That Shall Be Ordered By Client To Obtain Support Credit Points |
| ✔ Define Number Of Dedicated Points And Select Departments They Should Be Added To |
| ✔ Define Number Of Shared Points To Be Applied To Client's Account |
| ✔ Define If Support Credit Points Are Added To Client's Account Once Or After Each Billing Cycle |
| ✔ View Rule Status |
- General Info:
| ✔ Multi-Language Support |
| ✔ Supports PHP 8.1 Back To PHP 7.4 |
| ✔ Supports WHMCS Themes "Six", "Twenty-One" And "Lagom WHMCS Client Theme" |
| ✔ Supports WHMCS V8.10 Back To WHMCS V8.6 |
| ✔ Requires ionCube Loader V12 Or Later |
| ✔ Easy Module Upgrade To Open Source Version |
[edit] Installation
| This tutorial will show you how to successfully install and configure Premium Support Tickets For WHMCS. We will guide you step by step through the whole installation and configuration process. |
| 1. Log in to our client area and download the module. |
|
| 2. In the downloaded file you might find one or two packages that support different PHP versions. In the most recent versions of the module, you will find only one package that supports PHP 7.2 and later. |
|
| Previous updates of the module may contain two packages dedicated to various PHP versions. The first one that supports PHP 5.6 up to PHP 7.1, and the second one addressed to PHP 7.2 up to PHP 7.4. |
|
| Note: You can check the current PHP version in your WHMCS. To do so, proceed to 'Utilities' → 'System' → 'PHP Info'. |
| 3. Extract the package and upload its content into the main WHMCS directory. The content of the package to upload should look like this. |
|
| 4. When you install Premium Support Tickets For WHMCS for the first time you have to rename 'license_RENAME.php' file. File is located in '/modules/addons/PremiumSupportTickets/license_RENAME.php'. Rename it from 'license_RENAME.php' to 'license.php' . |
|
| 5. 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 our client area → 'My Products'. |
|
| 6. 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 'Premium Support Tickets' and press 'Activate' button. |
|
| 7. In the next step you need to permit access to this module. To do so click on 'Configure' button, tick 'Access Control' near desired admin role groups and press 'Save Changes'. |
|
| 8. Proceed to 'Addons' → 'Premium Support Tickets' → 'Integration Code' and follow steps listed there to apply code snippets to the theme you are using WHMCS theme 'Six': |
|
| Find and open file 'supportticketsubmit-steptwo.tpl' located in the template directory you are using, follow the steps described below: Please mind the lines numbers, they might differ in your files! |
|
| WHMCS theme 'Twenty-One': Find and open file 'supportticketsubmit-stepone.tpl' located in the theme directory, follow the steps described below: |
|
| Find and open file 'supportticketsubmit-steptwo.tpl' located in the theme directory and follow the below steps: Please mind the lines numbers, they might differ in your files! |
|
| 9. You have just successfully installed Premium Support Tickets For WHMCS! |
[edit] Configuration and Management
| At this section we will show you possibilities of Premium Support Tickets For WHMCS. Our module allows you to limit the quantity of new support tickets through introducing Support Credit Points. |
[edit] Rules List
| Rules section defines which products or product addons your clients can receive Support Credit Points for. Additionally, they define which department they can be spent in and if they are granted one time or with product's each billing cycle. As you can see, basic information related to the rules is listed under 'Rules' → 'Show Rules' tab. |
|
| You can view items assigned to the rule as well as departments, which Support Credit Points (Dedicated and Shared) will be granted to, by pressing buttons marked on the following screen. |
|
| Additionally, you can easily manage each of the rules by using buttons in the 'Actions' column. |
|
[edit] Add Rule
| Lets create a new rule by pressing 'Add Rule' to proceed. |
|
| Step 1. Fill in rule name and choose rule type through pressing 'Select' button next to the desired item. Item type selected here defines the type of the item, for ordering which, your clients will receive Support Credit Points. |
|
| Step 2. Select items the order and activation of which will result in receiving Support Credit Points. Alternatively, you can switch 'Select All' to 'On', then, this rule will be applied to all items in the selected items type. |
|
| Step 3. Now, define departments to apply Support Credit Points to by selecting desired ones or switching 'Select All' to 'On'. Next, select billing options for this rule, you can choose one time, for credits to be applied only for the fist bough of the product, or recurring, to apply them also every time the client renews it. Finally fill in amount of 'Dedicated Points' and 'Points' which will be added by the rule to client's Support Credit Points and select the rule status. Confirm creation of this rule through pressing 'Finish' button. |
|
| As you can see on the following screen, the rule has been successfully added. |
|
[edit] Department Settings
| By default, all tickets are free to open. In the 'Department Settings' tab you can define price per ticket. Let's set up Support Credit Points required to open tickets in the 'General Support' department. |
|
| Now, start by defining base price per ticket, it will be added to the price per ticket status. Afterwards, fill in the additional prices for low, normal and high status tickets. They will be sum up as 'Total' with the base price. |
|
[edit]
| Shared Points are a common support credits that are assigned to a client's account, instead by a single support departments. Thanks to this, the clients can freely distribute their shared credits among any departments you have selected here. Once the departments are chosen, the Support Credit Points will be used from a shared balance to open a ticket. Important: If you choose departments for Shared Points, this does not mean that their Dedicated Points will no longer be applied. Note: If you want, you can also not configure any Dedicated Points credits in the module, so all clients will only use their Shared Points freely for all chosen departments. |
|
[edit] Clients
| In the 'Clients' tab you can view the amount of Support Credit Points owned by your clients. You can use filter to search for a specific client. |
|
| To display/hide client's Support Credit Points, press 'Show Detailed Information' / 'Hide Detailed Information' as shown on the screen below. |
|
| You can also manually add/remove credit points to a client, press 'Modify Support Credit Points' to do so. |
|
| Now, fill in the amount of Support Credit Points to be added or removed and then press 'Save'. |
|
[edit] Client Area
| Let's proceed to the client area in order to create a ticket. As you can see, one of the departments is unavailable because this client does not own any Support Ticket Points assigned to this department. |
|
| Clients can view their Support Credit Points for chosen department. Additionally, they can see the price per each ticket priority as shown on the following screen. |
|
| As you can see the number of client's points in the department has been reduced from 200 to 100 once the ticket has been correctly submitted. |
|
[edit] Sample Workflow
| In this section we will show you basic workflow of Premium Support Ticket For WHMCS usage. |
[edit] New Product Department
| 1. Let's start by creating a new ticket department, proceed to 'Setup' → 'Support' → 'Support Departments'. Now, press 'Add New Department'. |
|
| 2. Fill in department name, description and email address. Additionally, assign administrators to it, mark 'Clients Only' and press 'Add New Department'. |
|
[edit] New Product Addon
| 3. Now, let's create a rule, which will add Support Credit Points to the new department. In our case, Support Credit Points will be added through product addon. |
|
| 4. Fill in addon name and description. Additionally mark 'Show on Order' option. |
|
| 5. Move to the Pricing tab, choose one time billing type, and set the desired price. |
|
| 6. Finally in Applicable Products, assign desired services and proceed through pressing 'Save Changes' . |
|
[edit] New Rule
|
|
[edit] Department Configuration
| 12. Let us now set up amount of points required to open tickets in the previously created departments. Proceed to the 'Department Settings' tab and press 'Show Details' next to the previously created department. |
| 13. Leave 'Required Points' at 0, and fill in 'Low' , 'Normal' and 'High' ticket statuses with 30, 60 and 120 values respectively. Press 'Save' to confirm changes. |
|
[edit] Example Order
| 14. Log in to client account and order one of product with the previously created product addon. |
|
[edit] New Ticket
| 15. After payment, both the product and product addon ordered along with it are now active. 200 Support Credit Points were granted to this account and now can be spent in the '24/7 Support' department. |
|
| 16. Let us use Support Credit Points by opening a new ticket in the '24/7 Support' department with the 'High' status. It will cost 120 Support Credit Points. There should be 200 points on your account so you can afford creating only one ticket with the 'High' status. |
|
| 17. As you can see on the following screen, the ticket was successfully created. |
|
| 18. Adequate number of Support Credit Points was removed from the '24/7 Support' department points bundle. |
|
[edit] Tips
| 1. It is advised to set one of the departments as free of any charge. Remember to assign it the lowest priority of support to keep the other competitive. |
2. Since version 1.2.0 of the module, there are two types of Support Credit Points:
However, if the client owns both types of support credits, they will be displayed as a sum under the Support Credits Points balance per department, with dedicated points being used first and shared points only afterwards. |
[edit] Update Instructions
| Essential guidance through the process of updating the module is offered here. Ensure successful completion of the module update by carefully following each step, thereby preventing data loss or any unforeseen issues. |
[edit] Upgrade Guide
| Seeking a solution that offers greater flexibility, customization tailored to your precise needs, and unrestricted availability? There is an option that not only proves to be cost-effective in the long run but also includes prioritized support services, making it a truly valuable investment. Opt for the Open Source version of your Premium Support Tickets For WHMCS module to unlock these benefits. Follow a comprehensive guide covering the transition process, the advantages it brings, and step-by-step instructions on what to do next after the order has been successfully finalized. |
[edit] Common Problems
| 1. When you have problems with connection, check whether your SELinux or firewall does not block ports. |