Freshdesk For WHMCS
(→Server Configuration) |
(→Management) |
||
Line 224: | Line 224: | ||
=Management= | =Management= | ||
{| | {| | ||
− | |style="padding: 10px 0px 30px 15px;"|'''Once Freshdesk For WHMCS is installed and connection configured, you can create/update your ticket departments and begin using | + | |style="padding: 10px 0px 30px 15px;"|'''Once Freshdesk For WHMCS is installed and the connection is configured, you can create/update your ticket departments and begin using them.'''<br/> |
− | Each ticket department you create in | + | Each ticket department you create in Freshdesk will be available for your customers in WHMCS client area. |
|} | |} | ||
==Settings== | ==Settings== | ||
Line 231: | Line 231: | ||
{| | {| | ||
|style="padding: 10px 0px 15px 15px;"|Before you start your actual work on support tickets with Freshdesk For WHMCS, move again to '' 'Addons' → 'Freshdesk' → 'Ticket Settings'. ''<br/> | |style="padding: 10px 0px 15px 15px;"|Before you start your actual work on support tickets with Freshdesk For WHMCS, move again to '' 'Addons' → 'Freshdesk' → 'Ticket Settings'. ''<br/> | ||
− | This section of the addon allows easy and comfortable management of the way tickets are displayed in your client area, their visibility, sorting etc. | + | This section of the addon allows an easy and comfortable management of the way tickets are displayed in your client area, their visibility, sorting etc. |
|} | |} | ||
{| | {| | ||
Line 243: | Line 243: | ||
*Replies Descending Order - enable this option and ticket replies will be sorted by date in descending order when viewing a ticket | *Replies Descending Order - enable this option and ticket replies will be sorted by date in descending order when viewing a ticket | ||
*Template Name - optional, select only in case you wish to use a custom template | *Template Name - optional, select only in case you wish to use a custom template | ||
− | *Client Services - choose the field | + | *Client Services - choose the field (created in Freshdesk), responsible for displaying all client's products and domains (click [https://www.docs.modulesgarden.com/Freshdesk_For_WHMCS#Freshdesk_Service_Field here] for more information) |
*Update Client Credentials - if a client's email is updated in WHMCS, it will be updated in Freshdesk accordingly ''(name is also updated but only if the email is changed)'' | *Update Client Credentials - if a client's email is updated in WHMCS, it will be updated in Freshdesk accordingly ''(name is also updated but only if the email is changed)'' | ||
Line 254: | Line 254: | ||
Click on the field to choose a color from the palette of colors or type in the number of the color you like.<br/> | Click on the field to choose a color from the palette of colors or type in the number of the color you like.<br/> | ||
Tickets of each status will be marked with selected colors on homage.<br/><br/> | Tickets of each status will be marked with selected colors on homage.<br/><br/> | ||
− | Remember to save the changes if you make any | + | Remember to save the changes if you make any in ticket settings. |
|} | |} | ||
{| | {| | ||
Line 260: | Line 260: | ||
|} | |} | ||
{| | {| | ||
− | |style="padding: 0px 0px 20px 15px;"|Tickets of each status are now marked with selected colors on homepage. | + | |style="padding: 0px 0px 20px 15px;"|Tickets of each status are now marked with the selected colors on homepage. |
|} | |} | ||
{| | {| | ||
Line 270: | Line 270: | ||
|style="padding: 10px 0px 15px 15px;"|You can also manage ticket fields, by adding fully editable ''Custom Fields'' that are available in WHMCS on a new ticket form, directly in Freshdesk.<br /> | |style="padding: 10px 0px 15px 15px;"|You can also manage ticket fields, by adding fully editable ''Custom Fields'' that are available in WHMCS on a new ticket form, directly in Freshdesk.<br /> | ||
Move to '' 'Freshdesk' → 'Admin' → 'General Settings' → 'Ticket Fields'. '' On this site you can edit or add new custom fields in order to collect the data you need from the customer when they submit a ticket.<br /> | Move to '' 'Freshdesk' → 'Admin' → 'General Settings' → 'Ticket Fields'. '' On this site you can edit or add new custom fields in order to collect the data you need from the customer when they submit a ticket.<br /> | ||
− | Choose | + | Choose ''Single Line Text'' from '' 'Drag & Drop Field' '' to add your new ticket field. |
|} | |} | ||
{| | {| | ||
Line 276: | Line 276: | ||
|} | |} | ||
{| | {| | ||
− | |style="padding: 0px 0px 10px 15px;"|For test purposes we adjusted '' 'Client Service' '' field according to our needs.<br/> | + | |style="padding: 0px 0px 10px 15px;"|For test purposes we adjusted the '' 'Client Service' '' field according to our needs.<br/> |
Make sure to leave the 'Required when submitting the form' box unchecked to keep this field optional for the clients trying to open a new ticket. | Make sure to leave the 'Required when submitting the form' box unchecked to keep this field optional for the clients trying to open a new ticket. | ||
|} | |} | ||
Line 311: | Line 311: | ||
|} | |} | ||
{| | {| | ||
− | |style="padding: 0px 0px 20px 15px;"|Now, you can manually export all of the users available on the list or choose only some of them.<br/>Check boxes next to the users you are going to export and press '' 'Export' '' button, marked with the red arrow on the screen.<br/> | + | |style="padding: 0px 0px 20px 15px;"|Now, you can manually export all of the users available on the list or choose only some of them.<br/>Check boxes next to the users you are going to export and press the '' 'Export' '' button, marked with the red arrow on the screen.<br/> |
You can always check the status of the exported clients. | You can always check the status of the exported clients. | ||
|} | |} | ||
Line 332: | Line 332: | ||
|} | |} | ||
{| | {| | ||
− | |style="padding: 0px 0px 20px 15px;"|Now, you can manually export all of the tickets available on the list or choose only some of them.<br/>Check boxes next to the tickets you are going to export and press '' 'Export' '' button as marked on the screen. | + | |style="padding: 0px 0px 20px 15px;"|Now, you can manually export all of the tickets available on the list or choose only some of them.<br/>Check boxes next to the tickets you are going to export and press the '' 'Export' '' button as marked on the screen. |
|} | |} | ||
{| | {| | ||
Line 338: | Line 338: | ||
|} | |} | ||
{| | {| | ||
− | |style="padding: 0px 0px 15px 15px;"|If a ticket has already been exported from WHMCS to Freshdesk, they will have a different ''Freshesk Status'' | + | |style="padding: 0px 0px 15px 15px;"|If a ticket has already been exported from WHMCS to Freshdesk, they will have a different ''Freshesk Status'' visible on the list.<br/> All tickets newly created to WHMCS will be automatically synchronized with Freshdesk.''<br/><br/> |
|} | |} | ||
{| | {| | ||
Line 346: | Line 346: | ||
==Support Tickets== | ==Support Tickets== | ||
{| | {| | ||
− | |style="padding: 10px 0px 15px 15px;"|Move to your client area. There, on your homepage, is | + | |style="padding: 10px 0px 15px 15px;"|Move to your client area. There, on your homepage, is the '' 'Recent Support Tickets' '' box. <br/> |
You will find the latest tickets available in your system. The visible tickets are marked with colors related to their current status. | You will find the latest tickets available in your system. The visible tickets are marked with colors related to their current status. | ||
|} | |} | ||
Line 353: | Line 353: | ||
|} | |} | ||
{| | {| | ||
− | |style="padding: 0px 0px 20px 15px;"|Now, we will create a ticket message to show the flow. Just like in case of standard WHMCS support ticket, choose department, fill out the form and submit the ticket. | + | |style="padding: 0px 0px 20px 15px;"|Now, we will create a ticket message to show the flow. Just like in case of a standard WHMCS support ticket, choose a department, fill out the form and submit the ticket. |
|} | |} | ||
{| | {| | ||
Line 380: | Line 380: | ||
=How To Update= | =How To Update= | ||
{| | {| | ||
− | |style="padding: 20px 0px 15px 15px;"|Updating Freshdesk For WHMCS to newest version is quite simple.<br /> | + | |style="padding: 20px 0px 15px 15px;"|Updating Freshdesk For WHMCS to the newest version is quite simple.<br /> |
'''1. Firstly download the newest version from your client area.''' | '''1. Firstly download the newest version from your client area.''' | ||
|} | |} | ||
Line 396: | Line 396: | ||
|style="padding: 0px 0px 15px 15px;"|'''3. Copy settings from '' 'configuration.php' '' to '' 'configuration_RENAME.php' ''.'''<br /> | |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\freshdesk' ''.<br /> | Both files are located at '' 'your_whmcs\modules\support\freshdesk' ''.<br /> | ||
− | + | Afterward, remove the '' 'configuration.php' '' file and rename '' 'configuration_RENAME.php' '' to '' 'configuration.php' ''. | |
|} | |} | ||
{| | {| |
Revision as of 09:44, 18 January 2018
Contents |
About Freshdesk For WHMCS
Freshdesk For WHMCS grants your customers the access to a complex support system solution in your own WHMCS.
With our module your clients will become authorized to manage Freshdesk tickets as if they were an integral part of your system. |
- Client Area Features:
✔ View Freshdesk Departments |
✔ Open New Ticket |
✔ Manage Existing Tickets |
✔ Fill Out Freshdesk Ticket Fields |
✔ Assign Owned Service To Ticket |
✔ Attach Files To Ticket |
✔ List Recent Ticket |
- Admin Area Features:
✔ Configure And Test Server Connection |
✔ Toggle SSL Verification |
✔ Define Available Support Departments |
✔ Manually Export to Freshdesk: |
✔ WHMCS Clients |
✔ WHMCS Tickets |
✔ Define Module Behavior |
✔ Show Solved Tickets |
✔ Update Client Credentials |
✔ Define Replies Order |
✔ Define Client Service Field |
✔ Define Ticket Status Colors |
✔ View Logs |
- Integration:
✔ Automatically Export To Freshdesk: |
✔ New Tickets |
✔ Clients On Tickets Creation |
✔ Synchronize Ticket Responses Between WHMCS And Freshdesk |
✔ Transfer Ticket Fields Settings |
- General Info:
✔ Custom Templates Support |
✔ Multi-Language Support |
✔ Supports PHP 5.6 Up To PHP 7 |
✔ Supports WHMCS Template Six |
✔ Supports WHMCS V7 |
Installation and Configuration
This tutorial will show you how to successfully install and configure Freshdesk For WHMCS. We will guide you step by step through the whole installation and configuration process. |
Installation
1. Log in to your client area and download the module. |
2. Extract the downloaded file into the main WHMCS directory. The content of the package should look like this. |
3. When you install Freshdesk For WHMCS for the first time you have to rename the 'license_RENAME.php' file. File is located in 'modules/addons/Freshdesk/license_RENAME.php'. Rename it from 'license_RENAME.php' to 'license.php'. |
4. In order to configure your license key, you have to edit the previously renamed 'license.php' file. Enter your license key between quotation marks as presented on the following screen. You can find your license key in your client area → 'My Products'. |
5. Now, set up the 'storage' folder as recursively writable. This folder is available at 'your_whmcs/modules/addons/Freshdesk/' . |
Activation
6. Now, you have to activate the module in your WHMCS system. Log in to your WHMCS admin area and proceed to 'Setup' → 'Addon Modules'. |
7. In the next step you need to permit access to this module. To do so, click on the 'Configure' button, tick checkboxes to assign desired admin roles. |
8. You have just successfully installed Freshdesk For WHMCS! |
Configuration
Now you have to configure your newly installed module. Before we proceed to the configuration itself, you have to log in to your Freshdesk account to find your API details. |
API Connection
Firstly, log in to your Support Portal in order to find API details. |
Click on your profile picture that is in the top right corner of the page and go to the 'Profile settings' section. |
You can find your API key below the 'Change Password' section, on the right side of the page.
Use existing key or reset it to generate a new one. Copy an active API key. |
Server Configuration
Now, that you have safely stored your API, you may move to the second part of configuration. Proceed to 'Addons' → 'Freshdesk' → 'Server Configuration', here you have to enter any data required to connect your WHMCS with the Freshdesk server. |
Enter your Freshdesk details:
Finally, save changes and test the connection. |
Finally, move to 'Setup' → 'General Settings' → 'Support'. There choose the 'Freshdesk' support module from a dropdown menu and save changes. |
Good job! Now your WHMCS is connected with the Freshdesk support system. |
Management
Once Freshdesk For WHMCS is installed and the connection is configured, you can create/update your ticket departments and begin using them. Each ticket department you create in Freshdesk will be available for your customers in WHMCS client area. |
Settings
WHMCS
Before you start your actual work on support tickets with Freshdesk For WHMCS, move again to 'Addons' → 'Freshdesk' → 'Ticket Settings'. This section of the addon allows an easy and comfortable management of the way tickets are displayed in your client area, their visibility, sorting etc. |
In the first box 'Options', you may enable some basic settings that will be applied to tickets view in the client area. Let's now discuss their functionality in details:
|
Under the 'Options' box you will find a section where you can assign some colors to a specific ticket status. Click on the field to choose a color from the palette of colors or type in the number of the color you like. |
Tickets of each status are now marked with the selected colors on homepage. |
Freshdesk Service Field
You can also manage ticket fields, by adding fully editable Custom Fields that are available in WHMCS on a new ticket form, directly in Freshdesk. Move to 'Freshdesk' → 'Admin' → 'General Settings' → 'Ticket Fields'. On this site you can edit or add new custom fields in order to collect the data you need from the customer when they submit a ticket. |
For test purposes we adjusted the 'Client Service' field according to our needs. Make sure to leave the 'Required when submitting the form' box unchecked to keep this field optional for the clients trying to open a new ticket. |
Once you have created your new field, you need to select it in the 'Ticket Settings' section of Freshdesk. Do not forget to save settings. |
As you can see on the screen below, a new field, which may help to draw the Administrator's attention to a specific client's service appeared in WHMCS client area. Edit/add ticket fields to adjust the ticket form perfectly to your needs. |
Export
Our module allows to export data gathered in your WHMCS, more specifically, all the users and tickets generated before the installation of the product. Read the below points to learn what data can be synchronized with Freshdesk and what are the possible means of such synchronizations. |
Users
The first option offered by our module is the export of users from WHMCS to Freshdesk, proceed to 'Users Export' . You will see here a list of all users who exist in your WHMCS and have not been synchronized with Freshdesk yet. |
Now, you can manually export all of the users available on the list or choose only some of them. Check boxes next to the users you are going to export and press the 'Export' button, marked with the red arrow on the screen. You can always check the status of the exported clients. |
After confirming your choice, the selected user should be exported from WHMCS to Freshdesk, their 'Status' field will become modified as well. All users newly added to WHMCS will be automatically synchronized with Freshdesk. |
Tickets
The next option offered by our module is the export of tickets from WHMCS to Freshdesk, proceed to 'Tickets Export'. You will see here a list of all tickets which exist in your WHMCS and have not been synchronized with Freshdesk yet. |
Now, you can manually export all of the tickets available on the list or choose only some of them. Check boxes next to the tickets you are going to export and press the 'Export' button as marked on the screen. |
If a ticket has already been exported from WHMCS to Freshdesk, they will have a different Freshesk Status visible on the list. All tickets newly created to WHMCS will be automatically synchronized with Freshdesk. |
Support Tickets
Move to your client area. There, on your homepage, is the 'Recent Support Tickets' box. You will find the latest tickets available in your system. The visible tickets are marked with colors related to their current status. |
Now, we will create a ticket message to show the flow. Just like in case of a standard WHMCS support ticket, choose a department, fill out the form and submit the ticket. |
A new ticket, sent with Freshdesk For WHMCS module, is immediately visible in Freshdesk admin area. |
Do not hesitate and send a reply to this ticket. |
Client has received an answer. Note that the ticket status has been updated as well. |
Logs
All module activities are recorded in 'Logs' . Note: You might have no visible logs here if there are no logged actions yet. |
In case you no longer wish to see a particular log you can easily remove it. Select a particular entry and click on the bin icon as presented on the screen below . |
In order to delete multiple logs at the same time you can simply take advantage of the 'Mass Remove Action'. |
Tips
1. If you create a custom field in Freshdesk, it will be also visible in WHMCS. Custom fields need to be enabled/visible/editable by the client. |
2. In case you wish to use a custom template, do not forget to place its files in the following directory:
/modules/addons/Freshdesk/templates/client/default/pages/submodule/yourCustomTemplateName/ |
Update Instructions
Essential guidance through the process of updating the module is offered here. While moving from the 1.0.0 version of Freshdesk, note that no data can be migrated, so the module needs to be configured from scratch. |
Common Problems
1. When you have problems with connection, check whether your SELinux or firewall does not block ports. |
2. In case it is taking too much time for new tickets to appear, keep in mind that the module's cache is set for 5 minutes. |