Platzhalter in E-Mail-Vorlagen und der Platzhalterkatalog
Platzhalter ermöglichen es einer E-Mail-Vorlage, Live-Daten — das Kennzeichen eines Fahrzeugs, die Daten einer Buchung — in den Betreff und den Text zu übernehmen. Der MobilityManager stellt einen Platzhalterkatalog bereit, der jede Entität und jedes Feld auflistet, auf das Sie verweisen können, sodass Sie niemals einen Feldnamen erraten müssen. Dieser Artikel erläutert, wie Platzhalter funktionieren und wie der Katalog zu lesen ist.
Erforderliche Berechtigung
Das Lesen des Katalogs und der Liste der Kontext-Entitätstypen erfordert email-templates:view. Sie verwenden dieselbe Berechtigung, mit der Sie eine Vorlage öffnen.
Wie Platzhalter geschrieben werden
Vorlagen verwenden die Scriban-Syntax. Ein Platzhalter ist die Entitätswurzel gefolgt von einem Feldpfad in geschweiften Klammern, zum Beispiel:
{{ vehicle.licensePlate }}{{ booking.startDate }}
Die Wurzel ist der Kontext-Entitätstyp in camelCase (eine Vorlage, deren Kontext-Entität Vehicle ist, stellt eine vehicle-Wurzel bereit). Feldnamen sind ebenfalls in camelCase. Verschachtelte Objekte sind mit Punkten bis zu zwei Ebenen tief erreichbar.
Hinweis: Das Rendern schlägt bei einer unbekannten Variablen nicht fehl — fehlende Werte werden einfach als leerer Text gerendert. Das macht Tippfehler unbemerkbar, daher überprüfen Sie Feldnamen stets anhand des Katalogs und zeigen Sie eine Vorschau des Ergebnisses an.
Was der Katalog enthält
Der Katalog wird automatisch aus dem Datenmodell der Plattform generiert. Jede Entität, die eine Kennung besitzt, wird registriert und gruppiert, und ihre skalaren Felder werden zu Platzhaltern. Jeder Platzhaltereintrag trägt:
- Pfad — was Sie eingeben, etwa
vehicle.licensePlate. - Anzeigename — eine lesbare Bezeichnung für das Feld.
- Datentyp — einer der Werte
string,number,decimal,boolean,date,guidoderenum. Ein nachgestelltes?kennzeichnet ein optionales (nullable) Feld.
Den Katalog durchsuchen
- Öffnen Sie das Platzhalter-Panel beim Bearbeiten einer Vorlage oder fordern Sie den vollständigen Katalog aller Entitätsgruppen an.
- Wählen Sie die Entität, die dem Kontext-Entitätstyp Ihrer Vorlage entspricht.
- Prüfen Sie die verfügbaren Pfade und ihre Datentypen.
- Fügen Sie den Platzhalter in den Betreff oder den Text ein.
Sie können auch Platzhalter für eine einzelne Entität anhand ihres Schlüssels abrufen oder alle registrierten Entitätstypen auflisten, um zu sehen, welche Kontexte verfügbar sind. Die Wahl der richtigen Kontext-Entität für eine Vorlage bestimmt, welche Platzhalter zu echten Daten aufgelöst werden.
Tipp: Passen Sie den Kontext-Entitätstyp der Vorlage an die Daten an, um die es in der Benachrichtigung geht. Eine Buchungsbestätigung sollte den Buchungskontext verwenden, damit {{ booking.* }}-Platzhalter aufgelöst werden; der Verweis auf ein Fahrzeugfeld, das im Buchungskontext nicht vorhanden ist, wird leer gerendert.
Datentypen und Formatierung
Der Datentyp sagt Ihnen, was Sie beim Rendern erwarten können. Datumsangaben werden im ISO-Format gerendert, Dezimalzahlen als Zahlen, Boolesche Werte als true/false und Enums als ihr Textwert. Verwenden Sie den Typ, um zu entscheiden, ob um einen Platzhalter zusätzliche Formulierungen nötig sind, zum Beispiel eine Währungsangabe neben einem decimal-Betrag.
Warnung: Der Katalog spiegelt das aktuelle Datenmodell wider. Wenn ein Feld in einer künftigen Version umbenannt wird, kann ein alter Platzhalterpfad nicht mehr aufgelöst werden. Überprüfen Sie Pfade nach größeren Upgrades erneut anhand des Katalogs und zeigen Sie eine Vorschau betroffener Vorlagen an.
Verwandte Artikel
- E-Mail-Vorlagen verwalten
- Eine E-Mail-Vorlage in der Vorschau anzeigen und rendern
- Systemkonfiguration – Übersicht und Zugriff