Personal tools
Namespaces

Variants
Actions

Hosting Quota Notifications 1.X For WHMCS

From ModulesGarden Wiki
(Difference between revisions)
Jump to: navigation, search
(→‎Place Order)
Line 1: Line 1:
−
<meta name="keywords" content="recurring billing for whmcs, recurring billing configuration, whmcs recurring billing management, whmcs recurring billing installation, whmcs recurring billing common problems, about whmcs recurring billing, whmcs recurring billing documentation, whmcs recurring billing faq, whmcs recurring billing help, whmcs recurring billing guide, whmcs recurring billing wiki, whmcs recurring billing tutorial, whmcs recurring billing tips, whmcs recurring billing wiki"></meta>
+
<meta name="keywords" content="zendesk for whmcs, whmcs zendesk configuration, whmcs zendesk management, whmcs zendesk installation, whmcs zendesk common problems, about whmcs zendesk, whmcs zendesk documentation, whmcs zendesk faq, whmcs zendesk help, whmcs zendesk guide, whmcs zendesk wiki, whmcs zendesk tutorial, whmcs zendesk tips, whmcs zendesk wiki"></meta>
−
<meta name="description" content="ModulesGarden Wiki Contains All The Information You Need About The Recurring Billing For WHMCS Module."></meta>
+
<meta name="description" content="ModulesGarden Wiki Contains All The Information You Need About The Zendesk For WHMCS Module."></meta>
  
 +
<h4 style="color: #ff0000; font-weight:bold; text-align:center;">Article update is ongoing on this page, watch out for broken links and unclear descriptions!<br/>
 +
We are sorry for the inconvenience caused.</h4>
  
−
=About [http://www.modulesgarden.com/products/whmcs/recurring_billing/features Recurring Billing For WHMCS]=
+
=About [http://www.modulesgarden.com/products/whmcs/zendesk/features Zendesk For WHMCS]=
 
{|
 
{|
−
|style="padding: 10px 0px 5px 0px;"|'''Recurring Billing For WHMCS''' .....
+
|style="padding: 10px 0px 10px 0px;"|'''Zendesk For WHMCS''' allows your customers to use a complex support system solution in your own WHMCS.<br />
 +
With our module your clients will be able to manage Zendesk tickets as if they were a part of your system.<br />
 +
This product replaces a standard WHMCS client area support system with Zendesk, allowing you to easily manage all the tickets.
 
|}
 
|}
 
<!-- fixed -->
 
<!-- fixed -->
−
*'''Admin Area Features:'''
 
−
{|
 
−
|style="padding: 10px 0px 0px 30px;"|✔
 
−
|}
 
−
{|
 
−
|style="padding: 0px 0px 0px 30px;"|✔
 
−
|}
 
−
{|
 
−
|style="padding: 0px 0px 0px 30px;"|✔
 
−
|}
 
−
 
−
{|
 
−
|style="padding: 0px 0px 0px 30px;"|✔
 
−
|}
 
−
{|
 
−
|style="padding: 0px 0px 10px 30px;"|✔
 
−
|}
 
 
*'''Client Area Features:'''
 
*'''Client Area Features:'''
 
{|
 
{|
−
|style="padding: 10px 0px 10px 30px;"|✔  
+
|style="padding: 10px 0px 0px 30px;"|✔ View Zendesk Departments
 
|}
 
|}
−
 
−
 
−
*'''General Info:'''
 
 
{|
 
{|
−
|style="padding: 10px 0px 0px 30px;"|✔  
+
|style="padding: 0px 0px 0px 30px;"|✔ Open New Ticket
 
|}
 
|}
 
{|
 
{|
−
|style="padding: 0px 0px 0px 30px;"|✔  
+
|style="padding: 0px 0px 0px 30px;"|✔ Manage Existing Tickets
 
|}
 
|}
 
{|
 
{|
−
|style="padding: 0px 0px 0px 30px;"|✔ Multi-Language Support
+
|style="padding: 0px 0px 0px 30px;"|✔ Fill Out Zendesk Ticket Fields
 
|}
 
|}
 
{|
 
{|
−
|style="padding: 0px 0px 0px 30px;"|✔ Supports WHMCS Templates Five and Six
+
|style="padding: 0px 0px 0px 30px;"|✔ Attach Files To Ticket
 
|}
 
|}
 
{|
 
{|
−
|style="padding: 0px 0px 30px 30px;"|✔ Supports WHMCS V5 and V6
+
|style="padding: 0px 0px 10px 30px;"|✔ List Recent Tickets
 
|}
 
|}
−
 
+
*'''Integration:'''
−
=Installation=
+
 
{|
 
{|
−
|style="padding: 10px 0px 30px 15px;"|'''This tutorial will show you how to successfully install and configure Recurring Billing For WHMCS.''' <br />
+
|style="padding: 10px 0px 0px 30px;"|✔ Single Sign On (SSO) Integration
−
We will guide you step by step through the whole installation and configuration process.
+
 
|}
 
|}
−
==Installation==
 
 
{|
 
{|
−
|style="padding: 10px 0px 20px 15px;"|'''1. Log in to your client area and download Recurring Billing For WHMCS.'''
+
|style="padding: 0px 0px 0px 30px;"|✔ Synchronize User Accounts Between WHMCS And Zendesk
 
|}
 
|}
 
{|
 
{|
−
|style="padding: 0px 0px 20px 25px;"|[[File:RB_1.png]]
+
|style="padding: 0px 0px 0px 30px;"|✔ Transfer Ticket Fields Settings
 
|}
 
|}
 
{|
 
{|
−
|style="padding: 0px 0px 15px 15px;"|'''2. Upload and extract the module into the main WHMCS directory.'''<br />
+
|style="padding: 0px 0px 10px 30px;"|✔ Disable SSL Verification Host/Peer In cURL
−
Files in your WHMCS directory should look like on the following screen.
+
 
|}
 
|}
 +
*'''General Info:'''
 
{|
 
{|
−
|style="padding: 0px 0px 20px 25px;"|[[File:RB_2.png]]
+
|style="padding: 10px 0px 0px 30px;"|✔ Custom Templates Support
 
|}
 
|}
 
{|
 
{|
−
|style="padding: 0px 0px 15px 15px;"|'''3. When you install Recurring Billing For WHMCS for the first time you have to rename '' 'license_RENAME.php' '' file.'''<br />
+
|style="padding: 0px 0px 0px 30px;"|✔ Multi-Language Support
−
File is located in '' 'modules/addons/recurring_billing/license_RENAME.php'.'' Rename it from '' 'license_RENAME.php' '' to '' 'license.php'. ''
+
 
|}
 
|}
 
{|
 
{|
−
|style="padding: 0px 0px 20px 25px;"|[[File:RB_3.png]]
+
|style="padding: 0px 0px 0px 30px;"|✔ Supports WHMCS Templates Five and Six
 
|}
 
|}
 
{|
 
{|
−
|style="padding: 0px 0px 15px 15px;"|'''4. In order to configure your license key, you have to edit the previously renamed '' 'license.php' file. '' '''<br />
+
|style="padding: 0px 0px 30px 30px;"|✔ Supports WHMCS V5 and V6
−
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 30px 25px;"|[[File:RB_4.png]]
+
 
|}
 
|}
  
−
==Activation==
+
=Installation and Configuration=
 
{|
 
{|
−
|style="padding: 10px 0px 15px 15px;"|'''5. Now, you have to activate the module in your WHMCS system.'''<br />
+
|style="padding: 10px 0px 0px 0px;"|Installation and configuration of Zendesk For WHMCS won't take you longer than 10 minutes.<br />
−
Log in to your WHMCS admin area and proceed to '' 'Setup' '' → '' 'Addon Modules'. ''<br />
+
We will guide you step by step through the whole process.
−
Afterwards, find '' 'Recurring Billing' '' and press '' 'Activate' '' button.
+
 
|}
 
|}
 
{|
 
{|
−
|style="padding: 0px 0px 20px 25px;"|[[File:RB_5.png]]
+
|style="padding: 20px 0px 20px 15px;"|'''1. Log in to your client area and download Zendesk For WHMCS.'''
 
|}
 
|}
 
{|
 
{|
−
|style="padding: 0px 0px 15px 15px;"|'''6. In the next step you need to permit access to this module.'''<br />
+
|style="padding: 0px 0px 20px 25px;"|[[File:Z1.png]]
−
To do so, click on '' 'Configure' '' button, tick checkboxes to assign desired admin roles.<br />
+
−
Press '' 'Save Changes'. ''
+
 
|}
 
|}
 
{|
 
{|
−
|style="padding: 0px 0px 20px 25px;"|[[File:RB_6.png]]
+
|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 this.
 
|}
 
|}
 
{|
 
{|
−
|style="padding: 0px 0px 15px 15px;"|'''7. Now it is time to insert proper integration codes. Note that this step is required only if you are using WHMCS V5 x.x.<br/>
+
|style="padding: 0px 0px 20px 25px;"|[[File:Z2.png]]
−
There is no integration required for WHMCS V6 x.x.'''<br/><br/>
+
−
Open the currently used template. For presentation purposes we opened modern template. You will them in '' 'yourWHMCs/template/orderforms/modern/viewcart.tpl'. ''<br/>
+
−
Find line 450. Insert the below code inside this line and save the changes.
+
−
  <nowiki><div class="signupfields">
+
−
                  <h2>Contracts</h2>
+
−
                  {$contractOutput}
+
−
              </div></nowiki>
+
−
Remember that you must insert the code to every used order form template. <br/><br/>
+
−
 
+
−
That is how a properly inserted code should look like:
+
 
|}
 
|}
 
{|
 
{|
−
|style="padding: 0px 0px 30px 15px;"|'''8. You have just successfully installed Recurring Billing For WHMCS!'''
+
|style="padding: 0px 0px 15px 15px;"|'''3. Afterwards log in to your Zendesk admin area in order to enable API access.'''<br />
 +
Go to '' 'Manage' '' → '' 'API' '' which is located in the '' 'Channels' '' section and enable '' 'Token Access' ''. Remember to save the changes.<br />
 +
'''IMPORTANT:''' Copy and keep your API token in a safe place. You will need it in a moment to complete the installation of the module.
 
|}
 
|}
−
 
−
=Configuration and Management=
 
 
{|
 
{|
−
|style="padding: 10px 0px 30px 15px;"|'''Once you have properly installed and activated the product you may move to its actual configuration.<br/>'''
+
|style="padding: 0px 0px 20px 25px;"|[[File:Z3.png]]
−
Read the below sections to learn how to use '''Recurring Billing For WHMCS''' completely.
+
 
|}
 
|}
−
==Configuration==
 
 
{|
 
{|
−
|style="padding: 10px 0px 15px 15px;"|In order to start using your Recurring Billing For WHMCS move to '' 'Addons → Recurring Billing'. ''<br/>
+
|style="padding: 0px 0px 15px 15px;"|'''4. Now go to '' 'Manage' '' → '' 'Security' '' which is located in the '' 'Settings' '' section and enable '' 'Single-Sign On' ''.'''<br />
−
By default, you will be moved to the addon's dashboard with a guide opened. You will find there short notes on how to configure the product.<br/>
+
Here you can also check your remote login URL and remote logout URL. Don't forget to press '' 'Save tab' '' at the bottom of the screen.
−
In this article we will expand these instructions a bit more.
+
 
|}
 
|}
 
{|
 
{|
−
|style="padding: 0px 0px 20px 25px;"|[[File:RB_.png]]
+
|style="padding: 0px 0px 20px 25px;"|[[File:Z4.png]]
 
|}
 
|}
 
{|
 
{|
−
|style="padding: 0px 0px 30px 15px;"|Hide the guide when you have completed the configuration and learn how to reconstruct the process.
+
|style="padding: 0px 0px 20px 15px;"|'''5. Scroll down to the bottom of page and press '' 'generate a new token' '' or use an existing one.'''<br />
 
|}
 
|}
−
===Contract Content===
 
 
{|
 
{|
−
|style="padding: 10px 0px 15px 15px;"|First off all, create your first contract's content. To do so, move to '' 'Contract Content' '' section and press '' 'Add New' '' button.
+
|style="padding: 0px 0px 20px 25px;"|[[File:Z5.png]]
 
|}
 
|}
 
{|
 
{|
−
|style="padding: 0px 0px 20px 25px;"|[[File:RB_.png]]
+
|style="padding: 0px 0px 15px 15px;"|'''6. Copy and keep your '' 'shared secret' '' in a safe place. We will need it in the next step.'''<br />
 +
'''IMPORTANT:''' Make sure that you have copied the entire secret. It's longer than shown on the screen below.
 
|}
 
|}
 
{|
 
{|
−
|style="padding: 0px 0px 15px 15px;"|Here you can compose the content of a contract.<br/>
+
|style="padding: 0px 0px 20px 25px;"|[[File:Z6.png]]
−
*Type in the '''''' 'Name' ''''' of a contract
+
−
*Fill out the filed with ''''' 'Content', '''''' you may use ''''' 'Available Merge Fields' '''''  to do so
+
−
**''Client Fields''
+
−
**''Product Fields''
+
−
**''Contract Fields''
+
−
*Use advanced edition tool to perfectly shape the contract. <br/>
+
 
|}
 
|}
 
{|
 
{|
−
|style="padding: 0px 0px 10px 25px;"|[[File:RB_.png]]
+
|style="padding: 0px 0px 15px 15px;"|'''7. Afterwards you need to configure one file. To do so, go to '' 'your_whmcs/modules/support/zendesk' '' and modify '' 'configuration.php' '' file.'''<br />
 +
Below we will briefly describe critical variables for proper operation of the module:<br />
 +
'''$token''' - enter your API token obtained in the step 3<br />
 +
'''$shared_secret''' - enter your shared secret obtained in the step 6<br />
 +
'''$zendesk_for_whmcs_licensekey''' = enter your license key here<br />
 +
Other modifications aren't mandatory.<br />
 +
All necessary information about additional changes like e.g. account name, ticket status colors or email updates you will find in the configuration file as shown on the screen below.
 
|}
 
|}
 
{|
 
{|
−
|style="padding: 0px 0px 15px 15px;"|Do not forget to '' 'Save' '' the changes once you have finished.
+
|style="padding: 0px 0px 20px 25px;"|[[File:Z7.png]]
 
|}
 
|}
 
{|
 
{|
−
|style="padding: 0px 0px 10px 25px;"|[[File:RB_.png]]
+
|style="padding: 0px 0px 15px 15px;"|'''8. The last step is performed directly in WHMCS.'''<br />
 +
Log in to your system, go to '' 'Setup' '' → '' 'General Settings' '' → '' 'Support' '', choose '' 'Zendesk' '' from a dropdown menu and save changes.
 
|}
 
|}
 
{|
 
{|
−
|style="padding: 0px 0px 15px 15px;"|Your newly created contract draft is now visible on the list. <br/>
+
|style="padding: 0px 0px 20px 25px;"|[[File:Z8.png]]
−
Use action buttons to edit the contract or delete it if you are sure it is useless.
+
 
|}
 
|}
 
{|
 
{|
−
|style="padding: 0px 0px 30px 25px;"|[[File:RB_.png]]
+
|style="padding: 0px 0px 30px 15px;"|'''Good job! Now your WHMCS is connected with Zendesk support system'''.
 
|}
 
|}
  
−
===Contract Templates===
+
=Management=
 
{|
 
{|
−
|style="padding: 10px 0px 15px 15px;"|Now, that you have a contract's content draft, move to '' 'Contract Templates'. ''
+
|style="padding: 10px 0px 15px 0px;"|Once Zendesk For WHMCS is installed and configured, you can create/update your ticket departments and begin to use it.<br />
−
In this section you can predefine which contract content draft and a specific product a template will refer to.<br/>
+
Each ticket department you create in the Zendesk will be available for your customers in WHMCS client area.
−
Press '' 'Add New' '' to begin.
+
 
|}
 
|}
 
{|
 
{|
−
|style="padding: 0px 0px 20px 25px;"|[[File:RB_.png]]
+
|style="padding: 0px 0px 15px 15px;"|Let's see what our Zendesk For WHMCS can do. Firstly, you can create and modify ticket fields which will show up in WHMCS while creating a new ticket.<br />
 +
For test purposes we activated and adjusted '' 'Priority' '' field according to our needs.
 
|}
 
|}
 
{|
 
{|
−
|style="padding: 0px 0px 15px 15px;"|Fill out the contract template form. Name the template, as mentioned before, choose Content Name from the ones you prepared previously (see '' 'Contract Content' '' section).<br/> Select product that this template will be available with.<br/> ''Note! You can assign only one template to a single product!''<br/> Choose ''Fixed'' or ''Percentage'' values for Promotion and Penalty amounts.<br/>
+
|style="padding: 0px 0px 20px 25px;"|[[File:Z9.png]]
−
Remember to '' 'Save' '' the changes.  
+
 
|}
 
|}
 
{|
 
{|
−
|style="padding: 0px 0px 20px 25px;"|[[File:RB_.png]]
+
|style="padding: 0px 0px 20px 15px;"|As you can see on the screen below, new field appeared in WHMCS client area. Let's send the ticket.
 
|}
 
|}
 
{|
 
{|
−
|style="padding: 0px 0px 15px 15px;"|Once you have added a new template, you have to fill out contract's details. An appropriate box should appear next to the template form.<br/>
+
|style="padding: 0px 0px 20px 25px;"|[[File:10.png]]
−
Find there the payment type and the price set up, number of signed contracts and checkbox,<br/> which when selected allows to order assigned product without the need to accept this contract.<br/>
+
−
Press '' '+' '' to see more.
+
 
|}
 
|}
 
{|
 
{|
−
|style="padding: 0px 0px 20px 25px;"|[[File:RB_.png]]
+
|style="padding: 0px 0px 20px 15px;"|Ticket has successfully appeared in your Zendesk admin area. Do not let him wait long unanswered.
 
|}
 
|}
 
{|
 
{|
−
|style="padding: 0px 0px 15px 15px;"|In this form you can define:
+
|style="padding: 0px 0px 20px 25px;"|[[File:11.png]]
−
*Length - how long such contract shall last
+
−
*Promo Amount - as fixed amount or percentage, depending on the previously selected type in the template form
+
−
*Penalty Amount - as fixed amount or percentage, depending on the previously selected type in the template form
+
−
*Notice Period - number of days when a client may resign from the contact without any consequences or giving reason of resignation<br/>
+
−
Next to each of the options ''(except 'Notice Period') '' there will appear counted pricing of product.<br/>
+
−
Remember to '' 'Save' '' the changes again.
+
 
|}
 
|}
 
{|
 
{|
−
|style="padding: 0px 0px 30px 25px;"|[[File:RB_.png]]
+
|style="padding: 0px 0px 20px 15px;"|Let's send an answer to our fellow Tester.
 
|}
 
|}
−
 
−
===Configuration===
 
 
{|
 
{|
−
|style="padding: 10px 0px 15px 15px;"|The last step mentioned in the '' 'Guide' '' is setting up '' 'Notifications' '' and '' 'Penalty'. '' These options can be found under 'Configuration' tab.
+
|style="padding: 0px 0px 20px 25px;"|[[File:12.png]]
 
|}
 
|}
 
{|
 
{|
−
|style="padding: 0px 0px 20px 25px;"|[[File:RB_.png]]
+
|style="padding: 0px 0px 20px 15px;"|Our customer received an answer with updated ticket status.
 
|}
 
|}
 
{|
 
{|
−
|style="padding: 0px 0px 15px 15px;"|Select which email notifications you want your clients to receive, enter number of days before due date to send the notification.<br/>
+
|style="padding: 0px 0px 20px 25px;"|[[File:13.png]]
−
Move to '' 'Setup' → 'Email Templates' → 'General Messages' '' in your WHMCS to view and edit the notifications. You will find them under '' 'Ending Contract Notification' '' name.<br/>
+
−
Enabled notifications are sent automatically with daily cron run. 
+
 
|}
 
|}
 
{|
 
{|
−
|style="padding: 0px 0px 20px 25px;"|[[File:RB_.png]]
+
|style="padding: 0px 0px 30px 15px;"|As you noticed management of Zendesk For WHMCS is very simple and intuitive. Now you are ready to offer your customers a new level of support!
 
|}
 
|}
−
{|
 
−
|style="padding: 0px 0px 15px 15px;"|Define number of days when a client can be late with payment.<br/> If a client misses to make payment for longer than the specified here number of days, a penalty will be imposed on such client.<br/> ''Note: penalty type and amount are specified in 'Contract Template' details.''
 
  
−
|}
+
==How To Update==
 
{|
 
{|
−
|style="padding: 0px 0px 20px 25px;"|[[File:RB_.png]]
+
|style="padding: 20px 0px 20px 15px;"|Updating Zendesk For WHMCS to newest version is quite simple.<br />
 +
'''1. Firstly download the newest version from your client area.'''
 
|}
 
|}
 
{|
 
{|
−
|style="padding: 0px 0px 15px 15px;"|Here you can also turn off the guide or turn it on again once you have hidden it.<br/>
+
|style="padding: 0px 0px 20px 25px;"|[[File:Z1.png]]
−
'' 'Save' '' the changes once your configuration is ready.
+
 
|}
 
|}
 
{|
 
{|
−
|style="padding: 0px 0px 30px 25px;"|[[File:RB_.png]]
+
|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 this.
 
|}
 
|}
−
 
−
==Management==
 
 
{|
 
{|
−
|style="padding: 10px 30px 15px 15px;"|In the following sections we will try to explain how previously configured contracts are forced on clients.
+
|style="padding: 0px 0px 20px 25px;"|[[File:Z2.png]]
 
|}
 
|}
−
===Client Area===
 
−
====Place Order====
 
 
{|
 
{|
−
|style="padding: 10px 0px 15px 15px;"|To illustrate the process, let's say a client orders one of your products with recurring payment (it is important that you have previously prepared a contract for this product).
+
|style="padding: 0px 0px 15px 15px;"|'''3. Copy settings from '' 'configuration.php' '' to '' 'configuration_RENAME.php' ''.'''<br />
 +
Both files are located at '' 'your_whmcs\modules\support\zendesk' ''.<br />
 +
Afterwards, remove '' 'configuration.php' '' file and rename '' 'configuration_RENAME.php' '' to '' 'configuration.php' ''.
 
|}
 
|}
 
{|
 
{|
−
|style="padding: 0px 0px 20px 25px;"|[[File:RB_.png]]
+
|style="padding: 0px 0px 30px 25px;"|[[File:Z13_1.png]]
 
|}
 
|}
 +
 +
=Tips=
 
{|
 
{|
−
|style="padding: 0px 0px 15px 15px;"|On the order form, there is a box where a client needs to select one of the available billing cycles.
+
|style="padding: 10px 0px 10px 15px;"|1. If you create a custom field in Zendesk, it will be also visible in WHMCS. Custom fields need to be enabled/visible/editable_by_client.
 
|}
 
|}
 
{|
 
{|
−
|style="padding: 0px 0px 20px 25px;"|[[File:RB_.png]]
+
|style="padding: 0px 0px 10px 15px;"|2. When you add '' ' |clientservice' '' at the end of the custom field title, a select with list of products and domains will show up.
 
|}
 
|}
 
{|
 
{|
−
|style="padding: 0px 0px 15px 15px;"|Once a billing cycle is chosen, in '' 'Additional Required Information' '' a client must select contract length from the available.
+
|style="padding: 0px 0px 10px 15px;"|3. Module supports '' 'default' '' and '' 'portal' '' templates but you can create and set up your own template.
 
|}
 
|}
 
{|
 
{|
−
|style="padding: 0px 0px 20px 25px;"|[[File:RB_.png]]
+
|style="padding: 0px 0px 10px 15px;"|4. You can translate ticket status names through creating '' 'zendesk_lang.txt' '' file in '' 'your_whmcs/lang' '' directory.<br />
−
|}
+
These are translation variables used by Zendesk module. You can add them to the bottom of any language file you would like to use.<br />
−
{|
+
Just translate the right side of the equal sign within the quotes. '''Do not change left side variables.'''<br />
−
|style="padding: 0px 0px 15px 15px;"|Before accepting any Terms of Use, a client may view the contract and read it.
+
−
|}
+
−
{|
+
−
|style="padding: 0px 0px 20px 25px;"|[[File:RB_.png]]
+
−
|}
+
−
{|
+
−
|style="padding: 0px 0px 15px 15px;"|Once familiar with the content of the contract accept '' 'Contract Terms of Use', '' only then you will be allowed to view the cart with the selected product.
+
−
|}
+
−
{|
+
−
|style="padding: 0px 0px 20px 25px;"|[[File:RB_.png]]
+
−
|}
+
−
{|
+
−
|style="padding: 0px 0px 15px 15px;"|If you do not accept the terms of use you will not be allowed to move to the cart.
+
−
|}
+
−
{|
+
−
|style="padding: 0px 0px 20px 25px;"|[[File:RB_.png]]
+
−
|}
+
−
{|
+
−
|style="padding: 0px 0px 15px 15px;"|In the cart all contracts are available to view, make sure you accepted all of them before you check out.<br/> Otherwise, you will not be allowed to proceed.
+
−
|}
+
−
{|
+
−
|style="padding: 0px 0px 30px 25px;"|[[File:RB_.png]]
+
−
|}
+
  
−
====Service Contracts====
+
$_LANG["zendesk_ticket_status_new"]    = "New";<br />
−
{|
+
$_LANG["zendesk_ticket_status_open"]   = "Open";<br />
−
|style="padding: 10px 0px 15px 15px;"|To view all accepted contracts, find '' 'Service Contracts' ''
+
  $_LANG["zendesk_ticket_status_pending"] = "Pending";<br />
−
|}
+
$_LANG["zendesk_ticket_status_hold"]    = "Hold";<br />
−
{|
+
$_LANG["zendesk_ticket_status_solved"] = "Solved";<br />
−
|style="padding: 0px 0px 20px 25px;"|[[File:RB_.png]]
+
$_LANG["zendesk_ticket_status_closed"]  = "Closed";
−
|}
+
−
{|
+
−
|style="padding: 0px 0px 15px 15px;"|There is a full list of client's contracts with the most important information about them.<br/>
+
−
Use action buttons to:
+
−
*View a PDF version of the contract
+
−
*See contract's history  
+
−
|}
+
−
{|
+
−
|style="padding: 0px 0px 20px 25px;"|[[File:RB_.png]]
+
−
|}
+
−
{|
+
−
|style="padding: 0px 0px 15px 15px;"|View PDF:
+
−
|}
+
−
{|
+
−
|style="padding: 0px 0px 20px 25px;"|[[File:RB_.png]]
+
−
|}
+
−
{|
+
−
|style="padding: 0px 0px 15px 15px;"|History:
+
−
|}
+
−
{|
+
−
|style="padding: 0px 0px 30px 25px;"|[[File:RB_.png]]
+
−
|}
+
  
−
===Admin Area===
+
Setting above is optional. If translations are not set, the default english values are displayed, straight from Zendesk.
−
{|
+
−
|style="padding: 10px 0px 30px 15px;"|Come back to your admin area addon view to manage signed contracts.
+
 
|}
 
|}
−
====Signed Contracts====
 
 
{|
 
{|
−
|style="padding: 10px 0px 15px 15px;"|In '' 'Signed Contracts' '' section you will find a list of all contracts accepted by your clients.<br/>
+
|style="padding: 0px 0px 10px 15px;"|5. Since Zendesk does not fully support WHMCS option to reopen closed tickets, '' ' Close ticket 4 days after status is set to solved' ''<br.>option is currently the only possibility to get around it. To enable configure this option proceed to ''Zendesk → Business Rules → Automations.'' <br/>Find there the option and edit it.
−
On the main page you can see name of the client with service used, recurring payment amount for their product and contract details such as signing and ending dates, length and status. <br/>
+
−
Use action buttons to delete or edit contracts. If you use edit button, you will be moved to a full view of the contract.
+
 
|}
 
|}
 
{|
 
{|
−
|style="padding: 0px 0px 20px 25px;"|[[File:RB_.png]]
+
|style="padding: 0px 0px 10px 15px;"|[[File:Z16.png]]
 
|}
 
|}
 
{|
 
{|
−
|style="padding: 0px 0px 15px 15px;"|On this page you can see once again details of a contract accepted between a client and you.  
+
|style="padding: 0px 0px 10px 15px;"|Here you can configure the time until when tickets can be reopened by an answer from teh client.<br/> Maximum possible time is now 672 hours (28 days).
 
|}
 
|}
 
{|
 
{|
−
|style="padding: 0px 0px 20px 25px;"|[[File:RB_.png]]
 
−
|}
 
 
{|
 
{|
−
|style="padding: 0px 0px 15px 15px;"|Here, you are allowed to modify the content of this very contract. Note that used '' 'Contract Content' '' will not be altered, only this signed item.
+
|style="padding: 0px 0px 30px 15px;"|[[File:Z15.png]]
 
|}
 
|}
−
{|
 
−
|style="padding: 0px 0px 20px 25px;"|[[File:RB_.png]]
 
−
|}
 
−
{|
 
−
|style="padding: 0px 0px 15px 15px;"|In case you decide to make any changes to the contract, the previous (before changes) version of the contract is added to teh '' 'History'. '' <br/>
 
−
Thanks to that, you may always come back to the original, restore it (changes made will be overwritten with the previous content) or view PDF version.
 
−
|}
 
−
{|
 
−
|style="padding: 0px 0px 20px 25px;"|[[File:RB_.png]]
 
−
|}
 
−
====Dashboard====
 
−
{|
 
−
|style="padding: 10px 0px 15px 15px;"|On the Dashboard of your addon you will find the most important information in a nutshell.<br/>
 
−
These are:
 
−
|}
 
−
{|
 
−
|style="padding: 0px 0px 20px 25px;"|[[File:RB_.png]]
 
−
|}
 
−
{|
 
−
|style="padding: 0px 0px 15px 15px;"|
 
−
|}
 
−
{|
 
−
|style="padding: 0px 0px 20px 25px;"|[[File:RB_.png]]
 
−
|}
 
−
{|
 
−
|style="padding: 0px 0px 15px 15px;"|
 
−
|}
 
−
{|
 
−
|style="padding: 0px 0px 30px 25px;"|[[File:RB_.png]]
 
 
|}
 
|}
  
−
====Logs====
+
=Common Problems=
 
{|
 
{|
−
|style="padding: 10px 0px 15px 15px;"|In '' 'Logs' '' section you have a full view on any attempted action on any contract.
+
|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: 0px 0px 30px 25px;"|[[File:RB_.png]]
+
|style="padding: 0px 0px 5px 15px;"|2. When you try to open a new ticket and you get error '' 'Unable to authenticate' '', this means that the user's email is already registered in Zendesk, but it's not verified yet.<br />
−
|}
+
To solve the problem log in to your Zendesk admin area and verify the email through clicking '' 'Verify now' '' as presented on the screen below.
−
 
+
−
<!--
+
−
=Additional Information=
+
−
{|
+
−
|style="padding: 10px 0px 30px 15px;"|
+
−
|}
+
−
-->
+
−
 
+
−
=Tips=
+
−
{|
+
−
|style="padding: 10px 0px 30px 15px;"|1. If you select '' 'Allow Orders Without Contract' '' in a contract template, while placing an order a client will be allowed to select '' 'I do not want a contract' '' option form '' 'Contract Length'.''<br/> No '' 'Terms of Use' '' will have to be accepted then and the client will not be charged according to the contract's details.
+
−
|}
+
−
 
+
−
=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: 0px 0px 30px 15px;"|2. Remember that Recurring Billing For WHCMS contracts can be applied to products with recurring payment type only.
+
|style="padding: 0px 0px 30px 25px;"|[[File:Z14.png]]
 
|}
 
|}

Revision as of 16:31, 25 November 2015

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

Contents

About Zendesk For WHMCS

Zendesk For WHMCS allows your customers to use a complex support system solution in your own WHMCS.

With our module your clients will be able to manage Zendesk tickets as if they were a part of your system.
This product replaces a standard WHMCS client area support system with Zendesk, allowing you to easily manage all the tickets.

  • Client Area Features:
✔ View Zendesk Departments
✔ Open New Ticket
✔ Manage Existing Tickets
✔ Fill Out Zendesk Ticket Fields
✔ Attach Files To Ticket
✔ List Recent Tickets
  • Integration:
✔ Single Sign On (SSO) Integration
✔ Synchronize User Accounts Between WHMCS And Zendesk
✔ Transfer Ticket Fields Settings
✔ Disable SSL Verification Host/Peer In cURL
  • General Info:
✔ Custom Templates Support
✔ Multi-Language Support
✔ Supports WHMCS Templates Five and Six
✔ Supports WHMCS V5 and V6

Installation and Configuration

Installation and configuration of Zendesk For WHMCS won't take you longer than 10 minutes.

We will guide you step by step through the whole process.

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

Files in your WHMCS directory should look like this.

File:Z2.png
3. Afterwards log in to your Zendesk admin area in order to enable API access.

Go to 'Manage' → 'API' which is located in the 'Channels' section and enable 'Token Access' . Remember to save the changes.
IMPORTANT: Copy and keep your API token in a safe place. You will need it in a moment to complete the installation of the module.

File:Z3.png
4. Now go to 'Manage' → 'Security' which is located in the 'Settings' section and enable 'Single-Sign On' .

Here you can also check your remote login URL and remote logout URL. Don't forget to press 'Save tab' at the bottom of the screen.

File:Z4.png
5. Scroll down to the bottom of page and press 'generate a new token' or use an existing one.
File:Z5.png
6. Copy and keep your 'shared secret' in a safe place. We will need it in the next step.

IMPORTANT: Make sure that you have copied the entire secret. It's longer than shown on the screen below.

File:Z6.png
7. Afterwards you need to configure one file. To do so, go to 'your_whmcs/modules/support/zendesk' and modify 'configuration.php' file.

Below we will briefly describe critical variables for proper operation of the module:
$token - enter your API token obtained in the step 3
$shared_secret - enter your shared secret obtained in the step 6
$zendesk_for_whmcs_licensekey = enter your license key here
Other modifications aren't mandatory.
All necessary information about additional changes like e.g. account name, ticket status colors or email updates you will find in the configuration file as shown on the screen below.

File:Z7.png
8. The last step is performed directly in WHMCS.

Log in to your system, go to 'Setup' → 'General Settings' → 'Support' , choose 'Zendesk' from a dropdown menu and save changes.

File:Z8.png
Good job! Now your WHMCS is connected with Zendesk support system.

Management

Once Zendesk For WHMCS is installed and configured, you can create/update your ticket departments and begin to use it.

Each ticket department you create in the Zendesk will be available for your customers in WHMCS client area.

Let's see what our Zendesk For WHMCS can do. Firstly, you can create and modify ticket fields which will show up in WHMCS while creating a new ticket.

For test purposes we activated and adjusted 'Priority' field according to our needs.

File:Z9.png
As you can see on the screen below, new field appeared in WHMCS client area. Let's send the ticket.
File:10.png
Ticket has successfully appeared in your Zendesk admin area. Do not let him wait long unanswered.
File:11.png
Let's send an answer to our fellow Tester.
File:12.png
Our customer received an answer with updated ticket status.
File:13.png
As you noticed management of Zendesk For WHMCS is very simple and intuitive. Now you are ready to offer your customers a new level of support!

How To Update

Updating Zendesk For WHMCS to newest version is quite simple.

1. Firstly download the newest version from your client area.

Z1.png
2. Upload and extract the module into the main WHMCS directory.

Files in your WHMCS directory should look like this.

File:Z2.png
3. Copy settings from 'configuration.php' to 'configuration_RENAME.php' .

Both files are located at 'your_whmcs\modules\support\zendesk' .
Afterwards, remove 'configuration.php' file and rename 'configuration_RENAME.php' to 'configuration.php' .

File:Z13 1.png

Tips

1. If you create a custom field in Zendesk, it will be also visible in WHMCS. Custom fields need to be enabled/visible/editable_by_client.
2. When you add ' |clientservice' at the end of the custom field title, a select with list of products and domains will show up.
3. Module supports 'default' and 'portal' templates but you can create and set up your own template.
4. You can translate ticket status names through creating 'zendesk_lang.txt' file in 'your_whmcs/lang' directory.

These are translation variables used by Zendesk module. You can add them to the bottom of any language file you would like to use.
Just translate the right side of the equal sign within the quotes. Do not change left side variables.

$_LANG["zendesk_ticket_status_new"]     = "New";

$_LANG["zendesk_ticket_status_open"]    = "Open";

$_LANG["zendesk_ticket_status_pending"] = "Pending";

$_LANG["zendesk_ticket_status_hold"]    = "Hold";

$_LANG["zendesk_ticket_status_solved"]  = "Solved";

$_LANG["zendesk_ticket_status_closed"]  = "Closed";

Setting above is optional. If translations are not set, the default english values are displayed, straight from Zendesk.

5. Since Zendesk does not fully support WHMCS option to reopen closed tickets, ' Close ticket 4 days after status is set to solved'
option is currently the only possibility to get around it. To enable configure this option proceed to Zendesk → Business Rules → Automations.
Find there the option and edit it.
Z16.png
Here you can configure the time until when tickets can be reopened by an answer from teh client.
Maximum possible time is now 672 hours (28 days).
Z15.png

Common Problems

1. When you have problems with connection, check whether your SELinux or firewall does not block ports.
2. When you try to open a new ticket and you get error 'Unable to authenticate' , this means that the user's email is already registered in Zendesk, but it's not verified yet.

To solve the problem log in to your Zendesk admin area and verify the email through clicking 'Verify now' as presented on the screen below.

Z14.png
Retrieved from "https://www.docs.modulesgarden.com/index.php?title=Hosting_Quota_Notifications_1.X_For_WHMCS&oldid=21524"
Navigation
WHMCS Modules
WHMCS Widgets
Tools And Applications
Translations
General
FAQ
Community