... |
... |
@@ -1,12
+1,12 @@ |
1 |
1 |
{{content/}} |
2 |
2 |
|
3 |
|
-{{figure image="dbcounter_plugin_installation_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. |
|
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. |
5 |
5 |
{{/figure}} |
6 |
6 |
|
7 |
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: |
8 |
8 |
|
9 |
|
-* Ein Teilnahmeformular, in dem die Anzahl der Teilnehmer gezählt wird und weitere Anmeldungen ab einer bestimmten Grenze blockiert werden. |
|
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 |
|
... |
... |
@@ -14,19
+14,21 @@ |
14 |
14 |
|
15 |
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 |
16 |
|
|
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 |
+ |
17 |
17 |
== Aktionverarbeitung "Counter" == |
18 |
18 |
|
19 |
|
-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. Hier ist es auch möglich, den Zähler in regelmäßigen Abständen zurückzusetzen. |
|
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 |
20 |
|
21 |
|
-=== Allgemeine Einstellungen === |
|
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. |
22 |
22 |
|
23 |
|
-{{figure image="dbcounter_plugin_action_base_settings_de.png"}} |
24 |
|
-Die Grundeinstellungen für die Verarbeitungsaktion //Counter//. Hier kann festgelegt werden, welcher Zähler in welcher Weise geändert werden soll. |
25 |
|
-{{/figure}} |
|
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. |
26 |
26 |
|
27 |
|
-; 1 - Zählername |
28 |
|
-: Auswahl des Zählers, dessen Wert geändert werden soll. 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. |
29 |
|
-; 2 - Zählaktion |
|
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 |
30 |
30 |
: Gibt an, in welcher Art und Weise der Wert des Zählers geändert werden soll. Möglich Optionen sind: |
31 |
31 |
:; Hochzählen |
32 |
32 |
:: Erhöht den Wert des Zählers um die eingegebene Zahl. |
... |
... |
@@ -34,60
+34,13 @@ |
34 |
34 |
:: Erniedrigt den Wert des Zählers um die eingegebene Zahl. |
35 |
35 |
:; Zähler auf Startwert zurücksetzen |
36 |
36 |
:: Setzt den Wert des Zählers auf den eingegebenen Startwert zurück. |
37 |
|
-; 3 - Schrittweite |
|
39 |
+; Schrittweite |
38 |
38 |
: Anzahl, um die der Zähler hoch beziehungsweise herunter gesetzt werden soll. |
39 |
|
-; 4 - Startwert |
40 |
|
-: Initialer Wert des Zählers, den dieser annimmt, wenn er angelegt wird. Es ist auch möglich, den Zähler auf diesen Startwert zurückzusetzen. |
41 |
|
-; 5 - Automatisch zurücksetzen |
42 |
|
-: Ist diese Option aktiviert, erscheint eine weitere Konfigurationsmöglichkeit zum Einstellen, wann der Zähler automatisch auf den Startwert zurückgesetzt werden soll. Dies kann etwa beim Überschreiten eines bestimmten Werts oder in regelmäßigen Zeitabständen erfolgen. |
|
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. |
43 |
43 |
|
44 |
|
-=== Automatisches Zurücksetzen === |
|
44 |
+== Rückgabeparameter der Aktionen == |
45 |
45 |
|
46 |
|
-{{figure image="dbcounter_plugin_action_reset_greater_or_equal_de.png"}} |
47 |
|
-Die Konfiguration zum Zurücksetzen eines Zählers, wenn dessen Wert eine bestimmte Grenze übersteigt. |
48 |
|
-{{/figure}} |
49 |
|
- |
50 |
|
-{{figure image="dbcounter_plugin_action_reset_daily_de.png"}} |
51 |
|
-Die Konfiguration zum täglichen Zurücksetzen eines Zählers. |
52 |
|
-{{/figure}} |
53 |
|
- |
54 |
|
-{{figure image="dbcounter_plugin_action_reset_weekly_de.png"}} |
55 |
|
-Die Konfiguration zum wöchentlichen Zurücksetzen eines Zählers. |
56 |
|
-{{/figure}} |
57 |
|
- |
58 |
|
-{{figure image="dbcounter_plugin_action_reset_monthly_de.png"}} |
59 |
|
-Die Konfiguration zum monatlichen Zurücksetzen eines Zählers. |
60 |
|
-{{/figure}} |
61 |
|
- |
62 |
|
-{{figure image="dbcounter_plugin_action_reset_yearly_de.png"}} |
63 |
|
-Die Konfiguration zum jährlichen Zurücksetzen eines Zählers. |
64 |
|
-{{/figure}} |
65 |
|
- |
66 |
|
-{{info}} |
67 |
|
-Geschieht ein Zurücksetzen des Zählers, so ist nach Ausführung der aktuellen Aktion der Wert des Zählers gleich dem Startwert, wie er in den allgemeinen Einstellung eingegeben wurde. 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 dern 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. |
68 |
|
-{{/info}} |
69 |
|
- |
70 |
|
-Es ist möglich, den Zähler in regelmäßigen Abständen zurückzusetzen. Diese Option ist nur verfügbar, wenn als Zählaktion nicht //Zähler auf Startwert zurücksetzen// gewählt wurde. Zudem muss in den allgemeinen Einstellungen die Option //Automatische zurücksetzen// aktiviert sein. Es kann dann ausgewählt werden, wann der Zähler zurückgesetzt werden soll. |
71 |
|
- |
72 |
|
-Hierbei ist zu beachten, dass der Zähler nicht in einem Hintergrundprozess zurückgesetzt wird, sondern erst wenn die Verarbeitungsaktion //Counter// ausgeführt wird. Genauer: Der Zählwert wird bei Ausführung der Aktion zurückgesetzt (anstelle erhöht oder erniedrigt zu werden), falls zwischen dem Zeitpunkt, an dem der Zählwert zuletzt geändert wurde, und dem aktuellen Zeitpunkt des Servers ein Zeitpunkt liegt, an dem der Zähler gemäß Konfiguration zurückgesetzt hätte werden müssen. |
73 |
|
- |
74 |
|
-; 1 - Bedingung |
75 |
|
-: Hier kann festgelegt werden, wann und unter welchen Umständen der Zähler zurückgesetzt werden soll. |
76 |
|
-:; Zähler größer gleich |
77 |
|
-:: 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 in (2) festgelegten Wert ist. |
78 |
|
-:; Zähler kleiner gleich |
79 |
|
-:: Nur verfügbar, wenn als Zählaktion //Herunterzä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 kleiner oder gleich dem in (2) festgelegten Wert ist. |
80 |
|
-:; täglich |
81 |
|
-:: Der Zähler wird jeden Tag zur bei (2) gewählten Uhrzeit auf den Startwert zurückgesetzt. |
82 |
|
-:; wöchentlich |
83 |
|
-:: Der Zähler wird an jedem unter (2) gewählten Wochentag zu der unter (3) gewählten Uhrzeit zurückgesetzt. |
84 |
|
-:; monatlich |
85 |
|
-:: Der Zähler wird jeden Monat zum unter (2) gewählten Tag zu der unter (3) gewählten Uhrzeit zurückgesetzt. |
86 |
|
-:; jährlich |
87 |
|
-:: Der Zähler wird jedes Jahr zum unter (2) und (3) gewählten Tag zu der unter (4) gewählten Uhrzeit zurückgesetzt |
88 |
|
- |
89 |
|
-=== Allgemeine Rückgabeparameter === |
90 |
|
- |
91 |
91 |
{{figure image="dbcounter_plugin_action_return_parameters_de.png"}} |
92 |
92 |
Einstellungen für die Rückgabeparameter, die später über Platzhalter verfügbar sind. |
93 |
93 |
{{/figure}} |