Zusammenfassung

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

Details

Seiteneigenschaften

Dokument-Autor

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

Inhalt

...	...	@@ -4,22 +4,27 @@
4	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	5	{{/figure}}
6	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:
	7	+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.
8	8
	9	+Mögliche Anwendungsfälle sind:
	10	+
9	9	* Ein Teilnahmeformular, in dem die Anzahl der Teilnehmer pro Termin gezählt wird und weitere Anmeldungen ab einer bestimmten Grenze blockiert werden.
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		-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.
	15	+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 auchneue Zähler anzulegen oder bestehende Zähler zu löschen.
14	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.
	17	+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 Anwendungsfälle finden Sie im entsprechenden Menüpunkt unten.
16	16
	19	+
17	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	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	20
21		-== Menü "Zählerkonfiguration" ==
	24	+Dieses Plugin kann als Bundle das Systemplatzhalter-Plugin und das Servlet-Aktions-Plugin beinhalten, welche unten beschrieben sind.
22	22
	26	+== Menüpunkt "Zählerkonfiguration" ==
	27	+
23	23	{{info}}
24	24	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.
25	25	{{/info}}
...	...	@@ -32,7 +32,7 @@
32	32
33	33	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.
34	34
35		-=== Eigenschaften
	40	+=== Eigenschaften ===
36	36
37	37	In der Liste links kann ein Zähler ausgewählt werden. Nach Auswahl erscheinen die folgenden Informationen zu dem Zähler:
38	38
...	...	@@ -48,20 +48,20 @@
48	48	Weiterhin können die folgenden Eigenschaften des Zählers bearbeitet werden:
49	49
50	50	; Zählername
51		-: 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.
	56	+: Der Name dieses Zählers. 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-Abfrage bei denen die UUID des Zählers verwendet wird müssen hingegen nicht angepasst werden, da die UUID des Zählers sich nicht ändert.
52	52	; Beschreibung
53		-: Eine optionale Beschreibung des Zählers, die auch nur in diesem Menü einsehbar ist.
	58	+: Eine optionale Beschreibung des Zählers, die auch nur in diesem Backend-Menü einsehbar ist.
54	54	; Startwert
55		-: Der Startwert des Zählers. Dieser wird etwa benutzt, wenn in einer Aktion der Zählerwert auf den Startwert zurückgesetzt werden soll.
	60	+: Der Startwert des Zählers. Dieser wird auch benutzt, wenn in einer Aktion der Zählerwert auf den Startwert zurückgesetzt werden soll.
56	56	; Automatisch zurücksetzen
57	57	: Wenn diese Option aktiviert ist, wird der Zähler in periodischen Abständen auf den Startwert zurückgesetzt.
58	58
59		-=== Automatisches Zurücksetzen
	64	+=== Automatisches Zurücksetzen ===
60	60
61	61	Folgende Eigenschaften erscheinen, wenn der Zähler automatisch zurückgesetzt werden soll:
62	62
63	63	{{info}}
64		-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.
	69	+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.
65	65	{{/info}}
66	66
67	67	{{info}}
...	...	@@ -69,7 +69,7 @@
69	69	{{/info}}
70	70
71	71	; Bedingung
72		-: Hier kann festgelegt werden, wann und unter welchen Umständen der Zähler zurückgesetzt werden soll.
	77	+: Hier kann festgelegt werden, wann und unter welchen Umständen der Zähler zurückgesetzt werden soll. Es kann zwischen folgenden Optionen gewählt werden:
73	73	:; Zähler größer gleich
74	74	:: 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.
75	75	:; Zähler kleiner gleich
...	...	@@ -89,7 +89,7 @@
89	89	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).
90	90	{{/figure}}
91	91
92		-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.
	97	+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.
93	93
94	94	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.
95	95
...	...	@@ -227,7 +227,7 @@
227	227	https://<Host>/<FORMCYCLE-Kontextpfad>/plugin?name=Servlet%20Counter&project-id=<Formular-ID>&id=<Zähler-UUID>
228	228	{{/code}}
229	229
230		-=== HTTP-Parameter
	235	+=== HTTP-Parameter ===
231	231
232	232	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.
233	233
...	...	@@ -234,9 +234,9 @@
234	234	; name
235	235	: Der Name des aufzurufenden Servlet-Aktions-Plugins, in dem Fall also //Servlet Counter//
236	236	; client-id
237		-: 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.
	242	+: 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// oder //project-id// angegeben werden.
238	238	; project-id
239		-: ID eines Formulars, in dem das Zähler-Plugin zur Verfügung steht. Es darf nur entweder //client-id// or //project-id// angegeben werden.
	244	+: ID eines Formulars, in dem das Zähler-Plugin zur Verfügung steht. Es darf nur entweder //client-id// oder //project-id// angegeben werden.
240	240	; id
241	241	: 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.
242	242	; counter-name
...	...	@@ -246,7 +246,7 @@
246	246	; counter-array
247	247	: 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.
248	248
249		-=== HTTP-Antwort
	254	+=== HTTP-Antwort ===
250	250
251	251	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.
252	252
...	...	@@ -280,24 +280,24 @@
280	280	:; Name
281	281	:: Der Name des angefragten Zählers, dessen Wert ausgelesen wurde.
282	282
283		-== Changelog
	288	+== Changelog ==
284	284
285	285	In diesem Abschnitt werden die vorhandenen Versionen des Zähler-Plugins und die jeweiligen Änderungen in dieser Version beschrieben.
286	286
287		-=== 2.3.3
	292	+=== 2.3.3 ===
288	288
289	289	* Rechtschreibfehler korrigiert
290	290
291		-=== 2.3.2
	296	+=== 2.3.2 ===
292	292
293	293	* Fehler in UI behoben: Checkbox //Globale Einstellungen nutzen// unter Zählereigenschaften bei Aktion //Counter// schaltet wieder die darauffolgenden Einstellungen sichtbar beziehungsweise unsichtbar
294	294	* Kleiner Schreibfehler korrigiert
295	295
296		-=== 2.3.1
	301	+=== 2.3.1 ===
297	297
298	298	* Fehler in MYSQL behoben: //connection// ist dort ein Schlüsselwort
299	299
300		-=== 2.3.0
	305	+=== 2.3.0 ===
301	301
302	302	* Neue Aktion: Variable ändern
303	303	* Hier kann der Zählername frei vergeben werden, auch per Platzhalter. Dafür ist aber ein initialer Wert notwendig. Optional kann eine initiale Konfiuration für das Zurücksetzen eingegeben werden.
...	...	@@ -304,13 +304,13 @@
304	304	* Neuer Platzhalter: //DBCOUNTER(name, initialValue)//. Legt Zähler neu an, wenn der noch nicht existiert.
305	305	* 3 neue Parameter für Servlet-Plugin: //counter-name//, //counter-initial// und //counter-array//.
306	306
307		-=== 2.2.0
	312	+=== 2.2.0 ===
308	308
309	309	* Reset (wenn notwendig) auch beim Auslesen des Zählers
310	310	* Portalseite (//Zählerkonfiguration//) im Backend für die Konfiguration der Zähler
311	311	* Einstellungen zum Zurücksetzen und zum initialen Wert jetzt nicht mehr in Aktionsverarbeitungskonfiguration, sondern auf der Portalseite.
312	312
313		-=== 2.1.0
	318	+=== 2.1.0 ===
314	314
315	315	* Anpassungen für FORMCYCLE 6.1.6
316	316	* //CounterPlugin// und //ServletCounterPlugin// hatten die gleichen Namen, dies führte zu Problemen.
...	...	@@ -318,14 +318,14 @@
318	318	* Im Servlet-Aktions-Plugin gibt es einen neuen Rückgabewert: //Counter.LastChangeTimestamp//
319	319	* Neues System-Platzhalter-Plugin zum Auslesen des Wertes eines Zähler über Platzhalter: //[%DBCOUNTER.name%]//
320	320
321		-=== 2.0.0
	326	+=== 2.0.0 ===
322	322
323	323	* Portierung auf FORMCYCLE Version 6.0.2
324	324
325		-=== 1.0.1
	330	+=== 1.0.1 ===
326	326
327	327	* Bugfix: Zähler wurde beim ersten Aufruf nicht gesetzt
328	328
329		-=== 1.0.0
	334	+=== 1.0.0 ===
330	330
331	331	* Initiale Version