Verwaltung - Platzhalter 

Page / - zuletzt bearbeitet von nlo am 09.07.2019, 14:41 

Platzhalter 
zuletzt bearbeitet von nlo
am 09.07.2019, 14:41

Inhaltsverzeichnis
Verwenden von Platzhaltern
Verwendung in Aktionen
Verwendung in Templates
Platzhaltertypen
Formularplatzhalter
Spezielle Formularplatzhalter
Systemplatzhalter
Benutzerplatzhalter 6.4.0+ 
Terminplatzhaler 6.5.0+ 
Systemplatzhalter für HTML-Templates
Textbausteinplatzhalter
Aktionsplatzhalter

Inhalt [ Verbergen ] 
•	Verwenden von Platzhaltern
•	Verwendung in Aktionen
•	Verwendung in Templates
•	Platzhaltertypen
•	Formularplatzhalter
•	Spezielle Formularplatzhalter
•	Systemplatzhalter
•	Benutzerplatzhalter 
•	Terminplatzhaler 
•	Systemplatzhalter für HTML-Templates
•	Textbausteinplatzhalter
•	Aktionsplatzhalter
Platzhalter werden für die Ersetzung von Formular- oder Systemwerten verwendet und stehen in Aktionen, Templates sowie Datenbank-Abfragen zur Verfügung.
Verwenden von Platzhaltern
 
Symbol für das Öffnen einer Platzhalterauswahl an einem Options- und einem Textfeld im Aktionstyp E-Mail.
 
Die geöffnete Platzhalterauswahl. Hier kann ein Formularfeld ausgewählt werden, dessen Wert genutzt wird.
Verwendung in Aktionen
Bei Optionsfeldern von Aktionen, die diese unterstützen, kann über das Symbol rechts die Platzhalterauswahl geöffnet werden.
Verwendung in Templates
 
Platzhalter können auch in Templates genutzt werden. Der Knopf Platzhalter öffnet das entsprechende Auswahlmenü.
Das Platzhaltermenü kann über den Knopf Platzhalter im Template-Editor geöffnet werden oder auch über die Tastenkombination Strg + Leerzeichenzeichentaste.
Platzhaltertypen

Formularplatzhalter
Syntax 
[%<NameDesFormularelements>%] 
Dieser Platzhalter wird ersetzt durch den Wert des Formularelements mit dem angegebenen Namen. Formularplatzhalter werden in Aktionen wie z.B. E-Mail, Text erzeugen, Datenbank sowie bei Templates verwendet.
Beispielweise wird der Platzhalter [%tfVorname%] durch den Wert des Eingabefelds mit Namen Vorname ersetzt.
Spezielle Formularplatzhalter
Einige spezielle Formularplatzhalter existieren für alle Formulare:
[%xf-action%]
Der Name der Schaltfläche, die zum Absenden verwendet wurde. Kann etwa genutzt werden, um über eine Bedingung bestimmte Aktionen nur auszuführen, wenn eine bestimmte Schaltfläche gedrückt wurde.
[%lang%]
Verweist auf die Sprache, die beim Ausfüllen des Formulars verwendet wurde, z.B. de, de-CH, en oder fr-FR.
Systemplatzhalter
Syntax 
[%$<Name>%] 
Dieser Platzhalter wird ersetzt durch den entsprechenden Systemwert. Aktuell stehen folgende Systemplatzhalter in Aktionen und Templates zur Verfügung.
[%$CLIENT_ID%]
Gibt die Mandant-ID des Formulars zurück.
[%$FORM_LINK%]
Gibt die URL des Formulars zurück.
[%$FORM_PROCESS_LINK%]
Gibt die URL des Formulars mit dem Inhalt des Vorgangs zurück.
[%$FORM_VERIFY_LINK%]
Gibt die einmalige Bestätigungs-URL zurück (nötig für Double-Opt-In).
[%$FORM_INBOX_NAME%]
6.1.0+ Gibt den Namen des Postfachs zurück, indem sich der Vorgang derzeit befindet.
[%$PROCESS_ID%]
Gibt die aktuelle Prozess-ID des Vorgangs zurück.
[%$PROJECT_ALIAS%]
Alias des derzeitigen Formulars.
[%$PROJECT_ID%]
Gibt die Formular-ID zurück.
[%$PROJECT_NAME%]
Name des derzeitigen Formulars.
[%$RECORD_ID%]
ID des derzeitigen Vorgangs.
[%$SOURCE_SERVER%]
Gibt den Namen des Servers zurück, auf welchem dieser bereitgestellt und abgesendet wurde (Name des Frontend-Servers oder lokal).
[%$SOURCE_SERVER_URL%]
Gibt die URL des Servers zurück, auf welchem dieser bereitgestellt und abgesendet wurde (Name des Frontend-Servers oder lokal).
[%$STATUS_ID%]
ID des derzeitigen Status.
[%$STATUS_NAME%]
Name des derzeitigen Status.
Parametrisierbare Systemplatzhalter
Syntax 
[%$<Name>(<Parameter>...)%] 
[%$DATE("<format>", <lang>)%]
6.0.5+  Aktuelles Datum. Die Parameter sind optional. Ohne Parameter wird das Datum im Standardformat zurückgegeben. Durch die Parameter kann das Format und die Sprache bestimmt werden. Siehe SimpleDateFormat für mehr Informationen zum Datumsformat. Beispiel: [%$DATE("dd.MM.yyyy", de)%].
[%$FORM_DATE_CREATED("<format>", <lang>)%]
6.0.5+  Erstellungsdatum des Vorgangs. Die Parameter sind optional. Ohne Parameter wird das Datum im Standardformat zurückgegeben. Durch die Parameter kann das Format und die Sprache bestimmt werden, wobei letztere sich auf die Benennung von Wochentagen und Monaten auswirkt. Siehe SimpleDateFormat für mehr Informationen zum Datumsformat. Beispiel: [%$FORM_DATE_CREATED("dd.MM.yyyy", de)%]
[%$FORM_DATE_MODIFIED("<format>", <lang>)%]
6.0.5+  Datum der letzten Änderung des Vorgangs. Die Parameter sind optional. Ohne Parameter wird das Datum im Standardformat zurückgegeben. Durch die Parameter kann das Format und die Sprache bestimmt werden, wobei letztere sich auf die Benennung von Wochentagen und Monaten auswirkt. Siehe SimpleDateFormat für mehr Informationen zum Datumsformat. Beispiel: [%$FORM_DATE_MODIFIED("dd.MM.yyyy", de)%]

Benutzerplatzhalter 6.4.0+ 

Vorbefüllung von Formularfeldern mit Daten des angemeldeten Benutzers.
 
Vorbefüllung von Formularfeldern mit Daten des angemeldeten Benutzers.
 
Vorbefüllung von Formularfeldern mit Daten des angemeldeten Benutzers.
Benutzerplatzhalter können in  Aktionen, Templates, Datenbank-Abfragen und direkt in Formularelementen zur Vorbefüllung des Formulars verwendet werden (siehe Abbildung).
Syntax 
[%$<Benutzerobjekt>.<Attribut>%] 
Über verschiedene Benutzerobjekte kann auf die Informationen der angemeldeten Benutzer zugrgriffen werden (Benutzerprofil). Wird der Platzhalter ohne Attribut angegeben (z.b. [%$USER%]), so werden sämtliche Benutzerinformation im JSON-Format ausgegeben.
Für die sinnvolle Verwendung von Benutzerplatzhaltern ist es nötig, dass eine Formularanmeldung am Formular konfiguriert ist. Ist dies nicht der Fall, ist das Benutzerobjekt mit einem anonymen Nutzer vorbelegt.
Benutzerobjekte
[%$USER%]
Benutzerobjekt für den Zugriff auf den aktuellen Benutzer.
[%$LAST_USER%]
Benutzerobjekt für den Zugriff auf den letzten Benutzer.
[%$INITIAL_USER%]
Benutzerobjekt für den Zugriff auf den Benutzer, der den Vorgang angelegt hat.
Attribute
Mit den Attributen eines Benutzerobjektes können gezielt Informationen über den Benutzer ermittelt werden. Die folgenden Attribute stehen bei allen Benutzern zur Verfügung. Auch wenn diese Attribute immer zur Verfügung stehen, müssen sie nicht immer einen Wert haben. Ob das Attribut einen Wert besitzt, hängt davon ab mit welcher Authentifizierungsmethode sich der Benutzer angemeldet hat.
Beispiel: Mit dem Platzhalter [%$USER.mail%] gelangt man an die E-Mailadresse des angemeldeten Benutzers.
authTypeId
ID des Authentifikators, der vom Benutzer verwendet wurde, um sich anzumelden.
displayName
Anzeigename des angemeldeten Benutzers
familyName
Nachname des angemeldeten Benutzers
firstName
Vorname des angemeldeten Benutzers
gender
Geschlecht des angemeldeten Benutzers
groups
Namen der Gruppen, denen der Benutzer angehört
id
ID des angemeldeten Benutzers. (System-ID bei FORMCYCLE-Benutzern)
linkedId
Ein Benutzerprofil kann einen sog. "linked identifier" haben. Dies ist der Identifikator eines anderen Benutzerprofils.
locale
Sprache des angemeldeten Benutzers
location
Ort des angemeldeten Benutzers
mail
E-Mailadresse des angemeldeten Benutzers
phone
Telefonnummer des angemeldeten Benutzers
pictureUrl
URL zum Profilbild des angemeldeten Benutzers
profileUrl
URL zum Profil des angemeldeten Benutzers
rawData
Die gesamte Rohdaten des angemeldeten Benutzers im JSON-Format. Abhängig vom verwendeten Authentifikator können die Rohdaten weitere Benutzerinformationen enthalten, die nicht über die Attribute des Benutzerobjektes abgebildet werden.
role
Rolle des angemeldeten Benutzers
title
Titel des angemeldeten Benutzers
typedId
Typ des Authentifikators, der vom Benutzer verwendet wurde, um sich anzumelden.
userName
Benutzername des angemeldeten Benutzers

Terminplatzhaler 6.5.0+ 
Terminplatzhalter können verwendet werden, wenn mit dem Formular Termine gebucht werden.
Syntax 
[%$<Name>%] 
[%$APPOINTMENT_LIST%]
Erzeugt eine Zusammenfassung der mit dem Vorgang gebuchten Termine in Form einer ul-HTML-Liste. Für jeden Termin wird zudem ein Button erzeugt, mit welchem der gebuchte Termin zu einem Kalender hinzugefügt werden kann. Ist für die Verwendung in HTML-Templates angedacht.
[%$APPOINTMENT_LINK%]
Erzeugt einen Link zu einer iCal-Datei, die sämtliche Termine des Vorgangs beinhaltet.

Systemplatzhalter für HTML-Templates
Syntax 
[%$<Name>(<Parameter1>,<Parameter2>)%] 
Zusätzlich zu den allgemeingültigen Systemplatzhaltern gibt es noch einige weitere Systemplatzhalter, welche nur innerhalb eines HTML-Templates verwendet werden können. Diese dienen zum Herunterladen von Anhängen und sind hierfür nur innerhalb der Browser-Session nach dem Absenden eines Formulars nutzbar.
[%$ATTACHMENT_LIST%]
Stellt alle an einem Vorgang verfügbaren Anhänge (Attachments) in einer Liste zum Herunterladen bereits. Die erzeugte Liste wird als ul-HTML-Element in das Tempalte eingefügt.
[%$ATTACHMENT_ZIP=Dateiname,Link-Text%]
Erzeugt einen Link zum Herunterladen aller Anhänge eines Vorgangs. Die Parameter Dateiname sowie Link-Text sind optional, sodass dieser Systemplatzhalter in folgenden Varianten genutzt werden kann.
[%$ATTACHMENT_ZIP=Dateiname,Link-Text%]
Erzeugt einen Link mit dem Text Link-Text zum Herunterladen der Datei, die den Dateinamen Dateiname erhält.
[%$ATTACHMENT_ZIP=Dateiname%]
Erzeugt einen Link mit dem Text Dateiname zum Herunterladen der Datei, die den Dateinamen Dateiname erhält.
[%$ATTACHMENT_ZIP%]
Erzeugt einen Link mit dem Text attachment.zip zum Herunterladen der Datei, die den Dateinamen attachment.zip erhält.
[%$ATTACHMENT=Anhang,Link-Text,Dateiname%]
Erzeugt einen Link zum Download eines einzelnen Anhangs eines Vorgangs mit dem Namen "Anhang". Dieser muss für eine korrekte Funktion den Namen einer erzeugten bzw. an den Vorgang angehangenen Datei entsprechen. Die Parameter "Link-Text" und "Dateiname" sind hierbei optional, sodass sich folgende Verwendungsmöglichkeiten ergeben:
[%$ATTACHMENT=Anhang,Link-Text,Downloadname%]
Erzeugt einen Link mit dem Text Link-Text zum Herunterladen des Anhangs mit dem Namen Anhang, der den Dateinamen Dateiname erhält.
[%$ATTACHMENT=Anhang,Link-Text%]
Erzeugt einen Link mit dem Text Link-Text zum Herunterladen des Anhangs mit dem Namen Anhang, der den Dateinamen Anhang erhält.
[%$ATTACHMENT=Anhang%]
Erzeugt einen Link mit dem Text Anhang zum Herunterladen des Anhangs mit dem Namen Anhang, der den Dateinamen Anhang erhält.
Zusätzlich ist bei dieser Art von Platzhaltern zu beachten, dass sie automatisch aus dem Template entfernt werden, wenn keine entsprechende Datei gefunden wurde bzw. erzeugt werden konnte.
Textbausteinplatzhalter
Syntax 
[%$$<Name>%] 
Ein Textbausteinplatzhalter gibt den Inhalt eines Templates (zum Beispiel Text-, Mail-, Link-Templates) zurück und wird beispieslweise in Aktionen vom Typ E-Mail verwendet.
Aktionsplatzhalter
Syntax 
[%$<Aktionsname>.<RückgabeWert>%] 
Einige Aktionen haben Rückgabewerte, die über diesen Platzhalter ausgelesen werden können.
Sie sehen ähnlich wie Systemplatzhalter aus, haben aber im Unterschied zu diesen einen Punkt als Trennzeichen zwischen dem Namen der Aktion und dem Rückgabewert. Folgende Rückgabebezeichner sind vorhanden.
[%$<Aktionsname>.SUCCESS%]
Rückgabe ob Aktion erfolgreich ausgeführt wurde. Liefert Boolean (true/false) zurück.
[%$<Aktionsname>.COUNT%]
Rückgabe der Anzahl von Ergebnissen. Liefert Integer-Wert zurück.
[%$<Aktionsname>.RESULT%]
Rückgabe eines einzelnen Ergebnis. Liefert String-Wert zurück.
[%$<Aktionsname>.RESULT[<Index>].<Bezeichner>%]
Einige Aktionen liefern mehrere Ergebnisse zurück (List<Map<String,String>> in Java). Der Bezeichner ist dabei fest durch die Verarbeitung definiert. Wird häufig bei Plugins verwendet, falls mehrere Ergebnisse zurückgegeben werden.