Jump to: navigation, search

Templates

Overview

Templates can be accessed by selecting the Templates menu from the Administration menu:

GKC Temp 01.png

Document templates allow you to define:

  • The desired breakdown (into section) of document content
  • Any instructions to authors on the intended use of any of the sections
  • Visibility for every section by limiting access to its content to the desired group of users (customer, agent or sub-groups of agents)

To be able to view and manage templates you need to have Knowledge.CMS.Administrator privilege (for more details, see Access Permissions).

Viewing existing templates

When you navigate to templates by selecting Templates from the Administration menu, CMS will show you the list of templates that are currently available in your system:

GKC Temp 02.png

From this view you can:

  • create new template:
    • from empty template
    • using previously exported template
  • modify existing template
  • delete existing template
  • disable template (to prevent new documents to be created using this templates)
  • filter out the list of the templates by:
    • template name
    • document type
    • enable/disable status
  • sort the template list by:
    • template name
    • modification date

Creating a new template

  1. Click Create
  2. Enter values for the mandatory fields (marked by a red star), as well as any other pertinent fields.
    GKC Temp 03.png
  3. Click Save & Close or select one of the other options from the Save & Close drop-down menu.
    GKC Temp 04.png

Standards templates

When you start CMS for the first time you will see two templates already created for you:

  • Standard Article
  • Standard FAQ

Both these templates are created by default and configured to have one public section. You can redefine these templates according to your needs.

Important
The template can be changed or deleted if there are no documents in your knowledge bases that are using it.
Tip
You can disable the template to prevent it from being used by authors to create new documents.

Templates explained

Field Description
Id Allows you to define a unique technical name for templates. This name is used when you export or import any templates or documents using it.

Id restrictions:

  • It is not allowed to have two templates with same id.
  • Only [a-z][A-Z][0-9]_ - characters allowed to be used in the id.
  • Id cannot be modified one document is created.
Name Defines the name that authors can chose from when they are creating new documents.
Description Provides a short explanation on how the template is used. It is shown to the authors when they create a new document.
Document type Allows you to select one of the basic document types that are extended with the templates. Supported types are:
  • Article
  • FAQ
Important
Templates are not allowed for Standard Response type documents.
Enable Allows you to enable or disable templates used by the authors. If templates are disabled all existing documents that are using templates will continue to function as is however authors will not be able to create any new documents using this template.
Sections Define the content parts of which the final document content is compiled. The order of these sections is essential. Knowledge Center uses a defined order to combine content together before showing it to an agent or a customer.
Important
Every template must have at least one section.

For every section you are able to provide:

  • name - visible for authors only when editing the document in CMS
  • instruction - visible for authors only when editing the document in CMS
  • mandatory flag that will instruct CMS that document cannot be sent for approval until content for this section is provided.
  • visibility rule
Important
At least one section in document must be mandatory.

A section can be:

  • Public - visible to any user
  • Agents only - visible to any agent, but hidden when customer views the document
  • Skilled agent - visible to certain set of the agent that has one of the defined skills
Important
When a template is used within a knowledge base, the Reading access defined for the knowledge base is what's used to set the priority for the section visibility. For example, if you have a template with "Public" sections within a knowledge base that are set to "Agent only" for Reading access, it results in all those sections within the document being visible to agents only. In this instance however, because of the priority set, this also means that none of the documents within this knowledge base are accessible by the customers.

While editing templates, you can:

  • Add a section by clicking the Add section link:
GKC Temp 05.gif
  • Delete a section by clicking: GKC Temp 06.png.
GKC Temp 07.gif
  • change the order of the section by dragging and dropping them into the desired order. Hover your cursor over the

GKC Temp 08.png icon in front of any section then click, hold, and drag to the proper location, and then release your cursor.

GKC Temp 09.gif

Deleting templates

You can delete templates by selecting the template from the list and then clicking on delete button:

GKC Temp 10.png
Important
You cannot delete a template that is used in a document within your knowledge bases. When trying to delete such a template, the CMS displays the following error message:
GKC Temp 11.png
Rather than deleting such templates, you can disable them. This prevents the template from being used when creating new documents.
Tip
Disabling a template does not disable, hide, or remove any content from the Knowledge Base and the content can still be updated. Disabling a template only prevents the creation of new content with that template.
Important
Ensure that at least one template is created and enabled for every document type. Disabling all templates for certain document types disables the ability to add these documents to your knowledge bases.

Modifying templates

To modify a template, select the template and then click the edit button:

GKC Temp 12.png

Alternatively, you can double-click on the template to enter edit view.

There are certain restrictions on the editing templates:

  • The template Id and Document type can be defined before the template is created but cannot be changed afterward.
  • Sections can be added and removed while there is no documents using this template. As soon as you have created at least one document using the template, you cannot add or delete sections within the document. You can however still change the order of the existing sections and change their attributes (such as Name, Instruction, Mandatory flag and visibility).

Templates that have restrictions on the modification will have special notice (1) shown when entering the edit mode:

GKC Temp 13.png

Using templates

When you add a document to the knowledge base you are able to select a template to use for that document.

  1. From the Documents view click the Create button:
    GKC Temp 14.png
  2. From the Create document window, choose the Document type and Document template. Once these fields are chosen, the template information is shown on the right of the window (Template name and description, list of the sections with their names, instructions, visibilities):
    GKC Temp 15.png
  3. Click Ok to create the document.

Importing templates

Cloning Template

To re-use an existing template to create a new one you must:

  1. Open the list of templates.
  2. Open the template you wish to clone.
  3. Click the drop-down menu next to the Save & Close button.
  4. Select Backup configuration:
    GKC Clone 06.png
  5. The browser downloads a text file with the template configuration (name: templateId + ".template").
    GKC Clone 07.png
  6. Go back to the Templates page.
  7. In the Create drop-down menu, select the Import ... option:
    GKC Clone 08.png
  8. Select Browse, choose the recently downloaded file in the open dialog window and then, click Import:
    GKC Clone 09.png
  9. The new template form is opened and pre-filled with the values from the loaded knowledge base configuration.
    Important
    You must change the template ID. You cannot have more than one template with the same ID.

Feedback

Comment on this article:

blog comments powered by Disqus
This page was last modified on August 31, 2018, at 11:47.