Änderungen von Dokument Platzhalter
Auf Version 49.5
bearbeitet von Nils Schweigert
am 02.09.2022, 17:17
am 02.09.2022, 17:17
Änderungskommentar:
Es gibt keinen Kommentar für diese Version
Zusammenfassung
-
Seiteneigenschaften (2 geändert, 0 hinzugefügt, 0 gelöscht)
Details
- Seiteneigenschaften
-
- Dokument-Autor
-
... ... @@ -1,1 +1,1 @@ 1 -XWiki. gru1 +XWiki.nsc - Inhalt
-
... ... @@ -1,11 +1,11 @@ 1 1 {{content/}} 2 2 3 -Platzhalter werden für die Ersetzung von Formular- oder Systemwerten verwendet und stehen in [[Aktionen>>doc:Formcycle. FormDesigner.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.WebHome]] zur Verfügung. 4 4 5 5 == Verwenden von Platzhaltern == 6 6 7 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]].8 +Symbol für das Öffnen einer Platzhalterauswahl an einem Options- und einem Textfeld im Aktionstyp [[E-Mail>>doc:Formcycle.Designer.Workflow.Actions.EMail]]. 9 9 {{/figure}} 10 10 11 11 {{figure image="2_de_Platzhalter.png" width="150" group="platzhalter"}} ... ... @@ -34,10 +34,26 @@ 34 34 [%<NameDesFormularelements>%] 35 35 {{/panel}} 36 36 37 -Dieser Platzhalter wird ersetzt durch den Wert des Formularelements mit dem angegebenen Namen. Formularplatzhalter werden in Aktionen wie z.B. [[E-Mail>>doc:Formcycle.Designer.Workflow.Actions.EMail]], [[Text erzeugen>>doc:Formcycle. FormDesigner.Workflow.Actions.WriteTextFile]], [[Datenbank>>doc:Formcycle.FormDesigner.Workflow.Actions.SQLStatement]] sowie bei [[Templates>>doc:Formcycle.FormDesigner.Workflow.Actions.ResponsePage]] verwendet.37 +Dieser Platzhalter wird ersetzt durch den Wert des Formularelements mit dem angegebenen Namen. Formularplatzhalter werden in Aktionen wie z.B. [[E-Mail>>doc:Formcycle.Designer.Workflow.Actions.EMail]], [[Text erzeugen>>doc:Formcycle.Designer.Workflow.Actions.CreateTextFile]], [[Datenbank>>doc:Formcycle.Designer.Workflow.Actions.SQLStatement]] sowie bei [[Templates>>doc:Formcycle.Designer.Workflow.Actions.HtmlResponsePage]] verwendet. 38 38 39 -Beispielweise wird der Platzhalter //[%tfVorname%]// durch den Wert des [[Eingabefelds>>doc:Formcycle. FormDesigner.FormElements.Input]] mit Namen //Vorname// ersetzt.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,14 +57,25 @@ 57 57 58 58 ; [%$CLIENT_ID%] 59 59 : Gibt die Mandant-ID des Formulars zurück. 78 +; [%$CLIENT_MAIL_SENDER%] {{version major="7" minor="0" patch="4"/}} 79 +: Liefert die Mailabsenderadresse des Mandanten zurück. Wenn diese nicht konfiguriert wurde, wird ein Leerstring zurückgegeben. 80 +; [%$CLIENT_MAIL_SENDERNAME%] {{version major="7" minor="0" patch="4"/}} 81 +: Liefert den Mailabsendernamen des Mandanten 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%] 65 65 : Gibt die einmalige Bestätigungs-URL zurück (nötig für [[Double-Opt-In>>doc:Formcycle.UserInterface.MyForms.DoubleOptIn.WebHome]]). 66 66 ; [%$FORM_INBOX_NAME%] 67 -: {{version major="6" minor="1"/}}Gibt den Namen des Postfachs zurück, indem sich der Vorgang derzeit befindet. 90 +: Gibt den Namen des Postfachs zurück, indem sich der Vorgang derzeit befindet. 91 +; [%$FORM_INBOX_LINK%] 92 +: Gibt den Link des Postfachs zurück, indem sich der Vorgang derzeit befindet. 93 +; [%$FORM_INVITE_LINK%] 94 +: Gibt den Einladungslink zum Formular zurück. 95 +; [%$FORM_HISTORY_HTML%] 96 +: Gibt eine den Verlauf eines Formulars als HTML zurück. 68 68 ; [%$PROCESS_ID%] 69 69 : Gibt die aktuelle Prozess-ID des Vorgangs zurück. 70 70 ; [%$PROJECT_ALIAS%] ... ... @@ -71,10 +71,17 @@ 71 71 : Alias des derzeitigen Formulars. 72 72 ; [%$PROJECT_ID%] 73 73 : Gibt die Formular-ID zurück. 74 -; [%$PROJECT_NAME%] 75 -: Name des derzeitigen Formulars. 103 +; [%$PROJECT_TITLE%] 104 +: Ab 7 heißt [%$PROJECT_NAME%] nun [%$PROJECT_TITLE%] . 105 +: Titel des derzeitigen Formulars. 76 76 ; [%$RECORD_ID%] 77 77 : 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. 78 78 ; [%$SOURCE_SERVER%] 79 79 : Gibt den Namen des Servers zurück, auf welchem dieser bereitgestellt und abgesendet wurde (Name des {{fserver case="gen"/}} oder lokal). 80 80 ; [%$SOURCE_SERVER_URL%] ... ... @@ -83,6 +83,14 @@ 83 83 : ID des derzeitigen Status. 84 84 ; [%$STATUS_NAME%] 85 85 : 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]]. 86 86 87 87 ==== Parametrisierbare Systemplatzhalter ==== 88 88 ... ... @@ -91,15 +91,15 @@ 91 91 {{/panel}} 92 92 93 93 ; [%$DATE("<format>", <lang>)%] 94 -: {{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}}.138 +: 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}}. 95 95 ; [%$FORM_DATE_CREATED("<format>", <lang>)%] 96 -: {{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, wobei letztere sich auf die Benennung von Wochentagen und Monaten auswirkt. 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}}140 +: 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>>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}} 97 97 ; [%$FORM_DATE_MODIFIED("<format>", <lang>)%] 98 -: {{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, wobei letztere sich auf die Benennung von Wochentagen und Monaten auswirkt. 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}}142 +: 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>>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}} 99 99 100 100 {{id name="sec_user_variables"/}} 101 101 102 -=== Benutzerplatzhalter {{version major="6" minor="4" patch="0"/}} ===146 +=== Benutzerplatzhalter === 103 103 104 104 {{id name="fig_prefill_user_variables"/}} 105 105 {{figure image="prefill_user_variables_de.png"}}Vorbefüllung von Formularfeldern mit Daten des angemeldeten Benutzers.{{/figure}} ... ... @@ -116,7 +116,7 @@ 116 116 {{/html}} 117 117 118 118 119 -Benutzerplatzhalter können in [[Aktionen>>doc:Formcycle. FormDesigner.Workflow.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 (siehe [[Abbildung>>||anchor="fig_prefill_user_variables"]]).163 +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"]]). 120 120 121 121 {{panel monospace="true" title="Syntax"}} 122 122 [%$<Benutzerobjekt>.<Attribut>%] ... ... @@ -184,9 +184,9 @@ 184 184 185 185 {{id name="sec_appointment_variables"/}} 186 186 187 -=== Terminplatzhaler {{version major="6" minor="5" patch="0"/}} ===231 +=== Terminplatzhaler === 188 188 189 -Terminplatzhalter können verwendet werden, wenn mit dem Formular [[Termine>>doc:Formcycle. FormDesigner.FormElements.Appointment.WebHome]] gebucht werden.233 +Terminplatzhalter können verwendet werden, wenn mit dem Formular [[Termine>>doc:Formcycle.Designer.Form.FormElements.Appointment.WebHome]] gebucht werden. 190 190 191 191 {{panel monospace="true" title="Syntax"}} 192 192 [%$<Name>%] ... ... @@ -238,6 +238,8 @@ 238 238 239 239 === Aktionsplatzhalter === 240 240 285 +{{id name="action"/}} 286 + 241 241 {{panel monospace="true" title="Syntax"}} 242 242 [%$<Aktionsname>.<RückgabeWert>%] 243 243 {{/panel}} ... ... @@ -248,9 +248,21 @@ 248 248 249 249 ; [%$<Aktionsname>.SUCCESS%] 250 250 : Rückgabe ob Aktion erfolgreich ausgeführt wurde. Liefert Boolean (true/false) zurück. 251 -; [%$<Aktionsname>.COUNT%] 252 -: Rückgabe der Anzahl von Ergebnissen. Liefert Integer-Wert zurück. 253 253 ; [%$<Aktionsname>.RESULT%] 254 254 : Rückgabe eines einzelnen Ergebnis. Liefert String-Wert zurück. 255 255 ; [%$<Aktionsname>.RESULT[<Index>].<Bezeichner>%] 256 256 : 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. 301 + 302 +Die folgenden Aktionsplatzhalter werden __nicht__ im alten Workflow unterstützt: 303 + 304 +; [%$<Aktionsname>.ERROR_CODE%] 305 +: Der geworfene Fehler-Code im Fehlerfall der Aktion. 306 +; [%$<Aktionsname>.ERROR_MESSAGE%] 307 +: Die geworfene Fehler-Nachricht im Fehlerfall der Aktion. 308 + 309 +Im neuen Workflow kann die Anzahl der Elemente von JSON-Arrays in Platzhalterwerten mit //.length()// erfragt werden, z.B.: **[%$Database query.RESULT.rows.length()%]** 310 + 311 +Der folgende Aktionsplatzhalter wird __nur__ im alten Workflow unterstützt: 312 + 313 +; [%$<Aktionsname>.COUNT%] 314 +: Rückgabe der Anzahl von Ergebnissen. Liefert Integer-Wert zurück.