Snippets
On this page
A snippet is a named piece of text that you insert into the field you are editing, such as a standard reply, a signature, or troubleshooting steps. A snippet is either personal, visible only to you, or shared, visible to every technician who may use shared snippets. A snippet can belong to a category, and its text can carry placeholders that are filled in at the moment of insertion: the current user, the current date, or the current date and time.
Technicians insert and manage snippets in the Web App. Administrators also manage shared snippets in the Settings App; see Shared Snippets.
Snippets in the Web App
What you can see and change
Three permissions decide which snippets you see and which you can change: Local Snippets Management, Shared Snippets Use, and Shared Snippets Management. A security role grants them; see Security Roles.
- Your personal snippets are always listed. Shared snippets are listed only when you hold Shared Snippets Use. Shared Snippets Management has no effect without Shared Snippets Use.
- The snippets panel has the Recent and All tabs. The Shared and Personal tabs appear when you hold Shared Snippets Use.
- Whether you can change snippets and categories is decided separately for personal and for shared ones. A snippet of a kind you can see but not change has no More menu, a category of that kind offers no Rename or Delete, and the snippet editor offers New Category only for a kind you can change.
A change to your snippet permissions takes effect in your next Web App session.
Open the snippets panel
Put the cursor in the text field you want to write into, then do one of the following:
- Press F4. F4 opens the panel from an HTML field, such as the Details editor of the activity form, from an action form, and from a memo field's editing window while insertion is enabled there.
- In an HTML field of an action form, or in an HTML editor that has an edit-mode button, click the snippet button in the field's footer, next to the Timestamp button. Both buttons are disabled while the field is read-only, and in an editor with an edit-mode button also while it is not in edit mode.
- In a memo field's editing window, choose Insert > Snippet....
The panel is titled Snippets. When you open it from the main menu's item for managing snippets, it has no target field: it is titled Manage Snippets and offers no Insert button.
Insert a snippet
- Put the cursor in the target field and open the snippets panel.
- Find the snippet: switch tabs, pick a category in the filter, or type in the search box. A search matches the name or the text of the snippets on the current tab, ignoring case and regardless of the category selected in the filter, and hides the tabs and the category filter while it is active. Outside the Recent tab, the matches stay grouped under their categories.
- Point to the snippet and click Insert.
The snippet's placeholders are replaced with their values, the text is written into the field you were last editing, and the panel closes with the cursor back in that field. If focus has moved elsewhere since you were editing that field, the text still goes to that field. If no target field is known, Insert does nothing. If the server request that replaces the placeholders fails, the text is inserted as stored, with its placeholders unreplaced, and no error is shown.
The Recent tab lists the snippets you have inserted, created, or edited, up to 20. Once 20 snippets are recorded there, no further snippets are added.
Insert a timestamp
A timestamp is your current date and time, without your name.
- In an HTML field of an action form, or in an HTML editor that has an edit-mode button, click the Timestamp button in the field's footer.
- In a memo field's editing window, choose the first item of the Insert menu.
The timestamp is written into the field. If the timestamp cannot be fetched, nothing is written into the field and no message is shown.
Create or edit a snippet
- In the snippets panel, click New, or point to an existing snippet and choose More > Edit.
- Enter a name and the Text. Both are required.
- Under Shared with, choose Only me for a personal snippet or Everyone for a shared one. Switching this choice on an existing snippet moves it between personal and shared. A new snippet starts as shared when you may change shared snippets and either you are on the Shared tab or you may not change personal snippets; otherwise it starts as personal.
- Optionally, choose a category. The list is titled Personal Category or Shared Category to match the Shared with choice.
- To add a placeholder to the text, click Insert Placeholder, pick one in the Select Placeholder dialog, and click OK. The placeholder is written into the Text box.
- Click Save. The button is enabled once the name and the text are filled in and something has changed; no message says which of them is missing.
A snippet you create or edit is also added to the Recent tab while that tab holds fewer than 20 snippets.
Snippet placeholders
- Current User stands for the person who inserts the snippet. On its own it is replaced with that person's full name. To use one field of the person record instead, pick the field under Current User; some fields expand to fields of their own. Such a field shows Loading... until you click its name, which loads its fields; expanding it does not. If you click OK with no field picked, or right after the first click on a field that expands, Current User on its own is inserted.
- Now is replaced with the date and time on the Alloy Navigator server.
- Today is replaced with the date on the Alloy Navigator server.
The snippets panel
The panel shows:
- New, when you may change personal or shared snippets, and a search box that reads Text to search for... and shows a clear button once you type.
- The tabs Recent, All, and, when you hold Shared Snippets Use, Shared and Personal. The panel reopens on the tab you used last.
- A category filter that lists All Categories and the tab's categories, and can also list Uncategorized. The filter is hidden on the Recent tab. When there are no categories, it reads No categories found and is disabled.
- The snippets of the tab, grouped under category headers that you can collapse and that all start expanded. A shared category is marked with an everyone icon, a personal one with an only-me icon. The Uncategorized header has no icon. Empty categories are not shown. The Recent tab lists its snippets without category headers. When the list is empty, the panel reads No snippets found.
The search text and the selected category and snippet stay as you left them when you close and reopen the panel on the same page. They are reset when the page loads again.
Click a snippet to show its text.
Manage categories
Categories are created, renamed, and deleted from the category list in the snippet editor, not from the filter in the panel.
- Click New Category under the list, enter a name, and click Create. The button is there when you may change categories of the chosen kind. The category is created as personal or shared by the type you pick in the dialog and is assigned to the snippet you are editing. The name must not be empty and must not be in use: the dialog shows an error for an empty name and a warning for a name already taken, and does not create the category.
- To rename a category, click More next to it and choose Rename. The Rename Category dialog has no type choice.
- To delete a category, click More next to it, choose Delete, and confirm the question "Are you sure to delete the selected item?". Delete is disabled while any snippet is in the category, with the tooltip "This category cannot be deleted because it is not empty." If the snippet you are editing was in the deleted category, its category is cleared.
Delete a snippet
Point to the snippet and choose More > Delete. In the Confirm dialog ("Are you sure to delete the selected item?"), click OK.
Related topics
- Shared Snippets - manage shared snippets in the Settings App.
- Activity Log