Wiki-Quellcode von Datenbankzähler-Plugin

Zeige letzte Bearbeiter
1 {{content/}}
2
3 {{figure image="plugin_dbcounter_workflow_select_de.png"}}
4 Das Datenbankzähler-Plugin kann sowohl als Mandant-Plugin als auch als System-Plugin installiert werden. Das Plugin selber benötigt keine Konfiguration. 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.
5 {{/figure}}
6
7 Das Datenbankzähler-Plugin ermöglicht es, einen oder mehrere globale Zähler in einer Datenbank anzulegen. Der Zählwert kann innerhalb der [[Statusverarbeitung>>doc:Formcycle.UserInterface.MyForms.WorkflowProcessing.WebHome]] erhöht, erniedrigt, ausgelesen oder zurückgesetzt werden. Mögliche Anwendungsfälle sind etwa:
8
9 * Ein Teilnahmeformular, in dem die Anzahl der Teilnehmer pro Termin gezählt wird und weitere Anmeldungen ab einer bestimmten Grenze blockiert werden.
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 * Das n-fache Durchlaufen der Aktionen eines Status, wobei //n// in Abhängigkeit einer Formulareingabe festgelegt wird.
12
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
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
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
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
21 == Menü "Zählerkonfiguration"
22
23 {{figure image="plugin_dbcounter_config_base_de.png"}}
24 Das Menü mit einer Übersicht über alle vorhandenen Zähler. Hier können auch neue Zähler hinzugefügt und bestehende Zähler gelöscht werden.
25 {{/figure}}
26
27 Nach Installation des Zähler-Plugins erscheint links im Hauptmenü ein neuer Menüeintrag mit dem Namen //Zählerkonfiguration//. In diesem Menü findet sich eine Übersicht mit Informationen über alle vorhandenen Zähler, etwa deren Namen und aktuellen Wert. Weiterhin ist es auch möglich, neue Zähler anzulegen oder bestehende Zähler zu löschen.
28
29 Ein neuer Zähler wird durch Drücken auf das Plus-Symbol links oben angelegt. Ein bestehender Zähler wird Betätigen des Papierkorb-Symbols links oben gelöscht.
30
31 In der Liste links kann ein Zähler ausgewählt werden. Nach Auswahl erscheinen die folgenden Informationen zu dem Zähler:
32
33 ; UUID
34 : Eine eindeutige ID des Zählers, die etwa beim Abruf des Zählerwerts per AJAX (siehe Servlet-Aktions-Plugin unten) verwendet wird.
35 ; Aktueller Wert
36 : Der aktuelle Wert des Zählers.
37 ; Erstelldatum
38 : Das Datum, an dem der Zähler erstellt wurde.
39 ; Letzte Änderung
40 : Das Datum, an dem der Wert des Zählers zuletzt geändert wurde.
41
42 Weiterhin können die folgenden Eigescnhaften des Zählers bearbeitet werden:
43
44 ; Zählername
45 : Der Name von diesem Zähler. Wird der Name geändert, sollte beachtet werden, dass Platzhalter und AJAX-Abfragen, wo der Name des Zählers verwendet wird, ebenfalls angepasst werden müssen. AJAX-Abfragen, wo die
46
47 == Aktionverarbeitung "Counter" ==
48
49 {{figure image="plugin_dbcounter_action_counter_de.png"}}
50 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).
51 {{/figure}}
52
53 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.
54
55 Im Unterschied zur Aktion //Variable// muss und kann hier der Zähler fest ausgewählt werden. Der Zähler sollte vorher in der Zählerkonfiguration (siehe oben) angelegt werden. Daher eignet sich diese Aktion besonders für globale Zähler, wie etwa für die Generierung einer fortlaufenden Vorgangs-ID.
56
57 ; Zählername
58 : Auswahl des Zählers, dessen Wert geändert werden soll. Der Zähler sollte vorher in der Zählerkonfiguration 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.
59 ; Zählaktion
60 : Gibt an, in welcher Art und Weise der Wert des Zählers geändert werden soll. Möglich Optionen sind:
61 :; Hochzählen
62 :: Erhöht den Wert des Zählers um die eingegebene Zahl.
63 :; Herunterzählen
64 :: Erniedrigt den Wert des Zählers um die eingegebene Zahl.
65 :; Zähler auf Startwert zurücksetzen
66 :: Setzt den Wert des Zählers auf den eingegebenen Startwert zurück.
67 ; Schrittweite
68 : Anzahl, um die der Zähler hoch beziehungsweise herunter gesetzt werden soll.
69 ; Globale Einstellungen nutzen (deprecated)
70 : 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 oben im Abschnitt zur Zählerkonfiguration beschrieben sind.
71
72 == Aktionsverarbeitung "Variable" ==
73
74 {{figure image="plugin_dbcounter_action_variable_de.png"}}
75 Die Einstellungen für die Verarbeitungsaktion //Variable//. Mit dieser Aktion kann der Zählername dynamisch festgelegt werden, etwa durch den Wert eines Formularelements und wie als Variable genutzt werden.
76 {{/figure}}
77
78 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.
79
80 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.
81
82 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.
83
84 === Variablenänderung ===
85
86 Hier wird der Name der Variable ("Zähler") ausgewählt und in angegeben, in welcher Weise deren Wert geändert werden soll.
87
88 ; Zählername
89 : Auswahl des Zählers, dessen Wert geändert werden soll. Der Zähler sollte vorher in der Zählerkonfiguration 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.
90 ; Zählaktion
91 : Gibt an, in welcher Art und Weise der Wert des Zählers geändert werden soll. Möglich Optionen sind:
92 :; Hochzählen
93 :: Erhöht den Wert des Zählers um die eingegebene Zahl.
94 :; Herunterzählen
95 :: Erniedrigt den Wert des Zählers um die eingegebene Zahl.
96 :; Zähler auf Startwert zurücksetzen
97 :: Setzt den Wert des Zählers auf den eingegebenen Startwert zurück.
98 ; Schrittweite
99 : Anzahl, um die der Zähler hoch beziehungsweise herunter gesetzt werden soll.
100
101 === Standardeinstellungen, falls Variable noch nicht existiert ===
102
103 Falls die Variable ("Zähler") mit dem angegebenen Namen noch nicht existiert, wird ein neuer Zähler erstellt. In diesem Bereich wird festgelegt, welche Einstellungen der neu angelegte Zähler haben soll. Falls der Zähler bereits existiert, haben diese Einstellungen keine Auswirkung.
104
105 ; Startwert
106 : Der Startwert des neu angelegten Zählers.
107 ; Automatisch zurücksetzen
108 : Ob der neu angelegte Zähler automatisch zurückgesetzt werden soll. Ist diese Option aktiviert, erscheinen weitere Einstellungen, die im Abschnitt zur Zählerkonfiguration (siehe oben) genauer erläutert sind.
109
110 == Rückgabeparameter der Aktionen ==
111
112 {{figure image="plugin_dbcounter_action_return_parameters_de.png"}}
113 Einstellungen für die Rückgabeparameter der Aktion, die später über Aktionsplatzhalter verfügbar sind.
114 {{/figure}}
115
116 Manchmal ist es notwendig, auf das Ergebnis der Zählaktion zugreifen zu können, etwa den aktuellen Wert oder den Statuscode. Dies kann über [[Aktionsplatzhalter>>doc:Formcycle.UserInterface.Variables]] geschehen, welche auf die Rückgabewerte einer Aktion zugreifen. In den allgemeinen Rückgabeparametern kann eingestellt werden, über welchem Schlüssel auf die Rückgabeparameter Aktion zugegriffen werden kann. Beispielsweise trage die Zähleraktion den Namen //CountUp//. Dann kann über den Platzhalter //[%$CountUp.RESULT[0].currentValue%]// auf den aktuellen Zählwert zugegriffen werden, falls unter bei den allgemeinen Rückgabeparameter der Wert //currentValue// im mittleren Eingabefelder //Counter// eingetragen wurde. Folgende Rückgabeparameter sind verfügbar:
117
118 ; ResultCode
119 : Ein nummerischer Zahlenwert, der angibt, ob die Zählaktion erfolgreich war oder nicht. Folgende Ergebnisnummern sind möglich:
120 :; 1 (OK)
121 :: Die Zählaktion wurde erfolgreich abgearbeitet.
122 :; 10 (UNKNOWN_ACTION_ERROR)
123 :: Die Zählaktion kann nicht ausgeführt werden, da eine unbekannte Zählaktion ausgewählt wurde. Aktuell werden die Zählaktionen //Hochzählen//, //Herunterzählen// und //Auf den Startwert zurücksetzen// unterstützt.
124 :; 11 (PARSING_ERROR)
125 :: Ein konfigurierter Wert hat nicht den erwarteten Datentyp, etwa wenn für die Schrittweite des Zählers keine syntaktisch korrekte Zahl eingegeben wurde.
126 :; 40 (INTERNAL_ERROR)
127 :: Es ist ein anderer Fehler aufgetreten, der nicht näher klassifiziert werden kann.
128 ; ResultMessage
129 : Eine englische Beschreibung des Resultats (Erfolg oder Fehler).
130 ; Counter
131 : Der neue nummerische Wert des Zählers, nachdem die Zählaktion ausgeführt wurde.
132 ; IsReset
133 : Entweder //true//, falls der Zähler durch die aktuelle Aktion zurückgesetzt wurde; oder //false//, wenn er nicht zurückgesetzt wurde.
134 ; CounterAfterReset
135 : Falls der Zähler zurückgesetzt wurde: Der nummerische Wert des Zählers vor dem Zurücksetzen.
136
137 == Systemplatzhalter-Plugin ==
138
139 {{figure image="dbcounter-plugin-placeholder_de.png"}}
140 Ein Beispiel für den Platzhalter zum Auslesen des Zählwerts. Hier wird ein Zähler ausgelesen, der die Anzahl an Anmeldungen für eine Veranstaltung zählt. Dann wird geprüft, ob der Zählwert die maximale Anzahl an Anmeldungen übersteigt. Basierend auf dieser Prüfung kann dem Nutzer dann ein Fehler angezeigt werden, falls die Veranstaltung bereits ausgebucht ist. Hierbei handelt es sich um eine serverseitige Prüfung zur Validierung, bereits im Formular bei der Anmeldung sollte dem Nutzer natürlich schon die Information gegeben werden, ob überhaupt noch Plätze frei sind.
141 {{/figure}}
142
143 Nach Installation des Plugins ist ein neuer [[Systemplatzhalter>>doc:Formcycle.UserInterface.Variables]] verfügbar, über den auf den aktuellen Wert eines Zählers zugegriffen werden kann. Dies ist etwa nützlich, um in einer Aktionsbedingung den Zählwert nutzen und prüfen zu können. Der Platzhalter baut sich nach dem folgenden Schema auf:
144
145 {{code language="none"}}
146 [%$DBCOUNTER.<Zählername>%]
147 {{/code}}
148
149 Um also etwa auf den Zähler mit dem Namen //test// zuzugreifen, muss der folgende Platzhalter genutzt werden:
150
151 {{code language="none"}}
152 [%$DBCOUNTER.test%]
153 {{/code}}
154
155 Falls auf einen Zähler zugegriffen werden soll, bei dem nicht bekannt ist, ob es diesen schon gibt, muss der Startwert für den Zähler mit angegeben werden. Falls der Zähler noch nicht existiert, wird dann ein neuer Zähler mit diesem Startwert erstellt. Der Platzhalter baut sich dann nach folgendem Schema auf:
156
157 {{code language="none"}}
158 [%$DBCOUNTER(<Zählername>, <Startwert>)%]
159 {{/code}}
160
161 Angenommen, der Zähler heiße //teilnehmer-2020-03-17// und soll den Wert //0// erhalten, falls er noch nicht existiert. Dann kann der folgende Platzhalter genutzt werden:
162
163 {{code language="none"}}
164 [%$DBCOUNTER(teilnehmer-2020-03-17, 0)%]
165 {{/code}}
166
167 == Servlet-Aktions-Plugin ==
168
169 {{figure image="dbcounter_plugin_servlet_action.png"}}
170 Beispiel zum Auslesen eines Zählers im Formular mittels AJAX. Die URL wird anhand der im Formular zur Verfügung stehenden Metadaten aufgebaut. Hiermit wird vermieden, die URL hart im Quelltext zu hinterlegen, was zu Fehlern führt, wenn sich etwa der Server oder der Kontextpfad ändern sollte.
171 {{/figure}}
172
173 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:
174
175 {{code language="none"}}
176 https://<Host>/<FORMCYCLE-Kontextpfad>/plugin?name=Servlet%20Counter&client-id=<Mandant-ID>&id=<Zähler-UUID>
177 {{/code}}
178
179 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:
180
181 {{code language="none"}}
182 https://localhost:8080/xima-formcycle/plugin?name=Servlet%20Counter&client-id=1&id=bc49d3b0-f869-4e59-864e-ddcc2925ed63
183 {{/code}}
184
185 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:
186
187 {{code language="none"}}
188 https://<Host>/<FORMCYCLE-Kontextpfad>/plugin?name=Servlet%20Counter&project-id=<Formular-ID>&id=<Zähler-UUID>
189 {{/code}}
190
191 === HTTP-Parameter
192
193 Zusätzlich zu den oben genannten Parametern gibt es noch weitere Parameter, die an die URL angehängt werden können. Im Folgenden werden alle verfügbaren Parameter kurz erläutert.
194
195 ; name
196 : Der Name des aufzurufenden Servlet-Aktions-Plugins, in dem Fall also //Servlet Counter//
197 ; client-id
198 : ID des Mandanten, in dem das Zähler-Plugin installiert wurde. Nicht nötig, falls das Plugin als System-Plugin installiert wurde. Es darf nur entweder //client-id// or //project-id// angegeben werden.
199 ; project-id
200 : ID eines Formulars, in dem das Zähler-Plugin zur Verfügung steht. Es darf nur entweder //client-id// or //project-id// angegeben werden.
201 ; id
202 : UUID des Zählers, auf den zugegriffen werden soll. Existiert der Zähler mit der angegebenen UUID noch nicht, wird ein entsprechender Fehler-Code zurückgeliefert (siehe unten). Es darf nur entwender eine //id// oder ein //counter-name// angegeben werden.
203 ; counter-name
204 : Name des Zählers, auf den zugegriffen werden soll. Existiert der Zähler mit dem angegebenen Namen noch nicht, wird ein neuer Zähler erstellt. Es darf nur entwender eine //id// oder ein //counter-name// angegeben werden.
205 ; counter-initial
206 : Optional. Initialer Wert des Counters, wenn dieser noch nicht existiert. Dieser Parameter darf nur angegeben werden, wenn auch //counter-name// angegeben wird.
207 ; counter-array
208 : Optional. Entweder //true// oder //false// (Standard). Wenn auf //true// gesetzt, darf der Parameter //counter-name// beziehungsweise //id// mehrfach angegeben werden. Es wird dann Array mit den Werten den Informationen zu den einzelnen Zählern angegeben. Diese Option sollte genutzt werden, wenn in einem Formular per AJAX mehrere Zähler auf einmal abgefragt werden sollen. So kann die Anzahl an HTTP-Anfrage reduziert werden.
209
210 === HTTP-Antwort
211
212 Nach Ausführung des Servlet-Aktions-Plugin wird das Ergebnis als JSON-Objekt zurückgeliefert, siehe hierzu auch die Abbildung. Falls der Parameter //counter-array// auf //true// gesetzt wurde, wird stattdessem ein JSON-Array zurückgegeben, wobei jeder Eintrag ein JSON-Objekt mit den unten beschriebenen Einträgen ist.
213
214 Das JSON-Objekt hat die folgenden Einträge:
215
216 ; Status
217 : Gibt an, ob der Servlet-Aufruf erfolgreich war. Der Wert ist ein weiteres JSON-Objekt mit folgenden Einträgen:
218 :; Msg
219 :: Ein nummerischer Wert, der angibt, ob der Servlet-Aufruf erfolgreich war. Mögliche Werte sind:
220 ::; 0 (OK)
221 ::: Die Servlet-Anfrage war erfolgreich.
222 ::; 12 (NO_REQUEST_ID_ERROR)
223 ::: Die Server-Anfrage enthielt keine Zähler-UUID.
224 ::; 13 (NO_COUNTER_TO_UUID_ERROR)
225 ::: Es existiert kein Zähler mit der angefragten UUID.
226 ::; 40 (INTERNAL_ERROR)
227 ::: Es ist ein anderer Fehler aufgetreten, der nicht näher klassifiziert werden kann.
228 :; Code
229 :: Eine englische Beschreibung des Resultats (Erfolg oder Fehler).
230 ; Counter
231 : Informationen zum angefragten Zähler. Der Wert ist ein weiteres JSON-Objekt mit folgenden Einträgen:
232 : Der aktuelle nummerische Wert des Zählers.
233 :; LastChange
234 :: Das Datum mit Uhrzeit, an dem der Zähler zuletzt geändert wurde. Das Datum wird mit dem Datums- und Zeitformat der aktuellen Server-Locale formattiert.
235 :; LastChangeTimestamp
236 :: Das Datum mit Uhrzeit, an dem der Zähler zuletzt geändert wurde. Der Zeitstempel ist eine ganze Zahl, welche die Anzahl an Millisekunden seit dem 1. Januar, 1970, 00:00:00 GMT angibt.
237 :; Value
238 :: Der aktuelle nummerische Wert des Zählers.
239 :; UUID
240 :: Die UUID des angefragten Zählers, dessen Wert ausgelesen wurde.
241 :; Name
242 :: Der Name des angefragten Zählers, dessen Wert ausgelesen wurde.

Navigation

Copyright 2000-2025