If you are visually impaired or blind, you can visit the PDF version by Pressing CONTROL + ALT + 4
You need a JavaScript-enabled browser to view this Publication
Please follow these steps to view the Publication:
Enable JavaScript in your browser
Refresh this page
Best regards
Zmags
Version : 3.10.02
Revision : 11
Website : www.kayako.com
Forums : http://forums.kayako.com
Support : http://support.kayako.com
Editorial : docs@kayako.com
Kayako SupportSuite
User Manual
Copyright © 2001 – 2007 Kayako Infotech Ltd. www.kayako.com
[ 2 ]
About this manual
This version of the manual can be used as a guide for many other preceeding and proceeding
versions of Kayako SupportSuite, LiveResponse and eSupport. However, please note that feature
discrepancies may exist between versions.
We publish a new and up to date manual upon the release of each stable build. For accuracy, be sure
to use the manual(s) bundled with your downloaded SupportSuite, LiveResponse or eSupport
package.
If you would like to
Version : 3.10.02 Revi
[ 2 ] About this manual This version of the m
[ 3 ] Using this manual The staff control pan
[ 4 ] Contents About this manual
[ 5 ] Staff control panel user manual
[ 6 ] Knowledgebase reports....
[ 7 ] Troubleshooter ..........
[ 8 ] Teamwork
[ 9 ] Why do I get an invalid domain error? ...
[ 10 ] Installation, upgrading, importing and
[ 11 ] System requirements System •
[ 12 ] Installation This procedure outlines a
[ 13 ] Step one: Activating your license and d
[ 14 ] • http://clients.support.mydomain.com
[ 15 ] Step two: Downloading the package The
[ 16 ] 1. Create a new PHP file called phpinfo
[ 17 ] Step three: Extracting the package For
[ 18 ] Step four: Setting up the database Kay
[ 19 ] 4. If successful, you will receive the
[ 20 ] 11.Now, this new MySQL user needs to be
[ 21 ] • Database name • Database user's
[ 22 ] Step five: Editing the config.php file
[ 23 ]
[ 24 ] 7. The rest of the settings in the file
[ 25 ] Step six: Uploading the files In this
[ 26 ] Transfer type has been se
[ 27 ]
[ 28 ]
[ 29 ]
[ 30 ] Step seven: Upload the key.php file Us
[ 31 ] Step eight: Setting file permissions B
[ 32 ] Step nine: Performing a first-time inst
[ 33 ]
[ 34 ]
[ 35 ]
[ 36 ]
[ 37 ]
[ 38 ]
[ 39 ] Upgrading
[ 40 ] Upgrading to a newer build This procedu
[ 41 ] Step three: Uploading the files See upl
[ 42 ]
[ 43 ]
[ 44 ] information on template reverting and se
[ 45 ] Upgrade from eSupport or LiveResponse t
[ 46 ] Step three: Uploading the files See upl
[ 47 ]
[ 48 ]
[ 49 ]
[ 50 ] 16.All of the database amendments and up
[ 51 ] Upgrading from eSupport v2.3.5 to a v3
[ 52 ] 2. Click on the Impex link.
[ 53 ] 4. Enter your (or a) administrator use
[ 54 ] Using Impex to import from third party
[ 55 ] Step one: Install version 3 Follow the
[ 56 ] Step two: Use Impex to import the data
[ 57 ]
[ 58 ]
[ 59 ] data. 5. Click on the Next button to p
[ 60 ] Step three: Rebuild the database indice
[ 61 ] Setting up e-mail piping An e-mail que
[ 62 ] Changing the file permissions The file
[ 63 ] E-mail piping in cPanel 1. Login
[ 64 ] 4. Click on Add Forwarder to create a
[ 65 ] parser will accept the incoming e-mail m
[ 66 ] E-mail piping in Plesk Control Panel T
[ 67 ] E-mail piping using Unix mail transport
[ 68 ] EXIM This procedure explains how to set
[ 69 ] a. /etc/aliases 2. Assuming that
[ 70 ] 2. The p
[ 71 ] a. /etc/postfix/aliases 2. Assum
[ 72 ] E-mail piping in Windows This section
[ 73 ] parser will accept the incoming e-mail m
[ 74 ] Setting up cron jobs (automated schedul
[ 75 ] Cron jobs in cPanel The following proc
[ 76 ] Step th
[ 77 ]
[ 78 ] Cron jobs in Plesk Control Panel The f
[ 79 ]
[ 80 ] 6. Into the command field, enter t
[ 81 ] Cron jobs in DirectAdmin Control Panel
[ 82 ] 1. Into the command
[ 83 ] Cron jobs (scheduled tasks) Microsoft W
[ 84 ]
[ 85 ]
[ 86 ] Step four: Configure the scheduled task
[ 87 ]
[ 88 ] 2
[ 89 ] a. A value between 5 and 10 minutes is
[ 90 ] Staff control panel user manual Staff
[ 91 ] Accessing the staff control panel The
[ 92 ] Interface quick reference The interfac
[ 93 ] Dashboard
[ 94 ] Ticket listing For clarification, the
[ 95 ] • 8 – the tick
[ 96 ] Ticket view
[ 97 ] • 7 – print , edit or delete
[ 98 ] Dashboard The dashboard is a system ov
[ 99 ] 6. Today overview 7. Instant-article
[ 100 ] Staff status The online staff bo
[ 101 ] Department and ticket tree
[ 102 ] Quick-insert menu The qu
[ 103 ] Navigation menu bar The navigatio
[ 104 ] Calendar overview
[ 105 ] Today overview The today overview giv
[ 106 ]
[ 107 ] Instant article search box
[ 108 ] Staff user preferences To access the
[ 109 ]
[ 110 ] • Enable Private Message E-mail Ale
[ 111 ] Changing your password To change your
[ 112 ] Your work schedule The work schedule
[ 113 ] Tickets The ticketing features of Sup
[ 114 ] Listing tickets A ticket list is a li
[ 115 ] T
[ 116 ] 3. Move 4. Status 5. Priority 6.
[ 117 ] Move Clicking on
[ 118 ] Priority Clicking on this menu will op
[ 119 ] Clicking on this butto
[ 120 ] Select Owner as Current User – if
[ 121 ] • Default
[ 122 ]
[ 123 ] 2. Click on
[ 124 ] View Title – the name of the
[ 125 ] Deleting a ticket listing view To d
[ 126 ] Departments a
[ 127 ] Under the department and ticket tree (
[ 128 ] Organizing and searching tickets Ther
[ 130 ] Medium Low P
[ 131 ] Ticket filters Ticket filters allow yo
[ 132 ] Filter Title –
[ 133 ] • Subject fie
[ 134 ] The filter will match if the string ent
[ 135 ] View and manage ticket filters To m
[ 136 ] For more information
[ 137 ] 2. The tic
[ 138 ] 3. Press the enter k
[ 139 ] 3. On the Labels/F
[ 140 ] Going back to
[ 141 ] Removing a
[ 142 ] Ticket labels
[ 143 ] 4. Click on the Go button to subm
[ 144 ] Searc
[ 145 ] The new column added to
[ 146 ] • New Ticket
[ 147 ] Advanced se
[ 148 ] More than one search
[ 149 ] The new column added to the ticket list
[ 150 ] Ticket handling Viewing and managing
[ 151 ] Flag ticket
[ 152 ] The SLA Plan menu allows you to assign
[ 153 ] Clicking on this
[ 154 ] Ban – adds the ticket creator's e-mail
[ 155 ] Ex
[ 156 ]
[ 157 ] •
[ 158 ] Ticket information bar Note – the tabs
[ 159 ] • Post Reply – the post reply tab wi
[ 160 ] From
[ 161 ] From If there are multiple e-mail queu
[ 162 ] Knowledgebase Working similarly to the
[ 163 ] The owner of the ticket can be set here
[ 164 ] Options Due As par
[ 165 ] Add to predefined Checking this box wil
[ 166 ] S
[ 167 ] Clicking on this button will open up ti
[ 168 ]
[ 169 ] Clicking on the binoculars
[ 170 ]
[ 171 ] Aft
[ 172 ] Spell check Clicking on the spell ch
[ 173 ] Any
[ 174 ] Following submissio
[ 175 ]
[ 176 ] Email – the e-mail address of the ticke
[ 177 ] 2. Open the Ne
[ 178 ] are not available in the create ticket
[ 179 ] 3. Hover over the Phone Ticket menu.
[ 180 ] Click on the Forward tab to open the ti
[ 181 ] Whether or not a user gets to see third
[ 182 ] 2. Open the Predefined Replies su
[ 183 ] Refer to predefined reply category fie
[ 184 ] Selecting multiple predef
[ 185 ] 2. Open the Predefined Replies su
[ 186 ] When billing or time trac
[ 187 ] • Time Spent
[ 188 ] Ticket and user n
[ 189 ] Adding a note
[ 190 ] Once a note has been added, it can be
[ 191 ] • To have an ongoing “Invoices” tick
[ 192 ] The add notes action can be used to:
[ 193 ] Clicking on
[ 194 ] Similarly, the chat history is
[ 195 ] • New Ticket Created By: X – log of
[ 196 ] • Ticket Forwarded To: X By: Y – the
[ 197 ] 1. On the ticket information bar, clic
[ 198 ] 2. Then, do as ap
[ 199 ] When a ticket becomes overdue (i.e. th
[ 200 ] 3. Select the a
[ 201 ] When viewing a ticket, the ticket infor
[ 202 ] Selecting multiple ticket alerts (by ch
[ 203 ]
[ 204 ] • Alert Actions – the alert will be
[ 205 ] Ti
[ 206 ] The work summary report gives a day-by-
[ 207 ]
[ 208 ] Service l
[ 209 ] The response time report gives an overv
[ 210 ] Users and groups
[ 211 ] Groups A user group is a grouping that
[ 212 ] 2. Click on Manage Groups. Y
[ 213 ]
[ 214 ] • Can View Submit Ticket Widget – if
[ 215 ] Tickets can a
[ 216 ] Users A user account is associated to
[ 217 ] 2. Click on Manage Users. You will be
[ 218 ]
[ 219 ] General I
[ 220 ] 2. Click on Manage Users. Y
[ 221 ] A user's accou
[ 222 ] Resending a registration e-mail To res
[ 223 ] Adding additional e-mail addresses to
[ 224 ] Mass mailing users To mass-mail users
[ 225 ] • Mail Contents – the e-mail b
[ 226 ] Live support The Live Support module
[ 227 ] Messages Messages are left by users w
[ 228 ] 2. Open the Messages su
[ 229 ] To reply to a mes
[ 230 ] Now the message ha
[ 231 ] Chat History To view the Chat History
[ 232 ] Viewing a c
[ 233 ] • Email – the e-mail address of the
[ 234 ] Advert tracking The Advert Tracking f
[ 235 ] Selecting multiple campaigns (by checki
[ 236 ] • Campaign Title – a nam
[ 237 ] Canned messages A canned message is v
[ 238 ] 1. Open Live Support on the navigation
[ 239 ] 2. Open the Canned menu.
[ 240 ] 2. Open the Canned m
[ 241 ] Tag generator The tag generator is us
[ 242 ] • HTML
[ 243 ] 2. Open the Tag Generator menu.
[ 244 ] 2. Open the Tag Gen
[ 245 ] 2. Open the Tag Gen
[ 246 ] Teamwork The teamwork modules of Supp
[ 247 ] Calendar To view the calendar:
[ 248 ]
[ 249 ]
[ 250 ] Creating a new event or appointment
[ 251 ] • Owner – the owner of the event. •
[ 252 ] Contacts To view contacts stored in t
[ 253 ] Note that cust
[ 254 ] • Fullname – the name of the c
[ 255 ] Under th
[ 256 ] Task List To view tasks logged in the
[ 257 ] To view a task, c
[ 258 ] 2. Click on Insert Task. You will
[ 259 ] Click on the Insert button to create th
[ 260 ] Knowledgebase The knowledgebase is a
[ 261 ] Managing knowledgebase categories To
[ 262 ] 2. Click on Insert Category.
[ 263 ] Managing knowledgebase articles To vi
[ 264 ] To view and
[ 265 ] 2. Click on Insert Article.
[ 266 ] Viewing and moderating user comments
[ 267 ] Importing and exporting articles To i
[ 268 ] Knowledgebase reports To view knowled
[ 269 ] Downloads The downloads module of Sup
[ 270 ]
[ 271 ] Managing downloads categories To view
[ 272 ] 2. Click on Insert Category.
[ 273 ] Managing downloads To view the files
[ 274 ] To view and
[ 275 ] File fields
[ 276 ] • Password (confirm) – confirm
[ 277 ] View and manage download comments To
[ 278 ] Download reports To view download rel
[ 279 ] Troubleshooter The troubleshooter off
[ 280 ]
[ 281 ] Building a troubleshooter A troublesh
[ 282 ] There is no limit to the number of step
[ 283 ] 1. Open Troubleshooter on the navigati
[ 284 ]
[ 285 ] Viewing and managing troubleshooter co
[ 286 ] Importing and exporting troubleshooter
[ 287 ] Troubleshooter reports To view troubl
[ 288 ]
[ 289 ] News SupportSuite comes with the News
[ 290 ]
[ 291 ] Managing news articles To view and ma
[ 292 ] To edit a news article, click on the ne
[ 293 ] News Details • News Subject
[ 294 ] Managing news subscribers A subscribe
[ 295 ] Click on the
[ 296 ] View and moderate news comments To vi
[ 297 ] Importing and exporting news subscribe
[ 298 ] Administrator control panel user manua
[ 299 ] What is an administrator? An administ
[ 300 ] Accessing the administrator control pa
[ 301 ] Staff status The online staff bo
[ 302 ] Staff Staff user accounts are created
[ 303 ] Teams Staff user accounts can be assi
[ 304 ] Refer to staff team fields for document
[ 305 ]
[ 306 ] • Can Delete Ticket Recipients - if
[ 307 ] • Can View Troubleshooter Tab – if
[ 308 ] • Can Edit Category - if enabled, st
[ 309 ] Staff users To view and manage staff
[ 310 ] Creating a staff user account To creat
[ 311 ] otherwise mail loops may occur. • T
[ 312 ] Mass-mailing staff To mass-mail staff
[ 313 ] Departments Departments in SupportSui
[ 314 ] Managing departments To view and mana
[ 315 ] Refer to department fields for documen
[ 316 ] • Module – if set to tickets (in Sup
[ 317 ] Settings and configuration The settin
[ 318 ] General • Com
[ 319 ] • Enable Extended Display for Client
[ 320 ] CPU optimization and server settings
[ 321 ] Optimization settings
[ 322 ] SMS Gateway For more information on th
[ 323 ] Outgoing Mail Settings
[ 324 ] SMTP Settings
[ 325 ] User registration For more informatio
[ 326 ] Security • Default
[ 327 ] Date and time
[ 328 ] Tickets For more information on ticke
[ 329 ] information, see CC, BCC and third part
[ 330 ] • Default Ticket Status for Client R
[ 331 ] • Enable Instant Response System (IR
[ 332 ] • Ticket Post Order for Client Suppo
[ 333 ] • Enable RSS Syndication for Ticket
[ 334 ] panel. • Enable Two Way Email Proce
[ 335 ] Search Options These settings affect t
[ 336 ] searches will be. • Minimum Word Le
[ 337 ] Auto Close Settings
[ 338 ] • Enable Po
[ 339 ] Mail parser POP3/IMAP fetch settings
[ 340 ] • Email Content Priority – which ty
[ 341 ] Live support For more information on
[ 342 ] • Client Chat Refresh Time – the val
[ 343 ] • Message Forward Email – the e-mail
[ 344 ] Click
[ 345 ] Teamwork For more information on usin
[ 346 ] Knowledgebase For more information on
[ 347 ] • Display Knowledgebase Widget – if
[ 348 ] Support center index
[ 349 ] • Enable RSS Feeds for Articles – if
[ 350 ] Troubleshooter For more information o
[ 351 ] • Maximum Number of Categories to Di
[ 352 ] Downloads For more information on man
[ 353 ] Quick Box setting). • Display Popul
[ 354 ] • Override Download Items Display Or
[ 355 ] News For more information on managing
[ 356 ] Support center
[ 357 ] RSS interface • Enable R
[ 358 ] Templates The templates are based on
[ 359 ] Template engine The templating system
[ 360 ] Template groups To view and manage te
[ 361 ] Selecting multiple template groups (by
[ 362 ] You will be presented with a list of th
[ 363 ] • Default Ticket Status – all newly
[ 364 ]
[ 365 ] Managing templates To manage template
[ 366 ] To expand all the template sections, cl
[ 367 ]
[ 368 ] Searching templates To search within
[ 369 ]
[ 370 ]
[ 371 ] LoginShare LoginShare is the login sy
[ 372 ] You wil
[ 373 ]
[ 374 ] • Hostname – the hostname of t
[ 375 ] Importing and exporting templates Tem
[ 376 ] • Filename – specify the filename yo
[ 377 ] Restoring templates Restoring (also k
[ 378 ] • Template Group
[ 379 ] Template diagnostics Using the templa
[ 380 ] Languages The languages system of is
[ 381 ] Managing language packs To manage lan
[ 382 ] To edit a language, click
[ 383 ] Managing phrases within a language pac
[ 384 ]
[ 385 ] You will be pres
[ 386 ] Importing and exporting languages Lan
[ 387 ] Language packs can be merged with one
[ 388 ] Custom fields The custom fields featu
[ 389 ] Managing custom field groups To view
[ 390 ] To edit a field group,
[ 391 ] Custom field group fields
[ 392 ] Managing custom fields To view and ma
[ 393 ] Under the Advanced Search tab, groups c
[ 394 ]
[ 395 ] •
[ 396 ] A text field features a multiple-line t
[ 397 ] • Staff Editable – if enabled, any s
[ 398 ] • Display Order – where more than on
[ 399 ]
[ 400 ] • Staff Editable – if enabled, any s
[ 401 ]
[ 402 ] • Staff Editable – if enabled, any s
[ 403 ]
[ 404 ] • Staff Editable – if enabled, any s
[ 405 ]
[ 406 ] • Staff Editable – if enabled, any s
[ 407 ] • Default Value – when the field is
[ 408 ] Custom field usage examples This sect
[ 409 ] At user group management
[ 410 ] At user ticket creation in the client s
[ 411 ] At staff event creation (appointment
[ 412 ] Live Support Visitor bans made using
[ 413 ] Visitor bans When a visitor is banned
[ 414 ] To edit a ban entry,
[ 415 ] Click on the Ins
[ 416 ] Mail parser The mail parser is not av
[ 417 ]
[ 418 ] E-mail queues An e-mail queue is requ
[ 419 ] To
[ 420 ] To create a new e-mail queue: 1. Clic
[ 421 ] • Email Queue Address – the e-mail a
[ 422 ] Queue Settings
[ 423 ] • Ticket Status – the default status
[ 424 ] Parser rules Parser rules allow you t
[ 425 ] Advanced Search tab, rules can be searc
[ 426 ] You will
[ 427 ] To add a new match
[ 428 ] • Please note that the Reply-
[ 429 ] • Attachment Sizes refer to the
[ 430 ]
[ 431 ] • C
[ 432 ] Breaklines SupportSuite and eSupport
[ 433 ] 1. Click on Manage Breaklines under Ma
[ 434 ]
[ 435 ] Catch-all rules Catch-all rules can b
[ 436 ] To delete a catch-al
[ 437 ] To insert
[ 438 ] Catch-all rule fields
[ 439 ] E-mail bans If an e-mail comes into a
[ 440 ] Selecting multiple e-mail bans (by chec
[ 441 ] Parser log A guide to the parser log
[ 442 ] Tickets
[ 443 ] Statuses Every ticket has a status. T
[ 444 ] To edit a ticket statu
[ 445 ] Ticket status fields
[ 446 ] Priorities Each ticket has a priority
[ 447 ] To edit a ti
[ 448 ] Ticket priority fields
[ 449 ] Attachment types If enabled (see tick
[ 450 ] Selecting multiple attachment types (by
[ 451 ] This link will open
[ 452 ] o For a comprehensive list of standar
[ 453 ] Purging attachments In order to save
[ 454 ] To add a new matching field, click on
[ 455 ] Maintenance The ticket maintenance ar
[ 456 ] If you r
[ 457 ] SLA An SLA (Service Level Agreement)
[ 458 ] Schedules A schedule can be thought o
[ 459 ]
[ 460 ]
[ 461 ] From here, you are able to specify the
[ 462 ] Plans An SLA plan is associated with
[ 463 ] Refer to SLA plan fields for documenta
[ 464 ] • Plan Title – a title for the SLA
[ 465 ] Escalation rules Escalation rules (if
[ 466 ] Creating a new escalation rule To cre
[ 467 ] Escalation rule fields From here, you
[ 468 ] Teamwork The teamwork module SupportS
[ 469 ] Managing teamwork statuses A status c
[ 470 ] A list of all of t
[ 471 ] To ed
[ 472 ] Teamwork status fields
[ 473 ] Managing teamwork priorities A priori
[ 474 ] To delete a priority, click on the cor
[ 475 ] Teamwork priority fields
[ 476 ] Managing teamwork labels Labels can b
[ 477 ] A list of all of t
[ 478 ]
[ 479 ] From here you can configure the proper
[ 480 ] Managing teamwork categories Categori
[ 481 ] A list of all of t
[ 482 ]
[ 483 ] From here you can
[ 484 ] Logs SupportSuite, eSupport and LiveR
[ 485 ] Task log To view the scheduled tasks
[ 486 ] Parser Log To view the mail parser lo
[ 487 ] Parsing
[ 488 ]
[ 489 ] Scheduled tasks SupportSuite, eSuppor
[ 490 ] • Daily System Cleanup – performs a
[ 491 ] Tasks log A guide to the tasks log ca
[ 492 ] Database Through the SupportSuite, eS
[ 493 ] Maintenance (repair and optimize) To
[ 494 ] Backup (database dump) To download a
[ 495 ] Diagnostics The sections belonging to
[ 496 ] Active sessions To view the user sess
[ 497 ] Cache info Most templates are cached
[ 498 ]
[ 499 ] PHP info PHP's phpinfo() command will
[ 500 ] MySQL info The server's MySQL setting
[ 501 ] Report bug To submit a bug report to
[ 502 ] License info To view your SupportSuit
[ 503 ] Mobile staff control panel interfaces
[ 504 ] PDA staff control panel interface To
[ 505 ] Ticket listing
[ 506 ] Managing tickets Multiple tickets can
[ 507 ]
[ 508 ] Viewing a ticket
[ 509 ] Replying to a ticket When viewing a t
[ 510 ] Kayako SMS gateway The Kayako SMS Gat
[ 511 ] Buying credits To buy SMS credits:
[ 512 ] Frequently asked questions
[ 513 ] What settings will directly affect the
[ 514 ] What is a widget? A widget is a compon
[ 515 ] What is an RSS feed?
[ 516 ] How do I create a new language pack for
[ 517 ] How do I set the default language for t
[ 518 ] How do I create a new language pack fo
[ 519 ] Why do I get an invalid domain error?
[ 520 ] What is Zend Optimizer and IonCube? Ze
[ 521 ] How do I disable comments in the clien
[ 522 ] Support resources If you would like t