| ... |
... |
@@ -14,9 +14,9 @@ |
| 14 |
14 |
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. |
| 15 |
15 |
{{/info}} |
| 16 |
16 |
|
| 17 |
|
-== Verwendung anhand von Beispielen == |
|
17 |
+== Beispiel für die Verwendung == |
| 18 |
18 |
|
| 19 |
|
-Im folgenden wird anhand eines Beispielprojekts die Verwendung von verschiedene Komponeten des Datenbankzähler-Plugins demonstriert. Das Ziel des Beispiels ist es, für eine Veranstaltung mit 15 Teilnehmern anzulegen. |
|
19 |
+Im folgenden wird anhand eines Beispielprojekts die Verwendung von verschiedene Komponeten des Datenbankzähler-Plugins demonstriert. Das Ziel des Beispiels ist es, für eine Veranstaltung mit 15 Teilnehmern einen Zähler anzulegen und das Anmelden von mehr als 15 Teilnehmern zu verhindern. |
| 20 |
20 |
|
| 21 |
21 |
=== Anlegen eines Zählers === |
| 22 |
22 |
|
| ... |
... |
@@ -24,8 +24,8 @@ |
| 24 |
24 |
Anlegen und konfigurieren eines neuen Zählers mit dem Namen //BeispielZaehler//. |
| 25 |
25 |
{{/figure}} |
| 26 |
26 |
|
| 27 |
|
-{{figure image="2_Beispiel_Wert.png" width="600"}} |
| 28 |
|
-Setzen des Wertes des Zählers auf die für das Beispiel gewünschte Teilnehmeranzahl. |
|
27 |
+{{figure image="2_Beispiel_Wert.png" width="200" clear="h3"}} |
|
28 |
+Setzen des Wertes des Zählers auf die für das Beispiel gewünschte Teilnehmeranzahl von 15. |
| 29 |
29 |
{{/figure}} |
| 30 |
30 |
|
| 31 |
31 |
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. |
| ... |
... |
@@ -32,7 +32,7 @@ |
| 32 |
32 |
|
| 33 |
33 |
=== Konfiguration der Statusverarbeitungsaktion === |
| 34 |
34 |
|
| 35 |
|
-{{figure image="3_Beispiel_Aktion.png" width="600"}} |
|
35 |
+{{figure image="3_Beispiel_Aktion.png" width="600" clear="h3"}} |
| 36 |
36 |
Konfigurieren einer //Counter//-Plugin-Aktion, welche den Wert des Zählers //BeispielZaehler// um 1 verringert. |
| 37 |
37 |
{{/figure}} |
| 38 |
38 |
|
| ... |
... |
@@ -40,18 +40,20 @@ |
| 40 |
40 |
|
| 41 |
41 |
=== Verwenden von Platzhaltern für die Prüfung der Formulareingänge === |
| 42 |
42 |
|
| 43 |
|
-{{figure image="3_Beispiel_Aktion.png" width="600"}} |
| 44 |
|
-Zusätzliche Aktionen im Status //Eingegangen//, um zu prüfen, ob es beim Eingang des Formulars noch einen Platz gab. |
|
43 |
+{{figure image="4_Beispiel_Aktionen.png" width="600" clear="h3"}} |
|
44 |
+Zusätzlicher Status und zusätzliche Aktionen, um zu prüfen, ob es beim Eingang des Formulars noch einen Platz gab bzw. den Absender zu informieren, wenn es keinen freien Platz mehr gab. |
| 45 |
45 |
{{/figure}} |
| 46 |
46 |
|
| 47 |
|
-{{figure image="4_Beispiel_Aktion.png" width="600"}} |
| 48 |
|
-Konfigurieren einer Bedingung für die //Counter//-Plugin-Aktion, welche den Wert des Zählers //BeispielZaehler// um 1 verringert. |
|
47 |
+{{figure image="5_Beispiel_Bedingung.png" width="600" clear="h3"}} |
|
48 |
+Konfigurieren einer Bedingung für die //Statuswechsel//-Plugin-Aktion, welche in den Status //Keine Plätze verfügbar// springt, wenn der Zählerwert 0 erreicht hat. |
| 49 |
49 |
{{/figure}} |
| 50 |
50 |
|
| 51 |
|
-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. |
|
51 |
+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 und ein Status eingefügt werden. |
| 52 |
52 |
|
| 53 |
|
-Über eine Bedingung an der Aktion //TODO// ist es möglich, zu prüfen, ob der Zählerwert beim Eingang des Fomulars bereits 0 ist. Ist dies der Fall, werden nur |
|
53 |
+Zunächst wird ein neuer Status //Keine Plätze verfügbar// eingefügt. In diesem kann über eine Aktion vom Typ Abschlusseite ein Template ausgewählt werden, welches dem Nutzer anzeigt, dass es keine freien Plätze mehr gegeben hat. Für diesen Zweck existiert kein vorgefertigtes HTML-Template, weshalb dies selbst erstellt werden muss. Über eine Aktion vom Typ Vorgang löschen wird der eingegangene Vorgang anschließend wieder gelöscht. |
| 54 |
54 |
|
|
55 |
+Im Status //Eingegangen// muss eine Aktion vom Typ //Statusänderung// eingefügt werden, welche so konfiguriert ist, dass sie in den Ziel-Status //Keine Plätze verfügbar// wechselt. Über eine Abarbeitungsbedingung an der Aktion //Statusänderung// ist es möglich, zu prüfen, ob der Zählerwert beim Eingang des Fomulars bereits 0 ist. Nur in diesem Fall soll die Aktion abgearbeitet werden. Für diese Prüfung kann der Platzhalter {{code language="none"}}[%$$DBCOUNTER.BeispielZaehler%]{{/code}} als //Formularelement// verwendet werden. |
|
56 |
+ |
| 55 |
55 |
=== Verwendung von Platzhaltern im Formular === |
| 56 |
56 |
|
| 57 |
57 |
{{figure image="5_Beispiel_Zahlfeld.png" width="600"}} |
| ... |
... |
@@ -58,8 +58,14 @@ |
| 58 |
58 |
Weiteres Eingabefeld zum Anzeigen der Anzahl der noch verfügbaren Plätze und die dafür nötigen Einstellungen im {{designer/}}. |
| 59 |
59 |
{{/figure}} |
| 60 |
60 |
|
| 61 |
|
-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. |
|
63 |
+{{figure image="6_Beispiel_Button.png" width="600" clear="h3"}} |
|
64 |
+Weiteres Eingabefeld zum Anzeigen der Anzahl der noch verfügbaren Plätze und die dafür nötigen Einstellungen im {{designer/}}. |
|
65 |
+{{/figure}} |
| 62 |
62 |
|
|
67 |
+Um dem Benutzer beim Öffnen des Formulars die Anzahl der zu diesem Zeitpunkt noch verfügbaren Plätze anzuzeigen, kann ein weiteres Eingabefeld verwendet. Dieses wird so Konfiguriert, dass es vom Benutzer nicht editiert werden kann und über den Platzhalter {{code language="none"}}[%$$DBCOUNTER.BeispielZaehler%]{{/code}} beim Aufruf des Formulars mit dem aktuellen Zählerwert befüllt wird. |
|
68 |
+ |
|
69 |
+Um zu verhindern, dass das Formular abgesendet werden kann, wenn es keine freien Plätze mehr gibt, kann im {{designer/}} für die Schaltfläche zum Absenden eine //Verstecken wenn//-Bedingung konfiguriert werden. Über diese wird die Schaltfläche unsichtbar, wenn das der Wert im gerade angelegten Eingabeelement (und damit der Wert des Zähler) 0 ist. |
|
70 |
+ |
| 63 |
63 |
{{velocity}} |
| 64 |
64 |
##=== Auslesen des Zählerwertes per JavaScript === |
| 65 |
65 |
## |
| ... |
... |
@@ -135,12 +135,13 @@ |
| 135 |
135 |
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). |
| 136 |
136 |
{{/figure}} |
| 137 |
137 |
|
| 138 |
|
-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. |
|
146 |
+Nach Installation des Datenbankzähler-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 verändert werden. |
| 139 |
139 |
|
| 140 |
140 |
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. |
| 141 |
141 |
|
| 142 |
142 |
; Zählername |
| 143 |
|
-: 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. |
|
151 |
+: Auswahl des Zählers, dessen Wert geändert werden soll. Der Zähler muss vorher in der Zählerkonfiguration angelegt 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. |
|
152 |
+ |
| 144 |
144 |
; Zählaktion |
| 145 |
145 |
: Gibt an, in welcher Art und Weise der Wert des Zählers geändert werden soll. Möglich Optionen sind: |
| 146 |
146 |
:; Hochzählen |
| ... |
... |
@@ -150,9 +150,7 @@ |
| 150 |
150 |
:; Zähler auf Startwert zurücksetzen |
| 151 |
151 |
:: Setzt den Wert des Zählers auf den eingegebenen Startwert zurück. |
| 152 |
152 |
; Schrittweite |
| 153 |
|
-: Anzahl, um die der Zähler hoch beziehungsweise herunter gesetzt werden soll. |
| 154 |
|
-; Globale Einstellungen nutzen (deprecated) |
| 155 |
|
-: 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. |
|
162 |
+: 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. |
| 156 |
156 |
|
| 157 |
157 |
== Rückgabeparameter der Aktionen == |
| 158 |
158 |
|
| ... |
... |
@@ -199,7 +199,9 @@ |
| 199 |
199 |
[%$$DBCOUNTER.test%] |
| 200 |
200 |
{{/code}} |
| 201 |
201 |
|
| 202 |
|
-{{info}}Bis einschließlich der Version 3.0.0 des Datenbankzähler-Plugins wurden Platzhalter nur über ein Systemplatzhalter-Plugin bereitgestellt und folgten damit dem Schema {{code language="none"}}[%$DBCOUNTER.<Zählername>%]{{/code}}. Diese werden in einer zukünftigen Version des Datenbankzähler-Plugins nicht mehr unterstützt.{{info}} |
|
209 |
+{{info}} |
|
210 |
+Bis einschließlich der Version 3.0.0 des Datenbankzähler-Plugins wurden Platzhalter nur über ein Systemplatzhalter-Plugin bereitgestellt und folgten damit dem Schema {{code language="none"}}[%$DBCOUNTER.<Zählername>%]{{/code}}. Diese werden in einer zukünftigen Version des Datenbankzähler-Plugins nicht mehr unterstützt. |
|
211 |
+{{/info}} |
| 203 |
203 |
|
| 204 |
204 |
== Servlet-Aktions-Plugin == |
| 205 |
205 |
|
