Nachrichten Vorlagen

Eine Nachrichtenvorlage ist eine Vorlage die in verschiedenen Szenarien zum Einsatz kommen, um den Inhalt einer z.B. E-Mail oder PDF zu definieren. Jede Vorlage verfügt über mehrere I18n Templates, die je nach User Sprache dann zum Einsatz kommen.

Anlegen

Zuerst legt man eine Vorlage mit gewünschtem Typ an und definiert noch eine Entity die für die Generierung des Inhaltes benutzt werden soll. Diese Entity bestimmt welche möglichen Werte man in das Template dynamisch einsetzen kann.

Es wird zwischen verschiedenen Typen von Nachrichtenvorlagen unterschieden.

Danach können beliebig viele I18n Übersetzungen des MessageTemplates erstellt werden. Dazu einfach auf das + Symbol bei den "Message Template I18n" klicken.

Message Template I18n

Zuerst muss die Sprache (z.B. "de") unter Locale angegeben werden.
Nach dem Speichern kann dann je nach Typ über den gleichnamigen Button der "Template Designer" oder der "Markdown Editor" geöffnet werden. Dort kann man z.B. über das E-Mail Element Betreff und Inhalt definieren

Eingabe Variablen Definieren

Damit im späteren Template Daten eingesetzt werden können, besteht die Möglichkeit Eingabe Parameter zu definieren. Dazu befindet sich bei der Nachrichten Vorlage ein eigener Abschnitt zur Erstellung neuer Eingabe Variablen. Diese sind sehr leicht zu konfigurieren. Sie bestehen aus einem Namen, einem EntityNamen und einen multiple-Flag.

Der Name definiert den Namen der Variable. Dieser muss mit dem Parameternamen in den templateParams beim späteren kompilieren der Vorlage übereinstimmen. Der EntityName und das multiple-Flag dienen zur Hilfe für die Autovervollständigung beim Entwickeln.

Werte einsetzen

Um Daten nicht per Hand aus dem jeweiligen record herauskopieren zu müssen, kann mithilfe von # eine Einsetzung von Daten aus dem record beginnen. Das kleine Overlay schlägt zunächst vor, welche Variable benutzt werden können.
Innerhalb von einer Schleife oder wenn Message Template Parameter angelegt wurden, kann das auch mehr als record sein. Mit Pfeil hoch und runter kann man einen Eintrag markieren und mit . bestätigen. Zum weiteren Suchen von Werten kann man einfach weiter tippen (siehe unten).
Nach der Auswahl erscheinen die möglichen Felder dieser Variable und diese können analog zur Variable gewählt werden. Bei Relationen ist auch hier ein weiterer "Dot walk" möglich.

Typ: Email

Im Formular der Message Templates ein neues MessageTemplate anlegen und den Message Type "EMail" auswählen.
E-Mail-Templates können zum einen in der Skript-API beim Versenden von E-Mails verwendet werden, als auch als Vorlage für ActivityStream-Emails.

Typ: HTML

Für alle MessageTemplates, die den TemplateDesigner verwenden, können wiederrum eigene Vorlagen erstellt werden. Diese werden auf dem herkömmlichen Weg erstellt. Dabei muss der Typ "HTML" gewählt werden.

Nachdem solch eine Vorlage erstellt wurde, kann sie im Template Designer verwendet werden.

Typ: Markdown

Ein Markdown Template verwendet den Markdown Editor zum Definieren seiner Inhalte und kann als Vorlage für andere Datensätze dienen die ebenfalls Markdown Inhalt verwenden. So z.b. ein Wiki Eintrag.
Beim Verwenden einer Markdown Vorlage wird der gesamte Inhalt mit dem der Vorlage ersetzt.

Typ: Markdown Snippet

Ein Markdown Snippet Template verwendet den Markdown Editor zum Definieren seiner Inhalte und kann als wiederverwendbare Vorlage für andere Markdown Templates dienen, die ebenfalls Markdown Inhalt verwenden.
Beim Verwenden einer Markdown Snippet Vorlage mit dem Vorlagen-Snippet Menüpunkt wird der Inhalt der Vorlage an die aktuelle Stelle des Cursors eingefügt.

Typ: Nachricht

Ein Nachrichten-Template ist ebenfalls wie E-Mail und HTML ein Template auf Basis des HTML Editors. Dieser Typ ist zur Verwendung für Nachrichten aus dem Activity Stream vorgesehen.

TYP: PDF

Ein PDF Template verfügt wie das E-Mail Template über ein spezielles Element um einen PDF Header, Footer und Inhalt für die PDF zu definieren. Solche Templates werden auch über den HTML-Editor erstellt und können bei der Generierung von PDFs über die Script API verwendet werden.