About Snippets

Snippets can be used in any text field in a case, but they’re most useful for replies to emails.

Let’s say you’ve got this snippet, which you call upgrade:

Hi {firstname},

Thanks for reporting this bug! Fortunately, we’ve already fixed it in the most recent version of the software, Frogger [[version]].

If there’s anything else we can do for you, or if upgrading doesn’t fix the issue, please just reply to this email and we’ll figure out what’s going on.

{myfirstname} – Frogger Software

To activate it, you can either type the snippet name and then the snippet activation key:

upgrade`

Or you can type the snippet activation key twice, which will bring up a snippet search box. Typing in the search box will filter the list of snippets to those that contain the text you’ve typed, as you type.

(The snippet activation key defaults to `. It is configurable on a per-user basis by heading to the Avatar menu > User Options > Legacy Settings. If you have a non-English keyboard layout, you might find the regular snippet key doesn’t work. If so, just change to one of the other keys.)

The text from the upgrade snippet will be inserted where the cursor is. Snippets can also contain placeholders, surrounded by curly braces, which will be replaced with text from case attributes or the current user’s profile (see below for more details). Additionally you can include one text symbol like [[version]] in each snippet. When the snippet is inserted, that portion of the text will be highlighted so the next thing you type will replace that text.

Snippet Placeholders

There are also many placeholders you can put in snippets that will be replaced automatically. All of these are available for mailbox autoreplies, too:

  • {case} for the case ID
  • {sender_firstname} (previously {firstname}) for the sender’s first name
  • {sender} for the sender’s email address
  • {subject} for the subject of the message
  • {ticket} for the external ticket ID
  • {ticket_singlecase} for the external ticket ID that only has access to the current case (not other cases submitted by the same person)
  • {url} for the URL of this Manuscript site
  • {ticketurl} for a link to the external case (e.g. http://try.manuscript.com/default.asp?[ticket])
  • {ticketurl_singlecase} for a link to the external case (e.g. http://try.manuscript.com/default.asp?[ticket_singlecase])
  • {userfirstname} (previously {myfirstname}) for the logged on user’s first name
  • {userlastname} (previously {mylastname}) for the logged on user’s last name
  • {username} for the name of the logged on user
  • {useremail} for the email of the logged on user

Snippet Administration

Snippets can either be personal to the user or global (available to all users). Both types are configured on same page, accessed via the Avatar menu. All site administrators see the global snippets available for management at the top of that page, before their own personal snippets. If a non-site-admin such as a project manager or a customer service lead needs access to creating, editing and removing global snippets, have a site administrator add them to the allowed list using the Edit Permissions control at the top of the snippet page.

Pro-Tip

When you have a lot of snippets and they fall into different categories or pertain to different projects, the list can become overwhelming. Pro-tip: if you use a standard naming system for the global snippets, when you search for that code in the search box, the user will see the full list of snippets shrink to just that subset. For instance, the code KLN/ could be used as a preface to all Kiln snippets, and the code MNU/ to preface all Manuscript snippets to allow for easy filtering to just Kiln or Manuscript snippets.