Changes for page Datenbankzähler-Plugin

From version < 1.3 >

edited by awa
on 21.11.2019, 10:04

To version < 2.1

edited by gru
on 29.01.2021, 16:38

Change comment: There is no comment for this version

Raw
Rendered

Summary

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

Details

Page properties

Author

@@ -1,1
          +1,1 @@
--XWiki.awa
++XWiki.gru

Default language

...	...	@@ -1,0 +1,1 @@
	1	+de

Content

@@ -1,31
          +1,106 @@
++[[**Plugin download**>>url:https://customer.formcycle.eu/index.php/apps/files/?dir=/FORMCYCLE%20-%20Plugins%20Customer/fc-plugin-bundle-dbcounter&fileid=5521||target="_blank"]] (requires login)
++
  {{content/}}
--{{figure image="dbcounter_plugin_installation_en.png"}}
--The database counter plugin may be installed as either a client plugin or a system plugin. It requries no additional configuration.
++{{figure image="plugin_dbcounter_workflow_select_en.png" width="600"}}
++The database counter plugin may be installed as either a client plugin or a system plugin. It requires no additional configuration. Once installed, it offers to new workflow actions: //Variable// and //Counter.//. The //Counter// action requires you to choose a fixed counter that you would like to change. In contrast, the //Variable// action lets you choose the counter based on the submitted form data.
  {{/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>>doc:Formcycle.UserInterface.MyForms.WorkflowProcessing.WebHome]]. Some possible uses cases are:
++The database counter plugin lets you create one or more counter in a database. It also adds a new menu entry to the backend where you can view and edit all available counters. You can then use the [[workflow processing>>doc:Formcycle.UserInterface.MyForms.WorkflowProcessing.WebHome]] to increment or decrement the counter. This plugin is subject to additional charge.
--* 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.
++Some of the possible use cases include:
--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.
++* A registration form for a weekly event, when you need to keep track of the number of registered participants. You can then block new registrations for a certain date when the maximum number of participants has been reached.
++* Generating a unique {{smallcaps}}id{{/smallcaps}} for a form record that is independent of internal {{smallcaps}}id{{/smallcaps}}s used by {{formcycle/}}. Useful especially when the {{smallcaps}}id{{/smallcaps}} needs to conform to a certain pattern or needs to be reset in fixed intervals.
++* Running the [[actions>>doc:Formcycle.UserInterface.MyForms.WorkflowProcessing.Actions.WebHome]] of a certain [[state>>doc:Formcycle.UserInterface.MyForms.WorkflowProcessing.States.WebHome]] n-times, where //n// is determined by the value of a submitted form field.
--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.
++Once the plugin is installed, you can manage the available counter in a separate backend page. You can check which counters exist currently and add or delete counter. The current value of each counter is displayed as well, and if necessary, you can also change the counter's value.
--== Workflow action "Counter" ==
++In addition, this plugin offers two new [[workflow>>doc:Formcycle.UserInterface.MyForms.WorkflowProcessing.WebHome]] [[actions>>doc:Formcycle.UserInterface.MyForms.WorkflowProcessing.Actions.WebHome]]: //Counter// and //Variable//. The action //Counter// requires you to select a predefined counter. The action //Variable//, on the other hand, lets you select a counter based on the value of a submitted fo m field. See the sections on each action below for further details.
--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 ===
++Lastly, you can also access the current value of a counter either via a [[variable>>doc:Formcycle.UserInterface.Variables]] during workflow processing or [[via an {{smallcaps}}Ajax{{/smallcaps}} request from within an opened form>>doc:Formcycle.FormDesigner.CodingPanel.ScriptTab.WebHome]].
--{{figure image="dbcounter_plugin_action_base_settings_en.png"}}
--Base settings for the workflow action //Counter//. Here you can choose which counter should be changed and in what manner.
++Each counter has got both a name as well as a unique [[{{smallcaps}}Uuid{{/smallcaps}}>>https://de.wikipedia.org/wiki/Universally_Unique_Identifier]]. The {{smallcaps}}Uuid{{/smallcaps}} uniquely identifies a counter and is used, for example, when querying the counter's current value via an {{smallcaps}}Ajax{{/smallcaps}} request.
++
++This is plugin bundle that includes two workflow action plugins, one placeholder replacer plugin, and one servlet action plugin. The following sections describe these plugins in more detail.
++
++== Menu entry "Counter configuration" ==
++
++{{info}}
++  This plugin adds a new [[role permission>>doc:Formcycle.UserInterface.UserSettings.Roles]] that controls whether a user is granted access to this menu entry. Contact your administrator in case you do not see the menu entry and believe you should have access.
++{{/info}}
++
++{{figure image="plugin_dbcounter_config_base_en.png" width="600"}}
++  The menu with an overview of all existing counter. You can add or delete counter, or modify existing counters.{{/figure}}
++
++Once installed, a new menu entry appears in the main menu bar to the left. Please note that you may have to sign out and sign in again. The menu //Counter configuration// contains an overview of all existing counters, including their name and their current value. You can modify or delete existing counter, or add new counters.
++
++Press the plus icon to the top left to add a new counter. If you would like to delete an existing counter, click on that counter to select it, then press the trash icon to the top left.
++
++=== Properties ===
++
++Select a counter by clicking on it in the list of counters to the left. The following details are shown for the counter:
++
++; {{smallcaps}}Uuid{{/smallcaps}}
++: A unique {{smallcaps}}id{{/smallcaps}} of the counter. You need to use this {{smallcaps}}Uuid{{/smallcaps}}, for example, when you want to retrieve the counter's current value via an {{smallcaps}}Ajax{{/smallcaps}} request, see also the servlet action plugin below.
++; Current value
++: The current value of the counter.
++; Creation date
++: The date when the counter was created.
++; Last change
++: The date of the most recent change to the counter's value.
++
++Additionally, you can also edit the following properties of a counter:
++
++; Counter name
++: The name of this counter. When you change the name of a counter, you may have to change existing //Variable// action, placeholders and {{smallcaps}}Ajax{{/smallcaps}} requests that reference a counter by its name. {{smallcaps}}Ajax{{/smallcaps}} requests that reference a counter by its {{smallcaps}}Uuid{{/smallcaps}} do not have to be updated.
++; Description
++: An optional description of this counter. This description is shown only within this backend menu.
++; Initial value
++: The initial value of this counter. This is also the value that is used when a workflow action resets a counter to its initial value.
++; Reset automatically
++: When this option es enabled, the value of this counter is reset in period intervals.
++
++=== Reset automatically ===
++
++The following settings are available when the option to reset the counter automatically is enabled:
++
++{{info}}
++  When a counter is reset, then after the counter action was processed, the counter's 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 //37// 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}}
++
++{{info}}
++  Please note that the counter is not reset by background task, but only when the workflow action //Counter// or //Variable// 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.
++{{/info}}
++
++; Condition
++: Lets you choose when and how the counter should be reset. The following options are available:
++:; 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 given limit.
++:; 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 given limit.
++:; daily
++:: The counter is reset each day at the given time of day.
++:; weekly
++:: The counter is reset at each of the given days of the week and at the given time of the day.
++:; monthly
++:: The counter is reset each month at the given date and time of the day.
++:; yearly
++:: The counter is reset each year the given day, month and time of the day.
++
++== Workflow action "Counter" ==
++
++{{figure image="plugin_dbcounter_action_counter_en.png"}}
++  The settings for the workflow action //Counter//. You can select the counter to modify and how its value should be changed, e.g. incrementing or decrementing it by a certain amount.
  {{/figure}}
--; 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
++Once the plugin is installed, you can select the new action //Counter// in the [[workflow processing configuration>>doc:Formcycle.UserInterface.MyForms.WorkflowProcessing.WebHome]]. This action lets you modify the value of a predefined counter.
++
++Compared with the action //Variable//, here you need to select a predefined counter. You should have created this counter in the counter configuration menu (see above). Use this action when you need a global, non-dynamic counter, such as when you want to generate an identifier for each form record.
++
++; Counter name
++: Name of the counter to be modified. For each counter you can see its name as well as its {{smallcaps}}Uuid{{/smallcaps}}. The {{smallcaps}}Uuid{{/smallcaps}} uniquely identifies a counter and is used when querying it via an {{smallcaps}}Ajax{{/smallcaps}} 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.
++; 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.
@@ -33,147
          +33,229 @@
  :: 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
++; 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.
++; Use global settings (deprecated)
++: You should leave this option checked and configure the counter settings in the counter configuration menu (see above). It exists only to ensure backwards compatibility with older versions of the plugin and may be removed in future versions.
--=== Reset automatically ===
++== Workflow action "Variable" ==
--{{figure image="dbcounter_plugin_action_reset_greater_or_equal_en.png"}}
--Configuration for resetting a counter when its value exceed a given limit.
++{{figure image="plugin_dbcounter_action_variable_en.png"}}
++  Settings for the workflow action //Variable//. It lets you select a counter dynamically by its name. You can also make use of placeholder variables to select a counter based on the value of some form field.
  {{/figure}}
--{{figure image="dbcounter_plugin_action_reset_daily_en.png"}}
--Configuration for resetting a counter on a daily basis.
--{{/figure}}
++Once the plugin is installed, you can select the new action //Variiable// in the [[workflow processing configuration>>doc:Formcycle.UserInterface.MyForms.WorkflowProcessing.WebHome]]. This action lets you select a counter by its name and modify its value.
--{{figure image="dbcounter_plugin_action_reset_weekly_en.png"}}
--Configuration for resetting a counter on a weekly basis.
--{{/figure}}
++Compared with the action //Counter//, here you do not have to choose a predefined counter. You can also use [[placeholder variables>>doc:Formcycle.UserInterface.Variables]] to select a counter based on the submitted form data. In case the counter does not exists yet, a new counter is created dynamically.
--{{figure image="dbcounter_plugin_action_reset_monthly_en.png"}}
--Configuration for resetting a counter on a monthly basis.
--{{/figure}}
++Use this action when you need different counters for each submitted form record. For example, if you have got a participation form where users can sign up for a certain date, you can use a counter for each date to keep track of the number of registered people for that date. The counter name could be formatted like //participants-year-month-day//.
--{{figure image="dbcounter_plugin_action_reset_yearly_en.png"}}
--Configuration for resetting a counter on a yearly basis.
--{{/figure}}
++=== Change variable ===
--{{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}}
++Select the name of the variable ("counter") to modify and how its value should be changed.
--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//.
++; Counter name
++: Name of the counter to modify. Enter name of the counter, not its {{smallcaps}}Uuid{{/smallcaps}}). You can also use [[placeholder variables>>doc:Formcycle.UserInterface.Variables]] to select a counter based on a submitted form field.
++; 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
++:: Subtracts 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.
++; Step size
++: Amount by which the counter is incremented or decremented.
--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.
++=== Default settings if variable does not exists yet ===
--; 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
++In case the variable ("counter") with the given name does not exist yet, a new counter is created. Here you can edit the default settings for a newly created counter. In case the counter exists already, these settings do not have any effect.
--=== Allgemeine Rückgabeparameter ===
++; Initial value
++: The initial value of the newly created counter.
++; Reset automatically
++: Whether the newly created counter should be reset automatically. When this option is enabled, a few more settings appear. See the section on the counter configuration menu above for further details.
--{{figure image="dbcounter_plugin_action_return_parameters_en.png"}}
--Einstellungen für die Rückgabeparameter, die später über Platzhalter verfügbar sind.
++== General return parameters ==
++
++{{figure image="plugin_dbcounter_action_return_parameters_en.png"}}
++Settings for the return parameters of the counter action. You can access the returned values via placeholder 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>>doc:Formcycle.UserInterface.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 were named //CountUp//. Then you can use the variable //[%$CountUp.RESULT[0].currentValue%]// to access the current counter value, provided you entered the key //currentValue// in the input field for the //Counter// return value. 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 to retrieve the current value of a counter. Here we read a counter that is used for keeping track of the number of participants of some event. We then check whether the value exceeds the maximum number of participants. Based on the result of this check, we can display an appropriate error message to the user in case the limit was reached. By performing this check during workflow processing, we can validate the data on the server and prevent manipulatios. Please note that it is best practice to give the user some feedback while the fill out the form and inform the user in case no more free slots are available.
  {{/figure}}
--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:
++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>%]
++{{code language="none"}}
++[%$DBCOUNTER.<CounterName>%]
  {{/code}}
--Um also etwa auf den Zähler mit dem Name //test// zuzugreifen, muss der folgende Platzhalter genutzt werden:
++For example, in order to access the value of a counter named //test//, you can use the following variable:
--{{code}}
++{{code language="none"}}
  [%$DBCOUNTER.test%]
  {{/code}}
--== Servlet-Aktions-Plugin ==
++In case you need to access a counter that may not exist yet, you need to provide an initial value for the counter. When the counter does not exist yet, a new counter with the given initial value is created. Use the following pattern:
++{{code language="none"}}
++[%$DBCOUNTER(<CounterName>, <InitialValue>)%]
++{{/code}}
++
++For example, if the counter is named //participants-2020-03-17// and should start at //0// in case it does not exist, you can use the following variable:
++
++{{code language="none"}}
++[%$DBCOUNTER(participants-2020-03-17, 0)%]
++{{/code}}
++
++== 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.
++  An example for how the counter value can be accessed via an {{smallcaps}}Ajax{{/smallcaps}} request. The {{smallcaps}}Url{{/smallcaps}} is build with the metadata available in the form context. This avoids having to enter the {{smallcaps}}Url{{/smallcaps}} directly in the code, which is prone to error: the host or context path could change, for example, when the form is moved between a development and production.
  {{/figure}}
--Nach Installation des Plugins ist eine neue Servlet-Aktion verfügbar, mit der auf den aktuellen Wert eines Zähler zugegriffen werden kann. Dies ist etwa nützlich, wenn aus dem Formular heraus ein Zählwert per AJAX-Anfrage abgerufen werden soll. Die URL für das Servlet baut sich nach dem folgenden Schema auf:
--{{code}}
--https://<HOST>/<FORMCYCLE_CONTEXT_PATH>/plugin?name=Servlet%20Counter&client-id=<MANDANT_ID>&id=<ZAEHLER_UUID>
++Once the plugin is installed, a new servlet plugin action is available that lets you access the current value of a counter via an {{smallcaps}}Http{{/smallcaps}} request. This is useful, for example, when you would like to read the counter's current value from within a form and display it in the form. The {{smallcaps}}Url{{/smallcaps}} for the counter action plugin servlet takes the following pattern:
++
++{{code language="none"}}
++https://<Host>/<FormcycleContextPath>/plugin?name=Servlet%20Counter&client-id=<ClientId>&id=<CounterUuid>
  {{/code}}
--Falls also etwa FORMCYCLE lokal unter dem Pfad //xima-formcycle// installiert wurde, der Zähler in einem Projekt des Mandanten mit der ID //1// verwendet wird und die UUID //bc49d3b0-f869-4e59-864e-ddcc2925ed63// besitzt, dann lautet die URL:
++Assuming {{formcycle/}} was installed locally and runs in the context path //formcycle//, and the counter plugins was installed within a client with the {{smallcaps}}id{{/smallcaps}} //1//, and the {{smallcaps}}Uuid{{/smallcaps}} of the counter is //bc49d3b0-f869-4e59-864e-ddcc2925ed63//, the {{smallcaps}}Url{{/smallcaps}} is:
--{{code}}
--https://localhost:8080/xima-formcycle/plugin?name=Servlet%20Counter&client-id=1&id=bc49d3b0-f869-4e59-864e-ddcc2925ed63
++{{code language="none"}}
++https://localhost:8080/formcycle/plugin?name=Servlet%20Counter&client-id=1&id=bc49d3b0-f869-4e59-864e-ddcc2925ed63
  {{/code}}
--Alternativ ist es auch möglich, statt der //client-id// die ID des Formulars zu verwenden. Diese IDs lediglich verwendet, um das Servlet-Aktions-Plugin zu bestimmen, welches ausgeführt werden soll, und werden von diesem konkreten Plugin nicht ausgewertet:
++Alternatively, you can also use the {{smallcaps}}id{{/smallcaps}} of the form instead of the //client-id//. Both the client and the form {{smallcaps}}id{{/smallcaps}} are used only to identify the servlet to be executed; and are not used in any way by this counter servlet.
--{{code}}
--https://<HOST>/<FORMCYCLE_CONTEXT_PATH>/plugin?name=Servlet%20Counter&project-id=<FORMULAR_ID>&id=<ZAEHLER_UUID>
++{{code language="none"}}
++https://<Host>/<FormcycleContextPath>/plugin?name=Servlet%20Counter&project-id=<FormID>&id=<CounterUuid>
  {{/code}}
--Nach Ausführung des Servlet-Aktions-Plugin wird das Ergebnis als JSON-Objekt zurückgeliefert, siehe hierzu auch die Abbildung. Dieses JSON-Objekt hat die folgenden Einträge:
++=== HTTP parameter ===
++In addtional to the parameters mentioned above, you can also specify a few more paramters as {{smallcaps}}Url{{/smallcaps}} parameters. The following is an overview of all available parameters.
++
++; name
++: The name of the servlet plugin action to execute. Set this to //Servlet Counter// for this plugin.
++; client-id
++: {{smallcaps}}id{{/smallcaps}} of the client where the counter plugin was installed. Not required in case the plugin was installed as a system plugin. Only one of //client-id// or //project-id// may be specified.
++; project-id
++: {{smallcaps}}id{{/smallcaps}} of a form that belongs to a client that has access to the counter plugin., in dem das Zähler-Plugin zur Verfügung steht. Only one of //client-id// or //project-id// may be specified.
++; id
++: {{smallcaps}}Uuid{{/smallcaps}} of counter to read. In case a counter with the given {{smallcaps}}Uuid{{/smallcaps}} does not exist yet, a corresponding error code is returned, see below. Only one of //id// or //counter-name// may be specified.
++; counter-name
++: Name of the counter to read. In case a counter with the given name does not exist yet, a new counter is created with the given initial value.Only one of //id// or //counter-name// may be specified.
++; counter-initial
++: Optional. The initial value of the counter, in case it does not exist yet. Defaults to //0//. This parameter is allowed only when //counter-name// is specified.
++; counter-array
++: Optional. Either //true// or //false//, defaults to //false//. When this is set to //true//, the parameter //counter-name// or //id// may be specified multiple times. This will return an array with the current value of all specified counters. This can be used, for example, to reduce the amount of {{smallcaps}}Http{{/smallcaps}} requests when you need to query multiple counter simultaneously.
++
++=== HTTP response ===
++
++If the servlet action plugin is executed successfully, it returns a {{smallcaps}}Json{{/smallcaps}} object as shown in the figure to the right. When the parameter //counter-array// was set to //true//, a {{smallcaps}}Json{{/smallcaps}} array is returned instead, with each item being a {{smallcaps}}Json{{/smallcaps}} object as described below.
++
++The {{smallcaps}}Json{{/smallcaps}}-Objekt has got the following properties:
++
  ; Status
--: Gibt an, ob der Servlet-Aufruf erfolgreich war. Der Wert ist ein weiteres JSON-Objekt mit folgenden Einträgen:
++: Indicates whether the servlet request was successful. The value is another {{smallcaps}}Json{{/smallcaps}} object with the following entries:
  :; Msg
--:: Ein nummerischer Wert, der angibt, ob der Servlet-Aufruf erfolgreich war. Mögliche Werte sind:
--::; (OK)
--::; (NO_REQUEST_ID_ERROR)
--::; (NO_COUNTER_TO_UUID_ERROR)
++:: A numerical value that indicates whether the servlet request was successful. Possible values are:
++::; 0 (OK)
++::: The request was successful.
++::; 12 (NO_REQUEST_ID_ERROR)
++::: The request did not specify a counter UUID.
++::; 13 (NO_COUNTER_TO_UUID_ERROR)
++::: No counter with the specified UUID exists.
++::; 40 (INTERNAL_ERROR)
++::: The counter action was not successful. The type of error cannot be specified more closely.
  :; Code
--:: Eine englische Beschreibung des Resultats (Erfolg oder Fehler).
++:: An English description of the result (success or error).
  ; Counter
--: Informationen zum angefragten Zähler. Der Wert ist ein weiteres JSON-Objekt mit folgenden Einträgen:
--: Der aktuelle nummerische Wert des Zählers.
++: Details about the requested counter. The value is another {{smallcaps}}Json{{/smallcaps}} object with the following entries:
  :; LastChange
--:: Das Datum mit Uhrzeit, an dem der Zähler zuletzt geändert wurde. Das Datum wird mit dem Datums- und Zeitformat der aktuellen Server-Locale formattiert.
++:: The date and time of the most recent modification of the counter value. The date and time is formatted according to the current server locale.
  :; LastChangeTimestamp
--:: Das Datum mit Uhrzeit, an dem der Zähler zuletzt geändert wurde. Der Zeitstempel ist eine ganze Zahl, welche die Anzahl an Millisekunden seit dem 1. Januar, 1970, 00:00:00 GMT angibt.
++:: The date and time of the most recent modification of the counter value. The timestamp is a whole number indicating the number of milliseconds January 1st, 1970, 00:00:00 GMT.
  :; Value
--:: Der aktuelle nummerische Wert des Zählers.
++:: The current numerical value of the counter.
  :; UUID
--:: Die UUID des angefragten Zählers, dessen Wert ausgelesen wurde.
++:: The UUID of the requested counter.
  :; Name
--:: Der Name des angefragten Zählers, dessen Wert ausgelesen wurde.
++:: The name of the requested counter.
++
++== Changelog ==
++
++This section lists all known versions of this plugin and describes the changes that were made in each version.
++
++=== 2.3.3 ===
++
++* Fixed some spelling mistakes
++
++=== 2.3.2 ===
++
++* Fixed a UI bug: The checkbox //Use global settings// (action //Counter//) now toggles the options below correctly.
++* Fixed some spelling mistakes
++
++=== 2.3.1 ===
++
++* Fixed a bug with {{smallcaps}}Mysql{{/smallcaps}} that prevented this plugin from working with that database management system.
++
++=== 2.3.0 ===
++
++* New action: //Variable//
++* Lets you select a counter by its name and allows for placeholder variables. This requires an initial value.
++* New placeholder variable: //DBCOUNTER(name, initialValue)//. Creates a new counter in case a counter with the given name does not exist yet.
++* Added 3 new parameters to the servlet action plugin: //counter-name//, //counter-initial// and //counter-array//.
++
++=== 2.2.0 ===
++
++* Make sure to reset the counter even when its value is only read
++* Portal page that adds a new menu entry to the backend: Counter configuration
++* Deprecate editing a counter's settings in the workflow action directly
++
++=== 2.1.0 ===
++
++* Modifications for {{formcycle/}} version 6.1.6
++* The //CounterPlugin// and //ServletCounterPlugin// had the same name, this resulted in errors
++* Fixed an error that resulted in a counter not being resetted correctly
++* Add a new property to the {{smallcaps}}Json{{/smallcaps}} object returned by the servlet action plugin: //Counter.LastChangeTimestamp//
++* Added a new system variable replacer plugin that lets you access the value of a counter via a variable: //[%DBCOUNTER.name%]//
++
++=== 2.0.0 ===
++
++* Modifications to make the plugin work with {{formcycle/}} version 6.0.2
++
++=== 1.0.1 ===
++
++* Fix a bug where the counter value was not set when retrieved for the first time
++
++=== 1.0.0 ===
++
++* Initial version

Changes for page Datenbankzähler-Plugin

Summary

Details

Navigation