Textvorlagen

Einführung in Textvorlagen in ConSol CM

Textvorlagen sind Entwürfe mit Text und Variablen, über die automatisch Daten des aktuellen Vorgangs oder Benutzers eingefügt werden können. Sie werden in E-Mails und Kommentaren verwendet. Textvorlagen tragen dazu bei, dass E-Mails bezüglich der Wortwahl und des Layouts einheitlich sind, und sie steigern die Produktivität der Benutzer, da diese nicht so viel Text schreiben müssen.

Konzepte, Begriffe und Definitionen

Konzept

Andere Begriffe

Definition

Textvorlage

Text-Template

Vorlage, die beim Schreiben von E-Mails oder Kommentaren verwendet wird.

Dokumentvorlage

Office-Template

Microsoft Office- oder OpenOffice-Datei, die als Vorlage für CM/Doc verwendet wird.

Freemarker

 

Template-Sprache, die für Templates in ConSol CM verwendet wird.

Zweck und Verwendung

Textvorlagen erleichtern die Arbeit der Web Client-Benutzer, indem sie Entwürfe für E-Mails und Kommentare bereitstellen. Zusätzlich kann der Text von automatischen E-Mails oder automatisch hinzugefügten Kommentaren in Textvorlagen gespeichert werden.

Textvorlagen können Variablen enthalten, die mit Daten aus dem Vorgang, in dem die Vorlage verwendet wird, gefüllt werden. Mit Variablen können Vorgangsdaten, die Daten des Kontakts oder Bearbeiters des Vorgangs oder die Daten des aktuellen Benutzers eingefügt werden.

Wenn eine Textvorlage verwendet wird, wird der Inhalt der Vorlage in den Kommentar- oder E-Mail-Editor eingefügt. Der Benutzer kann ihn nach Bedarf ändern, um den finalen Kommentar bzw. die E-Mail zu erstellen. Es ist möglich, mehrere Vorlagen für einen Kommentar oder eine E-Mail zu verwenden.

Textvorlagen werden auf der Seite Textvorlagen des Web Clients gespeichert. Vorlagen, die nur im Workflow benutzt werden und im Web Client nicht zur Auswahl stehen sollen, können auf der Seite Templates der Web Admin Suite gespeichert werden.

Verfügbare Einstellungen für Vorlagen

Textvorlagen haben folgende allgemeine Einstellungen:

Wenn in einer Vorlage Datenfelder verwendet werden, die nicht mehr verfügbar sind, wird die Zeile der entsprechenden Vorlage auf der Übersichtsseite in rot angezeigt. Die fehlerhaften Referenzen werden in rot angezeigt und müssen entfernt werden, um die Vorlage speichern zu können.

Vorlagentypen

Es gibt vier Typen von Textvorlagen. Eine Textvorlage gehört immer zu einem der Typen.

Vorlagennutzung

Es gibt vier Stellen, an denen Textvorlagen des Typs Brief verwendet werden können. Sie können eine oder mehrere Stellen auswählen:

Für Textvorlagen des Typs Include gibt es eine Einstellung:

Grundlegende Aufgaben

Finden einer Textvorlage

Die Liste der Textvorlagen wird direkt nach dem Aufrufen der Seite Textvorlagen im Web Client angezeigt. Sie können die Liste filtern, um eine Vorlage leichter zu finden:

Sie können die Checkbox Inaktive Vorlagen anzeigen markieren, wenn Sie auch die deaktivierten Vorlagen sehen möchten.

Verwalten von Textvorlagen

Sie benötigen die Berechtigung Vorlagen verwalten oder Administratorberechtigungen, um Textvorlagen zu verwalten, siehe Rollen.

Best Practice

Richten Sie eine spezielle Rolle für die Benutzer ein, die für die Text- und Dokumentvorlagen zuständig sind. Erstellen Sie dazu eine Rolle, die lediglich die Berechtigung Vorlagen verwalten enthält, und weisen Sie sie den Benutzern zu, die Vorlagen erstellen oder bearbeiten.

Die meisten Aktionen zur Vorlagenverwaltung sind an zwei Stellen verfügbar:

Für Vorlagen stehen folgende Aktionen zur Verfügung:

Schreiben von Textvorlagen

Zum Schreiben einer Textvorlage können Sie folgende Schritte durchführen:

  1. Erstellen Sie eine Vorlage des Typs Brief. Sie können Text eingeben und mit dem Rich-Text-Editor formatieren. Zusätzlich können Sie Variablen aus der Bibliothek der Templatefelder einfügen. Siehe Verwenden von Variablen in Textvorlagen. Sie können Attachments zur Vorlage hinzufügen. Wenn die Vorlage nur in bestimmten Queues verfügbar sein soll oder nur wenn bestimmte Vorgangsfelder ausgefüllt sind, können Sie die Vorlage entsprechend einschränken. Siehe Festlegen des Kontextes einer Textvorlage.

    Alternativ können Sie im Vorgangsprotokoll eine neue Vorlage aus einer ausgehenden E-Mail erstellen. Klicken Sie im Kontextmenü der E-Mail auf den Eintrag Als Vorlage verwenden, um die Seite zur Vorlagenerstellung zu öffnen.

  2. Optional. Fügen Sie Attachments an den Brief an. Wenn die Vorlage im Kommentar oder E-Mail-Editor verwendet wird, sind die Attachments vorausgewählt. Sie werden beim Speichern des Kommentars bzw. Senden der E-Mail an den Vorgang angehängt. Wenn eine E-Mail-Vorlage mit Attachments über den Workflow verwendet wird, werden die Attachments ignoriert.
  3. Optional. Erstellen Sie eine Vorlage des Typs Textblock. Sie können Text eingeben und mit dem Rich-Text-Editor formatieren. Zusätzlich können Sie Variablen aus der Bibliothek der Templatefelder einfügen. Siehe Verwenden von Variablen in Textvorlagen.
  4. Optional. Erstellen Sie eine Vorlage des Typs Include. Sie können Text eingeben und mit dem Rich-Text-Editor formatieren. Zusätzlich können Sie Variablen aus der Bibliothek der Templatefelder einfügen. Siehe Verwenden von Variablen in Textvorlagen. Sie können alle Arten von Variablen mit Ausnahme von Textblöcken und anderen Includes verwenden. Ein häufiger Anwendungsfall für Includes ist die E-Mail-Signatur, die in allen für E-Mails verwendeten Briefen eingefügt wird.
  5. Optional, Administratorberechtigungen erforderlich. Erstellen Sie eine Vorlage des Typs Skript. Sie können Text eingeben und mit Freemarker-Code Logik hinzufügen. Wenn Sie die Checkbox HTML erlauben markieren, können Sie den Skriptinhalt mit HTML-Tags formatieren.
  6. Optional. Referenzieren Sie Textblöcke, Includes und Skripte im Brief. Siehe Verwenden von Variablen in Textvorlagen.

Es ist nicht möglich, ausführbaren JavaScript-Code in Textvorlagen zu verwenden. Das System verwendet automatisch Escape-Zeichen für alle <script>-Tags.

Sie können im Rich-Text-Editor auf den Button Code-Ansicht klicken, um den Quellcode der Vorlage anzuzeigen.

Verwenden von Variablen in Textvorlagen

Mit der Bibliothek der Templatefelder können Sie Variablen in Textvorlagen einfügen. Es gibt vier Arten von Variablen:

Die folgende Tabelle enthält die verfügbaren Variablen mit einer kurzen Beschreibung. In der Vorlagenverwaltung werden unterschiedliche Farben verwendet, um es einfacher zu machen, zwischen den unterschiedlichen Arten von Variablen zu unterscheiden.

Variable

Beschreibung

Farbe

Kundendatenmodelle

Ermöglicht es, Kontaktfelder einzufügen. Wählen Sie eine Kundengruppe und ein Kontaktobjekt (Firma oder Person), um die verfügbaren Datenfelder zu sehen.

Blau

Kundengruppe

Ermöglicht es, den Namen der Kundengruppe einzufügen.

Blau

Prozesse

Ermöglicht es, den Namen der Queue einzufügen.

Blau

Benutzerdefinierte Felder

Ermöglicht es, Vorgangsfelder einzufügen. Wählen Sie die Feldgruppe, um die verfügbaren Datenfelder zu sehen.

Blau

Vorgang

Ermöglicht es, Basisdaten des Vorgangs einzufügen (ID, Name, Thema, Erstellungsdatum, Eskalationsdatum). Sie können die Option Bearbeiter wählen, um Daten des zugewiesenen Benutzers einzufügen, wie beispielsweise den Namen oder die Telefonnummer (siehe Benutzer für Details zu den verfügbaren Feldern).

Blau

Bearbeiter

Ermöglicht es, Daten des aktuellen Benutzers einzufügen, wie beispielsweise den Namen oder die Telefonnummer (siehe Benutzer für Details zu den verfügbaren Feldern).

Blau

Includes

Ermöglicht es, Vorlagen des Typs Include einzufügen.

Orange

Textblock

Ermöglicht es, Vorlagen des Typs Textblock einzufügen.

Grün

Workflow Includes

Ermöglicht es, Vorlagen des Typs Include einzufügen, bei denen die Option Für Workflow markiert ist, damit sie im Workflow verwendet werden können.

Orange

Skripte

Ermöglicht es, Vorlagen des Typs Skript einzufügen.

Lila

Parameter

Zeigt ein Textfeld über dem Kommentar- / E-Mail-Editor an, in dem der Benutzer Text eingeben kann, um ihn an der in der Vorlage konfigurierten Stelle einzufügen.

Rot

Enum-Parameter

Zeigt ein Auswahlfeld über dem Kommentar- / E-Mail-Editor an, in dem der Benutzer einen der Listenwerte auswählen kann, um ihn an der in der Vorlage konfigurierten Stelle einzufügen.

Rot

Gehen Sie folgendermaßen vor, um Referenzen zu Textvorlagen und Feldern einzufügen:

  1. Platzieren Sie den Cursor an der gewünschten Position im Text.
  2. Navigieren Sie im Abschnitt Bibliothek der Templatefelder zum gewünschten Element und klicken Sie auf das Element, um es einzufügen.

Gehen Sie folgendermaßen vor, um Parameter einzufügen:

  1. Platzieren Sie den Cursor an der gewünschten Position im Text.

  2. Fügen Sie den Parameter im Abschnitt Bibliothek der Templatefelder ein:

    Textparameter:

    1. Klicken Sie auf Parameter hinzufügen.
    2. Geben Sie den Namen des Parameters in das Feld unter Neuer Parameter ein.
    3. Klicken Sie auf Parameter hinzufügen.

    Enum-Parameter:

    1. Klicken Sie auf Enum-Parameter hinzufügen.
    2. Geben Sie den Namen des Parameters in das Feld unter Neuer Parameter ein.
    3. Wählen Sie eine sortierte Liste. Die Checkbox Template aktiviert muss für die Liste im Abschnitt Sortierte Listen ausgewählt sein.
    4. Klicken Sie auf Parameter hinzufügen.

Informationen über die Benutzerperspektive finden Sie in Verwenden von Parametern.

Festlegen des Kontextes einer Textvorlage

Die Zuordnung bestimmt, in welchen Vorgängen eine Briefvorlage verfügbar ist. Die Verfügbarkeit einer Textvorlage hängt von zwei Faktoren ab:

Wenn in den Textvorlagen nicht alle Vorgangsfelder des Typs enum verwendet werden, können Sie bestimmte Vorgangsfelder in der Seitenanpassung von markersLibrary ausschließen. Dies verbessert die Ladezeit der Seite mit den Vorlagendetails, da die ausgeschlossenen Felder nicht in den Abschnitt Zuordnung geladen werden müssen.

Verwenden von Textvorlagen

Textvorlagen können im Kommentar- und E-Mail-Editor des Web Clients und im Workflow verwendet werden. Textvorlagen, die im Workflow verwendet werden, funktionieren genauso wie reguläre Templates (siehe Verwenden von Templates in Skripten).

Im folgenden Abschnitt ist beschrieben, wie Benutzer im Web Client mit Textvorlagen arbeiten.

Der Benutzer kann die gewünschten Vorlagen im Auswahlfeld Textvorlage hinzufügen des Kommentar- und E-Mail-Editors auswählen. Er kann den Vorlagentext bearbeiten, bevor er den Kommentar speichert oder die E-Mail absendet. Wenn eine Standardvorlage verwendet wird, kann der Benutzer diese entfernen oder ihren Inhalt bearbeiten. Die Vorlage wird als Text eingefügt. Der Text, der zu den Variablen gehört, hat die gleiche Farbe wie in der Vorlagenverwaltung. Der Zweck der Farben ist es, die dynamisch eingefügten Elemente hervorzuheben, die gesendete E-Mail bzw. der gespeicherte Kommentar hat diese Farben nicht.

Die folgende Abbildung zeigt eine Vorlage mit zwei Textblöcken im Kommentareditor. Beide Textblöcke sind ausgewählt, sodass sie in den Kommentar übernommen werden.

Abbildung 11: Vorlage mit Textblöcken (Benutzerperspektive)

Die folgende Abbildung zeigt eine Vorlage mit einem Textparameter und einem Enum-Parameter. Der Benutzer kann die gewünschten Werte über dem Editor angeben, um sie einzufügen.

Abbildung 12: Vorlage mit Parametern (Benutzerperspektive)

Sie können mehrere Editoreinstellungen bezüglich Vorlagen in der Seitenanpassung von mailTemplate konfigurieren.

Erweiterte Aufgaben

Verwenden von Skripten in Textvorlagen

Mit Skripten können Sie Logik zu den Textvorlagen hinzufügen. Skripte können nur von Benutzern mit Administratorberechtigungen bearbeitet werden, siehe Rollen. Mit Skripten kann beispielsweise eine angepasste Anrede, die von einem Kontaktfeld abhängt, implementiert werden.

Skriptvorlagen werden in Freemarker geschrieben (siehe https://freemarker.apache.org/). Wenn Sie die Checkbox HTML erlauben markieren, können Sie den Skriptinhalt mit HTML-Tags formatieren.

Sie müssen statt den in der Standardnotation von Freemarker verwendeten geschweiften Klammern, eckige Klammern [] verwenden.

Skripte mit der Option HTML erlauben können Links enthalten. Die Links müssen mit einem der zulässigen Protokolle beginnen (http, https, ftp, ftps, file, mailto), andernfalls werden sie entfernt.

Deshalb können Sie nicht direkt in einem Link eine Skriptfunktion einsetzen, um einen vollständigen Link dynamisch aus einem Vorgangs- oder Kontaktfeld abzurufen. Der folgende Code mit einer Funktion innerhalb der Link-Tags in einem Skript funktioniert daher nicht:

<a href="${ticket.get('fieldgroup.field')}">My Link</a>

Stattdessen darf der Feldwert das Protokoll nicht enthalten. Sie können eine Variable verwenden, um den Rückgabewert der Funktion zu speichern:

[#assign link=ticket.get('fieldgroup.field')!]

<a href="https://${link}">My link</a>

Sonderfall: Skript, das Textvorlage mit Bildern einbindet

Wenn mit dem Skript Textvorlagen des Typs Brief oder Include, die Bilder enthalten, eingebunden werden, müssen Sie folgendermaßen vorgehen:

Wenn das Skript in einer Vorlage für automatische E-Mails verwendet wird, und der Inhalt der E-Mail ins Vorgangsprotokoll geschrieben werden soll, verwenden Sie die Methode workflowApi.addTicketTemplateText(String pTemplateName).

Code-Beispiel: Queue-spezifische Signaturen

Das folgende Beispiel zeigt eine Skriptvorlage, die eingesetzt wird, um abhängig von der aktuellen Queue des Vorgangs eine bestimmte Signatur einzufügen. Auf diese Wiese können Sie für unterschiedliche Unternehmensbereiche unterschiedliche Signaturen verwenden.

[#if ticket.queue.name??]

[#if ticket.queue.name=="ServiceDesk"]

[#include "Signature ServiceDesk"]

[#elseif ticket.queue.name=="HelpDesk_1st_Level"]

[#include "Signature Helpdesk"]

[#else]

[#include "Default signature"]

[/#if]

[#else]

[#include "Default signature"]

[/#if]

Code-Beispiel: Verwenden von Listen und Tabellen in Vorlagen

Datenfelder des Typs list oder struct können nicht direkt in der Bibliothek der Templatefelder ausgewählt werden. Stattdessen müssen Sie ein Skript erstellen und es in die Briefvorlage einfügen. Die Checkbox HTML erlauben muss für die Skriptvorlage ausgewählt sein. Das folgende Beispiel zeigt ein Skript, das den Inhalt des Structs order_list in der Vorgangsfeldgruppe helpdesk_standard anzeigt. Die Tabellenkopfzeile ist fett formatiert und enthält die Feldnamen.

[#if helpdesk_standard.order_list?has_content]

<table>

[#list 0..helpdesk_standard.order_list?size-1 as i]

<tr>

[#list helpdesk_standard.order_list[i] as value]

[#if i==0]

<td style="border:1px solid #d9d9d9; padding: 0 2px;font-weight:bold;">${value}</td>

[#else]

<td style="border:1px solid #d9d9d9; padding: 0 2px;">${value}</td>

[/#if]

[/#list]

</tr>

[/#list]

</table>

[/#if]