Wiki-Quellcode von Platzhalter

Zeige letzte Bearbeiter
1 {{content/}}
2
3 Platzhalter werden für die Ersetzung von Formular- oder Systemwerten verwendet und stehen in [[Aktionen>>doc:Formcycle.UserInterface.MyForms.WorkflowProcessing.Actions.WebHome]], [[Templates>>doc:Formcycle.UserInterface.FilesAndTemplates.WebHome]] sowie [[Datenbank-Abfragen>>Formcycle.UserInterface.Data.DBQueries.WebHome]] zur Verfügung.
4
5 == Verwenden von Platzhaltern ==
6
7 {{figure image="1_de_PlatzhalterEMail.png" group="platzhalter"}}
8 Symbol für das Öffnen einer Platzhalterauswahl an einem Options- und einem Textfeld im Aktionstyp [[E-Mail>>doc:Formcycle.UserInterface.MyForms.WorkflowProcessing.Actions.EMail.WebHome]].
9 {{/figure}}
10
11 {{figure image="2_de_Platzhalter.png" width="150" group="platzhalter"}}
12 Die geöffnete Platzhalterauswahl. Hier kann ein Formularfeld ausgewählt werden, dessen Wert genutzt wird.
13 {{/figure}}
14
15 === Verwendung in Aktionen ===
16
17 Bei Optionsfeldern von Aktionen, die diese unterstützen, kann über das Symbol rechts die Platzhalterauswahl geöffnet werden.
18
19 === Verwendung in Templates ===
20
21 {{figure image="3_de_PlatzhalterTemplates.png" group="platzhalter"}}
22 Platzhalter können auch in Templates genutzt werden. Der Knopf //Platzhalter// öffnet das entsprechende Auswahlmenü.
23 {{/figure}}
24
25 Das Platzhaltermenü kann über den Knopf //Platzhalter// im Template-Editor geöffnet werden oder auch über die Tastenkombination //Strg// + //Leerzeichenzeichentaste//.
26
27 == Platzhaltertypen ==
28
29 === Formularplatzhalter ===
30
31 {{panel monospace="true" title="Syntax"}}
32 [%<NameDesFormularelements>%]
33 {{/panel}}
34
35 Dieser Platzhalter wird ersetzt durch den Wert des Formularelements mit dem angegebenen Namen. Formularplatzhalter werden in Aktionen wie z.B. [[E-Mail>>doc:Formcycle.UserInterface.MyForms.WorkflowProcessing.Actions.EMail]], [[Text erzeugen>>doc:Formcycle.UserInterface.MyForms.WorkflowProcessing.Actions.WriteTextFile]], [[Datenbank>>doc:Formcycle.UserInterface.MyForms.WorkflowProcessing.Actions.SQLStatement]] sowie bei [[Templates>>doc:Formcycle.UserInterface.MyForms.WorkflowProcessing.Actions.ResponsePage]] verwendet.
36
37 Beispielweise wird der Platzhalter //[%tfVorname%]// durch den Wert des [[Eingabefelds>>doc:Formcycle.FormDesigner.FormElements.Input]] mit Namen //Vorname// ersetzt.
38
39 === Spezielle Formularplatzhalter ===
40
41 Einige spezielle Formularplatzhalter existieren für alle Formulare:
42
43 ; [%xf-action%]
44 : 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.
45 ; [%lang%]
46 : Verweist auf die Sprache, die beim Ausfüllen des Formulars verwendet wurde, z.B. //de//, //de-CH//, //en// oder //fr-FR//.
47
48 === Systemplatzhalter ===
49
50 {{panel monospace="true" title="Syntax"}}
51 [%$<Name>%]
52 {{/panel}}
53
54 Dieser Platzhalter wird ersetzt durch den entsprechenden Systemwert. Aktuell stehen folgende Systemplatzhalter in Aktionen und Templates zur Verfügung.
55
56 ; [%$CLIENT_ID%]
57 : Gibt die Mandant-ID des Formulars zurück.
58 ; [%$FORM_LINK%]
59 : Gibt die URL des Formulars zurück.
60 ; [%$FORM_PROCESS_LINK%]
61 : Gibt die URL des Formulars mit dem Inhalt des Vorgangs zurück.
62 ; [%$FORM_VERIFY_LINK%]
63 : Gibt die einmalige Bestätigungs-URL zurück (nötig für [[Double-Opt-In>>doc:Formcycle.UserInterface.MyForms.DoubleOptIn.WebHome]]).
64 ; [%$FORM_INBOX_NAME%]
65 : {{version major="6" minor="1"/}}Gibt den Namen des Postfachs zurück, indem sich der Vorgang derzeit befindet.
66 ; [%$PROCESS_ID%]
67 : Gibt die aktuelle Prozess-ID des Vorgangs zurück.
68 ; [%$PROJECT_ALIAS%]
69 : Alias des derzeitigen Formulars.
70 ; [%$PROJECT_ID%]
71 : Gibt die Formular-ID zurück.
72 ; [%$PROJECT_NAME%]
73 : Name des derzeitigen Formulars.
74 ; [%$RECORD_ID%]
75 : ID des derzeitigen Vorgangs.
76 ; [%$SOURCE_SERVER%]
77 : Gibt den Namen des Servers zurück, auf welchem dieser bereitgestellt und abgesendet wurde (Name des {{fserver case="gen"/}} oder lokal).
78 ; [%$SOURCE_SERVER_URL%]
79 : Gibt die URL des Servers zurück, auf welchem dieser bereitgestellt und abgesendet wurde (Name des {{fserver case="gen"/}} oder lokal).
80 ; [%$STATUS_ID%]
81 : ID des derzeitigen Status.
82 ; [%$STATUS_NAME%]
83 : Name des derzeitigen Status.
84
85 ==== Parametrisierbare Systemplatzhalter ====
86
87 {{panel monospace="true" title="Syntax"}}
88 [%$<Name>(<Parameter>...)%]
89 {{/panel}}
90
91 ; [%$DATE("<format>", <lang>)%]
92 : {{version major="6" minor="0" patch="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>>https://docs.oracle.com/javase/7/docs/api/java/text/SimpleDateFormat.html]]) für mehr Informationen zum Datumsformat. Beispiel: {{code language="none"}}[%$DATE("dd.MM.yyyy", de)%]{{/code}}.
93 ; [%$FORM_DATE_CREATED("<format>", <lang>)%]
94 : {{version major="6" minor="0" patch="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. Siehe [[SimpleDateFormat>>https://docs.oracle.com/javase/7/docs/api/java/text/SimpleDateFormat.html]]) für mehr Informationen zum Datumsformat. Beispiel: {{code language="none"}}[%$FORM_DATE_CREATED("dd.MM.yyyy", de)%]{{/code}}
95 ; [%$FORM_DATE_MODIFIED("<format>", <lang>)%]
96 : {{version major="6" minor="0" patch="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. Siehe [[SimpleDateFormat>>https://docs.oracle.com/javase/7/docs/api/java/text/SimpleDateFormat.html]]) für mehr Informationen zum Datumsformat. Beispiel: {{code language="none"}}[%$FORM_DATE_MODIFIED("dd.MM.yyyy", de)%]{{/code}}
97
98
99 {{id name="sec_user_variables" /}}
100 === Benutzerplatzhalter {{version major="6" minor="4" patch="0"/}} ===
101
102 Benutzerplatzhalter können in [[Aktionen>>doc:Formcycle.UserInterface.MyForms.WorkflowProcessing.Actions.WebHome]], [[Templates>>doc:Formcycle.UserInterface.FilesAndTemplates.WebHome]], [[Datenbank-Abfragen>>Formcycle.UserInterface.Data.DBQueries.WebHome]] und direkt in [[Formularelementen>>Formcycle.FormDesigner.FormElements.WebHome]] zur Vorbefüllung des Formulars verwendet werden.
103
104 {{panel monospace="true" title="Syntax"}}
105 [%$&lt;Benutzerobjekt&gt;.&lt;Attribut&gt;%]
106 {{/panel}}
107
108 Über verschiedene Benutzerobjekte kann auf die Informationen der angemeldeten Benutzer zugrgriffen werden. Wird der Platzhalter ohne Attribut angegeben (z.b. [%USER%]), so werden sämtliche Benutzerinformation im [[JSON>>https://de.wikipedia.org/wiki/JavaScript_Object_Notation]]-Format ausgegeben.
109
110 Für die sinnvolle Verwendung von Benutzerplatzhaltern ist es nötig, dass eine [[Formularanmeldung>>doc:Formcycle.UserInterface.MyForms.Access.WebHome]] am Formular konfiguriert ist. Ist dies nicht der Fall, ist das Benutzerobjekt mit einem anonymen Nutzer vorbelegt.
111
112 ==== Benutzerobjekte ====
113
114 ; [%$USER%]
115 : Benutzerobjekt für den Zugriff auf den aktuellen Benutzer.
116
117 ; [%$LAST_USER%]
118 : Benutzerobjekt für den Zugriff auf den letzten Benutzer.
119
120 ; [%$INITIAL_USER%]
121 : Benutzerobjekt für den Zugriff auf den Benutzer, der den Vorgang angelegt hat.
122
123 ==== Attribute ====
124
125 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>>doc:Formcycle.UserInterface.UserSettings.ExternalUsers.WebHome]] sich der Benutzer angemeldet hat.
126
127 Beispiel: Mit dem Platzhalter **[%$USER.mail%]** gelangt man an die E-Mailadresse des angemeldeten Benutzers.
128
129 ; authTypeId
130 : ID des [[Authentifikators>>doc:Formcycle.UserInterface.UserSettings.ExternalUsers.WebHome]], der vom Benutzer verwendet wurde, um sich anzumelden.
131 ; displayName
132 : Anzeigename des angemeldeten Benutzers
133 ; familyName
134 : Nachname des angemeldeten Benutzers
135 ; firstName
136 : Vorname des angemeldeten Benutzers
137 ; gender
138 : Geschlecht des angemeldeten Benutzers
139 ; groups
140 : Namen der Gruppen, denen der Benutzer angehört
141 ; id
142 : ID des angemeldeten Benutzers. (System-ID bei FORMCYCLE-Benutzern)
143 ; linkedId
144 :
145 ; locale
146 : Sprache des angemeldeten Benutzers
147 ; location
148 : Ort des angemeldeten Benutzers
149 ; mail
150 : E-Mailadresse des angemeldeten Benutzers
151 ; phone
152 : Telefonnummer des angemeldeten Benutzers
153 ; pictureUrl
154 : URL zum Profilbild des angemeldeten Benutzers
155 ; profileUrl
156 : URL zum Profil des angemeldeten Benutzers
157 ; rawData
158 : Die gesamte Rohdaten des angemeldeten Benutzers im [[JSON>>https://de.wikipedia.org/wiki/JavaScript_Object_Notation]]-Format. Abhängig vom verwendeten Authentifikator können die Rohdaten weitere Benutzerinformationen enthalten, die nicht über die Attribute des Benutzerobjektes abgebildet werden.
159 ; role
160 : Rolle des angemeldeten Benutzers
161 ; title
162 : Titel des angemeldeten Benutzers
163 ; typedId
164 : Typ des [[Authentifikators>>doc:Formcycle.UserInterface.UserSettings.ExternalUsers.WebHome]], der vom Benutzer verwendet wurde, um sich anzumelden.
165 ; userName
166 : Benutzername des angemeldeten Benutzers
167
168 === Systemplatzhalter für HTML-Templates ===
169
170 {{panel monospace="true" title="Syntax"}}
171 [%$&lt;Name&gt;(&lt;Parameter1&gt;,&lt;Parameter2&gt;)%]
172 {{/panel}}
173
174 Zusätzlich zu den allgemeingültigen Systemplatzhaltern gibt es noch einige weitere Systemplatzhalter, welche nur innerhalb eines [[HTML-Templates>>doc:Formcycle.UserInterface.FilesAndTemplates.HTML.WebHome]] 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.
175
176 ; [%$ATTACHMENT_LIST%]
177 : 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.
178 ; [%$ATTACHMENT_ZIP=Dateiname,Link-Text%]
179 : 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.
180 :; [%$ATTACHMENT_ZIP=Dateiname,Link-Text%]
181 :: Erzeugt einen Link mit dem Text //Link-Text// zum Herunterladen der Datei, die den Dateinamen //Dateiname// erhält.
182 :; [%$ATTACHMENT_ZIP=Dateiname%]
183 :: Erzeugt einen Link mit dem Text //Dateiname// zum Herunterladen der Datei, die den Dateinamen //Dateiname// erhält.
184 :; [%$ATTACHMENT_ZIP%]
185 :: Erzeugt einen Link mit dem Text //attachment.zip// zum Herunterladen der Datei, die den Dateinamen //attachment.zip// erhält.
186 ; [%$ATTACHMENT=Anhang,Link-Text,Dateiname%]
187 : 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:
188 :; [%$ATTACHMENT=Anhang,Link-Text,Downloadname%]
189 :: Erzeugt einen Link mit dem Text //Link-Text// zum Herunterladen des Anhangs mit dem Namen //Anhang//, der den Dateinamen //Dateiname// erhält.
190 :; [%$ATTACHMENT=Anhang,Link-Text%]
191 :: Erzeugt einen Link mit dem Text //Link-Text// zum Herunterladen des Anhangs mit dem Namen //Anhang//, der den Dateinamen //Anhang// erhält.
192 :; [%$ATTACHMENT=Anhang%]
193 :: Erzeugt einen Link mit dem Text //Anhang// zum Herunterladen des Anhangs mit dem Namen //Anhang//, der den Dateinamen //Anhang// erhält.
194
195 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.
196
197 === Textbausteinplatzhalter ===
198
199 {{panel monospace="true" title="Syntax"}}
200 [%$$&lt;Name&gt;%]
201 {{/panel}}
202
203 Ein Textbausteinplatzhalter gibt den Inhalt eines [[Templates>>doc:Formcycle.UserInterface.FilesAndTemplates.WebHome]] (zum Beispiel [[Text->>doc:Formcycle.UserInterface.FilesAndTemplates.Text]], [[Mail->>doc:Formcycle.UserInterface.FilesAndTemplates.Email]], [[Link-Templates>>doc:Formcycle.UserInterface.FilesAndTemplates.Link]]) zurück und wird beispieslweise in Aktionen vom Typ [[E-Mail>>doc:Formcycle.UserInterface.MyForms.WorkflowProcessing.Actions.EMail]] verwendet.
204
205 === Aktionsplatzhalter ===
206
207 {{panel monospace="true" title="Syntax"}}
208 [%$&lt;Aktionsname&gt;.&lt;RückgabeWert&gt;%]
209 {{/panel}}
210
211 Einige Aktionen haben Rückgabewerte, die über diesen Platzhalter ausgelesen werden können.
212
213 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.
214
215 ; [%$<Aktionsname>.SUCCESS%]
216 : Rückgabe ob Aktion erfolgreich ausgeführt wurde. Liefert Boolean (true/false) zurück.
217 ; [%$<Aktionsname>.COUNT%]
218 : Rückgabe der Anzahl von Ergebnissen. Liefert Integer-Wert zurück.
219 ; [%$<Aktionsname>.RESULT%]
220 : Rückgabe eines einzelnen Ergebnis. Liefert String-Wert zurück.
221 ; [%$<Aktionsname>.RESULT[<Index>].<Bezeichner>%]
222 : 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.
Copyright 2000-2024