| ... |
... |
@@ -4,11 +4,11 @@ |
| 4 |
4 |
|
| 5 |
5 |
== Funktionsbeschreibung == |
| 6 |
6 |
|
| 7 |
|
-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. |
|
7 |
+Das kostenpflichtige Datenbankzähler-Plugin ermöglicht es, 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 AJAX-Requests kann der Wert von einem oder mehreren Zählern ermittelt werden, z.B. im JavaScript-Code eines Formulars. |
| 8 |
8 |
|
| 9 |
9 |
== Installation == |
| 10 |
10 |
|
| 11 |
|
-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. |
|
11 |
+Das Plugin 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. |
| 12 |
12 |
|
| 13 |
13 |
{{info}} |
| 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. |
| ... |
... |
@@ -16,7 +16,7 @@ |
| 16 |
16 |
|
| 17 |
17 |
== Verwendung anhand von Beispielen == |
| 18 |
18 |
|
| 19 |
|
-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. |
|
19 |
+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 anzulegen. |
| 20 |
20 |
|
| 21 |
21 |
=== Anlegen eines Zählers === |
| 22 |
22 |
|
| ... |
... |
@@ -48,10 +48,10 @@ |
| 48 |
48 |
Konfigurieren einer Bedingung für die //Counter//-Plugin-Aktion, welche den Wert des Zählers //BeispielZaehler// um 1 verringert. |
| 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 |
| 52 |
|
-In der Verarbeitung müssen |
| 53 |
|
-Ü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 |
|
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. |
| 54 |
54 |
|
|
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 |
|
54 |
+ |
| 55 |
55 |
=== Verwendung von Platzhaltern im Formular === |
| 56 |
56 |
|
| 57 |
57 |
{{figure image="5_Beispiel_Zahlfeld.png" width="600"}} |
| ... |
... |
@@ -107,7 +107,7 @@ |
| 107 |
107 |
Folgende Eigenschaften erscheinen, wenn die Option //Automatisch Zurücksetzen// ausgewählt wurde: |
| 108 |
108 |
|
| 109 |
109 |
{{info}} |
| 110 |
|
-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. |
|
110 |
+Geschieht ein Zurücksetzen des Zählers, so ist nach Ausführung der aktuellen //Counter//-Verarbeitungsaktion 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. |
| 111 |
111 |
{{/info}} |
| 112 |
112 |
|
| 113 |
113 |
{{info}} |
| ... |
... |
@@ -154,35 +154,6 @@ |
| 154 |
154 |
; Globale Einstellungen nutzen (deprecated) |
| 155 |
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. |
| 156 |
156 |
|
| 157 |
|
-== Aktionsverarbeitung "Variable" == |
| 158 |
|
- |
| 159 |
|
-{{figure image="plugin_dbcounter_action_variable_de.png"}} |
| 160 |
|
-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. |
| 161 |
|
-{{/figure}} |
| 162 |
|
- |
| 163 |
|
-Nach Installation dieses Plugins gibt es in der [[Status- und Aktionsverarbeitung>>doc:Formcycle.UserInterface.MyForms.WorkflowProcessing.WebHome]] eine neue Aktion namens //Variable//. Mit dieser Aktion kann der aktuelle Zählwert eines dynamisch festlegbaren Zählers geändert werden. |
| 164 |
|
- |
| 165 |
|
-Im Unterschied zur Aktion //Counter// kann bei dieser Aktion ein Zähler über seinen Namen ausgewählt werden. Der Name kann frei über [[Platzhalter>>doc:Formcycle.UserInterface.Variables]] zusammengefasst werden. Wenn es den Zähler noch nicht gibt, wird ein neuer Zähler mit dem Namen angelegt. |
| 166 |
|
- |
| 167 |
|
-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. |
| 168 |
|
- |
| 169 |
|
-=== Variablenänderung === |
| 170 |
|
- |
| 171 |
|
-Hier wird der Name der Variable ("Zähler") ausgewählt und in angegeben, in welcher Weise deren Wert geändert werden soll. |
| 172 |
|
- |
| 173 |
|
-; Zählername |
| 174 |
|
-: Auswahl des Zählers, dessen Wert geändert werden soll. Hier wird der Name des Zählers (nicht dessen {{smallcaps}}Uuid{{/smallcaps}}) eingegeben. Zudem können Platzhalter verwendet werden, um den Zählernamen dynamisch zu erzeugen. Etwa kann hier ein Formularfeld mit der {{smallcaps}}id{{/smallcaps}} eines Termins verwendet werden. |
| 175 |
|
-; Zählaktion |
| 176 |
|
-: Gibt an, in welcher Art und Weise der Wert des Zählers geändert werden soll. Möglich Optionen sind: |
| 177 |
|
-:; Hochzählen |
| 178 |
|
-:: Erhöht den Wert des Zählers um die eingegebene Zahl. |
| 179 |
|
-:; Herunterzählen |
| 180 |
|
-:: Erniedrigt den Wert des Zählers um die eingegebene Zahl. |
| 181 |
|
-:; Zähler auf Startwert zurücksetzen |
| 182 |
|
-:: Setzt den Wert des Zählers auf den eingegebenen Startwert zurück. |
| 183 |
|
-; Schrittweite |
| 184 |
|
-: 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. |
| 185 |
|
- |
| 186 |
186 |
== Rückgabeparameter der Aktionen == |
| 187 |
187 |
|
| 188 |
188 |
{{figure image="plugin_dbcounter_action_return_parameters_de.png"}} |
| ... |
... |
@@ -189,7 +189,7 @@ |
| 189 |
189 |
Einstellungen für die Rückgabeparameter der Aktion, die später über Aktionsplatzhalter verfügbar sind. |
| 190 |
190 |
{{/figure}} |
| 191 |
191 |
|
| 192 |
|
-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>>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 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: |
|
163 |
+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>>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 auf die Rückgabeparameter Aktion zugegriffen werden kann. Beispielsweise trage die Zähleraktion den Namen //CountUp//. Dann kann über den Platzhalter //[%$CountUp.RESULT[0].Counter%]// auf den aktuellen Zählwert zugegriffen werden. Folgende Rückgabeparameter sind verfügbar: |
| 193 |
193 |
|
| 194 |
194 |
; ResultCode |
| 195 |
195 |
: Ein nummerischer Zahlenwert, der angibt, ob die Zählaktion erfolgreich war oder nicht. Folgende Ergebnisnummern sind möglich: |
| ... |
... |
@@ -341,6 +341,7 @@ |
| 341 |
341 |
|
| 342 |
342 |
* Verbesserung der Oberfläche für die Zählerkonfiguration |
| 343 |
343 |
* Entfernen der Aktion //Variable ändern// |
|
315 |
+* Einführen neuer Template-Platzhalter. |
| 344 |
344 |
|
| 345 |
345 |
=== 3.0.0 === |
| 346 |
346 |
|
