Änderungen von Dokument Datenbankzähler-Plugin

Von 3.9 nach 3.8

Von Version 3.8

bearbeitet von gru
am 10.03.2021, 11:01

Änderungskommentar: Es gibt keinen Kommentar für diese Version

Auf Version 1.1

bearbeitet von awa
am 20.01.2021, 16:19

Änderungskommentar: Imported from XAR

Rohform
Im Layout

Zusammenfassung

Seiteneigenschaften (2 geändert, 0 hinzugefügt, 0 gelöscht)

Details

Seiteneigenschaften

Dokument-Autor

@@ -1,1 +1,1 @@
--XWiki.gru
++XWiki.awa

Inhalt

@@ -2,85 +2,45 @@
  {{content/}}
--== Funktionsbeschreibung ==
--
--Das kostenpflichtige Datenbankzähler-Plugin-Bundle ermöglicht es, in einem neuen Menüpunkt einen oder mehrere globale Zähler zu erstellen und zu verwalten. Der Zählwert kann innerhalb der [[Platzhalter>>doc:Formcycle.UserInterface.MyForms.WorkflowProcessing.WebHome]] ausgelesen, erhöht, verringert oder zurückgesetzt werden und ist als [[Statusverarbeitung>>doc:Formcycle.UserInterface.Variables.WebHome]] verfügbar. Über ein Servlet-Aktions-Plugin kann zudem per AJAX-Request der Wert von einem oder mehreren Zählern ermittelt werden, z.B. im JavaScript-Code eines Formulars.
--
--== Installation ==
--
--Das Plugin-Bundle kann als Mandant-Plugin oder System-Plugin installiert werden. Eine Anleitung zur Installation von Plugins finden Sie [[hier>>doc:Formcycle.UserInterface.Client.Plugins.WebHome]]. Zu beachten ist hierbei, dass das Plugin nur genau einmal auf dem {{formcycle/}} Server installiert werden darf.
--
--{{info}}
--Durch dieses Plugin wird ein [[Rollenrecht>>doc:Formcycle.UserInterface.UserSettings.Roles]] erstellt, welches steuert, ob ein Benutzer Zugriff den Menüpunkt zur Konfiguration der Zähler hat. Diese Berechtigungen sollten nach der Installtion vergeben werden.
--{{/info}}
--
--== Verwendung anhand von Beispielen ==
--
--Im folgenden wird anhand eines Beispielprojekts die Verwendung von verschiedene Komponeten des Plugin-Bundles demonstriert. Das Ziel des Beispiels ist es, für eine Veranstaltung mit 15 Teilnehmern . Dabei werden verschiedene Funktionalitäten des Plugin-Bundles verwendet. Die folgenden Schritte können prinzipiell anhand jedes Formulars nachvollzogen werden. Einzige Voraussetzung ist das Vorhandensein einer Schaltfläche zum Absenden des Formulars.
--
--=== Anlegen eines Zählers ===
--
--{{figure image="1_Beispiel_Zaehler.png" width="600"}}
--Anlegen und konfigurieren eines neuen Zählers mit dem Namen //BeispielZaehler//.
++{{figure image="plugin_dbcounter_workflow_select_de.png" width="600"}}
++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.
  {{/figure}}
--{{figure image="2_Beispiel_Wert.png" width="600"}}
--Setzen des Wertes des Zählers auf die für das Beispiel gewünschte Teilnehmeranzahl.
--{{/figure}}
++Das Datenbankzähler-Plugin ermöglicht es, einen oder mehrere globale Zähler in einer Datenbank anzulegen und in einem speziellen Hauptmenüpunkt zu verwalten. Der Zählwert kann innerhalb der [[Statusverarbeitung>>doc:Formcycle.UserInterface.MyForms.WorkflowProcessing.WebHome]] erhöht, erniedrigt, ausgelesen oder zurückgesetzt werden.
--Nach der Installation des Plugin-Bundles gibt es im Hauptmenü der {{formcycle/}} Oberfläche einen neuen Menüeintrag [[//Zählerkonfiguration>>||anchor="HEinstellungenimMenFCpunkt22ZE4hlerkonfiguration22"]]. Dort kann über den einen Klick auf die Plus-Schaltfläche ein neuer Zähler angelegt werden. Für diesen muss ein //Zählername// angegeben werden. Über den Stift-Schaltfläche für //Aktueller Wert// kann der Wert des Zählers gesetzt werden. Nachdem dort der Wert 15 eingegeben wurde, muss dieser über die Haken-Schaltfläche bestätigt werden. Anschließend muss über die //Speichern//-Schaltfläche unten rechts der Zähler gespeichert werden.
++Mögliche Anwendungsfälle sind:
--=== Konfiguration der Statusverarbeitungsaktion ===
++* 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 {{smallcaps}}id{{/smallcaps}} für einen Formularvorgang, die unabhängig von der internen {{smallcaps}}id{{/smallcaps}} von {{formcycle/}} ist. Dies ist speziell dann sinnvoll, wenn die {{smallcaps}}id{{/smallcaps}} 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.
--{{figure image="3_Beispiel_Aktion.png" width="600"}}
--Konfigurieren einer //Counter//-Plugin-Aktion, welche den Wert des Zählers //BeispielZaehler// um 1 verringert.
--{{/figure}}
++Nach Installation können Zähler in einer separaten Menüseite im Backend verwaltet werden. Hier sieht man den aktuellen Stand aller bereits angelegten Zähler. Dort ist es auch möglich, den Wert der Zähler auszulesen, als auch neue Zähler anzulegen oder bestehende Zähler zu löschen.
--Nachdem der Zähler erstellt wurde, kann in einem Formular in der [[Statusverarbeitung>>doc:Formcycle.UserInterface.Variables.WebHome]] eine Plugin-Aktion vom Typ //Counter// angelegt werden. Diese muss so konfiguriert werden, dass der Zähler beim Eingang des Formulars um 1 verringert wird. Dafür muss unter //Zählername// der Zähler //BeispielZaehler// und bei //Zählaktion// die Option //Herunterzählen// ausgewählt werden.
++Mit diesem Plugin 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 genaue Unterschied sowie die Anwendungsfälle finden sich unten im entsprechenden Abschnitt dazu.
--=== Verwenden von Platzhaltern für die Prüfung der Formulareingänge ===
++Weiterhin ist es auch möglich, den aktuellen Wert eines Zählers über einen [[Platzhalter>>doc:Formcycle.UserInterface.Variables]] in der Verarbeitung oder [[per {{smallcaps}}Ajax{{/smallcaps}}>>doc:Formcycle.FormDesigner.CodingPanel.ScriptTab.WebHome]] im Formular abzufragen.
--{{figure image="3_Beispiel_Aktion.png" width="600"}}
--Zusätzliche Aktionen im Status //Eingegangen//, um zu prüfen, ob es beim Eingang des Formulars noch einen Platz gab.
--{{/figure}}
++Jeder Zähler besitzt sowohl einen Namen als auch eine eindeutige [[{{smallcaps}}Uuid{{/smallcaps}}>>https://de.wikipedia.org/wiki/Universally_Unique_Identifier]]. Die {{smallcaps}}Uuid{{/smallcaps}} dient zur eindeutigen Identifikation Zählers und wird bei der Abfrage per {{smallcaps}}Ajax{{/smallcaps}} verwendet.
--{{figure image="4_Beispiel_Aktion.png" width="600"}}
--Konfigurieren einer Bedingung für die //Counter//-Plugin-Aktion, welche den Wert des Zählers //BeispielZaehler// um 1 verringert.
--{{/figure}}
++Dieses Plugin ist ein Plugin-Bundle und enthält zwei Verarbeitungsplugins, ein Platzhalterersetzungsplugin und ein Servlet-Plugin. Diese Plugins werden in den folgendenen Abschnitten genauer beschrieben.
--Um zu verhindern, dass das Formular normal eingeht, wenn es keine freien PLätze mehr gibt und um den Benutzer darüber zu informieren, dass er leider keinen Platz mehr bekommen hat, muss in der Verarbeitung weitere Aktionen eingefügt werden.
++== Menüpunkt "Zählerkonfiguration" ==
--Über eine Bedingung an der Aktion für zum verringern des Zählerwertes ist es möglich, zu prüfen, ob der Zählerwert beim Eingang des Fomulars bereits 0 ist. Ist dies der Fall, wird
++{{info}}
++  Durch dieses Plugin wird ein [[Rollenrecht>>doc:Formcycle.UserInterface.UserSettings.Roles]] erstellt, welches steuert, ob ein Benutzer Zugriff auf dieses Menü hat. Falls dieses Menü nicht in der Menüleiste zu sehen ist, sollte der zuständige Administrator kontaktiert werden.
++{{/info}}
--=== Verwendung von Platzhaltern im Formular ===
--
--{{figure image="5_Beispiel_Zahlfeld.png" width="600"}}
--Weiteres Eingabefeld zum Anzeigen der Anzahl der noch verfügbaren Plätze und die dafür nötigen Einstellungen im {{designer/}}.
++{{figure image="plugin_dbcounter_config_base_de.png" width="600"}}
++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.
  {{/figure}}
--Um dem Benutzer beim Öffnen des Formulars die Anzahl der zu diesem Zeitpunkt noch verfügbaren Plätze anzuzeigen, wird in diesem Beispiel ein weiteres Eingabefeld verwendet. Dieses wird so Konfiguriert, dass es vom Benutzer nicht editiert werden kann und über den PLlatzhalter {{code language="none"}}TODO{{/code}} beim Aufruf des Formulars mit dem aktuellen Zählerwert befüllt wird.
++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.
--{{velocity}}
--##=== Auslesen des Zählerwertes per JavaScript ===
--##
--##Auslesen und Verändern der Zählerwerte in der Verarbeitung
--{{/velocity}}
--=== Herunterladen des Beispielformulars ===
--
--Das Formular mit allen gemachten Einstellungen kann **HIER** heruntergeladen werden. Damit das Formular funktioniert, muss jedoch ein eigener Zähler unter [[//Zählerkonfiguration>>||anchor="HEinstellungenimMenFCpunkt22ZE4hlerkonfiguration22"]] angelegt werden und dieser muss in der Aktion //Counter// ausgewählt werden.
--
--== Einstellungen im Menüpunkt "Zählerkonfiguration" ==
--
--{{figure image="6_plugin_dbcounter_config_base_de.png" width="600"}}
--Das Menü mit einer Übersicht über alle vorhandenen Zähler. Hier können auch neue Zähler hinzugefügt und bestehende {{/figure}}
--
--Nach Installation des Datenbankzähler-Plugin-Bundle 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 bearbeiten und 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 zum ausgewählten Zähler:
++In der Liste links kann ein Zähler ausgewählt werden. Nach Auswahl erscheinen die folgenden Informationen zu dem Zähler:
  ; {{smallcaps}}Uuid{{/smallcaps}}
  : Eine eindeutige {{smallcaps}}id{{/smallcaps}} des Zählers, die etwa beim Abruf des Zählerwerts per {{smallcaps}}Ajax{{/smallcaps}} (siehe Servlet-Aktions-Plugin unten) verwendet wird.
@@ -104,7 +104,7 @@
  === Automatisches Zurücksetzen ===
--Folgende Eigenschaften erscheinen, wenn die Option //Automatisch Zurücksetzen// ausgewählt wurde:
++Folgende Eigenschaften erscheinen, wenn der Zähler automatisch zurückgesetzt werden soll:
  {{info}}
  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 //37//, 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.
@@ -131,13 +131,13 @@
  == Aktionsverarbeitung "Counter" ==
--{{figure image="7_plugin_dbcounter_action_counter_de.png"}}
++{{figure image="plugin_dbcounter_action_counter_de.png"}}
  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).
  {{/figure}}
  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 statischen Zählers geändert werden.
--Im der Aktion muss der Zähler fest ausgewählt werden und muss daher zuvor in der [[//Zählerkonfiguration>>||anchor="HEinstellungenimMenFCpunkt22ZE4hlerkonfiguration22"]] (siehe oben) angelegt 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-{{smallcaps}}id{{/smallcaps}}.
  ; 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 {{smallcaps}}Uuid{{/smallcaps}} angezeigt. Die {{smallcaps}}Uuid{{/smallcaps}} dient der eindeutigen Identifikation des Zählers und wird etwa bei der Abfrage per {{smallcaps}}Ajax{{/smallcaps}} 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.
@@ -181,8 +181,17 @@
  :; 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. Nicht verfügbar, wenn //Zähler auf Startwert zurücksetzen// ausgewählt wurde.
++: 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 ==
  {{figure image="plugin_dbcounter_action_return_parameters_de.png"}}
@@ -240,13 +240,6 @@
  [%$DBCOUNTER(teilnehmer-2020-03-17, 0)%]
  {{/code}}
--Für die Verwendung der Platzhalter innerhalb des Formulars werden
--
--
--
--
--
--
  == Servlet-Aktions-Plugin ==
  {{figure image="dbcounter_plugin_servlet_action.png"}}
@@ -253,18 +253,8 @@
  Beispiel zum Auslesen eines Zählers im Formular mittels {{smallcaps}}Ajax{{/smallcaps}}. Die {{smallcaps}}Url{{/smallcaps}} wird anhand der im Formular zur Verfügung stehenden Metadaten aufgebaut. Hiermit wird vermieden, die {{smallcaps}}Url{{/smallcaps}} hart im Quelltext zu hinterlegen, was zu Fehlern führt, wenn sich etwa der Server oder der Kontextpfad ändern sollte.
  {{/figure}}
--Nach Installation des Plugins ist eine neue Servlet-Aktion verfügbar, mit der auf den aktuellen Wert eines Zähler zugegriffen werden kann. Dies kann dazu genutzt werden, um aus einem Formular den Wert eines Zählers per {{smallcaps}}Ajax{{/smallcaps}}-Anfrage zu ermitteln. Die {{smallcaps}}Url{{/smallcaps}} für das Servlet baut sich nach dem folgenden Schema auf:
--In der Konfigurationsoberfläche des Zählers wird bereits eine Vorlage für einen {{smallcaps}}Ajax{{/smallcaps}}-Zugriff geliefert.
--TODO: Für grun gelten die Regeln
++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 {{smallcaps}}Ajax{{/smallcaps}}-Anfrage abgerufen werden soll. Die {{smallcaps}}Url{{/smallcaps}} für das Servlet baut sich nach dem folgenden Schema auf:
--
--== Zugriff auf Zählerwert mittels AJAX-Request ==
--
--Diese werden in der Konfigurationsoberfläche des Zählers angezeigt. Die zurückgegebenen {{smallcaps}}Json{{/smallcaps}}-Objekt enthalten ein Objekt mit dem Namen Counter mit den folgenden Attributen:
--
--; LastChange
--: Gibt an, ob der Servlet-Aufruf erfolgreich war. Der Wert ist ein weiteres {{smallcaps}}Json{{/smallcaps}}-Objekt mit folgenden Einträgen:
--
  {{code language="none"}}
  https://<Host>/<FORMCYCLE-Kontextpfad>/plugin?name=Servlet%20Counter&client-id=<Mandant-ID>&id=<Zähler-UUID>
  {{/code}}
@@ -321,32 +321,23 @@
  :; Code
  :: Eine englische Beschreibung des Resultats (Erfolg oder Fehler).
  ; Counter
--: Informationen zum angefragten Zähler. Exisitert nur, wenn der angefragte Zähler existiert. Der Wert selbst ist ein weiteres {{smallcaps}}Json{{/smallcaps}}-Objekt mit folgenden Einträgen:
++: Informationen zum angefragten Zähler. Der Wert ist ein weiteres {{smallcaps}}Json{{/smallcaps}}-Objekt mit folgenden Einträgen:
++: Der aktuelle nummerische Wert des Zählers.
  :; LastChange
  :: 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.
  :; LastChangeTimestamp
  :: 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.
--:; Name
--:: Der Name des angefragten Zählers, dessen Wert ausgelesen wurde.
--:; {{smallcaps}}Uuid{{/smallcaps}}
--:: Die {{smallcaps}}Uuid{{/smallcaps}} des angefragten Zählers, dessen Wert ausgelesen wurde.
  :; Value
  :: Der aktuelle nummerische Wert des Zählers.
++:; {{smallcaps}}Uuid{{/smallcaps}}
++:: Die {{smallcaps}}Uuid{{/smallcaps}} des angefragten Zählers, dessen Wert ausgelesen wurde.
++:; Name
++:: Der Name des angefragten Zählers, dessen Wert ausgelesen wurde.
  == Versionshistorie ==
  In diesem Abschnitt werden die vorhandenen Versionen des Zähler-Plugins und die jeweiligen Änderungen in dieser Version beschrieben.
--=== 4.0.0 ===
--
--* Verbesserung der Oberfläche für die Zählerkonfiguration
--* Entfernen der Aktion //Variable ändern//
--
--=== 3.0.0 ===
--
--* Fehler in Zählerverwaltung für bestehende Zähler beim Update auf Version 2.3.3 des Plugins behoben.
--{{info}}Nach dem Update müssen alle Zähler neu angelegt werden.{{/info}}
--
  === 2.3.3 ===
  * Rechtschreibfehler korrigiert