Rich-Text-Vorlagen

Rich-Text-Vorlagen 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 Rich-Text-Vorlagen gespeichert werden. Vorlagen 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.

Rich-Text-Vorlagen 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 Rich-Text-Vorlage 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.

Rich-Text-Vorlagen werden auf der Seite Rich-Text-Vorlagen gespeichert. Vorlagen, die nur im Workflow benutzt werden und im Web Client nicht zur Auswahl stehen sollen, können auf der Seite Technische Vorlagen gespeichert werden.

Einstellungen für Rich-Text-Vorlagen

Rich-Text-Vorlagen haben folgende allgemeine Einstellungen. Sie können im Tab Einstellungen bearbeitet werden.

• Interner Name: Pflichtangabe. Der Name der Vorlage. Dieser muss innerhalb der Sprache eindeutig sein. In der Tabelle sind Vorlagen mit Attachments durch ein kleines Büroklammer-Symbol neben dem Namen gekennzeichnet.
• Lokalisierter Name: Optional. Der lokalisierte Name der Vorlage, der im Vorlagenselektor im Web Client angezeigt wird.
• Sprache: Pflichtangabe. Die Sprache der Vorlage. Dies ist nützlich, wenn Sie in mehreren Sprachen kommunizieren, sodass Sie die gleiche Vorlage für jede Sprache benötigen. Dann können Sie in Skripten mithilfe der Spracheinstellung die richtige Vorlage abrufen.
• Typ: Pflichtangabe. Es gibt vier Arten von Vorlagen:
  • Vorlage: Die Vorlage, die für Kommentare oder E-Mails verwendet werden kann.
  • Include: Includes können in anderen Vorlagen verwendet werden. Sie ermöglichen die Wiederverwendung von Text für mehrere Vorlagen. Ein häufiger Anwendungsfall für Includes ist die E-Mail-Signatur, die für alle E-Mail-Vorlagen benötigt wird.
  • Textblock: Textblöcke können in anderen Vorlagen verwendet werden. Sie sind für manuelle E-Mails und Kommentare praktisch, da der Benutzer entscheiden kann, welche Textblöcke der finale Kommentar oder die E-Mail haben soll. Siehe Verwenden von Rich-Text-Vorlagen.
  • Skript: Skripte können in Vorlagen, Includes und Textblöcken verwendet werden. Sie werden in Freemarker geschrieben und ermöglichen es, Logik zu Vorlagen hinzuzufügen. Siehe Verwenden von Skripten in Rich-Text-Vorlagen.
• Gruppe: Pflichtangabe. Die Gruppe, zu der die Vorlage gehört. Diese Einstellung ist nützlich, um die Vorlagen zu ordnen und leichter finden zu können. Sie gilt sowohl in der Vorlagenverwaltung als auch im Kommentar- und E-Mail-Editor.
• Untergruppe: Optional. Die Untergruppe, zu der die Vorlage gehört. Diese Einstellung ist nützlich, wenn Ihre Gruppen viele Vorlagen enthalten.
• Verwendung: Gibt an, wie oft die Vorlage auf dem aktuellen ConSol CM-System verwendet, d. h. von einem Benutzer im Vorlagenselektor eines Vorgangs ausgewählt, wurde. Wird nur in der Übersichtstabelle angezeigt.

Es gibt drei Stellen, an denen Rich-Text-Vorlagen verwendet werden können. Im Tab Verfügbarkeit können Sie eine oder mehrere Stellen auswählen:

• E-Mail: Die Vorlage kann für manuelle E-Mails, die mit dem E-Mail-Editor im Web Client versendet werden, verwendet werden.
• Vorgangserstellung: Die Vorlage kann für Kommentare verwendet werden, die mit dem Kommentareditor im Web Client bei der Erstellung eines neuen Vorgangs geschrieben werden.
• Vorgangsbearbeitung: Die Vorlage kann für Kommentare verwendet werden, die mit dem Kommentareditor im Web Client in einem vorhandenen Vorgang hinzugefügt oder editiert werden.

Verwendungen von Rich-Text-Vorlagen

Im Tab Verwendungen können Sie sehen, wie die Vorlage mit anderen Entitäten im System zusammenhängt:

• Eingehende Referenzen: Verwendung in Queues, Skripten und anderen Vorlagen
• Ausgehende Referenzen: Datenfelder und andere Vorlagen, die in der Vorlage verwendet werden

Wenn Sie über allgemeine Administratorberechtigungen verfügen, können Sie auf die Chip-Symbole klicken, um zu den referenzierten Entitäten zu navigieren.

Grundlegende Aufgaben

Finden einer Rich-Text-Vorlage

Die Rich-Text-Vorlagen werden direkt nach dem Aufrufen der Seite Rich-Text-Vorlagen angezeigt. Sie können die Tabelle filtern, um eine Vorlage leichter zu finden:

• Textsuche: Geben Sie einen Text in das Feld Suchen ein und wählen Sie Im Namen, um im Namen der Vorlagen zu suchen, oder Im Inhalt, um eine Freitextsuche im Inhalt der Vorlagen durchzuführen.
• Vorlagentyp: Wählen Sie den Typ im Auswahlfeld Alle Typen aus, um nur Vorlagen eines bestimmten Typs anzuzeigen.
• Verfügbarkeit der Vorlage: Wählen Sie die Verfügbarkeit im Auswahlfeld Alle Verfügbarkeiten aus, um nur Vorlagen anzuzeigen, die in einem bestimmten Kontext angezeigt werden.
• Vorlagengruppe: Wählen Sie die Vorlagengruppe oder -untergruppe im Auswahlfeld Alle Gruppen aus, um nur Vorlagen anzuzeigen, die zu einer bestimmten Gruppe gehören.
• Queue: Wählen Sie die Queue im Auswahlfeld Alle Queues aus, um nur Vorlagen anzuzeigen, die in einer bestimmten Queue verfügbar sind.

Verwalten von Rich-Text-Vorlagen

Sie benötigen die Berechtigung Vorlagen verwalten oder Administratorberechtigungen, um Rich-Text-Vorlagen 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.

Für Rich-Text-Vorlagen stehen folgende Aktionen zur Verfügung:

• Neue Vorlage erstellen: Klicken Sie über der Vorlagenliste auf den Button Neue Rich-Text-Vorlage. Füllen Sie die Basisdaten für die Vorlage aus (siehe Einstellungen für Rich-Text-Vorlagen) und schreiben Sie den Vorlageninhalt (siehe Schreiben von Rich-Text-Vorlagen). Sie können die Verfügbarkeit der Vorlage definieren, siehe Festlegen der Verfügbarkeit von Rich-Text-Vorlagen. Wenn die neue Vorlage einer vorhandenen Vorlage ähnelt, können Sie auf das Icon Duplizieren klicken, um die Vorlage zu kopieren.

• Vorlage bearbeiten: Klicken Sie auf die Zeile der Vorlage, um die Basisdaten der Vorlage zu aktualisieren (siehe Einstellungen für Rich-Text-Vorlagen), den Vorlageninhalt ändern (siehe Schreiben von Rich-Text-Vorlagen) oder die Verfügbarkeit zu ändern, siehe Festlegen der Verfügbarkeit von Rich-Text-Vorlagen.

• Vorlage deaktivieren: Klicken auf das Icon Deaktivieren, um die Vorlage zu deaktivieren. Deaktivierte Vorlagen können nicht mehr verwendet werden. Sie werden in der Übersicht in grau und kursiv angezeigt.

• Vorlage aktivieren: Klicken auf das Icon Aktivieren, um die Vorlage zu aktivieren.

• Vorlage löschen: Klicken Sie auf das Icon Löschen, um eine nicht mehr benötigte Vorlage zu löschen. Vorlagen, die in Verwendung sind, entweder vom Workflow oder weil sie von anderen Vorlagen referenziert werden, können nicht gelöscht werden.

• Standardvorlagen für Kommentare und E-Mails festlegen: Klicken Sie auf den Button Standardvorlagen festlegen über der Liste der Vorlagen, um festzulegen, welche Vorlagen automatisch in den Editor eingefügt werden sollen, wenn ein Benutzer einen Kommentar oder eine E-Mail verfasst. Bei E-Mails handelt es sich dabei in der Regel um die E-Mail-Signatur. Diese Einstellung kann je nach Queue überschrieben werden, siehe Skripte und Vorlagen

  Nutzung von Standardvorlagen

  Normalerweise wird die Signatur als Standardvorlage für E-Mails verwendet. Eine Standardvorlage darf keine Textblöcke oder Parameter enthalten.

Sie können die Vorlagengruppen und -untergruppen verwalten, indem Sie auf den Button Gruppen verwalten klicken. Es öffnet sich ein Modalfenster, in dem Sie Gruppen hinzufügen und entfernen und die Gruppennamen lokalisieren können.

Schreiben von Rich-Text-Vorlagen

Zum Schreiben einer Rich-Text-Vorlage können Sie folgende Schritte durchführen:

1. Erstellen Sie eine Vorlage des Typs Vorlage. Im Tab Inhalt können Sie Text eingeben und mit dem Rich-Text-Editor formatieren. Zusätzlich können Sie auf den Button Variable einfügen klicken, um Variablen einzufügen, siehe Verwenden von Variablen in Rich-Text-Vorlagen. Wenn die Vorlage nur in bestimmten Queues verfügbar sein soll oder nur wenn bestimmte Vorgangsfelder ausgefüllt sind, können Sie die Vorlage im Tab Verfügbarkeit entsprechend einschränken, siehe Definieren der Verfügbarkeit von Rich-Text-Vorlagen.
2. Optional. Fügen Sie Attachments an die Vorlage 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 einfügen. Siehe Verwenden von Variablen in Rich-Text-Vorlagen.
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 einfügen, indem Sie auf den Button Variable einfügen klicken, siehe Verwenden von Variablen in Rich-Text-Vorlagen. 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 Vorlagen 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 beim Anzeigen der Vorlage interpretieren markieren, können Sie den Skriptinhalt mit HTML-Tags formatieren.
6. Optional. Referenzieren Sie Textblöcke, Includes und Skripte in der Vorlage, siehe Verwenden von Variablen in Rich-Text-Vorlagen.

Ausführbarer Code

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

Quellcode

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

Verwenden von Variablen in Rich-Text-Vorlagen

Es gibt verschiedene Arten von Variablen:

• Referenzen auf andere Rich-Text-Vorlagen (Includes, Textblöcke, Skripte): Die referenzierte Vorlage wird automatisch eingefügt. Der einzige Fall, in dem eine Benutzerinteraktion notwendig ist, sind Textblöcke, die der Benutzer aus- und abwählen kann.
• Referenzen auf Vorgangs- und Kontaktfelder: Die referenzierten Felder werden automatisch durch ihre Werte im aktuellen Vorgang / Vorgangskontakt ersetzt. Wenn das Feld leer ist, wird es in der Vorlage ausgelassen. Es ist keine Benutzerinteraktion erforderlich.
• Referenzen auf Benutzer: Die referenzierten Felder werden automatisch durch ihren Wert im aktuellen Benutzer oder Bearbeiter des Vorgangs ersetzt.
• Vom Benutzer auszufüllende Variablen: Es gibt zwei Arten von Variablen: Texteingabe und Auswahl aus sortierter Liste. Der Benutzer muss die Variable ausfüllen, wenn er die Vorlage verwendet.
• Links: Links zum aktuellen Vorgang werden automatisch durch einen Hyperlink zum Vorgang im Web Client oder CM/Track ersetzt.

Gehen Sie wie folgt vor, um Variablen einzufügen:

1. Setzen Sie den Cursor an die gewünschte Stelle im Text.
2. Klicken Sie auf den Button Variable einfügen.
3. Suchen Sie die gewünschte Variable im Modalfenster. Sie können das Suchfeld verwenden und/oder einen Filter nach Queue oder Kundengruppe anwenden, um die Ergebnisse einzugrenzen.
4. Doppelklicken Sie auf die gewünschte Variable, um sie einzufügen. Bei Variablen für manuelle Benutzereingaben öffnet sich ein weiteres Modalfenster, in dem Sie einen Namen eingeben müssen. Bei Variablen für Auswahl aus sortierter Liste müssen Sie zusätzlich die Liste auswählen.

Auswirkungen der Verwendung von Variablen

Die Verwendung von Variablen wirkt sich auf die Verfügbarkeit der Vorlage aus:

• Vorgangsfelder: Die Vorlage ist nur in Vorgängen verfügbar, deren Queue die entsprechende Feldgruppe zugewiesen ist.
• Kontaktfelder: Die Vorlage ist nur in Vorgängen verfügbar, deren Hauptkontakt zu einer Kundengruppe gehört, deren Datenmodell die entsprechenden Felder enthält.
• Links: Links funktionieren auf der Seite zur Vorgangserstellung nicht. Die System-Properties cmas-core-server, url.track.auth und cmas-core-server, url.webclient müssen gesetzt sein, da sie die in den Hyperlinks verwendete System-URL bestimmen.
• Manuelle Elemente: Wenn die Vorlage Textblöcke und Variablen für die manuelle Eingabe enthält, sollte sie nicht im Workflow verwendet werden. Solche Vorlagen sind in der Übersichtstabelle mit einem roten Chip-Icon versehen, das anzeigt, dass sie für eine manuelle Verwendung vorgesehen sind.

Festlegen der Verfügbarkeit von Rich-Text-Vorlagen

Der Kontext bestimmt, in welchen Vorgängen eine Rich-Text-Vorlage verfügbar ist. Die Verfügbarkeit einer Vorlage hängt von zwei Faktoren ab:

• Kontexteinstellungen: Im Tab Verfügbarkeit können Sie die Verfügbarkeit von Vorlagen in Abhängigkeit von der Queue und Datenfeldern einschränken. Folgende Einstellungen stehen zur Verfügung:

  • Queue: Wählen Sie die Queue, in der sich der Vorgang befinden muss.
  • Datenfelder: Wählen Sie den Wert, der für ein Vorgangsfeld gesetzt sein muss (nur Felder des Typs Sortierte Liste).

  Sie können mehrere Kriterien hinzufügen. Wenn mehrere Kriterien kombiniert sind, gelten folgende Regeln:

  • Queues: Mehrere Queues werden mit ODER kombiniert, d. h. der Vorgang muss sich in einer der Queues befinden.
  • Vorgangsfelder: Mehrere Vorgangsfelder werden mit UND kombiniert. Mehrere Werte des gleichen Vorgangsfeldes werden mit ODER kombiniert. Das heißt, der Vorgang muss für jedes der Vorgangsfelder einen der angegebenen Werte haben.
  • Queues und Vorgangsfelder: Queue und Vorgangsfelder werden mit UND kombiniert, d. h. der Vorgang muss sich in der ausgewählten Queue befinden und den angegebenen Wert im ausgewählten Vorgangsfeld haben.

  Es gibt zwei Arten von Kontext: fest und überschreibbar. Fest bedeutet, dass die Vorlage nur verfügbar ist, wenn das Kriterium erfüllt ist. Überschreibbar bedeutet, dass die Web Client-Benutzer im Vorlagenselektor auf den Button Mehr anzeigen klicken können, um die Vorlage anzuzeigen.

• Variablen: Wenn Vorgangs- oder Kontaktfelder als Variablen ausgewählt sind, ist die Vorlage nur verfügbar, wenn der aktuelle Vorgang und sein Hauptkontakt ein Datenmodell haben, das die entsprechenden Felder enthält, iehe Verwenden von Variablen in Rich-Text-Vorlagen).

Verwenden von Rich-Text-Vorlagen

Rich-Text-Vorlagen können im Kommentar- und E-Mail-Editor des Web Clients und im Workflow verwendet werden. Rich-Text-Vorlagen, die im Workflow verwendet werden, funktionieren genauso wie technische Vorlagen (siehe Verwenden von Vorlagen in Skripten).

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

Der Benutzer kann die gewünschten Vorlagen im Auswahlfeld Inhalt aus Vorlage einfü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.

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

Erweiterte Aufgaben

Verwenden von Skripten in Rich-Text-Vorlagen

Mit Skripten können Sie Logik zu den Vorlagen hinzufügen. 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 beim Anzeigen der Vorlage interpretieren markieren, können Sie den Skriptinhalt mit HTML-Tags formatieren.

Bracket style

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

Links

Skripte mit der Option HTML beim Anzeigen der Vorlage interpretieren 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 Rich-Text-Vorlagen mit Bildern einbindet

Wenn mit dem Skript Vorlagen, die Bilder enthalten, eingebunden werden, müssen Sie folgendermaßen vorgehen:

• Erstellen Sie die eingebundene Vorlage, bevor Sie sie im Skript referenzieren.
• Referenzieren Sie die eingebundene Vorlage über ihren Namen ohne Sprachangabe, d. h. die Syntax ist <#include "Vorlagenname">. Sie können keine Variablen für den Vorlagennamen verwenden.
• Die eingebundene Vorlage muss dieselbe Sprache haben wie der Brief.

Vorgangshistorie

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 Liste oder Spalten können nicht direkt als Variable ausgewählt werden. Stattdessen müssen Sie ein Skript erstellen und es in die Vorlage einfügen. Die Checkbox HTML beim Anzeigen der Vorlage interpretieren muss für die Skriptvorlage ausgewählt sein. Das folgende Beispiel zeigt ein Skript, das den Inhalt der Tabelle 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]