Wiki-Quellcode von Datenbankzähler-Plugin

Verstecke letzte Bearbeiter

version	line-number	content
20.6	1	{{content/}}
	2
28.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.
20.3	5	{{/figure}}
	6
20.26	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:
20.2	8
28.2	9	* Ein Teilnahmeformular, in dem die Anzahl der Teilnehmer pro Termin gezählt wird und weitere Anmeldungen ab einer bestimmten Grenze blockiert werden.
20.2	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.
20.3	11	* Das n-fache Durchlaufen der Aktionen eines Status, wobei //n// in Abhängigkeit einer Formulareingabe festgelegt wird.
	12
20.4	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.
20.5	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.
	16
28.2	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.
	18
20.5	19	== Aktionverarbeitung "Counter" ==
	20
28.2	21	{{figure image="plugin_dbcounter_action_counter_de.png"}}
	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	{{/figure}}
20.5	24
28.2	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.
20.5	26
28.2	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.
20.5	28
28.2	29	; Zählername
	30	: 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.
	31	; Zählaktion
20.5	32	: Gibt an, in welcher Art und Weise der Wert des Zählers geändert werden soll. Möglich Optionen sind:
	33	:; Hochzählen
	34	:: Erhöht den Wert des Zählers um die eingegebene Zahl.
	35	:; Herunterzählen
	36	:: Erniedrigt den Wert des Zählers um die eingegebene Zahl.
	37	:; Zähler auf Startwert zurücksetzen
	38	:: Setzt den Wert des Zählers auf den eingegebenen Startwert zurück.
28.2	39	; Schrittweite
20.5	40	: Anzahl, um die der Zähler hoch beziehungsweise herunter gesetzt werden soll.
28.2	41	; Globale Einstellungen nutzen (deprecated)
	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.
20.5	43
28.2	44	== Rückgabeparameter der Aktionen ==
20.7	45
20.16	46	{{figure image="dbcounter_plugin_action_return_parameters_de.png"}}
	47	Einstellungen für die Rückgabeparameter, die später über Platzhalter verfügbar sind.
	48	{{/figure}}
	49
20.27	50	Manchmal ist es notwendig, auf den neuen Zählwert zugreifen zu können. 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 die Rückgabeparameter Aktion zugegriffen werden kann. Beispielsweise trage die Zähleraktion den Namen //CountUp//. Dann kann über den Platzhalter //[%$CountUp.RESULT[0].count%]// auf den aktuellen Zählwert zugegriffen werden, falls unter (3) bei den allgemeinen Rückgabeparameter der Wert //count// eingetragen wurde. Folgende Rückgabeparameter sind verfügbar:
20.16	51
20.19	52	; 1 - ResultCode
20.17	53	: Ein nummerischer Zahlenwert, der angibt, ob die Zählaktion erfolgreich war oder nicht. Folgende Ergebnisnummern sind möglich:
20.18	54	:; 1 (OK)
20.17	55	:: Die Zählaktion wurde erfolgreich abgearbeitet.
20.18	56	:; 10 (UNKNOWN_ACTION_ERROR)
20.17	57	:: 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.
20.18	58	:; 11 (PARSING_ERROR)
20.17	59	:: Ein konfigurierter Wert hat nicht den erwarteten Datentyp, etwa wenn für die Schrittweite des Zählers keine syntaktisch korrekte Zahl eingegeben wurde.
20.18	60	:; 40 (INTERNAL_ERROR)
20.17	61	:: Es ist ein anderer Fehler aufgetreten, der nicht näher klassifiziert werden kann.
	62	; 2 - ResultMessage
20.19	63	: Eine englische Beschreibung des Resultats (Erfolg oder Fehler).
20.17	64	; 3 - Counter
	65	: Der neue nummerische Wert des Zählers, nachdem die Zählaktion ausgeführt wurde.
	66	; 4 - IsReset
	67	: Entweder //true//, falls der Zähler durch die aktuelle Aktion zurückgesetzt wurde; oder //false//, wenn er nicht zurückgesetzt wurde.
	68	; 5 - CounterAfterReset
	69	: Falls der Zähler zurückgesetzt wurde: Der nummerische Wert des Zählers vor dem Zurücksetzen.
	70
20.21	71	== Systemplatzhalter-Plugin ==
20.20	72
	73	{{figure image="dbcounter-plugin-placeholder_de.png"}}
20.21	74	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.
20.20	75	{{/figure}}
	76
20.26	77	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:
20.20	78
20.21	79	{{code}}
	80	[%$DBCOUNTER.<Zählername>%]
	81	{{/code}}
20.20	82
20.21	83	Um also etwa auf den Zähler mit dem Name //test// zuzugreifen, muss der folgende Platzhalter genutzt werden:
	84
	85	{{code}}
	86	[%$DBCOUNTER.test%]
	87	{{/code}}
	88
20.24	89	== Servlet-Aktions-Plugin ==
20.21	90
20.22	91	{{figure image="dbcounter_plugin_servlet_action.png"}}
20.24	92	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.
20.22	93	{{/figure}}
20.23	94
	95	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:
	96
	97	{{code}}
	98	https://<HOST>/<FORMCYCLE_CONTEXT_PATH>/plugin?name=Servlet%20Counter&client-id=<MANDANT_ID>&id=<ZAEHLER_UUID>
	99	{{/code}}
	100
20.28	101	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:
20.23	102
	103	{{code}}
	104	https://localhost:8080/xima-formcycle/plugin?name=Servlet%20Counter&client-id=1&id=bc49d3b0-f869-4e59-864e-ddcc2925ed63
	105	{{/code}}
	106
	107	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:
	108
	109	{{code}}
	110	https://<HOST>/<FORMCYCLE_CONTEXT_PATH>/plugin?name=Servlet%20Counter&project-id=<FORMULAR_ID>&id=<ZAEHLER_UUID>
	111	{{/code}}
20.24	112
	113	Nach Ausführung des Servlet-Aktions-Plugin wird das Ergebnis als JSON-Objekt zurückgeliefert, siehe hierzu auch die Abbildung. Dieses JSON-Objekt hat die folgenden Einträge:
	114
	115	; Status
	116	: Gibt an, ob der Servlet-Aufruf erfolgreich war. Der Wert ist ein weiteres JSON-Objekt mit folgenden Einträgen:
	117	:; Msg
	118	:: Ein nummerischer Wert, der angibt, ob der Servlet-Aufruf erfolgreich war. Mögliche Werte sind:
20.27	119	::; 0 (OK)
	120	::: Die Servlet-Anfrage war erfolgreich.
	121	::; 12 (NO_REQUEST_ID_ERROR)
	122	::: Die Server-Anfrage enthielt keine Zähler-UUID.
	123	::; 13 (NO_COUNTER_TO_UUID_ERROR)
	124	::: Es existiert kein Zähler mit der angefragten UUID.
	125	::; 40 (INTERNAL_ERROR)
	126	::: Es ist ein anderer Fehler aufgetreten, der nicht näher klassifiziert werden kann.
20.24	127	:; Code
	128	:: Eine englische Beschreibung des Resultats (Erfolg oder Fehler).
	129	; Counter
20.25	130	: Informationen zum angefragten Zähler. Der Wert ist ein weiteres JSON-Objekt mit folgenden Einträgen:
20.24	131	: Der aktuelle nummerische Wert des Zählers.
	132	:; LastChange
	133	:: 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.
	134	:; LastChangeTimestamp
	135	:: 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.
	136	:; Value
	137	:: Der aktuelle nummerische Wert des Zählers.
	138	:; UUID
20.25	139	:: Die UUID des angefragten Zählers, dessen Wert ausgelesen wurde.
20.24	140	:; Name
20.25	141	:: Der Name des angefragten Zählers, dessen Wert ausgelesen wurde.

Wiki-Quellcode von Datenbankzähler-Plugin

Navigation