Änderungen von Dokument Platzhalter

Von Version 31.1
bearbeitet von jdr
am 21.07.2021, 08:43
Änderungskommentar: Es gibt keinen Kommentar für diese Version
Auf Version 54.3
bearbeitet von gru
am 27.09.2023, 17:58
Änderungskommentar: Es gibt keinen Kommentar für diese Version

Zusammenfassung

Details

Seiteneigenschaften
Dokument-Autor
... ... @@ -1,1 +1,1 @@
1 -XWiki.jdr
1 +XWiki.gru
Inhalt
... ... @@ -1,6 +1,6 @@
1 1  {{content/}}
2 2  
3 -Platzhalter werden für die Ersetzung von Formular- oder Systemwerten verwendet und stehen in [[Aktionen>>doc:Formcycle.Designer.Workflow.Actions.WebHome]], [[Templates>>doc:Formcycle.UserInterface.FilesAndTemplates.WebHome]] sowie [[Datenbank-Abfragen>>Formcycle.UserInterface.Data.DBQueries.WebHome]] zur Verfügung.
3 +Platzhalter werden für die Ersetzung von Formular- oder Systemwerten verwendet und stehen in [[Aktionen>>doc:Formcycle.Designer.Workflow.Actions.WebHome]], [[Templates>>doc:Formcycle.UserInterface.FilesAndTemplates.WebHome]] sowie [[Datenbank-Abfragen>>Formcycle.UserInterface.Data.DBQueries]] zur Verfügung.
4 4  
5 5  == Verwenden von Platzhaltern ==
6 6  
... ... @@ -38,6 +38,22 @@
38 38  
39 39  Beispielweise wird der Platzhalter //[%tfVorname%]// durch den Wert des [[Eingabefelds>>doc:Formcycle.Designer.Form.FormElements.Input]] mit Namen //Vorname// ersetzt.
40 40  
41 +=== Platzhalter für Fragenelemente ===
42 +
43 +Um auf die Werte von [[Auswahlelementen>>doc:Formcycle.Designer.Form.FormElements.Selection]] mit Darstellungstyp //Fragen// zuzugreifen, stehen folgende Platzhalter zur Verfügung. Gibt es beispielsweise an einem Fragenelement //sel1// 3 Fragen Q1, Q2, Q3 mit jeweils 3 Antworten A1, A2, A3 und sind folgende Antworten ausgewählt:
44 +
45 +{{table}}
46 +|= - |= A1 |= A2 |= A3
47 +|Q1|☑|☐|☐
48 +|Q2|☑|☑|☐
49 +|Q3|☑|☑|☑
50 +{{/table}}
51 +
52 +Dann:
53 +
54 +* //[%sel1%]// wird ersetzt durch //A1;A1,A2;A1,A2,A3//
55 +* //[%sel1_0%]// wird ersetzt durch //A1//, //[%sel1_1%]// durch //A1,A2//, //[%sel1_2%]// durch //A1,A2,A3//
56 +
41 41  === Spezielle Formularplatzhalter ===
42 42  
43 43  Einige spezielle Formularplatzhalter existieren für alle Formulare:
... ... @@ -49,6 +49,8 @@
49 49  
50 50  === Systemplatzhalter ===
51 51  
68 +{{id name="system"/}}
69 +
52 52  {{panel monospace="true" title="Syntax"}}
53 53  [%$<Name>%]
54 54  {{/panel}}
... ... @@ -57,8 +57,13 @@
57 57  
58 58  ; [%$CLIENT_ID%]
59 59  : Gibt die Mandant-ID des Formulars zurück.
78 +; [%$DEFAULT_MAIL_SENDER%] {{version major="7" minor="3"}}{{/version}}
79 +: Liefert den E-Mail Absender (System) für den konfigurierten Mailserver zurück. Falls unter Mandant > Einstellungen ein eigener Mailserver konfiguriert ist, wird diese Konfiguration verwendet, sonst der System E-Mail Server.
80 +; [%$DEFAULT_MAIL_SENDERNAME%] {{version major="7" minor="3"}}{{/version}}
81 +: Liefert den Absendername (System) für den konfigurierten Mailserver zurück. Wenn dieser nicht konfiguriert wurde, wird ein Leerstring zurückgegeben.
60 60  ; [%$FORM_LINK%]
61 61  : Gibt die URL des Formulars zurück.
84 +{{id name="ph_form_process_link"/}}
62 62  ; [%$FORM_PROCESS_LINK%]
63 63  : Gibt die URL des Formulars mit dem Inhalt des Vorgangs zurück.
64 64  ; [%$FORM_VERIFY_LINK%]
... ... @@ -69,6 +69,8 @@
69 69  : Gibt den Link des Postfachs zurück, indem sich der Vorgang derzeit befindet.
70 70  ; [%$FORM_INVITE_LINK%]
71 71  : Gibt den Einladungslink zum Formular zurück.
95 +; [%$FORM_HISTORY_HTML%] {{version major="7" minor="2" patch="0"/}}
96 +: Gibt den Verlauf eines Formulars als (HTML-) Tabelle zurück.
72 72  ; [%$PROCESS_ID%]
73 73  : Gibt die aktuelle Prozess-ID des Vorgangs zurück.
74 74  ; [%$PROJECT_ALIAS%]
... ... @@ -76,9 +76,16 @@
76 76  ; [%$PROJECT_ID%]
77 77  : Gibt die Formular-ID zurück.
78 78  ; [%$PROJECT_TITLE%]
104 +: Ab 7 heißt [%$PROJECT_NAME%] nun [%$PROJECT_TITLE%] .
79 79  : Titel des derzeitigen Formulars.
80 80  ; [%$RECORD_ID%]
81 81  : ID des derzeitigen Vorgangs.
108 +; [%$RECORD_READ%]
109 +: Rückgabe ob der derzeitige Vorgang gelesen wurde. Liefert Boolean (true/false) zurück.
110 +; [%$RECORD_UNREAD%]
111 +: Rückgabe ob der derzeitige Vorgang nicht gelesen wurde. Liefert Boolean (true/false) zurück.
112 +; [%$RECORD_ATTR.<customAttrKey>%]
113 +: Auslesen von benutzerdefinierten Vorgangswerten (z.B. [%$RECORD_ATTR.loopCount%]). Damit können am Vorgang Werte gespeichert und in jeder Aktion darauf zugegriffen werden.
82 82  ; [%$SOURCE_SERVER%]
83 83  : Gibt den Namen des Servers zurück, auf welchem dieser bereitgestellt und abgesendet wurde (Name des {{fserver case="gen"/}} oder lokal).
84 84  ; [%$SOURCE_SERVER_URL%]
... ... @@ -87,6 +87,14 @@
87 87  : ID des derzeitigen Status.
88 88  ; [%$STATUS_NAME%]
89 89  : Name des derzeitigen Status.
122 +; [%$STATUS_TYPE%]
123 +: Typ des derzeitigen Status. Diese Werte sind möglich: //RECEIVED// (Eingegangen) und //CUSTOM// (Benutzerdefinierter Status, der durch den Nutzer angelegt wurde).
124 +; [%$TRIGGER%]
125 +: Kann im neuen Workflow verwendet werden, um auf die Daten zuzugreifen, die der aktuelle Trigger zur Verfügung stellt. Diese Daten werden als JSON zurückgegeben. Auf die einzelnen Werte des Triggers kann über JsonPath zugegriffen werden (siehe [%$TRIGGER.<JSON_PATH>%]).
126 +; [%$TRIGGER.<JSON_PATH>%]
127 +: Abhängig vom Typ des Triggers werden unterschiedliche Informationen über den Trigger-Platzhalter zur Verfügung gestellt. Per JsonPath kann auf spezifische Informationen des Triggers zugegriffen werden. Welche Informationen die verschiedenen Triggertypen bereitstellen, ist über die Infobox am Trigger einsehbar.
128 +; [%$COUNTER_CLIENT.<Name des Zählers>%]
129 +: Der aktuelle Wert eines [[Mandantzählers>>doc:Formcycle.UserInterface.Data.Counter]].
90 90  
91 91  ==== Parametrisierbare Systemplatzhalter ====
92 92  
... ... @@ -120,8 +120,50 @@
120 120  {{/html}}
121 121  
122 122  
123 -Benutzerplatzhalter können in [[Aktionen>>doc:Formcycle.Designer.Workflow.Actions.WebHome]], [[Templates>>doc:Formcycle.UserInterface.FilesAndTemplates.WebHome]], [[Datenbank-Abfragen>>Formcycle.UserInterface.Data.DBQueries.WebHome]] und direkt in [[Formularelementen>>Formcycle.Designer.Form.FormElements.WebHome]] zur Vorbefüllung des Formulars verwendet werden (siehe [[Abbildung>>||anchor="fig_prefill_user_variables"]]).
124 124  
164 +{{html wiki="true"}}
165 +<div class='xm-figure xm-float-right xm-clear-h2' data-alt='Vorbefüllung von Formularfeldern mit Daten des angemeldeten Benutzers.'><div class='xm-figure-inner' style='width:310px'>{{lightbox image='prefill_user_variables_de.png' width='300' group='$height' group='$group' title='Vorbefüllung von Formularfeldern mit Daten des angemeldeten Benutzers.'/}}<div class='xm-figure-caption'>Vorbefüllung von Formularfeldern mit Daten des angemeldeten Benutzers.</div></div></div>
166 +{{/html}}
167 +
168 +
169 +
170 +{{html wiki="true"}}
171 +<div class='xm-figure xm-float-right xm-clear-h2' data-alt='Vorbefüllung von Formularfeldern mit Daten des angemeldeten Benutzers.'><div class='xm-figure-inner' style='width:310px'>{{lightbox image='prefill_user_variables_de.png' width='300' group='$height' group='$group' title='Vorbefüllung von Formularfeldern mit Daten des angemeldeten Benutzers.'/}}<div class='xm-figure-caption'>Vorbefüllung von Formularfeldern mit Daten des angemeldeten Benutzers.</div></div></div>
172 +{{/html}}
173 +
174 +
175 +
176 +{{html wiki="true"}}
177 +<div class='xm-figure xm-float-right xm-clear-h2' data-alt='Vorbefüllung von Formularfeldern mit Daten des angemeldeten Benutzers.'><div class='xm-figure-inner' style='width:310px'>{{lightbox image='prefill_user_variables_de.png' width='300' group='$height' group='$group' title='Vorbefüllung von Formularfeldern mit Daten des angemeldeten Benutzers.'/}}<div class='xm-figure-caption'>Vorbefüllung von Formularfeldern mit Daten des angemeldeten Benutzers.</div></div></div>
178 +{{/html}}
179 +
180 +
181 +
182 +{{html wiki="true"}}
183 +<div class='xm-figure xm-float-right xm-clear-h2' data-alt='Vorbefüllung von Formularfeldern mit Daten des angemeldeten Benutzers.'><div class='xm-figure-inner' style='width:310px'>{{lightbox image='prefill_user_variables_de.png' width='300' group='$height' group='$group' title='Vorbefüllung von Formularfeldern mit Daten des angemeldeten Benutzers.'/}}<div class='xm-figure-caption'>Vorbefüllung von Formularfeldern mit Daten des angemeldeten Benutzers.</div></div></div>
184 +{{/html}}
185 +
186 +
187 +
188 +{{html wiki="true"}}
189 +<div class='xm-figure xm-float-right xm-clear-h2' data-alt='Vorbefüllung von Formularfeldern mit Daten des angemeldeten Benutzers.'><div class='xm-figure-inner' style='width:310px'>{{lightbox image='prefill_user_variables_de.png' width='300' group='$height' group='$group' title='Vorbefüllung von Formularfeldern mit Daten des angemeldeten Benutzers.'/}}<div class='xm-figure-caption'>Vorbefüllung von Formularfeldern mit Daten des angemeldeten Benutzers.</div></div></div>
190 +{{/html}}
191 +
192 +
193 +
194 +{{html wiki="true"}}
195 +<div class='xm-figure xm-float-right xm-clear-h2' data-alt='Vorbefüllung von Formularfeldern mit Daten des angemeldeten Benutzers.'><div class='xm-figure-inner' style='width:310px'>{{lightbox image='prefill_user_variables_de.png' width='300' group='$height' group='$group' title='Vorbefüllung von Formularfeldern mit Daten des angemeldeten Benutzers.'/}}<div class='xm-figure-caption'>Vorbefüllung von Formularfeldern mit Daten des angemeldeten Benutzers.</div></div></div>
196 +{{/html}}
197 +
198 +
199 +
200 +{{html wiki="true"}}
201 +<div class='xm-figure xm-float-right xm-clear-h2' data-alt='Vorbefüllung von Formularfeldern mit Daten des angemeldeten Benutzers.'><div class='xm-figure-inner' style='width:310px'>{{lightbox image='prefill_user_variables_de.png' width='300' group='$height' group='$group' title='Vorbefüllung von Formularfeldern mit Daten des angemeldeten Benutzers.'/}}<div class='xm-figure-caption'>Vorbefüllung von Formularfeldern mit Daten des angemeldeten Benutzers.</div></div></div>
202 +{{/html}}
203 +
204 +
205 +Benutzerplatzhalter können in [[Aktionen>>doc:Formcycle.Designer.Workflow.Actions.WebHome]], [[Templates>>doc:Formcycle.UserInterface.FilesAndTemplates.WebHome]], [[Datenbank-Abfragen>>Formcycle.UserInterface.Data.DBQueries]] und direkt in [[Formularelementen>>Formcycle.Designer.Form.FormElements.WebHome]] zur Vorbefüllung des Formulars verwendet werden (siehe [[Abbildung>>||anchor="fig_prefill_user_variables"]]).
206 +
125 125  {{panel monospace="true" title="Syntax"}}
126 126  [%$&lt;Benutzerobjekt&gt;.&lt;Attribut&gt;%]
127 127  {{/panel}}
... ... @@ -128,7 +128,7 @@
128 128  
129 129  Ü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>>https://de.wikipedia.org/wiki/JavaScript_Object_Notation]]-Format ausgegeben.
130 130  
131 -Für die sinnvolle Verwendung von Benutzerplatzhaltern ist es nötig, dass eine [[Formularanmeldung>>doc:Formcycle.UserInterface.MyForms.Access.WebHome||anchor="form_login"]] am Formular konfiguriert ist. Ist dies nicht der Fall, ist das Benutzerobjekt mit einem anonymen Nutzer vorbelegt.
213 +Für die sinnvolle Verwendung von Benutzerplatzhaltern ist es nötig, dass eine [[Formularanmeldung>>doc:Formcycle.UserInterface.MyForms.Access||anchor="form_login"]] am Formular konfiguriert ist. Ist dies nicht der Fall, ist das Benutzerobjekt mit einem anonymen Nutzer vorbelegt.
132 132  
133 133  ==== Benutzerobjekte ====
134 134  
... ... @@ -242,6 +242,8 @@
242 242  
243 243  === Aktionsplatzhalter ===
244 244  
327 +{{id name="action"/}}
328 +
245 245  {{panel monospace="true" title="Syntax"}}
246 246  [%$&lt;Aktionsname&gt;.&lt;RückgabeWert&gt;%]
247 247  {{/panel}}
... ... @@ -252,9 +252,21 @@
252 252  
253 253  ; [%$<Aktionsname>.SUCCESS%]
254 254  : Rückgabe ob Aktion erfolgreich ausgeführt wurde. Liefert Boolean (true/false) zurück.
255 -; [%$<Aktionsname>.COUNT%]
256 -: Rückgabe der Anzahl von Ergebnissen. Liefert Integer-Wert zurück.
257 257  ; [%$<Aktionsname>.RESULT%]
258 258  : Rückgabe eines einzelnen Ergebnis. Liefert String-Wert zurück.
259 259  ; [%$<Aktionsname>.RESULT[<Index>].<Bezeichner>%]
260 260  : 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.
343 +
344 +Die folgenden Aktionsplatzhalter werden __nicht__ im alten Workflow unterstützt:
345 +
346 +; [%$<Aktionsname>.ERROR_CODE%]
347 +: Der geworfene Fehler-Code im Fehlerfall der Aktion.
348 +; [%$<Aktionsname>.ERROR_MESSAGE%]
349 +: Die geworfene Fehler-Nachricht im Fehlerfall der Aktion.
350 +
351 +Im neuen Workflow kann die Anzahl der Elemente von JSON-Arrays in Platzhalterwerten mit //.length()// erfragt werden, z.B.: **[%$Database query.RESULT.rows.length()%]**
352 +
353 +Der folgende Aktionsplatzhalter wird __nur__ im alten Workflow unterstützt:
354 +
355 +; [%$<Aktionsname>.COUNT%]
356 +: Rückgabe der Anzahl von Ergebnissen. Liefert Integer-Wert zurück.