Wiki

Version 23 (Gurpreet Singh, 10/29/2015 04:07 pm)

1 22 Gurpreet Singh
*Installation Procedure*
2 1
3 23 Gurpreet Singh
1. Download and extract the WHMCS & Kayako integration files using the link: https://github.com/kayako/whmcs-integration/archive/master.zip
4 23 Gurpreet Singh
2. In the ‘src/templates/’ folder, copy the ‘kayako’ folder and paste it into the ‘templates’ directory of your WHMCS installation.
5 23 Gurpreet Singh
3. In the ‘src/modules/support/’ folder, copy the ‘kayako’ folder and paste it into the ‘modules/support/’ directory of your WHMCS installation. 
6 23 Gurpreet Singh
4. In the ‘includes/hooks/’ folder, copy ‘hooks.php’ and paste it into the ‘includes/hooks/’ folder of your WHMCS installation. 
7 22 Gurpreet Singh
8 22 Gurpreet Singh
_NOTE: If ‘hooks.php’ already exists, then open the Kayako ‘hooks.php’ file, copy the contents, and paste it into the end of the existing ‘hooks.php’ file._
9 22 Gurpreet Singh
10 22 Gurpreet Singh
At this point the Kayako WHMCS Integration app is installed. All that’s left to do is the app configuration. To configure the app: 
11 22 Gurpreet Singh
12 23 Gurpreet Singh
5. Login to Admin Control Panel of your Kayako installation. 
13 23 Gurpreet Singh
6. On the menu sidebar, click _REST API_ and then _Settings_.
14 23 Gurpreet Singh
7. Next to ‘Enable API’ select the _Yes_ radio button.
15 23 Gurpreet Singh
8. Click the _Update_ button to save your changes.
16 23 Gurpreet Singh
9. Click the _API Information_ link on the menu and copy all of the Kayako REST API details.
17 22 Gurpreet Singh
18 11 Amarjeet Kaur
!http://forge.kayako.com/attachments/593/API_Details.png!
19 22 Gurpreet Singh
20 23 Gurpreet Singh
10. On your WHMCS installation, go the ‘modules/support/kayako’ folder and open the ‘config.php’ file. 
21 23 Gurpreet Singh
11.  Add the Kayako API details in their respective code sections and save your changes. 
22 23 Gurpreet Singh
12. Log into the Admin Control Panel of your WHMCS installation. 
23 23 Gurpreet Singh
13. Navigate to Set up > General Settings > Support > Support Module.
24 23 Gurpreet Singh
14. Select ‘Kayako’ from the drop down and click on Save Changes. 
25 22 Gurpreet Singh
26 8 Amarjeet Kaur
!http://forge.kayako.com/attachments/594/select_Kayako_for_support_module.png!
27 12 Amarjeet Kaur
28 23 Gurpreet Singh
15. Whoo! You are good to go! You can now create and modify tickets using the WHMCS Kayako Integration app.
29 1
30 12 Amarjeet Kaur
31 1
*How to use*
32 12 Amarjeet Kaur
33 1
* *Open New Ticket*
34 12 Amarjeet Kaur
35 1
# In client interface of 'WHMCS installation’, click on 'Open Ticket’ and you will see the following screen:
36 22 Gurpreet Singh
37 12 Amarjeet Kaur
!http://forge.kayako.com/attachments/595/select_department.png!
38 12 Amarjeet Kaur
39 13 Amarjeet Kaur
Select your department for ticket submission and click ‘Next’. 
40 22 Gurpreet Singh
41 12 Amarjeet Kaur
# Type your message details and submit your ticket.
42 22 Gurpreet Singh
43 12 Amarjeet Kaur
!http://forge.kayako.com/attachments/596/step-2.png!
44 22 Gurpreet Singh
45 12 Amarjeet Kaur
# Click on submit to save the ticket details and you will get following screen:
46 22 Gurpreet Singh
47 12 Amarjeet Kaur
!http://forge.kayako.com/attachments/597/step-3.png!
48 13 Amarjeet Kaur
49 13 Amarjeet Kaur
50 13 Amarjeet Kaur
* *View Ticket*
51 14 Amarjeet Kaur
52 14 Amarjeet Kaur
# Click on ‘Support’ and select ‘Tickets’. Here you can see list of all tickets submitted by you.
53 22 Gurpreet Singh
54 14 Amarjeet Kaur
!http://forge.kayako.com/attachments/598/view-tickets.png!
55 22 Gurpreet Singh
56 14 Amarjeet Kaur
# Now click on any ‘Ticket Heading’ to view its details.
57 22 Gurpreet Singh
58 16 Amarjeet Kaur
!http://forge.kayako.com/attachments/599/view_ticket_details.png!
59 16 Amarjeet Kaur
60 1
61 16 Amarjeet Kaur
* *Update Ticket*
62 16 Amarjeet Kaur
63 16 Amarjeet Kaur
# Click on Update button to update ticket status and priority.
64 22 Gurpreet Singh
65 17 Amarjeet Kaur
!http://forge.kayako.com/attachments/600/update_status.png!
66 17 Amarjeet Kaur
67 1
68 17 Amarjeet Kaur
* *Post Reply*
69 1
70 17 Amarjeet Kaur
# Click on 'Post Reply' button to follow up with your ticket and you will see a new message area to post your reply:
71 22 Gurpreet Singh
72 17 Amarjeet Kaur
!http://forge.kayako.com/attachments/601/post_reply.png!
73 18 Amarjeet Kaur
74 18 Amarjeet Kaur
75 18 Amarjeet Kaur
*Knowledgebase*
76 18 Amarjeet Kaur
77 18 Amarjeet Kaur
# In client interface of ‘WHMCS installation’, click on ‘Support’ and select ‘knowledgebase’. Here you will see the list of articles present in helpdesk.
78 22 Gurpreet Singh
79 18 Amarjeet Kaur
!http://forge.kayako.com/attachments/602/knowledgebase.png!
80 22 Gurpreet Singh
81 1
# You can view detail description of article by clicking on its heading  and can also post your comment for it.
82 22 Gurpreet Singh
83 1
http://forge.kayako.com/attachments/603/post_comment.png