Datenbankzähler-Plugin

Inhalt [ Verbergen ]

Menü "Zählerkonfiguration"
- Eigenschaften
- Automatisches Zurücksetzen
Aktionsverarbeitung "Counter"
Aktionsverarbeitung "Variable"
- Variablenänderung
- Standardeinstellungen, falls Variable noch nicht existiert
Rückgabeparameter der Aktionen
Systemplatzhalter-Plugin
Servlet-Aktions-Plugin
- HTTP-Parameter
- HTTP-Antwort

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.

Das Datenbankzähler-Plugin ermöglicht es, einen oder mehrere globale Zähler in einer Datenbank anzulegen. Der Zählwert kann innerhalb der Statusverarbeitung erhöht, erniedrigt, ausgelesen oder zurückgesetzt werden. Mögliche Anwendungsfälle sind etwa:

Ein Teilnahmeformular, in dem die Anzahl der Teilnehmer pro Termin gezählt wird und weitere Anmeldungen ab einer bestimmten Grenze blockiert werden.
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.
Das n-fache Durchlaufen der Aktionen eines Status, wobei n in Abhängigkeit einer Formulareingabe festgelegt wird.

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.

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.

Weiterhin ist es auch möglich, den aktuellen Wert eines Zählers über einen Platzhalter in der Verarbeitung oder per AJAX im Formular abzufragen.

Jeder Zähler besitzt sowohl einen Namen als auch eine eindeutige UUID. Die UUID dient zur eindeutigen Identifikation Zählers und wird bei der Abfrage per AJAX verwendet.

Menü "Zählerkonfiguration"

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.

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.

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.

Eigenschaften

In der Liste links kann ein Zähler ausgewählt werden. Nach Auswahl erscheinen die folgenden Informationen zu dem Zähler:

UUID: Eine eindeutige ID des Zählers, die etwa beim Abruf des Zählerwerts per AJAX (siehe Servlet-Aktions-Plugin unten) verwendet wird.
Aktueller Wert: Der aktuelle Wert des Zählers.
Erstelldatum: Das Datum, an dem der Zähler erstellt wurde.
Letzte Änderung: Das Datum, an dem der Wert des Zählers zuletzt geändert wurde.

Weiterhin können die folgenden Eigenschaften des Zählers bearbeitet werden:

Zählername: 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 UUID des Zählers verwendet wird, müssen hingegen nicht angepasst werden, da die UUID des Zählers sich nicht ändert.
Beschreibung: Eine optionale Beschreibung des Zählers, die auch nur in diesem Menü einsehbar ist.
Startwert: Der Startwert des Zählers. Dieser wird etwa benutzt, wenn in einer Aktion der Zählerwert auf den Startwert zurückgesetzt werden soll.
Automatisch zurücksetzen: Wenn diese Option aktiviert ist, wird der Zähler in periodischen Abständen auf den Startwert zurückgesetzt.

Automatisches Zurücksetzen

Folgende Eigenschaften erscheinen, wenn der Zähler automatisch zurückgesetzt werden soll:

Geschieht ein Zurücksetzen des Zählers, so ist nach Ausführung der aktuellen Verarbeitungsaktion (Counter oder Variable) der Wert des Zählers gleich dem Startwert. Zum Beispiel: Die Counter-Aktion sei so eingestellt, dass der Zähler um 3 erhöht wird. Weiterhin soll der Zähler täglich zurückgesetzt werden. Der aktuelle Wert sei 39, der Startwert 11. Die erste Counter-Aktion, die an einem Tag ausgeführt wird, setzt nun der Wert des Zählers auf den Wert 11 zurück. Das Hochzählen um 3 erfolgt erst ab der zweiten Counter-Aktion an einem Tag.

Es ist zu beachten, dass der Zähler nicht in einem Hintergrundprozess zurückgesetzt wird, sondern erst wenn die Verarbeitungsaktion Counter ausgeführt wird. Genauer: Der Zählwert wird bei Ausführung der Aktion zurückgesetzt (anstelle erhöht oder erniedrigt zu werden), falls zwischen dem Zeitpunkt, an dem der Zählwert zuletzt geändert wurde, und dem aktuellen Zeitpunkt des Servers ein Zeitpunkt liegt, an dem der Zähler gemäß Konfiguration zurückgesetzt hätte werden müssen.

Bedingung

Hier kann festgelegt werden, wann und unter welchen Umständen der Zähler zurückgesetzt werden soll.

Zähler größer gleich: Nur verfügbar, wenn als Zählaktion Hochzählen gewählt wurde. Der Zähler wird auf den Startwert zurückgesetzt, wenn durch die aktuelle Aktion der Wert des Zählers so geändert wird, dass dieser größer oder gleich dem festgelegten Wert ist.
Zähler kleiner gleich: Nur verfügbar, wenn als Zählaktion Herunterzählen gewählt wurde. Der Zähler wird auf den Startwert zurückgesetzt, wenn durch die aktuelle Aktion der Wert des Zählers so geändert wird, dass dieser kleiner oder gleich dem festgelegten Wert ist.
täglich: Der Zähler wird jeden Tag zur gewählten Uhrzeit auf den Startwert zurückgesetzt.
wöchentlich: Der Zähler wird an jedem gewählten Wochentag zu der gewählten Uhrzeit zurückgesetzt.
monatlich: Der Zähler wird jeden Monat zum gewählten Tag zu der gewählten Uhrzeit zurückgesetzt.
jährlich: Der Zähler wird jedes Jahr zum gewählten Tag zu der gewählten Uhrzeit zurückgesetzt

Aktionsverarbeitung "Counter"

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).

Nach Installation dieses Plugins gibt es in der Status- und Aktionsverarbeitung eine neue Aktion namens Counter. Mit dieser Aktion kann der aktuelle Zählwert eines Zählers geändert werden.

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.

Zählername

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.

Zählaktion

Gibt an, in welcher Art und Weise der Wert des Zählers geändert werden soll. Möglich Optionen sind:

Hochzählen: Erhöht den Wert des Zählers um die eingegebene Zahl.
Herunterzählen: Erniedrigt den Wert des Zählers um die eingegebene Zahl.
Zähler auf Startwert zurücksetzen: Setzt den Wert des Zählers auf den eingegebenen Startwert zurück.

Schrittweite

Anzahl, um die der Zähler hoch beziehungsweise herunter gesetzt werden soll.

Globale Einstellungen nutzen (deprecated)

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.

Aktionsverarbeitung "Variable"

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.

Nach Installation dieses Plugins gibt es in der Status- und Aktionsverarbeitung eine neue Aktion namens Variable. Mit dieser Aktion kann der aktuelle Zählwert eines dynamisch festlegbaren Zählers geändert werden.

Im Unterschied zur Aktion Counter kann bei dieser Aktion ein Zähler über seinen Namen ausgewählt werden. Der Name kann frei über Platzhalter zusammengefasst werden. Wenn es den Zähler noch nicht gibt, wird ein neuer Zähler mit dem Namen angelegt.

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.

Variablenänderung

Hier wird der Name der Variable ("Zähler") ausgewählt und in angegeben, in welcher Weise deren Wert geändert werden soll.

Zählername

Zählaktion

Gibt an, in welcher Art und Weise der Wert des Zählers geändert werden soll. Möglich Optionen sind:

Hochzählen: Erhöht den Wert des Zählers um die eingegebene Zahl.
Herunterzählen: Erniedrigt den Wert des Zählers um die eingegebene Zahl.
Zähler auf Startwert zurücksetzen: Setzt den Wert des Zählers auf den eingegebenen Startwert zurück.

Schrittweite

Anzahl, um die der Zähler hoch beziehungsweise herunter gesetzt werden soll.

Standardeinstellungen, falls Variable noch nicht existiert

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.

Startwert: Der Startwert des neu angelegten Zählers.
Automatisch zurücksetzen: 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.

Rückgabeparameter der Aktionen

Einstellungen für die Rückgabeparameter der Aktion, die später über Aktionsplatzhalter verfügbar sind.

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 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:

ResultCode

Ein nummerischer Zahlenwert, der angibt, ob die Zählaktion erfolgreich war oder nicht. Folgende Ergebnisnummern sind möglich:

1 (OK): Die Zählaktion wurde erfolgreich abgearbeitet.
10 (UNKNOWN_ACTION_ERROR): 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.
11 (PARSING_ERROR): Ein konfigurierter Wert hat nicht den erwarteten Datentyp, etwa wenn für die Schrittweite des Zählers keine syntaktisch korrekte Zahl eingegeben wurde.
40 (INTERNAL_ERROR): Es ist ein anderer Fehler aufgetreten, der nicht näher klassifiziert werden kann.

ResultMessage

Eine englische Beschreibung des Resultats (Erfolg oder Fehler).

Counter

Der neue nummerische Wert des Zählers, nachdem die Zählaktion ausgeführt wurde.

IsReset

Entweder true, falls der Zähler durch die aktuelle Aktion zurückgesetzt wurde; oder false, wenn er nicht zurückgesetzt wurde.

CounterAfterReset

Falls der Zähler zurückgesetzt wurde: Der nummerische Wert des Zählers vor dem Zurücksetzen.

Systemplatzhalter-Plugin

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.

Nach Installation des Plugins ist ein neuer Systemplatzhalter 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:

[%$DBCOUNTER.<Zählername>%]

Um also etwa auf den Zähler mit dem Namen test zuzugreifen, muss der folgende Platzhalter genutzt werden:

[%$DBCOUNTER.test%]

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:

[%$DBCOUNTER(<Zählername>, <Startwert>)%]

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:

[%$DBCOUNTER(teilnehmer-2020-03-17, 0)%]

Servlet-Aktions-Plugin

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.

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:

https://<Host>/<FORMCYCLE-Kontextpfad>/plugin?name=Servlet%20Counter&client-id=<Mandant-ID>&id=<Zähler-UUID>

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:

https://localhost:8080/xima-formcycle/plugin?name=Servlet%20Counter&client-id=1&id=bc49d3b0-f869-4e59-864e-ddcc2925ed63

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:

https://<Host>/<FORMCYCLE-Kontextpfad>/plugin?name=Servlet%20Counter&project-id=<Formular-ID>&id=<Zähler-UUID>

HTTP-Parameter

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.

name: Der Name des aufzurufenden Servlet-Aktions-Plugins, in dem Fall also Servlet Counter
client-id: 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.
project-id: ID eines Formulars, in dem das Zähler-Plugin zur Verfügung steht. Es darf nur entweder client-id or project-id angegeben werden.
id: 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.
counter-name: 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.
counter-initial: Optional. Initialer Wert des Counters, wenn dieser noch nicht existiert. Dieser Parameter darf nur angegeben werden, wenn auch counter-name angegeben wird.
counter-array: 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.

HTTP-Antwort

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.

Das JSON-Objekt hat die folgenden Einträge:

Status

Gibt an, ob der Servlet-Aufruf erfolgreich war. Der Wert ist ein weiteres JSON-Objekt mit folgenden Einträgen:

Msg

Ein nummerischer Wert, der angibt, ob der Servlet-Aufruf erfolgreich war. Mögliche Werte sind:

0 (OK): Die Servlet-Anfrage war erfolgreich.
12 (NO_REQUEST_ID_ERROR): Die Server-Anfrage enthielt keine Zähler-UUID.
13 (NO_COUNTER_TO_UUID_ERROR): Es existiert kein Zähler mit der angefragten UUID.
40 (INTERNAL_ERROR): Es ist ein anderer Fehler aufgetreten, der nicht näher klassifiziert werden kann.

Code