Changes for page Datenbankzähler-Plugin

From version 1.1 >

edited by awa
on 21.11.2019, 09:24

To version < 1.5 >

edited by awa
on 21.11.2019, 10:26

Change comment: There is no comment for this version

Raw
Rendered

Summary

Page properties (1 modified, 0 added, 0 removed)

Details

Page properties

Content

@@ -4,134
          +4,132 @@
  The database counter plugin may be installed as either a client plugin or a system plugin. It requries no additional configuration.
  {{/figure}}
--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:
++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:
--* Ein Teilnahmeformular, in dem die Anzahl der Teilnehmer gezählt wird und weitere Anmeldungen ab einer bestimmten Grenze blockiert werden.
--* 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.
--* Das n-fache Durchlaufen der Aktionen eines Status, wobei //n// in Abhängigkeit einer Formulareingabe festgelegt wird.
++* A reservation form that counts the number of participants. When a certain limit is reached, further form submissions are blocked.
++* 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.
++* Repeating the actions of a certain state //n// times, where //n// is set depending of a submitted form value.
--Zudem ist es auch möglich, den aktuellen Wert eines Zählers über einen [[Platzhalter>>doc:Formcycle.UserInterface.Variables]] in der Verarbeitung oder [[per AJAX>>doc:Formcycle.FormDesigner.CodingPanel.ScriptTab.WebHome]] im Formular abzufragen.
++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.
--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.
++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.
--== Aktionverarbeitung "Counter" ==
++== Workflow action "Counter" ==
--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.
--
++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.
  === Allgemeine Einstellungen ===
  {{figure image="dbcounter_plugin_action_base_settings_en.png"}}
--Die Grundeinstellungen für die Verarbeitungsaktion //Counter//. Hier kann festgelegt werden, welcher Zähler in welcher Weise geändert werden soll.
++Base settings for the workflow action //Counter//. Here you can choose which counter should be changed and in what manner.
  {{/figure}}
--; 1 - Zählername
--: 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.
--; 2 - Zählaktion
--: Gibt an, in welcher Art und Weise der Wert des Zählers geändert werden soll. Möglich Optionen sind:
--:; Hochzählen
--:: Erhöht den Wert des Zählers um die eingegebene Zahl.
--:; Herunterzählen
--:: Erniedrigt den Wert des Zählers um die eingegebene Zahl.
--:; Zähler auf Startwert zurücksetzen
--:: Setzt den Wert des Zählers auf den eingegebenen Startwert zurück.
--; 3 - Schrittweite
--: Anzahl, um die der Zähler hoch beziehungsweise herunter gesetzt werden soll.
--; 4 - Startwert
--: 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.
--; 5 - Automatisch zurücksetzen
--: 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.
++; 1 - Counter name
++: 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.
++; 2 - Counting action
++: Lets you chose how the value of the counter should be changed. Possible options are:
++:; Increment count
++:: Adds the given amount to the current value of the counter.
++:; Decrement count
++:: Substracts the given amount from the current value of the counter.
++:; Reset counter to start value
++:: Sets the current value of the counter back to the selected initial value.
++; 3 - Step size
++: Amount by which the counter is incremented or decremented.
++; 4 - Initial value
++: 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.
++; 5 - Reset automatically
++: 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.
--=== Automatisches Zurücksetzen ===
++=== Reset automatically ===
  {{figure image="dbcounter_plugin_action_reset_greater_or_equal_en.png"}}
--Die Konfiguration zum Zurücksetzen eines Zählers, wenn dessen Wert eine bestimmte Grenze übersteigt.
++Configuration for resetting a counter when its value exceed a given limit.
  {{/figure}}
  {{figure image="dbcounter_plugin_action_reset_daily_en.png"}}
--Die Konfiguration zum täglichen Zurücksetzen eines Zählers.
++Configuration for resetting a counter on a daily basis.
  {{/figure}}
  {{figure image="dbcounter_plugin_action_reset_weekly_en.png"}}
--Die Konfiguration zum wöchentlichen Zurücksetzen eines Zählers.
++Configuration for resetting a counter on a weekly basis.
  {{/figure}}
  {{figure image="dbcounter_plugin_action_reset_monthly_en.png"}}
--Die Konfiguration zum monatlichen Zurücksetzen eines Zählers.
++Configuration for resetting a counter on a monthly basis.
  {{/figure}}
  {{figure image="dbcounter_plugin_action_reset_yearly_en.png"}}
--Die Konfiguration zum jährlichen Zurücksetzen eines Zählers.
++Configuration for resetting a counter on a yearly basis.
  {{/figure}}
  {{info}}
--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.
--{{/info}}
++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}}
--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.
++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//.
--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.
++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.
--; 1 - Bedingung
--: Hier kann festgelegt werden, wann und unter welchen Umständen der Zähler zurückgesetzt werden soll.
--:; Zähler größer gleich
--:: 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.
--:; Zähler kleiner gleich
--:: 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.
--:; täglich
--:: Der Zähler wird jeden Tag zur bei (2) gewählten Uhrzeit auf den Startwert zurückgesetzt.
--:; wöchentlich
--:: Der Zähler wird an jedem unter (2) gewählten Wochentag zu der unter (3) gewählten Uhrzeit zurückgesetzt.
--:; monatlich
--:: Der Zähler wird jeden Monat zum unter (2) gewählten Tag zu der unter (3) gewählten Uhrzeit zurückgesetzt.
--:;  jährlich
--:: Der Zähler wird jedes Jahr zum unter (2) und (3) gewählten Tag zu der unter (4) gewählten Uhrzeit zurückgesetzt
++; 1 - Condition
++: Lets you choose when and how the counter should be reset.
++:; Counter greater than or equal
++:: Available only when the counting action was set to //count up//. The counter is reset to its initial value when, after the counter was incremented, its value is now greater than or equal to the limit entered in (2).
++:; Counter less than or equal
++:: Available only when the counting action was set to //count down//. The counter is reset to its initial value when, after the counter was decremented, its value is now less than or equal to the limit entered in (2).
++:; daily
++:: The counter is reset each day at the time of day as entered in (2).
++:; weekly
++:: The counter is reset at each of the days of the week selected in (2); at the time of day as entered in (2).
++:; monthly
++:: The counter is reset each month at the date and time of day as entered in (2) and (3).
++:; yearly
++:: The counter is reset each year the the day, month and time of day as entered in (2), (3), and (4), respectively.
--=== Allgemeine Rückgabeparameter ===
++=== General return parameters ===
  {{figure image="dbcounter_plugin_action_return_parameters_en.png"}}
--Einstellungen für die Rückgabeparameter, die später über Platzhalter verfügbar sind.
++Settings for the return parameters of the counter action. You can access the returned values via variables.
  {{/figure}}
--Manchmal ist es notwendig, auf den neuen Zählwert zugreifen zu können. Dies kann über Aktionsplatzhalter geschehen, welche auf die Rückgabewerte einer Aktion zugreifen. In den allgemeinen Rückgabeparametern kann eingestellt werden, über welchem Schlüssel die Rückgabeparameter Aktion zugegriffen werden kann. Beispielsweise trage die Zähleraktion den Namen //CountUp//. Dann kann über den Platzhalter //[%$CountUp.RESULT[0].count%]// auf den aktuellen Zählwert zugegriffen werden, falls unter (3) bei den allgemeinen Rückgabeparameter der Wert //count// eingetragen wurde. Folgende Rückgabeparameter sind verfügbar:
++Sometimes it may be necessary to access the new value of the counter. To do so, you can use action variables for accessing the returned values of an action. The section //general return parameters// lets you configure the key you need to use for accessing the return values. For example, assume a counter action was named //CountUp//. Then you can use the variable //[%$CountUp.RESULT[0].count%]// to access the current counter value, provided you entered the key //count// in the input field (3). The following return values are available:
  ; 1 - ResultCode
--: Ein nummerischer Zahlenwert, der angibt, ob die Zählaktion erfolgreich war oder nicht. Folgende Ergebnisnummern sind möglich:
++: A numerical value that indicates whether the counter action was successful or not. The following result codes are possible:
  :; 1 (OK)
--:: Die Zählaktion wurde erfolgreich abgearbeitet.
++:: The counter action was processed successfully.
  :; 10 (UNKNOWN_ACTION_ERROR)
--:: Die Zählaktion kann nicht ausgeführt werden, da eine unbekannte Zählaktion ausgewählt wurde. Aktuell werden die Zählaktionen //Hochzählen//, //Herunterzählen// und //Auf den Startwert zurücksetzen// unterstützt.
++:: The counter action could not be processed, an unknown counting action was selected. The currently supported counting actions are //count up//, //count down// and //reset counter to start value//.
  :; 11 (PARSING_ERROR)
--:: Ein konfigurierter Wert hat nicht den erwarteten Datentyp, etwa wenn für die Schrittweite des Zählers keine syntaktisch korrekte Zahl eingegeben wurde.
++:: A settings does not conform to the expected data type or syntax; such as when a letter was entered for the initial value (instead of a number).
  :; 40 (INTERNAL_ERROR)
--:: Es ist ein anderer Fehler aufgetreten, der nicht näher klassifiziert werden kann.
++:: The counter action was not successful. The type of error cannot be specified more closely.
  ; 2 - ResultMessage
--: Eine englische Beschreibung des Resultats (Erfolg oder Fehler).
++: An English description of the result (success or error).
  ; 3 - Counter
--: Der neue nummerische Wert des Zählers, nachdem die Zählaktion ausgeführt wurde.
++: The new numerical value of the counter, after the counting action was applied.
  ; 4 - IsReset
--: Entweder //true//, falls der Zähler durch die aktuelle Aktion zurückgesetzt wurde; oder //false//, wenn er nicht zurückgesetzt wurde.
++: Either //true//, when the counter was reset during the current action; or //false// if it was not reset.
  ; 5 - CounterAfterReset
--: Falls der Zähler zurückgesetzt wurde: Der nummerische Wert des Zählers vor dem Zurücksetzen.
++: In case the counter was reset: The numerical value of the counter before the reset.
--== Systemplatzhalter-Plugin ==
++== System variable plugin ==
  {{figure image="dbcounter-plugin-placeholder_en.png"}}
--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.
++An example for how a counter value can be accessed via variables. Here we read the value of a counter that keeps track of the number of reservations for an event. When the user submits the reservation form, we check the current value of the counter against the limit for that event. When the limit is exceeded, we can return an appropriate error message to the users. Please note that this is meant as a server-side validation - to make the form user-friendly, you should indicate the number of free slots in the form itself.
  {{/figure}}
--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:
++Once the plugin is installed, you can access the current value of the plugin with a [[system variable>>doc:Formcycle.UserInterface.Variables]]. This can be used, for example, to access the counter value in the condition of a workflow action and compare it with a submitted value. The system variable has got the following pattern:
  {{code}}
--[%$DBCOUNTER.<Zählername>%]
++[%$DBCOUNTER.<CounterName>%]
  {{/code}}
--Um also etwa auf den Zähler mit dem Name //test// zuzugreifen, muss der folgende Platzhalter genutzt werden:
++So to access the value of a counter named //test//, you can use the following variable:
  {{code}}
  [%$DBCOUNTER.test%]
  {{/code}}
--== Servlet-Aktions-Plugin ==
++== Servlet action plugin ==
  {{figure image="dbcounter_plugin_servlet_action.png"}}
  Beispiel zum Auslesen eines Zählers im Formular mittels AJAX. Die URL wird anhand der im Formular zur Verfügung stehenden Metadaten aufgebaut. Hiermit wird vermieden, die URL hart im Quelltext zu hinterlegen, was zu Fehlern führt, wenn sich etwa der Server oder der Kontextpfad ändern sollte.

Changes for page Datenbankzähler-Plugin

Summary

Details

Navigation