| ... |
... |
@@ -10,12
+10,14 @@ |
| 10 |
10 |
* Das Generieren einer ID für einen Formularvorgang, die unabhängig von der FORMCYCLE-internen Prozess-ID ist. Dies ist speziell dann sinnvoll, wenn die ID einem bestimmten Muster folgen soll oder in regelmäßigen Abständen zurückgesetzt werden muss. |
| 11 |
11 |
* Das n-fache Durchlaufen der Aktionen eines Status, wobei //n// in Abhängigkeit einer Formulareingabe festgelegt wird. |
| 12 |
12 |
|
| 13 |
|
-Zudem ist es auch möglich, den aktuellen Wert eines Zählers über einen [[Platzhalter>>doc:Formcycle.UserInterface.Variables]] in der Verarbeitung oder [[per AJAX>>doc:Formcycle.FormDesigner.CodingPanel.ScriptTab.WebHome]] im Formular abzufragen. |
|
13 |
+Nach Installation stehen zwei neue Aktionen in der Statusverarbeitung zur Verfügung: //Counter// und //Variable//. Bei //Counter// muss der Zählername fest eingegeben werden, bei //Variable// kann der Zählername dynamisch durch den Wert eines Formularfelds bestimmt werden. |
| 14 |
14 |
|
| 15 |
|
-Jeder Zähler besitzt sowohl einen Namen als auch eine eindeutige [[UUID>>https://de.wikipedia.org/wiki/Universally_Unique_Identifier]]. Die UUID dient zur eindeutigen Identifikation Zählers und wird bei der Abfrage per AJAX verwendet. |
|
15 |
+Der Stand aller angelegten Zähler kann in einer separaten Menüseite im Backend eingesehen werden. Dort ist es auch möglich, die Zähler zu verwalten, also etwa deren Wert zu ändern, neue Zähler anzulegen oder bestehende Zähler zu löschen. |
| 16 |
16 |
|
| 17 |
|
-Nach Installation stehen zwei neue Aktionen in der Statusverarbeitung zur Verfügung: //Counter// und //Variable//. Bei //Counter// muss der Zählername fest eingegeben werden, bei //Variable// kann der Zählername dynamisch durch den Wert eines Formularfelds bestimmt werden. |
|
17 |
+Weiterhin ist es auch möglich, den aktuellen Wert eines Zählers über einen [[Platzhalter>>doc:Formcycle.UserInterface.Variables]] in der Verarbeitung oder [[per AJAX>>doc:Formcycle.FormDesigner.CodingPanel.ScriptTab.WebHome]] im Formular abzufragen. |
| 18 |
18 |
|
|
19 |
+Jeder Zähler besitzt sowohl einen Namen als auch eine eindeutige [[UUID>>https://de.wikipedia.org/wiki/Universally_Unique_Identifier]]. Die UUID dient zur eindeutigen Identifikation Zählers und wird bei der Abfrage per AJAX verwendet. |
|
20 |
+ |
| 19 |
19 |
== Aktionverarbeitung "Counter" == |
| 20 |
20 |
|
| 21 |
21 |
{{figure image="plugin_dbcounter_action_counter_de.png"}} |
| ... |
... |
@@ -22,7
+22,7 @@ |
| 22 |
22 |
Die Einstellungen für die Verarbeitungsaktion //Counter//. Hier kann festgelegt werden, welcher Zähler in welcher Weise geändert werden soll (hochzählen, herunterzählen etc). |
| 23 |
23 |
{{/figure}} |
| 24 |
24 |
|
| 25 |
|
-Nach Installation gibt es in der [[Status- und Aktionsverarbeitung>>doc:Formcycle.UserInterface.MyForms.WorkflowProcessing.WebHome]] eine neue Aktion namens //Counter//. Mit dieser Aktion kann der aktuelle Zählwert eines Zählers geändert werden. |
|
27 |
+Nach Installation dieses Plugins gibt es in der [[Status- und Aktionsverarbeitung>>doc:Formcycle.UserInterface.MyForms.WorkflowProcessing.WebHome]] eine neue Aktion namens //Counter//. Mit dieser Aktion kann der aktuelle Zählwert eines Zählers geändert werden. |
| 26 |
26 |
|
| 27 |
27 |
Im Unterschied zur Aktion //Variable// muss und kann hier der Zähler fest ausgewählt werden. Der Zähler sollte vorher auf der Zählerübersichtsseite (siehe unten) angelegt werden. Daher eignet sich diese Aktion besonders für globale Zähler, wie etwa für die Generierung einer fortlaufenden Vorgangs-ID. |
| 28 |
28 |
|
| ... |
... |
@@ -41,6
+41,34 @@ |
| 41 |
41 |
; Globale Einstellungen nutzen (deprecated) |
| 42 |
42 |
: Diese Option sollte angehakt bleiben und dient nur der Abwärtskompatibilität zu älteren Versionen des Plugins. Bei älteren Versionen gab es nicht die Möglichkeit, eine Menüseite im Backend für die Zählerkonfiguration anzulegen, daher musste dies in der Aktionsverarbeitung geschehen. Ist diese Option deaktiviert, erscheinen weitere Einstellungen, die weiter unter im Abschnitt zur Zählerübersichtsseite beschrieben sind. |
| 43 |
43 |
|
|
46 |
+== Aktionsverarbeitung "Variable" == |
|
47 |
+ |
|
48 |
+{{figure image="plugin_dbcounter_action_variable_de.png"}} |
|
49 |
+Die Einstellungen für die Verarbeitungsaktion //Variable//. Mit dieser Aktion kann der Zählername dynamisch festgelegt werden, etwa durch den Wert eines Formularelements. |
|
50 |
+{{/figure}} |
|
51 |
+ |
|
52 |
+Nach Installation dieses Plugins gibt es in der [[Status- und Aktionsverarbeitung>>doc:Formcycle.UserInterface.MyForms.WorkflowProcessing.WebHome]] eine neue Aktion namens //Variable//. Mit dieser Aktion kann der aktuelle Zählwert eines dynamisch festlegbaren Zählers geändert werden. |
|
53 |
+ |
|
54 |
+Im Unterschied zur Aktion //Counter// kann bei dieser Aktion ein Zähler über seinen Namen ausgewählt werden. Der Name kann frei über [[Platzhalter>>doc:Formcycle.UserInterface.Variables]] zusammengefasst werden. Wenn es den Zähler noch nicht gibt, wird ein neuer Zähler mit dem Namen angelegt. |
|
55 |
+ |
|
56 |
+Daher eignet sich diese Aktion besonders, wenn es eine unbekannte Anzahl von Zählern gibt. Beispielsweise kann diese Aktion für ein Teilnahmeformular genutzt werden, bei dem es jede Woche neue Termine gibt. Für jeden Termin kann dann ein Zähler (etwa im //Format Jahr-Monat-Tag//) benutzt werden, um die Anzahl der Teilnehmer an dem jeweiligen Tag zu zählen. |
|
57 |
+ |
|
58 |
+; Zählername |
|
59 |
+: Auswahl des Zählers, dessen Wert geändert werden soll. Der Zähler sollte vorher auf der Zählerübersichtsseite angelegt werden, kann aber auch hier neu erstellt werden. Für jeden Zähler wird sowohl sein Name als auch seine UUID angezeigt. Die UUID dient der eindeutigen Identifikation des Zählers und wird etwa bei der Abfrage per AJAX verwendet. Um einen Zähler zu löschen, wird dieser ausgewählt und das Papierkorb-Symbol rechts neben der Auswahl betätigt. Um einen neuen Zähler hinzuzufügen, wird zuerst auf das Plus-Symbol gedrückt, anschließend der gewünschte Name des Zählers eingegeben und schließlich der neue Zähler durch Drücken des Plus-Symbols angelegt. |
|
60 |
+; Zählaktion |
|
61 |
+: Gibt an, in welcher Art und Weise der Wert des Zählers geändert werden soll. Möglich Optionen sind: |
|
62 |
+:; Hochzählen |
|
63 |
+:: Erhöht den Wert des Zählers um die eingegebene Zahl. |
|
64 |
+:; Herunterzählen |
|
65 |
+:: Erniedrigt den Wert des Zählers um die eingegebene Zahl. |
|
66 |
+:; Zähler auf Startwert zurücksetzen |
|
67 |
+:: Setzt den Wert des Zählers auf den eingegebenen Startwert zurück. |
|
68 |
+; Schrittweite |
|
69 |
+: Anzahl, um die der Zähler hoch beziehungsweise herunter gesetzt werden soll. |
|
70 |
+; Globale Einstellungen nutzen (deprecated) |
|
71 |
+: Diese Option sollte angehakt bleiben und dient nur der Abwärtskompatibilität zu älteren Versionen des Plugins. Bei älteren Versionen gab es nicht die Möglichkeit, eine Menüseite im Backend für die Zählerkonfiguration anzulegen, daher musste dies in der Aktionsverarbeitung geschehen. Ist diese Option deaktiviert, erscheinen weitere Einstellungen, die weiter unter im Abschnitt zur Zählerübersichtsseite beschrieben sind. |
|
72 |
+ |
|
73 |
+ |
| 44 |
44 |
== Rückgabeparameter der Aktionen == |
| 45 |
45 |
|
| 46 |
46 |
{{figure image="plugin_dbcounter_action_return_parameters_de.png"}} |
| ... |
... |
@@ -106,19
+106,19 @@ |
| 106 |
106 |
|
| 107 |
107 |
Nach Installation des Plugins ist eine neue Servlet-Aktion verfügbar, mit der auf den aktuellen Wert eines Zähler zugegriffen werden kann. Dies ist etwa nützlich, wenn aus dem Formular heraus ein Zählwert per AJAX-Anfrage abgerufen werden soll. Die URL für das Servlet baut sich nach dem folgenden Schema auf: |
| 108 |
108 |
|
| 109 |
|
-{{code}} |
|
139 |
+{{code language="none"}} |
| 110 |
110 |
https://<Host>/<FORMCYCLE-Kontextpfad>/plugin?name=Servlet%20Counter&client-id=<Mandant-ID>&id=<Zähler-UUID> |
| 111 |
111 |
{{/code}} |
| 112 |
112 |
|
| 113 |
113 |
Falls also etwa FORMCYCLE lokal unter dem Pfad //xima-formcycle// installiert wurde, der Zähler in einem Formular des Mandanten mit der ID //1// verwendet wird und die UUID //bc49d3b0-f869-4e59-864e-ddcc2925ed63// besitzt, dann lautet die URL: |
| 114 |
114 |
|
| 115 |
|
-{{code}} |
|
145 |
+{{code language="none"}} |
| 116 |
116 |
https://localhost:8080/xima-formcycle/plugin?name=Servlet%20Counter&client-id=1&id=bc49d3b0-f869-4e59-864e-ddcc2925ed63 |
| 117 |
117 |
{{/code}} |
| 118 |
118 |
|
| 119 |
119 |
Alternativ ist es auch möglich, statt der //client-id// die ID des Formulars zu verwenden. Diese IDs lediglich verwendet, um das Servlet-Aktions-Plugin zu bestimmen, welches ausgeführt werden soll, und werden von diesem konkreten Plugin nicht ausgewertet: |
| 120 |
120 |
|
| 121 |
|
-{{code}} |
|
151 |
+{{code language="none"}} |
| 122 |
122 |
https://<Host>/<FORMCYCLE-Kontextpfad>/plugin?name=Servlet%20Counter&project-id=<Formular-ID>&id=<Zähler-UUID> |
| 123 |
123 |
{{/code}} |
| 124 |
124 |
|