| ... |
... |
@@ -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 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. |
| 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. |
| ... |
... |
@@ -41,33 +41,37 @@ |
| 41 |
41 |
=== Verwenden von Platzhaltern für die Prüfung der Formulareingänge === |
| 42 |
42 |
|
| 43 |
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. |
|
45 |
+{{/figure}} |
|
46 |
+ |
|
47 |
+{{figure image="4_Beispiel_Aktion.png" width="600"}} |
| 44 |
44 |
Konfigurieren einer Bedingung für die //Counter//-Plugin-Aktion, welche den Wert des Zählers //BeispielZaehler// um 1 verringert. |
| 45 |
45 |
{{/figure}} |
| 46 |
46 |
|
| 47 |
|
-Ü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. |
|
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. |
| 48 |
48 |
|
|
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 |
+ |
| 49 |
49 |
=== Verwendung von Platzhaltern im Formular === |
| 50 |
50 |
|
| 51 |
|
-{{figure image="4_Beispiel_Zahlfeld.png" width="600"}} |
|
57 |
+{{figure image="5_Beispiel_Zahlfeld.png" width="600"}} |
| 52 |
52 |
Weiteres Eingabefeld zum Anzeigen der Anzahl der noch verfügbaren Plätze und die dafür nötigen Einstellungen im {{designer/}}. |
| 53 |
53 |
{{/figure}} |
| 54 |
54 |
|
| 55 |
|
-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"}}YYY{{/code}} beim Aufruf des Formulars mit dem aktuellen Zählerwert befüllt wird. |
|
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. |
| 56 |
56 |
|
| 57 |
|
-=== Auslesen des Zählerwertes per JavaScript === |
| 58 |
|
- |
| 59 |
|
-Auslesen und Verändern der Zählerwerte in der Verarbeitung |
| 60 |
|
- |
| 61 |
|
- |
| 62 |
|
-Hier einfügen. |
| 63 |
|
- |
|
63 |
+{{velocity}} |
|
64 |
+##=== Auslesen des Zählerwertes per JavaScript === |
|
65 |
+## |
|
66 |
+##Auslesen und Verändern der Zählerwerte in der Verarbeitung |
|
67 |
+{{/velocity}} |
| 64 |
64 |
=== Herunterladen des Beispielformulars === |
| 65 |
65 |
|
| 66 |
|
-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. |
|
70 |
+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. |
| 67 |
67 |
|
| 68 |
68 |
== Einstellungen im Menüpunkt "Zählerkonfiguration" == |
| 69 |
69 |
|
| 70 |
|
-{{figure image="5_plugin_dbcounter_config_base_de.png" width="600"}} |
|
74 |
+{{figure image="6_plugin_dbcounter_config_base_de.png" width="600"}} |
| 71 |
71 |
Das Menü mit einer Übersicht über alle vorhandenen Zähler. Hier können auch neue Zähler hinzugefügt und bestehende {{/figure}} |
| 72 |
72 |
|
| 73 |
73 |
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. |
| ... |
... |
@@ -127,7 +127,7 @@ |
| 127 |
127 |
|
| 128 |
128 |
== Aktionsverarbeitung "Counter" == |
| 129 |
129 |
|
| 130 |
|
-{{figure image="plugin_dbcounter_action_counter_de.png"}} |
|
134 |
+{{figure image="7_plugin_dbcounter_action_counter_de.png"}} |
| 131 |
131 |
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). |
| 132 |
132 |
{{/figure}} |
| 133 |
133 |
|
| ... |
... |
@@ -150,35 +150,6 @@ |
| 150 |
150 |
; Globale Einstellungen nutzen (deprecated) |
| 151 |
151 |
: 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. |
| 152 |
152 |
|
| 153 |
|
-== Aktionsverarbeitung "Variable" == |
| 154 |
|
- |
| 155 |
|
-{{figure image="plugin_dbcounter_action_variable_de.png"}} |
| 156 |
|
-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. |
| 157 |
|
-{{/figure}} |
| 158 |
|
- |
| 159 |
|
-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. |
| 160 |
|
- |
| 161 |
|
-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. |
| 162 |
|
- |
| 163 |
|
-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. |
| 164 |
|
- |
| 165 |
|
-=== Variablenänderung === |
| 166 |
|
- |
| 167 |
|
-Hier wird der Name der Variable ("Zähler") ausgewählt und in angegeben, in welcher Weise deren Wert geändert werden soll. |
| 168 |
|
- |
| 169 |
|
-; Zählername |
| 170 |
|
-: 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. |
| 171 |
|
-; Zählaktion |
| 172 |
|
-: Gibt an, in welcher Art und Weise der Wert des Zählers geändert werden soll. Möglich Optionen sind: |
| 173 |
|
-:; Hochzählen |
| 174 |
|
-:: Erhöht den Wert des Zählers um die eingegebene Zahl. |
| 175 |
|
-:; Herunterzählen |
| 176 |
|
-:: Erniedrigt den Wert des Zählers um die eingegebene Zahl. |
| 177 |
|
-:; Zähler auf Startwert zurücksetzen |
| 178 |
|
-:: Setzt den Wert des Zählers auf den eingegebenen Startwert zurück. |
| 179 |
|
-; Schrittweite |
| 180 |
|
-: 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. |
| 181 |
|
- |
| 182 |
182 |
== Rückgabeparameter der Aktionen == |
| 183 |
183 |
|
| 184 |
184 |
{{figure image="plugin_dbcounter_action_return_parameters_de.png"}} |
