Академический Документы
Профессиональный Документы
Культура Документы
3 Staff notifications and alerts . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 1.1.4 Staff user preferences . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 1.2 Handling tickets . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 1.2.1 Ticket listing (ticket view) . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 1.2.2 Viewing and handling a ticket . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 1.2.3 Logging a new ticket . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 1.2.4 Ticket macros (canned responses) . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 1.2.5 Ticket searching . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 1.2.6 Ticket filters (saved searches) . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 1.2.7 Ticket views . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 1.3 Live support . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 1.3.1 Call logs . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 1.3.2 Canned . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 1.3.3 Chat history . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 1.3.4 Messages and surveys . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 1.3.5 Search messages . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 1.4 Knowledgebase . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 1.4.1 Categories . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 1.4.2 Manage knowledgebase . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 1.4.3 New article . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 1.4.4 View knowledgebase . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 1.5 Troubleshooter . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 1.5.1 Manage Troubleshooter . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 1.5.2 New Step . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 1.5.3 Troubleshooter Categories . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 1.5.4 View Troubleshooter . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 1.6 News . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 1.6.1 Insert news . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 1.6.2 Manage news . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 1.6.3 News categories . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 1.6.4 Subscribers . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 1.6.5 View news . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 1.7 Users and Organizations . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 1.7.1 Insert organization . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 1.7.2 Insert user . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 1.7.3 Manage organizations . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 1.7.4 Manage users . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 1.7.5 Search users & organizations . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 1.8 Reports . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 1.8.1 Report Types . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 1.8.2 Kayako Query Language (KQL) . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 1.8.3 KQL Reference . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . .
2 2 2 6 7 13 15 16 18 25 27 31 33 35 39 40 41 44 49 52 54 55 58 59 61 61 62 64 67 70 71 72 75 76 78 80 80 81 83 86 87 88 89 91 96 101
Home (staff)
Comment moderation
Table of contents 1 Overview 2 View client comments 3 Approve client comments 4 Mark comment as spam 5 Delete a comment
Overview
This section holds all the comments that the users have made on the Knowledgebase articles, News articles and Troubleshooter, at the client support interface. The client comments will not be visible in the comments section under the article the comments are made, at the client support interface, until a staff user who has the access to moderate the comments, approves them from the staff control panel. In the following example, a client is commenting at one of the published News article, from the client support interface
This comment will be saved under the comments section in the staff control panel, as shown
The staff user who has the access to view and approve the comments, can review the comment and approve it, if desired. Once the comment is approved, it can be seen under that particular news article, as shown
By default, you will be presented with a page that lists all the comments that are pending approval, a shown
In order to view complete history of the approved comments by you or other staff users, click on Approved in the left hand side Status box, and you will be presented with the page which displays all the approved comments.
In the above snapshot the comment "This is a test" from the author "test" is marked as spam, and will be immediately moved to the Spam folder.
Delete a comment
In order to delete a comment or multiple comments simultaneously, mark the boxes corresponding to the comments to be deleted, and click Delete, as shown
The comment or comments will then be deleted from the staff control panel.
Staff dashboard
Table of contents 1 Various parts of the dashboard 1.1 Navigation menu bar and sub-menu bar 1.2 Department and ticket tree 1.3 Staff status box 1.4 Quick reference menu
The dashboard is your staff user's helpdesk homepage, providing them with an overview of what is currently happening and what new things have come into the desk.
main menu bar is sub-menu bar which allows you to insert and mange knowledgebase articles, news articles etc.
1 View and manage notifications 2 Inserting a notification rule 2.1 Inserting a notification as user type 2.2 Inserting a notification as ticket type
A ticket notification is processed (based on a set of criteria or rules) whenever a certain ticket-related action occurs, notifying by e-mail or SMS to all staff users or one staff user of the event. For example, a ticket notification can be created to e-mail all the staff users when a new ticket is created of priority " Urgent". Ticket notifications can be public or private. A public ticket alert is executed for all staff members, whereas a private ticket alert is executed only for yourself.
You will be presented with a list of all the current notification rules present within the support desk system, along with their type (Ticket/User) and creator.
Example of user type notification: If you have inserted a notification for New User Registration, then, whenever a new client registers via client support interface, the staff users will get an alert at the email addresses the notification is configured for, as shown
Example of ticket type notification: If you have inserted a notification for the change of department to services, then, whenever the department of a ticket changes to services, the staff users will get an alert at the email address the notification is configured for, as shown
General
This is the name with which this rule will be inserted. The name should always be relevant to the nature of the rule you are inserting, although it entirely depends on your preference. You can create this notification and keep it disabled until required. You may create as many notification rules and keep them disabled for future usage. Select from the following criteria: Event: User Group:
Specify the prefix for the notification made. Prefix helps to identify that the email being received is a notification. Select the staff users to whom you wish to dispatch the email notifications.
Specify a custom email address here to whom you wish to send the notification to. This is helpful if you wish to send notification to a non staff members.
Notify App
Staff
Select the staff users who will get the notifications on their Kayako Alert desktop application.
Click Insert to save and insert this notification in the support desk system.
General
Rule Title
This is the name with which this rule will be inserted. The name should always be relevant to the nature of the rule you are inserting, although it entirely depends on your preference.
You can create this notification and keep it disabled until required. You may create as many notification rules and keep them disabled for future usage. Select a criteria from the drop down menu for which you wish to get the notifications. You can select multiple criteria by clicking on the Insert Criteria tab. Select OR if you wish any one of the criteria should be met, or select AND if you wish that all the inserted criteria should be met.
Specify the prefix for the notification made. Prefix helps to identify that the email being received is a notification. Select from the following options: Staff: If selected, notification would be send to ticket owner. Staff Team: If selected, notification would be send to the team in which the ticket owner is. Department: If selected, notification would be sent to all the staff users of the department of current ticket owner.
Select the staff users to whom you wish to dispatch the email notifications. Specify a custom email address here to whom you wish to send the notification to. This is helpful if you wish to send notification to a non staff members.
Notify App
Select from the following options: Staff: If selected, notification would be send to ticket owner's Kayako Alert desktop application. Staff Team: If selected, notification would be send to Kayako Alert desktop application of the team in which the ticket owner is. Department: If selected, notification would be sent to Kayako Alert desktop application of all the staff users under the department of current ticket owner.
Staff
Select the staff users who will get the notifications on their Kayako Alert desktop application.
Click Insert to save and insert this notification in the support desk system.
Overview
This section allows the staff user to edit his/her profile data. The staff user can edit his/her personal details viz. name, username, profile image, password etc.
The administrator has the privileges to change the profile for any staff user, anytime he wishes to, from the admin control panel. The following settings will then be overwritten for this particular staff user or any staff user which is being edited. Also, the staff user can individually change his/her profile settings, and that will be updated at the admin control panel.
There are three different configurable settings tabs that are provided under preferences section: Profile Change Password Assigned Departments All the settings under the above mentioned tabs are explained in this section
Profile
Edit/change first name of your profile Edit/change last name of your profile Edit/change the email address of your profile Change/insert your profile image. This image will appear in all ticket posts replied by you and in the live chat window.
Mobile Phone Number Signature Time Zone Enable Daylight Savings Auto Greeting
Change/insert your mobile phone number. You need this mobile phone number inserted here if you wish to receive the SMS alerts Edit/change the outgoing emails signature of your profile. This signature will be appended to all outgoing email messages sent by this staff user. Change/select an appropriate time zone for your profile Select whether or not you wish to enable Daylight Savings Time for your profile Change/insert the greeting message that will be dispatched automatically whenever you accept a chat via Kayako Desktop from a client.
Change Password
Insert your current staff user login password Insert the new password you wish to keep. The password should be inserted according to the password policy configured in the admin control panel Insert the new password again that you have inserted in the New Password column
Assigned Departments
This section provides you an overview of the departments (tickets & live chat modules) assigned to you. The live chat and tickets departments are represented with their respective icons
Handling tickets
Table of contents
1 Overview
Overview
The ticketing features of support desk make up one of the major components of the system ticketed help support. The client user can submit a support ticket via the client support interface as shown.
The user can also submit a ticket through an e-mail (if the email queues are setup in the admin control panel), by sending an email at the designated email queue, for example "sales@supportdesk.com" When a new e-mail is sent with a new subject, a new ticket is created. All e-mail replies to this e-mail subject (which contains, by this time, a ticket ID) will be appended to the same ticket. The client can log in to the client support interface and review all correspondence to and from their e-mail address, and staff users can log in to the staff control panel to review tickets (such as move their department, respond to tickets, change a ticket's status and much more). A ticket that is created in the support desk system has the following properties: Ticket ID Ticket subject Ticket department An SLA plan Ticket type Ticket status Ticket priority Flag This is the identification number that will be attached to the ticket, after being submitted either from the client support center or via email queue. This is the subject of the ticket submitted. This is the department in which the ticket is submitted. The ticket can be located by the staff users under this department. An SLA plan is being associated with all the tickets that comes into the support desk system. A ticket type is associated with a ticket. The default ticket types are issue, bug, task, feedback and lead. A ticket status is associated with a ticket. The default ticket statuses are open, in progress and closed. A ticket priority is associated with a ticket. The default ticket priorities are normal, medium, high, urgent, emergency and critical. A ticket flag can be used to identify a particular kind of ticket.
The various icons that are seen besides the Ticket ID and Subject of a ticket are used to identify various ticket properties. The various icon are described in the following section. Icons Description This ticket is created via an email queue inserted in the support desk. The ticket has note(s) with note type as User. The ticket is assigned to you.
This is an escalated ticket The ticket has note(s) with note type as Ticket or User Organization. This ticket is created with type as Ticket. There has been an activity on this ticket recently. The ticket is being viewed or replied to by another staff user. The ticket has a scheduled follow-up attached to it. More information on follow-up tab can be found here. Time tracking and billing is enabled for this ticket.
From within a ticket list, click on a ticket's ID/subject to access the ticket view. You will then be presented with the ticket view interface similar to the following.
The various tabs on the ticket management menu are explained in the following section.
Tabs
General
The general tab shows the ticket contents and other properties associated with it, viz. ticket department, ticket owner, ticket note, SLA associated with the ticket and much more. The various properties of a ticket under general tab are shown here.
Reply
Clicking on the reply tab will present you with the ticket reply interface. The ticket properties and information can be altered while replying to a ticket.
Forward Follow-Up
The follow-up tab is used to add a scheduled task for a ticket. For example, if you wish to change the ticket status from Close to Open at some particular date and time, then you can schedule a follow-up task for that ticket. The follow-up tab has the following components.
You can setup the follow-up time in minutes, hours, days, weeks, months or you can customize it to a particular date and time. Select the general option if you wish to set the follow-up to change the ticket department, owner, type, status and priority. Select the add note option if you wish to set the follow-up to add a note on the ticket at a particular date and time.
Select the post reply option if you wish to schedule the ticket reply. The post reply option allows you to add the ticket reply content and support desk schedules it at a latter time as set by you. Select the forward option if you wish to schedule the forwarding of this ticket at a latter time.
You can check the follow-up status, by clinking the follow-up tab. The status will be shown along with the time left for the task to execute, as shown below.
Billing
The billing module allows you to bill your customers in accordance with the time spend, working on the ticket. The time spent working on a ticket and what of that is billable can be logged to a ticket, including a work summary. Time tracking and billing information for a ticket (if the data exists) will appear on the ticket information bar when viewing a ticket, as shown below.
When billing or time tracking information has been added to a ticket, a ticket billing indication icon Unable to render embedded object: File (icon_tickettimetrack.gif) not found. will be given within a ticket listing, as shown.
To add time tracking information to a ticket, click on the Billing tab. This will open the billing/time tracking interface, as shown below.
Time Spent
Specify the following time for the following criteria: Worked: Total time spent (in minutes) working on this entry. Billable: Time (in minutes) that is billable out of the total worked time.
The date and time of billing. The date and time of working. Which staff user performed the recorded work. Specify the details of the log.
Release
The release tab allows you to perform multiple tasks on a ticket viz. changing ticket department, ticket owner, billing time, adding a note, ticket resolution and due time in a single go. Select the required options and click Update to make all the required changes to the ticket.
Chats
The chats tab logs all the chats which originated from the same client user who has submitted this ticket. The identification is made on the basis of the email address used while submitting the ticket and initiating the chats. Click on the chats tab to see all the chat history of the client user, as shown.
Click on the chat ID or user's fullname to see the complete chat details of that chat. For more information on chat logs, click here.
Calls History
The history tab logs all the tickets which originated from the same client user. The identification is made on the basis of the email address used while submitting the tickets. Click on the history tab to see all the ticket history of the client user, as shown.
Click on the ticket ID or ticket's subject to see the ticket properties and contents.
Audit Log
The audit log of a ticket details every action performed by the user, system or a staff user on a ticket. The audit log provides a powerful way of overseeing the path a ticket has taken through the support system. These logs entries cannot be modified using the support desk interface. An example of a ticket's audit log is shown below.
A logged action performed by the system will have an Entry Type of System. Some system actions include automatically setting a due time according to an SLA plan, or automatically closing a ticket if auto-close has been enabled from within the administrator control panel. The following actions will be logged by the audit log: == ACTION TABLE ==
Edit
Click on the Edit tab to open a list of editable ticket fields, as shown below.
To merge the current ticket to another ticket, enter the ID of the second ticket here. The ticket replies will all be merged chronologically, and the current ticket will be deleted. The ticket creator's address of the current ticket will be added as a CC user to the new, merged ticket. Specify a new subject for the ticket, if you wish to change the current subject. This is the full name of the ticket creator.
This is email address of the ticket creator. Specify a custom SLA for this ticket with will override the default SLA attached to it. A third party recipient added to a ticket is carbon copied all replies sent by a staff user. A third party is able to send e-mail replies and have them appended to the ticket that was not originally created by them. A CC user who has been added to a ticket is carbon copied all replies sent by a staff user. A BCC user who has been added to a ticket is blind-carbon copied all replies sent by a staff user.
Adding an e-mail address as a recipient does not give a user of this e-mail address access to the client support interface.
Whether or not a user gets to see third party recipient replies in the client support interface is configured in the administrator control panel.
Buttons
Add note
Notes can be attached to tickets, client user accounts or user organizations. These notes can be viewed only by staff users (or specific staff users - this is defined at note creation). Notes can be used to share information between staff users, or simply as a record whilst working on a ticket or dealing with a client. A note that is attached to a ticket will be visible on the ticket information bar when viewing the corresponding ticket. A note that is attached to a user account will be visible in the same place for every ticket the user creates, as shown below.
To add a note, click on the Add Notes tab. This will open the add note interface, as shown below.
Notes
Type the contents of the note here. You can use different colors for different type of notes.
Note Type
Select from the following note types: Ticket: This note will be attached to the particular ticket. User: This note will be attached to the user account, and every ticket will have this user note which originates from this particular user. User Organization: This note will be attached to all the tickets that are created by the client users under this particular user organization.
Visibility
Select to whom the note will be visible to. A note can be visible to all staff members or a specific staff member.
Take/Surrender
Take Surrender If a staff user wishes to assign a ticket to him/herself, then he/she can just click Take tab and the ticket will be assigned to that staff user. Once a ticket is taken or assigned to by a staff user, it can be surrendered by clicking the Surrender tab. A surrendered ticket will not be assigned to any staff user.
Dispatch
The dispatch tab allows a staff user to assign a particular ticket to a particular staff user. Clicking on the dispatch tab, a list of all the staff users will be displayed, and the ticket can be assigned to one of the staff users.
After selecting a staff user, click Assign to assign to this ticket to the selected staff user.
Watch
The watch tab is used to track the activities on a ticket. On selecting this option, staff member will receive alert on his/her email address for every reply/update on the ticket by the client and staff users.
Flag
A ticket can be flagged with a flag of a certain color. This functionality is useful for dynamically and quickly organizing tickets from within a ticket listing or ticket view. Click on Flag tab to select a flag from the drop down menu and attach it with the ticket.
Spam
Clicking on the spam tab, the ticket will be marked as spam, and according to the Bayesian feature, software will mark the content/email address as spam and will restrict such emails.
Trash
Click on the Trash tab to move the ticket into the trash folder. From within the trash folder the ticket can be deleted permanently.
Overview
The staff users can create tickets from within the staff support center. This feature is particularly beneficial if the staff needs to create a ticket on clients behalf, if for some reasons the client got disconnected from the live chat and his queries went unanswered or you wish to send a mass mail to some of your clients regarding a server outage etc.
On clicking the New Ticket button, you will be prompted to select the department in which you wish to create the ticket, as well as you need to select the type of ticket you are creating, as shown
Type
Select from the following two types: Send Mail: In this type a general email is being sent to the recipient. As User/Phone:
Department
Select from the drop down menu the department you wish to create this ticket in. The department permissions for staff users are set here.
There are two different sections that are provided on this page, which are:
Click Add Note tab to add a ticket note. The ticket notes are visible to the staff users only and are hidden from the client users. Notes can be used to share information between staff users, or simply as a record whilst working on a ticket or dealing with a client. Click the Attach tab to attach a file or multiple files with this ticket. Click Options tab to set the following parameters: BCC: If you wish to dispatch this ticket to additional email addresses concealing them from the recipients in the To and CC field, then, specify the email addresses in this Bcc filed. Due: As part of the new ticket, a due date and time can be set for the ticket. Clicking on the calendar icon will bring up a calendar. Clicking on a day will set the ticket due date and besides that the due time can be set. Resolution Due: As part of the new ticket, a resolution due date and time can be set for the ticket. Clicking on the calendar icon will bring up a calendar. Clicking on a day will set the ticket resolution due date and besides that the resolution due time can be set.
This is the email address from which the email is being sent, that is, this email address will be in the "From" filed of the sent ticket. If there are multiple e-mail queues configured for your support desk, a different From address can be set here. Specify a subject for this ticket. Specify the email address of the recipient. This is the carbon copy field. Specify additional email addresses of the recipients, if required. Select and insert from the following categories: Macros: Introduces a menu of predefined reply categories, allowing you to navigate through the replies and paste a predefined reply into the reply area. Knowledgebase: Working similarly to the predefined replies menu, opening this menu will introduce a list of knowledgebase categories and articles for pasting into the reply area.
Recurrence
The recurrence feature allows you to set a recurrence date and time for this ticket and this ticket will be re-created with the same ticket properties
Once you have specified all the fields, click Send to send the ticket from the support desk.
Overview
A ticket macro is more commonly known as a standard reply a ticket reply that has already been typed up along with a predefined ticket properties associated with it and saved for re-use. When selecting a macro, the ticket property changes are not executed immediately. The macro fills in the reply options as defined while creating the macro, that is you can make the changes to the ticket properties beyond the defaults set by the macro you selected.
2. You will be presented with a list of macros inserted under the category you have selected, as shown
3. Click on the macro to insert the contents defined in the macro along with the change of ticket properties associated with it, as shown
Executing the above macro has inserted the reply contents to the ticket, along with a change of department, ticket type, ticket status and priority. You may make any change to these settings, before sending the reply.
In the macros section, click on Replies tab, and you will be presented with a list of all the current macros inserted in the support desk system, along with the categories under which they are inserted.
Insert Category
In order to insert a new macro category/sub-category, click on Insert Category and you will be directed to the page where you will need to provide the information relevant to the new category/sub-category you are inserting, a shown
This is the name with which this category/sub-category will be inserted. The name should always be relevant to the nature of the category/sub-category you are inserting, although it entirely depends on your preference. Select if you wish to insert this category as a parent category or as a sub-category of an already inserted category. Select from the following two category types: Public: If inserted as public, this category will be visible to all the staff users. Private: If inserted as private, this category will be visible only to the staff user who has created it.
Visible to
You can restrict the visibility of this category to a specified team by selecting one from the available in the drop down menu.
Click Save once you have specified all the required fields to save the newly created macro category in the support system.
Insert Macro
In order to insert a new macro, click on Insert Macro and you will be directed to the page where you will need to provide the information relevant to the new macro you are inserting. There are two different configurable settings tabs that are provided on this page, which are: 1. General 2. Properties All the editable fields specific to these two tabs are explained in the following section
General
This is the name with which this macro will be inserted. The name should always be relevant to the nature of the macro you are inserting, although it entirely depends on your preference. Select if you wish to insert this macro under parent category, that is, root category or under an already existing category. Insert the contents that you wish to be associated with this macro.
Properties
Ticket Properties
Specify the ticket properties that you wish to be associated to the ticket when this macro is applied to it. For example, change of department, owner, ticket type and so on.
Click Save once you have specified all the required fields, to save the newly created macro in the support system.
Ticket searching
Table of contents
Overview
The search tool is provided in the staff control panel to locate a particular ticket or a batch of tickets. The advanced search feature allows you to filter the list of tickets according to certain ticket properties, that match the criteria you have inserted.
It lists all tickets that have been created or replied to since your last visit. It performs an advanced ticket search. For more information, click here. It quick-search all common ticket fields. Type in the required search terms followed by pressing the return key to perform a search. When the ID of a ticket is known, it is possible to directly open up the ticket. Type in the ticket ID followed by pressing the return key to perform the lookup. It lists all tickets created by or replied to the address of name(s) entered here. Type in your search terms followed by pressing the return key to perform the search.
If tickets that match your search criteria are found, a new listing of these tickets will be presented, otherwise you will get a zero tickets found message, as shown
Select if you wish that all the inserted criteria (if you have inserted multiple criteria in the Insert Criteria option) should be met, that is Match All, or any one of the inserted criteria should be met, that is Match Any, for this search lookup.
Insert the criteria by selecting the options from the drop down menu according to your preferences. More than one search criteria can be added to the advanced search by clicking on the Insert Criteria button.
Click Lookup button to start the search corresponding to the criteria inserted and if tickets that match your search criteria are found, a new listing of these tickets will be presented.
Overview
Ticket filters allow you to quickly access and sort through your tickets across all departments by setting a variety of filter criteria. Filters can be created publicly or privately. A private ticket filter is only accessible by the staff user who created it, meaning that staff members can create and manage their own ticket filters. A public ticket filter is accessible to all staff users. When created, a ticket filter will appear in the Filters drop down menu provided on the tickets navigation menu bar. When a filter is executed ( clicked on), a ticket listing of all tickets that match the filter's criteria will be displayed. An example ticket filter is shown below. It has been created to display all tickets that have been set to the status In Progress that have a Critical priority
You will be presented with a list of all the current ticket filter rules present within the support desk system, as shown
This is the name with which this filter rule will be inserted. The name should always be relevant to the nature of the rule you are inserting, although it entirely depends on your preference. Select from the following two options: Public: If selected, the filter will be accessible to both the creator and all other staff users as well. Private: If selected, the filter will be accessible only to the creator and will be hidden from other staff users.
You can restrict the visibility of this filter to a specified team by selecting the team from the drop down menu. Select from the following two options: Match All (AND): Only tickets that match all of the criteria you have set will be listed when this filter is executed. Match Any (OR): Only tickets that match any of the criteria you have set will be listed when this filter is executed - if you have set three criteria and a ticket matches one of them, the ticket will still be listed. Insert the required criteria for which you wish to list the tickets when this rule is executed. You can insert multiple criteria.
Insert Criteria
Click Insert once you have specified all the required options, to save the newly create ticket filter in the support desk system.
Ticket views
Table of contents 1 Overview 2 View and manage ticket views 3 Inserting a new ticket view 3.1 General 3.2 Options 3.3 Columns
Overview
From within a ticket list, the view of the list displayed, can be customized. Listing templates can be created to display a list of tickets in a particular way. That is, the information for the tickets shown in a list can be customized. When viewing a ticket list, the ticket listing view can be changed by clicking the View menu, and selecting a particular view that is inserted in the
You will be presented with a list of all the current ticket views present within the support desk system, as shown
General
This is the name with which this ticket view will be inserted. The name should always be relevant to the nature of the view you are inserting, although it entirely depends on your preference. Select from the following options: Unassigned: If selected, all the tickets which are currently not assigned to any staff user will be displayed when this view is selected. Assigned To Me: If selected, all the tickets which are currently assigned to the creator of this view will be displayed when this view is selected. All Tickets: If selected, all the tickets which are currently assigned or unassigned to any staff user will be displayed when this view is selected. Select from the following options: Global Views: If selected, this view will be visible for selection to all the staff users inserted in the support desk, including yourself. Private Views: If selected, this view will be visible for selection only to the creator of this view. Team Views: If selected, this view will be visible for selection to you and your team members.
View Scope
Using this option, you can link this view with the selected departments. The linked departments will automatically use this view when opened, however, if there are two views linking to the same department then the view to be used will be selected in the chronological order.
Options
Tickets Per Page Auto Refresh Grid Select Owner as Active Staff User Default Ticket Status when Replying/Forwarding After reply/forward take me to
Specify the number of tickets to be displayed on a single page for this view. If enabled, the ticket listing will be auto refreshed after this much interval of time. If enabled, the ticket will be assigned to the staff who is replying/forwarding the ticket, if this view is selected. Select the status to which tickets should be set to after you have made a reply or forwarded the ticket.
Select the section from the drop down menu, to which you should be directed after you have made a reply or forwarded the ticket. You can select from the following sections: Top Level Ticket List (View All): If selected, you will be directed to the Tickets > Manage Tickets page, that is, to the page where all the tickets are displayed, irrespective of the departments they belong to. The Active Ticket List (Department/Search): If selected, you will be directed to the page from where you have replied/forwarded the ticket. The Active Ticket: If selected, you will stay on the same ticket, after it has been forwarded/replied to, irrespective of the ticket properties. The Next Available Ticket: If selected, you will be presented with the next ticket in the queue.
Columns
Select the field by which the tickets will be sorted (such as ticket ID, last response time, subject etc). Select whether the tickets will be sorted from top-to-bottom (ascending) or bottom-to-top (descending). Drag and drop the fields in the box (as shown in the snapshot) that will be displayed within the ticket listing view. The fields will be displayed as shown:
In the above snapshot, the fields are sorted by Last Activity. Click Insert, once you have specified all the required options to save the newly created ticket view in the support system.
Live support
Table of contents 1 Overview 2 View and manage live chat
Overview
The Live chat module and area of the staff control panel is available only in Fusion and Engage installations. For more information on Kayako's different products, click here. From the Live chat area, staff members can review message histories, chat histories, call logs, manage canned messages, etc. Rest of the support desk logs can be found here.
Call logs
Table of contents 1 Overview 2 Access and view call logs
Overview
This section logs all the call conversations that the client has initiated with the staff users from the client support interface, along with the call properties, such as phone number, call duration, type etc.
You will be presented with a list of all the outgoing and incoming call logs within the support desk system, as shown
Click on a phone number to view its properties. Clicking a phone number will open up a floating window showing all the ticket properties, as shown.
Canned
Table of contents 1 Overview 2 View and manage canned responses 2.1 Categories 2.2 Responses 3 Insert a new category 4 Insert a new canned response
Overview
A canned message is very much like a predefined reply. The predefined reply is created and managed via the staff control panel, the canned messages list is populated in the Kayako Desktop application at login. During a chat session, a user can send a canned message to a client, as shown in the following screenshot.
Categories
Clicking on the categories tab you will be presented with a list of all the current categories/sub-categories inserted in the support desk system, as shown
Responses
Clicking on the responses tab you will be presented with a list of all the current canned responses inserted in the support desk system, along with the categories under which they are inserted, as shown
Specify a category/sub-category title/name. Select a category name under which the new category will be added. Select from the following category type: Public: This category type will be visible to all the staff users. Private: This category type will be visible only to the staff user who created the category.
Click Save to save the changes and insert the new category/sub-category in the support desk system.
Specify a title/name for the caned response. Select the category under which this canned response will be added.
Check the box and insert the URL to be dispatched when this canned response is chosen. Check the box and insert an image URL or upload an image(in gif/png/jpeg format) from the local hard disk drive tp be dispatched when this response is chosen. Check the box and select the type of message (either text or code) to be dispatched to the user when this response is chosen. The message or code to be dispatched is inserted in the contents box.
Click Save to save the changes and insert this canned response in the support desk system.
Chat history
Table of contents 1 Overview 2 View and manage chat history 3 Viewing a chat log 3.1 Chat: chat ID 3.2 GeoIP 3.3 History 3.4 Tickets 3.5 Calls
Overview
This section logs all the live chat conversations that the client has initiated with the staff users from the client support interface, along with the rating client has given to that chat conversation.
You will be presented with a list of all the ongoing and previous chat logs within the support desk system, as shown
The description of the various column fields under which the logs are created is as follows: Quick Filter Chat status icons This section is provided to quickly sort the tickets on the basis of the department they are logged in, date on which the chat was logged and type of chat log. The following three icons represents the chat status: This icon represents an ongoing chat conversation. This icon represents a chat conversation which was terminated before completion. This icon represents a completed chat conversation. Chat ID Full Name Staff Name Department Date This is the ID of the chat log with which is logged in the support desk system. This is the full name of the client as inserted at the start of the chat conversation, along with the chat subject. This is the full name of the staff user which which the chat was initiated. This is the department which was selected by the client at the start of the chat conversation. This is exact date and time at which this offline message or survey was submitted.
All the fields specific to these tabs are explained in the following section.
Chat: chat ID
Subject Wait Time IP Address Chat Type Round Robin Hits Rating Is Proactive? Chat Status Insert Tag Survey Comments Conversation
This is the question client specified while initiating the live chat. This is the time elapsed after which the staff user accepted the chat request. This is the IP address from which the chat originated. If the user made the chat request, the chat type will be displayed as Client < > Staff. If the staff user made the chat request (preemptive chat), the chat type will be displayed as Staff < > Client. The number of round robin tries before the chat got connected to the staff user. The star rating that client gave at the end of the chat conversation.
The chat status specifies is a particular chat has ended mutually or went unanswered. If you wish to tag this chat log, then specify the tag(s) here. These are the comments client has given at the end of the chat conversation. This is the transcript of the chat conversation between the client and staff user.
Create Ticket
The create ticket option allows you to automatically send a ticket to the client user with the chat subject and contents. A ticket (with type as email) for the chat log shown in the above snapshot will look like, as shown
Add Note
Click add note tab if you wish to put up a text note on the chat log for reference.
Email
Click email tab to forward the contents of the chat transcript to an email account. On clicking the email tab you need to insert the recipient's email address along with a text note and click save to send the contents. The recipient will receive the chat contents in the following format.
Print
Click print tab to print the contents of the chat transcript. The contents will be printed in the following format.
Delete
Click the delete tab to delete this particular chat log. Once deleted, you will get a success message, as shown.
GeoIP
The GeoIP tab logs the client's location information, as shown.
History
The history tab logs all the previous chats originating from the same email address.
Tickets
The tickets tab logs all the previous tickets originating from the the same email address.
Calls
This section logs all the call information initiated from this client user.
Overview
This section contains the following logs: Messages: These are the messages left by the client users when live support is unavailable. For example, if no staff user is logged into the Kayako Desktop application or if all staff users are busy at that moment, the client is prompted to leave a message, when he clicks on the live chat icon, which then route here. Click here for more information on message routing. The offline messages are identified by an envelope icon (for unread message) and (for read message).
Surveys: These are the ratings given by the clients at the end of a chat, along with their remarks for that particular survey. The client ratings are prefixed with a star icon , which helps to identify them from the offline messages.
You will be presented with a list of all the currently logged messages and surveys within the support desk system, as shown
The description of the various column fields under which the logs are created is as follows:
This is the ID of the survey or offline message with which is logged in the support desk system. This field is only associated with the offline messages. The chat surveys will not have any subject associated with them. This is the department which was selected by the client at the start of the chat conversation. This is the full name of the client as inserted at the start of the chat conversation. This is exact date and time at which this offline message or survey was submitted.
Editing a message/survey
In order to edit an offline message, click on that particular message and you will be directed to the page where you can make the necessary edits. This section is divided into four tabs, which are: 1. 2. 3. 4. Message Reply GeoIP Chats
The information and settings defined under these tabs are explained in the following section.
Message/Survey:ID
This section describes the general properties of the offline message, viz. subject of the message, full name of the client, date of creation, message ID etc. Insert a tag for this offline message, if needed. These are the message contents with which this offline message was created by the client from the client support center.
Reply
Select the email address from which the reply should be dispatched. This email address will be in the From: field of the reply received by the client user. Specify the subject for this reply. Specify the contents of the reply to be sent.
GeoIP
As shown in the above snapshot, GeoIP determines the geographical location and other information about the client. Please click here for GeoIP introduction and configuration instructions.
Chats
The chats tab shows all the previous chat logs for a particular client. In the above screenshot there are a total of two previous chats that have been initiated by a client "Mathew" from the client support interface, in General department.
Search messages
Table of contents 1 Overview 2 View and search messages/surveys and client chats 3 Advanced search option
Overview
The search tool is provided in the staff control panel to locate a particular client chat or messages/surveys . The advanced search feature allows you to filter the list of tickets according to certain properties, that match the criteria you have inserted.
It performs an advanced chat and messages/surveys search. For more information, click here. It quick-search all common chat and messages/surveys fields. Type in the required search terms followed by pressing the return key to perform a search. When the ID of a client chat is known, it is possible to directly open up the ticket. Type in the chat ID followed by pressing the return key to perform the lookup. Specify a key word to search the related message/survey log.
If tickets that match your search criteria are found, a new listing of these tickets will be presented, otherwise you will get a zero tickets found message, as shown
Select if you wish that all the inserted criteria (if you have inserted multiple criteria in the Insert Criteria option) should be met, that is Match All, or any one of the inserted criteria should be met, that is Match Any, for this search lookup.
Insert the criteria by selecting the options from the drop down menu according to your preferences. More than one search criteria can be added to the advanced search by clicking on the Insert Criteria button.
Click Lookup button to start the search corresponding to the criteria inserted and if the chat conversation(s) that match your search criteria are found, a new listing of these chats will be presented.
Knowledgebase
Table of contents 1 Overview 2 View and manage knowledgebase section
Overview
The knowledgebase is a database of categorized articles that act as an information repository (much like a frequently asked question database) for your clients. For an insight on advantages and need for knowledge management, click here. The client's interface to the knowledgebase is shown below.
Knowledgebase articles can be rated and also commented on by client users, per confirmation within the admin control panel and staff control panel respectively. From within the staff control panel, knowledge base articles and their categories are managed and article comments can be moderated here as well.
Categories
Table of contents 1 Overview 2 View and manage knowledgebase categories 3 Inserting a new category/sub-category 3.1 General 3.2 Options 3.3 Permissions: Users 3.4 Permissions: Staff
Overview
This section allows you to insert the knowledgebase categories and sub-categories, under which the articles are created. You can categorize the knowledgebase articles on the basis of departments, nature of queries etc. and create the categories and sub categories accordingly.
Clicking on the categories tab, you will be presented with a list of all the current categories and sub-categories inserted in the support desk system, as shown
All the settings relevant to these tabs are explained in the following section.
General
This is the name with which this category/sub-category will be inserted. The name should always be relevant to the nature of the category/sub-category you are inserting, although it entirely depends on your preference. Select if you wish to insert this category as a parent category or as a sub-category of an already inserted category.
Type
Select from the following two category types: Inherit: This type is only available for the sub-categories. The sub-category will inherit the properties of its parent category. Global: The categories classified as Global are visible in both the client support center and the staff control panel. Public: The categories classified as Public are visible only in the client support center. Private: The categories classified as Private are only visible in the staff control panel.
Options
Categories/sub-categories are listed within the client support interface according to their display order, as specified here. The list is sorted in ascending order. Select whether you wish to enable commenting for articles under this knowledgebase category/sub-category. Select whether you wish to enable rating for articles under this knowledgebase category/sub-category.
Permissions: Users
Enable this option if you want to restrict the knowledgebase category/sub-category visibility only to selected user groups. This field will only be relevant if the option "Restrict to custom User Groups?" is enabled. You may create different user groups in the admin control panel from Users >> Insert User Group option.
Permissions: Staff
Enable this option if you want to restrict this knowledgebase category/sub-category to certain staff teams.
This field will only be relevant if the option "Restrict to Custom Staff Teams?" is enabled. You may create different staff teams in the admin control panel from Staff >> Insert Team option, and restrict this knowledgebase category/sub-category to these staff teams.
Click Save, to save and insert this knowledgebase category/sub-category into the support desk system.
Manage knowledgebase
Table of contents 1 Overview 2 View and manage knowledgebase articles 3 Editing a knowledgebase article
Overview
This section shows you all the knowledgebase articles currently published or saved as drafts in the support desk system. You can make changes to the articles such as, change of article title, changing contents of the article, changing article category under which it is created etc.
You will be presented with a list of all the current knowledgebase articles (published or saved as drafts) present within the support desk system, as shown
Once you have made the required changes, click Update to save the changes and publish those changes immediately at the client support interface under Knowledgebase section, or click Mark as Draft to unpublish the article and save the changes as draft in the support desk system.
New article
Table of contents 1 Overview 2 Inserting a new article 2.1 General 2.2 Attachments 2.3 Options
Overview
This section allows you to insert the knowledgebase articles under the categories/sub-categories inserted in the support desk system, and publish them at the client support interface. A WYSIWYG editor is provided to create the knowledgebase articles. An option is provided to immediately publish the created article or save it as a draft to be published later.
All the settings relevant to these tabs are explained in the following section.
General
This is the name with which this knowledgebase article will be inserted. The name should always be relevant to the nature of the article you are inserting, however it entirely depends on your preference. Select a category/sub-category under which this article will be inserted. The WYSIWYG editor is provided to insert the contents of the article.
Attachments
Click Choose File to browse for a file placed on your system's hard disk, you wish to upload along with this knowledgebase article. Click Add File to attach more files to upload in a single go.
Options
Select if you wish to mark this article as a Featured article. Featured articles are shown in a colored box at the client support interface under the Knowledgebase section. Also, the featured articles will be at the top of the articles stack.
Once you have made all the required settings, click Publish, to publish this article along with the attachment (if any) immediately at the client support center, or click Save as Draft to save this article for future publishing.
View knowledgebase
Table of contents 1 Overview 2 Access view knowledgebase section
Overview
The View Knowledgebase section of the staff control panel displays the knowledgebase section as seen by the clients at the client support interface. Only the published articles under the Root Category and Global type categories will be seen under the View Knowledgebase section.
You will be presented with all the currently published articles and global categories as seen on the client support interface.
Troubleshooter
Table of contents
Overview
Troubleshooter wizards guide your clients through a series of questions and instructions which enable self-diagnosis and resolution of the issue they are facing. The clients are offered step-by-step problem solving using a story-board of questions and answers, as shown, a series of static interviews helping the user resolve their issue.
If a wizard fails to solve a client's problem, they have the option to create a ticket pre-filled with the answers they gave at each step, hence saving clients time.
Manage Troubleshooter
Overview
This section shows you all the troubleshooter categories and the steps/sub-steps created under those categories in a tree/list form. You can quick insert the steps and sub-steps for any category from the manage troubleshooter section.
You will be presented with all the current categories inserted in the support desk along with the inserted steps/sub-steps under them. You can choose either the tree format or list format to view the inserted categories and steps:
Tree form
List form
New Step
Table of contents 1 Overview 2 Inserting a troubleshooter step 2.1 General 2.2 Attachments 2.3 Options
Overview
This section allows you to insert the troubleshooting steps under a category. The steps will be presented as shown in the following screenshot, when the client clicks on a troubleshooting category under the Troubleshooter section at the client support interface.
There is no limit to the number of steps and sub-steps that can be created for one troubleshooter.
Select a troubleshooter category and click Next. You will be directed to the page where you will need to provide the information relevant to the new step you are inserting. This section is divided into three different configurable settings tabs, which are 1. General 2. Attachements 3. Options All the settings relevant to these tabs are explained in the following section.
General
This is the name with which this troubleshooter step will be inserted. A step can be added to one or more parent steps. Select a parent step from here. The WYSIWYG editor is provided to insert the contents of the step.
Attachments
Click Choose File to browse for a file placed on your system's hard disk, you wish to upload along with this step. Click Add File to attach more files to upload in a single go.
Options
Display Order Allow Comments Enable Ticket Redirection Redirection Department Ticket Type Ticket Priority ID Custom Ticket Subject
This is the default display order for this step at the client support interface. The list is sorted in Ascending Order. Select whether you wish to enable commenting for this step. If enabled, the user will be redirected to the ticket submission page for the specified department or to the department list page ( if no department is selected). The department can be selected from the Redirection Department option.
Select the department to which the user should be redirected to. Select the ticket type to be selected by default on the ticket submission page. This option needs the Ticket Type setting to be enabled for the Template Group. Select the ticket priority to be selected by default on the ticket submission page. If specified, the ticket form will be prefilled with the specified ticket subject.
Once you have made all the required settings, click Publish, to publish this step immediately at the client support center under the chosen category, or click Save as Draft to save this step for future publishing.
Troubleshooter Categories
Table of contents 1 Overview 2 View and manage troubleshooter categories 3 Inserting a new category 3.1 General 3.2 Options 3.3 Permissions: Users 3.4 Permissions: Staff
Overview
This section allows you to insert the troubleshooter categories, under which the troubleshooting steps for that particular category are inserted. You can categorize the troubleshooter categories on the basis of nature of the issues, departments etc. The troubleshooter categories will be shown at the client support center under the troubleshooter tab, as shown
Clicking on a category will take you through a series of questions and instructions, a shown, assisting you to localize and eradicate the issue.
Clicking on the categories tab, you will be presented with a list of all the current troubleshooter categories inserted in the support desk system, along with there visibility type, as shown
All the editable fields specific to these four tabs are explained in the following section.
General
Category Type
Specify a category title/name. Select from the following category types: Global: The categories classified as global are visible in both the client support center and the staff control panel. Public: The categories classified as public are visible only in the client support center. Private: The categories classified as private are only visible in the staff control panel.
Options
This is the display order in which this category will be displayed on the client support interface under the troubleshooter section. The list is sorted in ascending Order. Provide a short description of the category you are inserting.
Permissions: Users
Enable this option if you want to restrict this category visibility only to selected user groups. This field will only be relevant if the option "Restrict to custom User Groups?" is enabled. You may create different user groups in the admin control panel from Users >> Insert User Group option.
Permissions: Staff
Enable this option if you want to restrict this category to certain staff teams.
This field will only be relevant if the option "Restrict to Custom Staff Teams?" is enabled. You may create different staff teams in the admin control panel from Staff >> Insert Team option, and restrict this category to these staff teams.
Once you have made all the required settings, click Insert to save the settings you have made and insert this new category in the support desk system.
View Troubleshooter
Table of contents 1 Overview 2 Accessing view troubleshooter section
Overview
The View Troubleshooter section of the staff control panel displays the Troubleshooter section as seen by the clients at the client support
interface.
You will be presented with all the currently published news articles as seen on the client support interface.
News
Table of contents 1 Overview 2 View and manage News section
Overview
Kayako Fusion, Engage and Resolve comes with the news module that allows you to post news items visible to your client users, via the client support interface or to staff, via the staff dashboard. News articles can be commented on by client users at the client support interface under the news section. RSS feeds of articles can be generated so that clients can subscribe to your news and announcements using a feed reader or your news items can be cross posted to blogs or bulletin boards, using a post robot, for example the RSS syndicating post bot that is a feature of vBulletin Bulletin Board. News articles can also be set to expire after a certain date. It also possible for client users to subscribe to new news articles and receive them by e-mail users who do this are known as subscribers. Client users can do this without registering a user account. Subscribers can also be added manually by staff users via the staff control panel. When a client user subscribe himself to the News, a link is sent to the email address he inserts, for validation, as shown
The news are presented at the client support interface under the news section as shown in the following screenshot
On clicking the Read more link, you will be presented with the complete news article along with an option to comment on the article (if allowed).
Insert news
Table of contents 1 Overview 2 Inserting a news article 2.1 General 2.2 Options 2.3 Permissions (Users) 2.4 Permissions (Staff)
Overview
This section allows you to insert the news articles in the support desk system, and publish them at the client support interface. A WYSIWYG editor is provided to create the news articles. An option is provided to immediately publish the created article or save it as a draft to be published later. You can also send a mass email to all your subscribers once you create the article and publish it.
Clicking on the insert news tab will prompt you to choose from the following types: Global: The news articles classified as Global are visible in both the client support center and the staff control panel. Public: The news articles classified as Public are visible only in the client support center. Private: The news article classified as Private are only visible in the staff control panel. Choose the news type and click Next. You will be directed to the page where you will need to provide the information and content relevant to the new news article you are inserting. This section is divided into four different configurable settings tabs, which are 1. 2. 3. 4. General Options Permissions (Users) Permissions (Staff)
All the settings relevant to these tabs are explained in the following section.
General
Title
Select Yes if you wish to send a mass email to all the subscribers when you publish this article. The mass email will not be sent if you save this article as a draft in the support desk system, to be published latter. The WYSIWYG editor is provided to write the contents of the news article.
Options
Categories Expiration
Select a category or categories under which this news article should be inserted. The news categories will be seen at the client support interface, below the client login box, with a count of articles besides them. If you wish that this article should expire (be removed from client view after a certain amount of time), the date of expiry should be set here. Click on the calendar icon to open the date selector.
An expired article will not be deleted from the support desk system.
Select Yes if you wish the clients to comment on this news article. If the setting "Send Email" is selected under the General settings options, then you can specify a subject for the mass email that will be send out to the subscribers for this news article. If no subject is specified, the subject of the news article will be used instead. This is the From Name email header that will be used for the emails sent out to subscribers. This is the From Email address that will be used for the emails sent out to subscribers. Please note that this may be the address users reply back to (if they reply to the news article email).
Permissions (Users)
Enable this option if you want to restrict this news article visibility only to selected user groups. This field will only be relevant if the option "Restrict to custom User Groups?" is enabled. You may create different user groups in the admin control panel from Users >> Insert User Group option.
Permissions (Staff)
Enable this option if you want to restrict this news article to certain staff teams.
This field will only be relevant if the option "Restrict to Custom Staff Teams?" is enabled. You may create different staff teams in the admin control panel from Staff >> Insert Team option, and restrict this news article to these staff teams.
Once you have made all the required settings, click Publish, to publish this article immediately at the client support center, or click Save as Draft to save this article for future publishing.
Manage news
Table of contents 1 Overview 2 View and manage news articles 3 Editing a news article
Overview
This section shows you all the news articles currently present in the support desk system. You can make changes to the articles such as, change of article title, changing contents of the article, etc.
You will be presented with a list of all the current news articles (published, saved as drafts or expired) present within the support desk system, along with their type and author name, as shown
Once you have made the required changes, click Update to save the changes and publish those changes immediately at the client support interface under News section.
News categories
Table of contents 1 Overview 2 View and manage news categories 3 Inserting a news category
Overview
This section allows you to insert the news categories, under which the articles are created. You can categorize the news articles on the basis of departments, news severity etc. and create the categories accordingly. The news categories will be shown at the client support center under the client login box, as shown
Click on the news category title and you will be presented with the news under that particular category.
Clicking on the categories tab, you will be presented with a list of all the current news categories inserted in the support desk system, along with there visibility status, as shown
Specify a category title. Select from the following visibility statuses: Public: These categories are visible in both the client support interface and the staff control panel. Private: These categories are only visible in the staff control panel .
Click Save to save the changes and insert the news category in the support desk system.
Subscribers
Table of contents 1 Overview 2 View and manage subscribers 3 Inserting a new email subscriber
Overview
A subscriber is a client user who has added their e-mail address to the news subscription list, via the client support interface. A user does not need a user account to be able to do this. When users subscribes to the news article postings, they must confirm their subscription by validating their e-mail address. A staff user can also manually add subscribers. In the following screenshot a client user subscribes to the news from the client support center.
On submitting the email address, the client user will receive a conformation email at the email address "simran.kayako@gmail.com" so as to validate their email address, as shown.
The client user need to click on the validation link provided, to activate his subscription.
You will be presented with a list of all the current subscribers (validated as well as non-validated) present within the support desk system, as shown
Email Address
After specifying the email address, click Insert to add this email address to the current subscribers list. Inserting the email address via staff control panel will automatically validate it.
View news
Table of contents 1 Overview 2 Access view news section
Overview
The View News section of the staff control panel displays the news section as seen by the clients at the client support interface. Only the published articles either with type as private or public will be seen under the View News section.
You will be presented with all the currently published news articles as seen on the client support interface.
Overview
The users section of the staff control panel allows you to manage the users and organizations for your support desk. This section allows you the access to a client's complete profile and support ticket history, detailing all the interactions made with your support desk over tickets, live chats
and phone calls. Each user account can have an automatic expiry date, after which the account is disabled (but not removed from the support desk). SLA plans with an expiry date can be assigned to individual user accounts. Any ticket raised by that user will be monitored according to the SLA plan specified. The organization section allows you to build centralized record of information for each organization, including contact details, listing of important contacts, documents, organization notes and an aggregate support history of all correspondence raised by users of that organization. The e-mail domain filter has been implemented which allows you to specify any number of domain names that belong to a particular organization, enabling the system to detect incoming correspondence from an organization. Your support desk can automatically associate your tickets and new user accounts with the organization profile. A specific SLA plan (with expiry date) can be assigned to entire organization. This means that all tickets raised by users associated with that organization will be covered by the specific reply and resolution target times. Users accounts that have been associated with an organization are listed within the organizations profile.
Insert organization
Table of contents 1 Overview 2 Inserting a new organization 2.1 General 2.2 Profile
Overview
The client users can be grouped into meta-groups, called organizations. The e-mail domain filter feature implemented withing the user organization module allows you to specify any number of domain names that belong to a particular organization, enabling the system to detect incoming correspondence from an organization. Your support desk can automatically associate your tickets and new user accounts with the organization profile. You can build profiles of the organizations you deal with, which contains the organization addresses, contact numbers, e-mail addresses and associate SLA plans to them.
You will be presented with all the configurable profile settings specific to the new organization. The profile page is divided into two tabs, which are: 1. General 2. Profile All the editable profile fields specific to these two tabs are explained in the following section.
General
Insert the name of the organisation/company. Select from the following organization types: Restricted: This type limits the visibility of the tickets to only the users who created them. Shared: In this type the tickets are visible to all users in the organization.
Specify a tag here if you wish to, for this organization. This tag will be visible to the staff users only. Insert the domains belonging to this organization. Support desk will automatically assign the users with email domains as members of this organization. Example: kayako.com; webworld.com etc. Specify a note to be associated with this organization, if required. This note will be visible to the staff users only.
Profile
Address City State ZIP/Postal Code Country Phone Fax Web Site Address SLA Plan SLA Plan Expires
Specify the full mailing address of the organization. Specify the city in which the organization is located. Specify the state in which the city is located. Specify the zip/postal code. Specify the country. Specify the phone number. You may inert multiple phone numbers, separated by a comma "," Specify the company fax number. You may insert multiple phone numbers, separated by a comma "," Specify the URL for the organization web site. Select the default SLA plan for this organization. If set, it overrides all other SLA plan rules. However, an SLA plan assigned to a user of this organization will supercede this setting. Select the SLA plan expiry. Upon expiry of the selected plan the support desk will use the default SLA rules to calculate the SLA plan for tickets raised by the users of this organization.
Click Insert once you have specified all the required fields, to insert the newly created organization in the support desk.
Insert user
Table of contents 1 Overview 2 Inserting a new user 2.1 General 2.2 Profile
Overview
This section of the staff control panel allows you to insert new client users in the support desk and create a complete profile for them. Depending
on the configuration of your support desk installation, visitors to your support desk can manually register themselves and create a user account using an e-mail address apart from staff users manually creating user accounts from the staff control panel. A user account can have an automatic expiry date, after which the account is disabled (but not removed). SLA plans with an expiry date can be assigned to individual user accounts and any ticket raised by that user will be monitored according to the SLA plan specified.
You will be presented with all the configurable profile settings specific to the new client user. The profile page is divided into two tabs, which are: 1. General 2. Profile All the editable profile fields specific to these two tabs are explained in the following section.
General
Full Name
User Organization Title/Position Insert Tag User Email(s) Phone number User Role User Group Is Enabled? Expires Notes
Specify the last name of this user Specify the title/position of the user in the corporation. The title/position inserted here will be visible below the ticket replies. For example. CEO, Support Manager, Marketing Head etc. Specify a tag if you wish to, for this client user. This will be hidden from the client. Specify a primary e-mail address of this user. All tickets and replies coming from this e-mail address will be associated with this user's account. This is also the e-mail address the user will log into the client support interface. You can enter multiple addresses simply by pressing enter after each email address. Specify the client's phone number. Select the client's role in the organization. If you select Manager, then this user will have access to all tickets created by others users in the same organization. Select the User Group for this client. All the permissions from the selected user group will be inherited when this client logs in. Select the status of this user. If disabled, this user will be unable to login into the support center. Select the client's account expiry date. If specified, the user account will cease to function once the threshold limit is reached. Specify a note for this user, if required. This will be hidden from the client.
Profile
Profile Image Time Zone Enable Automatic Daylight Savings Default Language SLA Plan SLA Plan Expires
Upload the client's profile picture here. This image will appear in all tickets client creates or replies. Select the appropriate time zone for the client. Select whether or not you wish to enable Daylight Savings Time. Select the language to load when this client logs into the client support center. Select the default SLA plan for this user. If set, it overrides all other SLA plan rules. Select the SLA plan expiry. Upon expiry of the selected plan support desk will use the default SLA rules to calculate the SLA plan for tickets raised by this user.
Click Insert once you have specified all the required fields, to insert the newly created client user in the support desk.
Manage organizations
Table of contents 1 Overview 2 View and manage organizations 3 Editing an organization
Overview
This section shows you all the organizations currently present in the support desk system. You can make changes to the organizational profile for example changing organization name, domain filters, organization address etc. as well as check all the users associated with the organization.
You will be presented with a list of all the current organizations present within the support desk system, along with the organization's location, as shown
Editing an organization
In order to edit an organization properties, click on the corresponding organization name you wish to edit and this will redirect you to the page, where you can make the necessary edits. The various tabs present on the organization edit page are explained in the following table. General Profile Users Add Note Edit the general properties of the client user such as organization name, type etc. Here you can edit and change the organization address and SLA plan options. This tab shows all the clients associated with this organization. Add an additional note for this organization, if required.
Delete
Click delete if you wish to delete this organization's account from the support desk.
Once you have made the required changes, click Update to save the changes.
Manage users
Table of contents 1 Overview 2 View and manage users 3 Editing a client user
Overview
This section shows you all the clients currently present in the support desk system. You can make changes to the client's profile as well as change the login password. You can also view the tickets and chat history associated with this client user.
You will be presented with a list of all the current client users present within the support desk system, along with their organization and user group status, as shown
This tab holds the information about the tickets associated with this client user. This tab has all the previous chat logs for the chats initiated by this client. This tab holds the information about the calls initiated by this client user along with the information about the call duration, start and end time. The billing information for this client's support hours is logged here. Add an additional note for this client user, if required. You may add as many notes as required. Clicking on the change password button open a floating window where you need to insert the new password. Click any of the following buttons: Update: This will change the client's login password as provided by you. Generate & Email: The support desk will generate a password and email it to the client's registered email address.
Delete
Click delete if you wish to delete this client's account from the support desk.
Once you have made the required changes, click Update to save the changes.
Overview
The search tool is provided in the staff control panel to locate users or user organizations inserted within the support desk system. The advanced search feature allows you to filter the list of users and user organizations according to certain criteria.
If the user or organization that you have inserted in the quick search box are found, a new listing of these users or organizations will be presented, otherwise you will get a zero result found message, as shown
Advanced search is used to generate more finite search results, enabling you to further narrow down your search results to speed up finding a user or organization. In order to access the advanced search section, click Advanced Search on the search menu and you will be directed to the page where you can set the criteria for more granular searching, as shown
Select if you wish that all the inserted criteria (if you have inserted multiple criteria in the Insert Criteria option) should be met, that is Match All, or any one of the inserted criteria should be met, that is Match Any, for this search lookup.
Insert the criteria by selecting the options from the drop down menu according to your preferences. More than one search criteria can be added to the advanced search by clicking on the Insert Criteria button.
Click Lookup button to start the search corresponding to the criteria inserted and if the user or organization that match your search criteria are found, a new listing will be presented.
Reports
Reports 2 is in beta. The latest beta is available in the latest update to your Kayako helpdesk (released on the 1st November 2011).
Reports in Kayako lets you access the huge amount of data in your helpdesk and turn that data into useful information. Table of contents 1 Accessing and Running Reports 2 Creating Reports 2.1 Kayako Query Language (KQL) 2.2 Report Writer
which can be searched, filtered by category or you can filter out the reports you have created.
Click on the Run Report button to run a report. The results of the report (if there are any) will be rendered in a table.
Creating Reports
Although your Kayako helpdesk comes with a long list useful reports out-of-the-box, unlike other helpdesk reporting systems Kayako allows you to tweak and create your own, almost without limitation.
Report Writer
Using Report Writer, you can create and modify reports without get bogged down in syntax. The Report Writer makes creating your own reports using KQL really simple. It checks what you type on-the-fly and automatically provides suggestions about what you may need to type next.
In fact, the auto-completion and suggestions are so comprehensive that you can create reports using just your mouse or up and down arrow keys, so you could create a report without typing or knowing any syntax at all. Report Writer will check your syntax for errors, providing specific error messages where possible. To get started, simply place your cursor inside of the text editor and start with the first suggestion. You can use your mouse or arrow keys to make a selection. It's as easy as that!
Report Types
This is an advanced topic. Your helpdesk contains a comprehensive list of out-of-the-box reports, so if you're not comfortable writing your own reports using the Kayako Query Language, don't worry. See ?Reports for more information.
Table of contents 1 Tabular Report 2 Summary Table Report 3 Grouped Tabular Report (Multigroup) 4 Matrix Reports 4.1 Simple matrix report 4.2 Nested matrix report
Kayako Reports is capable of producing various types of report layout. The way a report is displayed depends on how you structure your report query using a KQL statement.
Tabular Report
The tabular report is the simplest type of report, with a single heading row followed by information. The following KQL statement was used to produce a tabular report. Tabular report example
SELECT 'Tickets.Ticket Mask ID', 'Tickets.Subject', 'Tickets.Priority', 'Tickets.Average Response Time' FROM 'Tickets' WHERE 'Tickets.Status' = 'Open' AND 'Tickets.Creation Date' = Today()
We can go further than this and add nested groups to the summary table. We can take the same KQL statement as above, and add some more groupings to the end of the statement to break the ticket counts down by department, then priority and then by statum Summary table report
SELECT COUNT(*) AS Tickets FROM 'Tickets' WHERE 'Tickets.Department' IN ('Support', 'Sales', 'Billing') GROUP BY 'Tickets.Department', 'Tickets.Priority', 'Tickets.Status'
There is no limit to the depth of nests you can include in your report.
Matrix Reports
Simple matrix report
A matrix report is a grid report. At its simplest it contains one row of labels, one column of labels and information in the middle. For example, you could create a matrix report displaying the number of tickets created within each of your department on each day of the last seven days. Simple matrix report example
SELECT COUNT(*) FROM 'Tickets' WHERE 'Tickets.Creation Date' = Last7Days() GROUP BY X('Tickets.Department'), Y('Tickets.Creation Date':DayName)
The KQL statement of a matrix report must contain an X() and Y() grouping. The X() indicates what will be your columns (horizontal) and the Y() indicates what will be your labels (vertical).
As another example, rather than just counting tickets created within the last seven days, we can count tickets created in the last month, grouped by week and then by day of the week. Another nested matrix report example
SELECT COUNT(*) FROM 'Tickets' WHERE 'Tickets.Creation Date' = LastMonth() GROUP BY X('Tickets.Department'), X('Tickets.Priority'), Y('Tickets.Creation Date':Week), Y('Tickets.Creation Date':DayName)
There is no limit to the depth of nests you can include in your report.
The Kayako Query Language (KQL) is a powerful and easy-to-grasp syntax used to create helpdesk reports.
Introduction to KQL
This is an advanced topic. Your helpdesk contains a comprehensive list of out-of-the-box reports, so if you're not comfortable writing your own reports using the Kayako Query Language, don't worry. See ?Reports for more information.
A line of KQL (a KQL statement) specifies what information to include in your report, on what conditions and how to display the information. Every report in your Kayako helpdesk is defined by a KQL statement, and each report can be opened and its KQL statement tweaked or copied as a
template for another report. If you are familiar with SQL, you can treat KQL almost exactly the same (except we have added some Kayako-specific features).
This example statement is valid contains the complete minimum components required for a report. The result of this report will be a list of every ticket and its corresponding ID and subject in your helpdesk. The statement has two components: SELECT - Every statement starts with a SELECT. With it you are telling Reports what fields and information to fetch from your helpdesk. FROM - Each SELECT is proceeded by a FROM, which explicitly tells Reports the data sources you wish to use in your report. As we are only using the Tickets source in this example, this is the only one we need to specify.
In the example above we had two things - a source and a couple of fields. Every source has a list of fields.
SELECT 'Tickets.Ticket Mask ID', 'Tickets.Subject', 'Users.Fullname' FROM 'Tickets', 'Users'
In this new example, we have the following sources: Tickets Users And the following fields: Tickets.Ticket Mask ID Tickets.Subject Users.Organization Even though you are asked to select a primary source when creating a new report, it is possible to reference multiple sources within your KQL statement. You don't need to worry about the way this source linking is done - it is automatically taken care of. All you need to do is specify the respective FROMs sources for the fields you are SELECTing. The Report Writer will automatically suggest the sources you need to include in your statement.
Would produce a report that listed every single ticket in the helpdesk, including the ticket ID, subject and user's name. We can refine this report to include tickets that match some specific criteria. For example, the following KQL statement includes a WHERE and some conditions. It will only include tickets that belong to the Sales department and are set to the status Open:
SELECT 'Tickets.Ticket Mask ID', 'Tickets.Subject', 'Users.Fullname' FROM 'Tickets', 'Users' WHERE 'Tickets.Department' = 'Sales' AND 'Tickets.Status' = 'Open'
Multiple conditions
The AND operator in the example above indicates that tickets must match both conditions. We could also use the OR operator to indicate
optional conditions. The example below will produce a report listing tickets set to the status Open that belong to either the Support department or the Sales department:
SELECT 'Tickets.Ticket Mask ID', 'Tickets.Subject', 'Users.Fullname' FROM 'Tickets', 'Users' WHERE ('Tickets.Department' = 'Sales' OR 'Tickets.Department' = 'Support') AND 'Tickets.Status' = 'Open'
Because we grouped the department condition in brackets, it gets treated as one condition. This KQL statement contains the following conditions: ('Tickets.Department' = 'Sales' OR 'Tickets.Department' = 'Support') AND 'Tickets.Status' = 'Open' Only when both of these conditions are met will a ticket be included in our report. For example: Ticket ID #ABC-123-0001 #ABC-123-0002 #ABC-123-0003 #ABC-123-0004 Ticket Status Open Open Closed Open Ticket Department Sales Billing Support Support Would be included in the report? Meets both conditions Fails to meet the condition ('Tickets.Department' = 'Sales' OR 'Tickets.Department' = 'Support') Fails to meet the condition 'Tickets.Status' = 'Open' Meets both conditions
For a list of conditions and operators (including IN and LIKE), see the KQL Reference.
Functions
For a list of functions, see the KQL Reference.
Shortcuts
For a list of shortcuts, see the KQL Reference.
And would produce something fairly basic, which looked like this:
Using GROUP BY we could break this count down by department, so we'll retrieve the count of Open tickets across our departments. The revised KQL statement is:
SELECT COUNT(*) FROM 'Tickets' WHERE 'Tickets.Status' = 'Open' AND 'Tickets.Department' GROUP BY 'Tickets.Department'
It is possible to GROUP BY multiple fields to break the summary table report down into even more detail. The following KQL statement will GROUP BY ticket department and then by priority:
SELECT COUNT(*) FROM 'Tickets' WHERE 'Tickets.Status' = 'Open' AND 'Tickets.Department' GROUP BY 'Tickets.Department', 'Tickets.Priority'
For more information on report types and layouts, see Report Types.
SELECT COUNT(*) FROM 'Tickets' WHERE 'Tickets.Status' = 'Open' GROUP BY X('Tickets.Department'), Y('Tickets.Owner')
We can created a nested matrix report by adding more X()*s and Y()s to the *GROUP BY. So, taking the same example above, we can further break the ticket counts down by priority:
SELECT COUNT(*) FROM 'Tickets' WHERE 'Tickets.Status' = 'Open' GROUP BY X('Tickets.Department'), X('Tickets.Priority'), Y('Tickets.Owner')
To produce:
MULTIGROUP BY
The MULTIGROUP BY operator is used to produce a list of tables within one report. For example, to the following KQL statement will produce a list of user organization's phone numbers, MULTIGROUPed BY country:
SELECT 'User Organizations.Name', 'User Organizations.Phone', 'User Organizations.Country' FROM 'User Organizations' MULTIGROUP BY 'User Organizations.Country'
A MULTIGROUP BY can be used with the GROUP BY operator. Specifically, the MULTIGROUP BY operator is used to produced grouped tabular reports. For more information, see Report Types.
Selectors
For various value types, we have implemented a feature called Selectors. Selectors are best demonstrated by an example:
SELECT AVG('Chats.Wait Time') FROM 'Chats' WHERE 'Chats.Type' = 'User' AND 'Chats.Creation Date' = ThisMonth() GROUP BY X('Chats.Creation Date':MonthName), Y('Chats.Creation Date':DayName)
Chats.Creation Date is a value that represents a date. You can attach various Selectors to this using a colon, following by the selector such as DayName and MonthName. In this case, these Selectors allow you to select parts of a date or render dates in different ways in your reports, without any complicated syntax. Currently, Selectors can only be used within a GROUP BY. For a list of Selectors, see the KQL Reference.
KQL Reference
Table of contents 1 Conditions and Operators 1.1 Numerical operators 2 Functions 2.1 Math functions 2.2 Date and time functions 3 Shortcuts 3.1 Date and time shortcuts 4 Selectors 4.1 Date and time selectors
This is an advanced topic. Your helpdesk contains a comprehensive list of out-of-the-box reports, so if you're not comfortable writing your own reports using the Kayako Query Language, don't worry. See Reports for more information.
KQL Example Report to include all past chats that do belong to the Technical Support department.
!=
SELECT 'Tickets.Ticket ID' FROM Tickets WHERE 'Tickets.Department' != 'Sales'
Report to include all tickets that do not belong to the Sales department.
IN
SELECT 'Tickets.Ticket ID' FROM Tickets WHERE 'Tickets.Department' IN ('Sales', 'Support', 'Billing')
Report to include all tickets that are in one of the following departments: Sales or Support or Billing .
NOT IN
SELECT 'Tickets.Ticket ID' FROM Tickets WHERE 'Tickets.Status' NOT IN ('Closed', 'In Progress')
Report to include tickets that are not set to the statuses Closed or In Progress.
LIKE
SELECT 'Users.Fullname', 'Users.Organization' FROM Users WHERE 'Users.Email' LIKE '%kayako.com'
Report to include all users whose email address matches %kayako.com, where % means 'anything here.
NOT LIKE
SELECT 'Users.Fullname', 'Users.Organization' FROM Users WHERE 'Users.Email' NOT LIKE '%hotmail.com'
As above, but will include users where the email address does not match '%hotmail.com'.
AND
SELECT 'Tickets.Ticket ID' FROM Tickets WHERE 'Tickets.Department' = 'Sales' AND 'Tickets.Status' = 'Open'
Report to include tickets that are in the Sales department and are set to the status Open.
OR
SELECT 'Tickets.Ticket ID' FROM Tickets WHERE 'Tickets.Department' = 'Sales' OR 'Tickets.Department' = 'Support'
As above, but will include tickets that are in the Sales department or the Support department.
Numerical operators
Operator Description KQL Example
SELECT 'Tickets.Ticket ID', 'Tickets.Subject' FROM Tickets WHERE 'Tickets.Reply Count' > 5 AND 'Tickets.Creation Date' = LastMonth()
Includes all tickets that have more than 5 replies and were created in the last month.
+, -, *, /
Functions
Function COUNT() Description Counts the number of matching results KQL Example Produces a count all of the tickets that were created yesterday, grouped by department.
SELECT COUNT('Tickets.Ticket ID') FROM Tickets WHERE 'Tickets.Creation Date' = Yesterday() GROUP BY 'Tickets.Department'
IF()
Math functions
Function SUM() Description Calculates the sum of matching results KQL Example Produces a matrix of the total billable time logged for this week, displayed by staff user and by day.
SELECT SUM('Ticket Billing.Time Spent') FROM 'Ticket Billing' WHERE 'Ticket Billing.Creation Date' >= ThisWeek() GROUP BY X('Ticket Billing.Creation Date':DayName), Y('Ticket Billing.Worker')
AVG()
SELECT AVG('Rating Results.Score') FROM 'Rating Results', 'Tickets' WHERE 'Ratings.Type' = 'Tickets' AND 'Tickets.Creation Date' = ThisMonth() GROUP BY X('Ratings.Title'), Y('Tickets.Owner')
Produces a matrix of the average ticket ratings for the month, displayed per ticket owner.
MAX()
SELECT MAX('Rating Results.Score'), 'Tickets.Ticket Mask ID' FROM 'Rating Results', 'Tickets' WHERE 'Tickets.Creation Date' = ThisWeek() GROUP BY 'Tickets.Owner', 'Ratings.Title'
Produces a list of staff users and their corresponding best ( max) rated ticket for the week.
MIN()
SELECT MIN('Rating Results.Score'), 'Tickets.Ticket Mask ID' FROM 'Rating Results', 'Tickets' WHERE 'Tickets.Creation Date' = ThisWeek() GROUP BY 'Tickets.Owner', 'Ratings.Title'
As above, but displays the worst (min) rated ticket for the week.
Shortcuts
Date and time shortcuts
Shortcut Yesterday()
SELECT Count('Tickets.Ticket ID') FROM Tickets WHERE 'Tickets.Creation Date' = Yesterday()
KQL Example
Today()
... WHERE 'Tickets.Creation Date' = Today()
Tomorrow()
... WHERE 'Tickets.Due Date' = Tomorrow()
Last7Days()
... WHERE 'Tickets.Creation Date' = Last7Days()
LastWeek()
... WHERE 'Tickets.Creation Date' = LastWeek()
ThisWeek()
... WHERE 'Tickets.Due Date' = ThisWeek()
NextWeek()
... WHERE 'Tickets.Due Date' = NextWeek()
LastMonth()
... WHERE 'Tickets.Creation Date' = LastMonth()
ThisMonth()
... WHERE 'Tickets.Resolution Due Date' = ThisMonth()
NextMonth()
... WHERE 'Tickets.Resolution Due Date' = NextMonth()
EndOfWeek()
... WHERE 'Tickets.Due Date' = EndOfWeek()
Selectors
For various value types, we have implemented a feature called Selectors. Selectors are best demonstrated by an example:
SELECT AVG('Chats.Wait Time') FROM 'Chats' WHERE 'Chats.Type' = 'User' AND 'Chats.Creation Date' = ThisMonth() GROUP BY X('Chats.Creation Date':MonthName), Y('Chats.Creation Date':DayName)
Chats.Creation Date is a value that represents a date. You can attach various selectors to this using a colon, following by the selector such as DayName and MonthName. In this case, these selectors allow you to select parts of a date or render dates in different ways in your reports, without any complicated syntax. Currently, selectors can only be used within a GROUP BY.
:Day
:DayName
:Minute
:Hour
:Week
:WeekDay
:Month
:MonthName
:Quarter
:Year