Wiki-Quellcode von Platzhalter

Zeige letzte Bearbeiter
1 {{content/}}
2
3 Platzhalter werden für die Ersetzung von Formularwerten verwendet und stehen in [[Aktionen>>doc:Formcycle.UserInterface.MyForms.WorkflowProcessing.Actions.WebHome]] sowie [[Templates>>doc:Formcycle.UserInterface.FilesAndTemplates.WebHome]] zur Verfügung.
4
5 == Verwenden von Platzhaltern ==
6
7 {{figure image="1_de_PlatzhalterEMail.png" width="300" 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="300" 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" width="300" 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 [%{{italic}}<NameDesFormularelements>{{/italic}}%]
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%] 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.
44 * [%lang%] Verweist auf die Sprache, die beim Ausfüllen des Formulars verwendet wurde, z.B. //de//, //de-CH//, //en/ oder //fr-FR//.//
45
46 === Systemplatzhalter ===
47
48 {{panel monospace="true" title="Syntax"}}
49 [%${{italic}}<Name>{{/italic}}%]
50 {{/panel}}
51
52 Dieser Platzhalter wird ersetzt durch den entsprechenden Systemwert. Aktuell stehen folgende Systemplatzhalter in Aktionen und Templates zur Verfügung.
53
54 * {{litem styleTitle="letter-spacing:1px;" title="[%$CLIENT_ID%]"}}Gibt die Mandant-ID des Formulars zurück.{{/litem}}
55 * {{litem styleTitle="letter-spacing:1px;" title="[%$FORM_LINK%]"}}Gibt die URL des Formulars zurück.{{/litem}}
56 * {{litem styleTitle="letter-spacing:1px;" title="[%$FORM_PROCESS_LINK%]"}}Gibt die URL des Formulars mit dem Inhalt des Vorgangs zurück.{{/litem}}
57 * {{litem styleTitle="letter-spacing:1px;" title="[%$FORM_VERIFY_LINK%]"}}Gibt die einmalige Bestätigungs-URL zurück (nötig für [[Double-Opt-In>>doc:Formcycle.UserInterface.MyForms.DoubleOptIn.WebHome]]).{{/litem}}
58 * {{litem styleTitle="letter-spacing:1px;" title="[%$PROCESS_ID%]"}}Gibt die aktuelle Prozess-ID des Vorgangs zurück.{{/litem}}
59 * {{litem styleTitle="letter-spacing:1px;" title="[%$PROJECT_ALIAS%]"}}Alias des derzeitigen Formulars.{{/litem}}
60 * {{litem styleTitle="letter-spacing:1px;" title="[%$PROJECT_ID%]"}}Gibt die Formular-ID zurück.{{/litem}}
61 * {{litem styleTitle="letter-spacing:1px;" title="[%$PROJECT_NAME%]"}}Name des derzeitigen Formulars.{{/litem}}
62 * {{litem styleTitle="letter-spacing:1px;" title="[%$RECORD_ID%]"}}ID des derzeitigen Vorgangs.{{/litem}}
63 * {{litem styleTitle="letter-spacing:1px;" title="[%$SOURCE_SERVER%]"}}Gibt den Namen des Servers zurück, auf welchem dieser bereitgestellt und abgesendet wurde (Name des {{fserver case="gen"/}} oder lokal).{{/litem}}
64 * {{litem styleTitle="letter-spacing:1px;" title="[%$SOURCE_SERVER_URL%]"}}Gibt die URL des Servers zurück, auf welchem dieser bereitgestellt und abgesendet wurde (Name des {{fserver case="gen"/}} oder lokal).{{/litem}}
65 * {{litem styleTitle="letter-spacing:1px;" title="[%$STATUS_ID%]"}}ID des derzeitigen Status.{{/litem}}
66 * {{litem styleTitle="letter-spacing:1px;" title="[%$STATUS_NAME%]"}}Name des derzeitigen Status.{{/litem}}
67
68 ==== Parametrisierbare Systemplatzhalter ====
69
70 {{panel monospace="true" title="Syntax"}}
71 [%${{italic}}<Name>(<Paramater>){{/italic}}%]
72 {{/panel}}
73
74 * {{litem styleTitle="letter-spacing:1px;" title="[%$FORM_DATE_CREATED(<format>)%]"}}{{info}}Verfügbar ab FORMCYCLE Version 6.1.0{{/info}} Erstellungsdatum des Vorgangs. Der Parameter ist optional. Ohne Parameter wird das Datum im Standardformat zurückgegeben. Durch den Paramater kann das Format genau bestimmt werden.
75
76 Biepsiel: {{code}}[%$FORM_DATE_CREATED(<dd.mm.yyyy>)%]{{/code}}
77
78 (siehe [[SimpleDateFormat>>https://docs.oracle.com/javase/7/docs/api/java/text/SimpleDateFormat.html]]){{/litem}}
79 * {{litem styleTitle="letter-spacing:1px;" title="[%$FORM_DATE_MODIFIED(<format>)%]"}}{{info}}Verfügbar ab FORMCYCLE Version 6.1.0{{/info}} Datum der letzten Änderung des Vorgangs. Der Parameter ist optional. Ohne Parameter wird das Datum im Standardformat zurückgegeben. Durch den Paramater kann das Format genau bestimmt werden.
80
81 Biepsiel: {{code}}[%$FORM_DATE_MODIFIED(<dd.mm.yyyy>)%]{{/code}}
82
83 (siehe [[SimpleDateFormat>>https://docs.oracle.com/javase/7/docs/api/java/text/SimpleDateFormat.html]]){{/litem}}
84
85 === Systemplatzhalter für HTML-Templates ===
86
87 {{panel monospace="true" title="Syntax"}}
88 [%${{italic}}&lt;Name&gt;{{/italic}}({{italic}}&lt;Parameter1&gt;{{/italic}},{{italic}}&lt;Parameter2&gt;{{/italic}})%]
89 {{/panel}}
90
91 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.
92
93 * {{litem styleTitle="letter-spacing:1px;" title="[%$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.{{/litem}}
94 * {{litem styleTitle="letter-spacing:1px;" title="[%$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.{{/litem}}
95 ** {{litem styleTitle="letter-spacing:1px;" title="[%$ATTACHMENT_ZIP=Dateiname,Link-Text%]"}}Erzeugt einen Link mit dem Text //Link-Text// zum Herunterladen der Datei, die den Dateinamen //Dateiname// erhält.{{/litem}}
96 ** {{litem styleTitle="letter-spacing:1px;" title="[%$ATTACHMENT_ZIP=Dateiname%]"}}Erzeugt einen Link mit dem Text //Dateiname// zum Herunterladen der Datei, die den Dateinamen //Dateiname// erhält.{{/litem}}
97 ** {{litem styleTitle="letter-spacing:1px;" title="[%$ATTACHMENT_ZIP%]"}}Erzeugt einen Link mit dem Text //attachment.zip// zum Herunterladen der Datei, die den Dateinamen //attachment.zip// erhält.{{/litem}}
98 * {{litem styleTitle="letter-spacing:1px;" title="[%$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.{{/litem}}
99 ** {{litem styleTitle="letter-spacing:1px;" title="[%$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.{{/litem}}
100 ** {{litem styleTitle="letter-spacing:1px;" title="[%$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.{{/litem}}
101 ** {{litem styleTitle="letter-spacing:1px;" title="[%$ATTACHMENT=Anhang%]"}}Erzeugt einen Link mit dem Text //Anhang// zum Herunterladen des Anhangs mit dem Namen //Anhang//, der den Dateinamen //Anhang// erhält.{{/litem}}
102
103 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.
104
105 === Textbausteinplatzhalter ===
106
107 {{panel monospace="true" title="Syntax"}}
108 [%$${{italic}}&lt;Name&gt;{{/italic}}%]
109 {{/panel}}
110
111 Ein Textbausteinplatzhalter gibt den Inhalt eines [[Templates>>doc:Formcycle.UserInterface.FilesAndTemplates.WebHome]] zurück und wird z.B. in Aktionen vom Typ [[E-Mail>>doc:Formcycle.UserInterface.MyForms.WorkflowProcessing.Actions.EMail]] verwendet.
112
113 === Aktionsplatzhalter ===
114
115 {{panel monospace="true" title="Syntax"}}
116 [%${{italic}}&lt;Aktionsname&gt;{{/italic}}.{{italic}}&lt;RückgabeWert&gt;{{/italic}}%]
117 {{/panel}}
118
119 Einige Aktionen haben Rückgabewerte, die über diesen Platzhalter ausgelesen werden können.
120
121 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.
122
123 * {{litem styleTitle="letter-spacing:1px;" title="[%$<Aktionsname>.SUCCESS%]"}}Rückgabe ob Aktion erfolgreich ausgeführt wurde. Liefert Boolean (true/false) zurück.{{/litem}}
124 * {{litem styleTitle="letter-spacing:1px;" title="[%$<Aktionsname>.COUNT%]"}}Rückgabe der Anzahl von Ergebnissen. Liefert Integer-Wert zurück.{{/litem}}
125 * {{litem styleTitle="letter-spacing:1px;" title="[%$<Aktionsname>.RESULT%]"}}Rückgabe eines einzelnen Ergebnis. Liefert String-Wert zurück.{{/litem}}
126 * {{litem styleTitle="letter-spacing:1px;" title="[%$<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.{{/litem}}

Navigation

Copyright 2000-2024