Textvorlagen werden in den folgenden Bereichen verwendet:
Typ |
Format |
Bestätigungsbildschirme (commit templates) |
HTML |
Bestätigung eines Speichervorgangs bei der Aktion „saveFormWithReceiptAction" |
HTML |
Versenden von Emails (mail templates) |
TXT |
Bei einer Textvorlage handelt es sich um einen beliebigen Text (HTML oder TXT) der als Vorlage verwendet werden kann. Zusätzlich können spezielle Variablen verwendet werden um den Text dynamisch mit zusätzlichen Inhalten anzureichern. Eine Variable startet mit der Zeichenkette „${„ und endet mit „}". Mögliche Variablen sind:
Propertyname |
Beschreibung |
TODAY_DATE |
Aktuelles Datum |
USER_GOUPS |
Gruppen zu denen der Benutzer gehört |
USER_LANGUAGE |
Sprache des Benutzers |
USER_EMAIL |
E-Mail Addresse des Benutzers |
TODAY_TS |
Aktueller Zeitstempel |
USER_LOGIN_TIME |
Loginzeitpunkt des Benutzers. |
USER_ID |
Benutzer ID |
MANDANT_NAME |
Name des Mandanten |
XPATH_ |
Referenz auf ein Formularfeld mittels eines XPfad Ausdrucks. z.B.: ${r"${XPATH_/root/group-1/leaf}"}. Details siehe Kapitel 9.3.4 |
formID |
Formular ID |
Textvorlagen werden in einer fest definierten Reihenfolge geladen bzw. gesucht. Die Reihenfolge ist:
- mailContent (nur bei Versand von Emails)
- mailTemplate oder commitTemplate
- templates/MANDANT_ID/SPRACHE/FORM_ID+STATUS+ ".txt" oder ".html"
- templates/MANDANT_ID/FORM_ID+STATUS+".txt"oder ".html"
- templates/SYSTEM/ SPRACHE/FORM_ID+STATUS+".txt"oder ".html"
- templates/SYSTEM/FORM_ID+STATUS+".txt"oder ".html"
Wird kein mailTemplate angegeben, so wird standardmässig nach einer Email-Vorlage basierend auf der Formular-ID und dem Status (auf welchen dieser Workflow definiert ist) mit der Endung ".txt" gesucht. Bei Bestätigungsbildschirmen sowie Bestätigung eines Speichervorgangs gilt das selbe Vorgehen jedoch mit der Endung ".html".
Beispiel für ein mailTemplate namens "Beantragte-freigeben.txt". Falls das Template "Beantragte-freigeben.txt" nicht existiert, wird nachträglich noch nach dem Standardtemplate (Formular-ID + Status) gesucht. Die erste Zeile einer Emailvorlage wird jeweils als Betreff (Subject) des zu versendenden Emails interpretiert.
templates/TEST_MANDANT/de/Beantragte-freigeben.txt
templates/TEST_MANDANT/Beantragte-freigeben.txt
templates/TEST_MANDANT/de/FORM-ID_30.txt
templates/TEST_MANDANT/FORM-ID_30.txt
templates/SYSTEM/de/FORM-ID_30.txt
templates/SYSTEM/FORM-ID_30.txt