From version 1.1 >
edited by awa
on 21.11.2019, 09:24
To version < 1.3 >
edited by awa
on 21.11.2019, 10:04
>
Change comment: There is no comment for this version

Summary

Details

Page properties
Content
... ... @@ -4,72 +4,70 @@
4 4  The database counter plugin may be installed as either a client plugin or a system plugin. It requries no additional configuration.
5 5  {{/figure}}
6 6  
7 -The database counter plugin lets you create one or more global counter in a database. The counter value may be incremented, decremented or reset during workflow processing. Some possible uses cases are:
7 +The database counter plugin lets you create one or more global counter in a database. The counter value may be incremented, decremented or reset during [[workflow processing>>doc:Formcycle.UserInterface.MyForms.WorkflowProcessing.WebHome]]. Some possible uses cases are:
8 8  
9 -* Ein Teilnahmeformular, in dem die Anzahl der Teilnehmer gezählt wird und weitere Anmeldungen ab einer bestimmten Grenze blockiert werden.
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 -* Das n-fache Durchlaufen der Aktionen eines Status, wobei //n// in Abhängigkeit einer Formulareingabe festgelegt wird.
9 +* A reservation form that counts the number of participants. When a certain limit is reached, further form submissions are blocked.
10 +* Generating a custom ID for a form record that is independent of the internal FORMCYCLE process ID. This is useful especially when the ID needs to conform to a certain pattern or has to be reset in regular intervals.
11 +* Repeating the actions of a certain state //n// times, where //n// is set depending of a submitted form value.
12 12  
13 -Zudem ist es auch möglich, den aktuellen Wert eines hlers über einen [[Platzhalter>>doc:Formcycle.UserInterface.Variables]] in der Verarbeitung oder [[per AJAX>>doc:Formcycle.FormDesigner.CodingPanel.ScriptTab.WebHome]] im Formular abzufragen.
13 +Furthermore, it is also possible to access the current value of the counter via a [[system variable>>doc:Formcycle.UserInterface.Variables]] during workflow processing; or via [[an AJAX request >>doc:Formcycle.FormDesigner.CodingPanel.ScriptTab.WebHome]] from within a form.
14 14  
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.
15 +Each counter has got both a name as well as a unqiue [[UUID>>https://en.wikipedia.org/wiki/Universally_Unique_Identifier]]. The UUID uniquely identifies a counter and is used when querying the counter value with an AJAX request.
16 16  
17 -== Aktionverarbeitung "Counter" ==
17 +== Workflow action "Counter" ==
18 18  
19 -Nach Installation gibt es in der Status- und Aktionsverarbeitung 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.
20 -
19 +Once the plugin is installed, you can choose a new action in the [[workflow processing configuration>>doc:Formcycle.UserInterface.MyForms.WorkflowProcessing.WebHome]]. The action is a plugin action named //Counter//. You can use this action to modify the value of a counter or reset it in regular intervals.
21 21  === Allgemeine Einstellungen ===
22 22  
23 23  {{figure image="dbcounter_plugin_action_base_settings_en.png"}}
24 -Die Grundeinstellungen für die Verarbeitungsaktion //Counter//. Hier kann festgelegt werden, welcher Zähler in welcher Weise geändert werden soll.
23 +Base settings for the workflow action //Counter//. Here you can choose which counter should be changed and in what manner.
25 25  {{/figure}}
26 26  
27 -; 1 - Zählername
28 -: Auswahl des 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 hlers eingegeben und schlilich der neue Zähler durch Drücken des Plus-Symbols angelegt.
29 -; 2 - Zählaktion
30 -: Gibt an, in welcher Art und Weise der Wert des Zählers geändert werden soll. Möglich Optionen sind:
31 -:; Hochzählen
32 -:: Erhöht den Wert des hlers um die eingegebene Zahl.
33 -:; Herunterzählen
34 -:: Erniedrigt den Wert des hlers um die eingegebene Zahl.
35 -:; Zähler auf Startwert zurücksetzen
36 -:: Setzt den Wert des hlers auf den eingegebenen Startwert zurück.
37 -; 3 - Schrittweite
38 -: Anzahl, um die der Zähler hoch beziehungsweise herunter gesetzt werden soll.
39 -; 4 - Startwert
40 -: Initialer Wert des hlers, den dieser annimmt, wenn er angelegt wird. Es ist auch möglich, den 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 zuckgesetzt werden soll. Dies kann etwa beim Überschreiten eines bestimmten Werts oder in regelmäßigen Zeitabständen erfolgen.
26 +; 1 - Counter name
27 +: Name of the counter to be modified. For each counter you can see its name as well as its UUID. The UUID uniquely identifies a counter and is used when querying it via an AJAX request. To delete a counter, first select the counter, then click on the thrash icon to the right. To add a counter, first click on the plus icon, then enter a name for the new counter, and finally save the counter by pressing the floppy disc icon.
28 +; 2 - Counting action
29 +: Lets you chose how the value of the counter should be changed. Possible options are:
30 +:; Increment count
31 +:: Adds the given amount to the current value of the counter.
32 +:; Decrement count
33 +:: Substracts the given amount from the current value of the counter.
34 +:; Reset counter to start value
35 +:: Sets the current value of the counter back to the selected initial value.
36 +; 3 - Step size
37 +: Amount by which the counter is incremented or decremented.
38 +; 4 - Initial value
39 +: The intial starting value of the counter. This is the value of the counter when it is first created. You may also reset the counter to this value.
40 +; 5 - Reset automatically
41 +: When this option is enabled, the counter is reset automatically by the system when certain conditions are met; such as each week, or when the counter value reaches a certain limit. See below for how to configure this feature.
43 43  
44 -=== Automatisches Zurücksetzen ===
43 +=== Reset automatically ===
45 45  
46 46  {{figure image="dbcounter_plugin_action_reset_greater_or_equal_en.png"}}
47 -Die Konfiguration zum Zurücksetzen eines Zählers, wenn dessen Wert eine bestimmte Grenze übersteigt.
46 +Configuration for resetting a counter when its value exceed a given limit.
48 48  {{/figure}}
49 49  
50 50  {{figure image="dbcounter_plugin_action_reset_daily_en.png"}}
51 -Die Konfiguration zum täglichen Zurücksetzen eines Zählers.
50 +Configuration for resetting a counter on a daily basis.
52 52  {{/figure}}
53 53  
54 54  {{figure image="dbcounter_plugin_action_reset_weekly_en.png"}}
55 -Die Konfiguration zum wöchentlichen Zurücksetzen eines Zählers.
54 +Configuration for resetting a counter on a weekly basis.
56 56  {{/figure}}
57 57  
58 58  {{figure image="dbcounter_plugin_action_reset_monthly_en.png"}}
59 -Die Konfiguration zum monatlichen Zurücksetzen eines hlers.
58 +Configuration for resetting a counter on a monthly basis.
60 60  {{/figure}}
61 61  
62 62  {{figure image="dbcounter_plugin_action_reset_yearly_en.png"}}
63 -Die Konfiguration zum jährlichen Zurücksetzen eines Zählers.
62 +Configuration for resetting a counter on a yearly basis.
64 64  {{/figure}}
65 65  
66 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}}
66 +When a counter is reset, then after the counter action was processed, its value will be equal to the configured initial value. For example: Assume the counter action was configured to increment the counter by 3 each time it is executed, and should be reset daily. Let the the current counter value be //39// and the intial value //11//. The first counter action that is executed on a new day will now reset the counter to //11//, and not be incremented at all. Starting with the second counter action of that day, the counter will be incremented by //3// each time the action is executed.{{/info}}
69 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// gehlt 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.
68 +A counter may be reset either in regular intervals or when its value exceeds a certain threshold. This feature is available only if the checkbox //reset automatically// was enabled and the counting action was not set to //Reset counter to start value//.
71 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 Aushrung 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 hler gemäß Konfiguration zurückgesetzt tte werden müssen.
70 +Regarding resetting the counter in daily intervals: Please note that the counter is not reset by background task, but only when the workflow action //counter// is executed. Or, to be more precise, the counter value is reset (instead of being incremented or decremented), when the time points at which the counter should have been reset contains at least one point that lies between the last point in time the counter value was modified and the current point in time.
73 73  
74 74  ; 1 - Bedingung
75 75  : Hier kann festgelegt werden, wann und unter welchen Umständen der Zähler zurückgesetzt werden soll.
... ... @@ -119,7 +119,7 @@
119 119  Ein Beispiel für den Platzhalter zum Auslesen des Zählwerts. Hier wird ein Zähler ausgelesen, der die Anzahl an Anmeldungen für eine Veranstaltung zählt. Dann wird geprüft, ob der Zählwert die maximale Anzahl an Anmeldungen übersteigt. Basierend auf dieser Prüfung kann dem Nutzer dann ein Fehler angezeigt werden, falls die Veranstaltung bereits ausgebucht ist. Hierbei handelt es sich um eine serverseitige Prüfung zur Validierung, bereits im Formular bei der Anmeldung sollte dem Nutzer natürlich schon die Information gegeben werden, ob überhaupt noch Plätze frei sind.
120 120  {{/figure}}
121 121  
122 -Nach Installation des Plugins ist ein neuer Systemplatzhalter verfügbar, über den auf den aktuellen Wert eines Zählers zugegriffen werden kann. Dies ist etwa nützlich, um in einer Aktionsbedingung den Zählwert nutzen und prüfen zu können. Der Platzhalter baut sich nach dem folgenden Schema auf:
120 +Nach Installation des Plugins ist ein neuer [[Systemplatzhalter>>doc:Formcycle.UserInterface.Variables]] verfügbar, über den auf den aktuellen Wert eines Zählers zugegriffen werden kann. Dies ist etwa nützlich, um in einer Aktionsbedingung den Zählwert nutzen und prüfen zu können. Der Platzhalter baut sich nach dem folgenden Schema auf:
123 123  
124 124  {{code}}
125 125  [%$DBCOUNTER.<Zählername>%]
Copyright 2000-2025