Wiki source code of Datenbankzähler-Plugin

Hide last authors

version	line-number	content
47.2	1	[[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)
46.3	2
20.6	3	{{content/}}
	4
47.2	5	{{figure image="plugin_dbcounter_workflow_select_en.png" width="600"}}
	6	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.
	7	{{/figure}}
47.1	8
47.2	9	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.
47.1	10
47.2	11	Some of the possible use cases include:
47.1	12
47.2	13	* 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.
	14	* 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.
	15	* 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.
47.1	16
47.2	17	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.
47.1	18
47.2	19	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.
47.1	20
47.2	21	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]].
47.1	22
47.2	23	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.
47.1	24
47.2	25	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.
20.3	26
47.2	27	== Menu entry "Counter configuration" ==
20.2	28
47.2	29	{{info}}
	30	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.
	31	{{/info}}
44.8	32
47.2	33	{{figure image="plugin_dbcounter_config_base_en.png" width="600"}}
	34	The menu with an overview of all existing counter. You can add or delete counter, or modify existing counters.{{/figure}}
20.3	35
47.2	36	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.
30.10	37
47.2	38	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.
20.5	39
47.2	40	=== Properties ===
30.11	41
47.2	42	Select a counter by clicking on it in the list of counters to the left. The following details are shown for the counter:
20.5	43
47.2	44	; {{smallcaps}}Uuid{{/smallcaps}}
	45	: 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.
	46	; Current value
	47	: The current value of the counter.
	48	; Creation date
	49	: The date when the counter was created.
	50	; Last change
	51	: The date of the most recent change to the counter's value.
30.19	52
47.2	53	Additionally, you can also edit the following properties of a counter:
44.8	54
47.2	55	; Counter name
	56	: 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.
	57	; Description
	58	: An optional description of this counter. This description is shown only within this backend menu.
	59	; Initial value
	60	: 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.
	61	; Reset automatically
	62	: When this option es enabled, the value of this counter is reset in period intervals.
44.2	63
47.2	64	=== Reset automatically ===
47.1	65
47.2	66	The following settings are available when the option to reset the counter automatically is enabled:
47.1	67
47.2	68	{{info}}
	69	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.
	70	{{/info}}
30.19	71
47.2	72	{{info}}
	73	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.
	74	{{/info}}
30.19	75
47.2	76	; Condition
	77	: Lets you choose when and how the counter should be reset. The following options are available:
	78	:; Counter greater than or equal
	79	:: 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.
	80	:; Counter less than or equal
	81	:: 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.
	82	:; daily
	83	:: The counter is reset each day at the given time of day.
	84	:; weekly
	85	:: The counter is reset at each of the given days of the week and at the given time of the day.
	86	:; monthly
	87	:: The counter is reset each month at the given date and time of the day.
	88	:; yearly
	89	:: The counter is reset each year the given day, month and time of the day.
47.1	90
47.2	91	== Workflow action "Counter" ==
47.1	92
47.2	93	{{figure image="plugin_dbcounter_action_counter_en.png"}}
	94	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.
	95	{{/figure}}
47.1	96
47.2	97	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.
47.1	98
47.2	99	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.
47.1	100
47.2	101	; Counter name
	102	: 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.
	103	; Counting action
	104	: Lets you chose how the value of the counter should be changed. Possible options are:
	105	:; Increment count
	106	:: Adds the given amount to the current value of the counter.
	107	:; Decrement count
	108	:: Substracts the given amount from the current value of the counter.
	109	:; Reset counter to start value
	110	:: Sets the current value of the counter back to the selected initial value.
	111	; Step size
	112	: Amount by which the counter is incremented or decremented.
	113	; Use global settings (deprecated)
	114	: 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.
47.1	115
47.2	116	== Workflow action "Variable" ==
47.1	117
47.2	118	{{figure image="plugin_dbcounter_action_variable_en.png"}}
	119	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.
	120	{{/figure}}
30.20	121
47.2	122	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.
30.22	123
47.2	124	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.
30.21	125
47.2	126	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//.
30.21	127
47.2	128	=== Change variable ===
30.21	129
47.2	130	Select the name of the variable ("counter") to modify and how its value should be changed.
30.22	131
47.2	132	; Counter name
	133	: 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.
	134	; Counting action
	135	: Lets you chose how the value of the counter should be changed. Possible options are:
	136	:; Increment count
	137	:: Adds the given amount to the current value of the counter.
	138	:; Decrement count
	139	:: Subtracts the given amount from the current value of the counter.
	140	:; Reset counter to start value
	141	:: Sets the current value of the counter back to the selected initial value.
	142	; Step size
	143	: Amount by which the counter is incremented or decremented.
30.22	144
47.2	145	=== Default settings if variable does not exists yet ===
30.22	146
47.2	147	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.
30.22	148
47.2	149	; Initial value
	150	: The initial value of the newly created counter.
	151	; Reset automatically
	152	: 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.
30.22	153
47.2	154	== General return parameters ==
20.5	155
47.2	156	{{figure image="plugin_dbcounter_action_return_parameters_en.png"}}
	157	Settings for the return parameters of the counter action. You can access the returned values via placeholder variables.
30.11	158	{{/figure}}
	159
47.2	160	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:
30.11	161
47.2	162	; 1 - ResultCode
	163	: A numerical value that indicates whether the counter action was successful or not. The following result codes are possible:
20.18	164	:; 1 (OK)
47.2	165	:: The counter action was processed successfully.
20.18	166	:; 10 (UNKNOWN_ACTION_ERROR)
47.2	167	:: 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//.
20.18	168	:; 11 (PARSING_ERROR)
47.2	169	:: 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).
20.18	170	:; 40 (INTERNAL_ERROR)
47.2	171	:: The counter action was not successful. The type of error cannot be specified more closely.
	172	; 2 - ResultMessage
	173	: An English description of the result (success or error).
	174	; 3 - Counter
	175	: The new numerical value of the counter, after the counting action was applied.
	176	; 4 - IsReset
	177	: Either //true//, when the counter was reset during the current action; or //false// if it was not reset.
	178	; 5 - CounterAfterReset
	179	: In case the counter was reset: The numerical value of the counter before the reset.
20.17	180
47.2	181	== System variable plugin ==
20.20	182
47.2	183	{{figure image="dbcounter-plugin-placeholder_en.png"}}
	184	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.
20.20	185	{{/figure}}
	186
47.2	187	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:
20.20	188
30.9	189	{{code language="none"}}
47.2	190	[%$DBCOUNTER.<CounterName>%]
20.21	191	{{/code}}
20.20	192
47.2	193	For example, in order to access the value of a counter named //test//, you can use the following variable:
20.21	194
30.9	195	{{code language="none"}}
47.2	196	[%$DBCOUNTER.test%]
20.21	197	{{/code}}
	198
47.2	199	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:
30.3	200
47.2	201	{{code language="none"}}
	202	[%$DBCOUNTER(<CounterName>, <InitialValue>)%]
	203	{{/code}}
30.3	204
47.2	205	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:
	206
	207	{{code language="none"}}
	208	[%$DBCOUNTER(participants-2020-03-17, 0)%]
	209	{{/code}}
	210
	211	== Servlet action plugin ==
	212
	213	{{figure image="dbcounter_plugin_servlet_action.png"}}
	214	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.
47.1	215	{{/figure}}
30.3	216
	217
47.2	218	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:
20.21	219
30.10	220	{{code language="none"}}
47.2	221	https://<Host>/<FormcycleContextPath>/plugin?name=Servlet%20Counter&client-id=<ClientId>&id=<CounterUuid>
20.23	222	{{/code}}
	223
47.2	224	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:
20.23	225
30.10	226	{{code language="none"}}
47.2	227	https://localhost:8080/formcycle/plugin?name=Servlet%20Counter&client-id=1&id=bc49d3b0-f869-4e59-864e-ddcc2925ed63
20.23	228	{{/code}}
	229
47.2	230	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.
20.23	231
30.10	232	{{code language="none"}}
47.2	233	https://<Host>/<FormcycleContextPath>/plugin?name=Servlet%20Counter&project-id=<FormID>&id=<CounterUuid>
20.23	234	{{/code}}
20.24	235
47.2	236	=== HTTP parameter ===
30.4	237
47.2	238	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.
30.4	239
30.5	240	; name
47.2	241	: The name of the servlet plugin action to execute. Set this to //Servlet Counter// for this plugin.
30.5	242	; client-id
47.2	243	: {{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.
30.5	244	; project-id
47.2	245	: {{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.
30.6	246	; id
47.2	247	: {{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.
30.6	248	; counter-name
47.2	249	: 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.
30.6	250	; counter-initial
47.2	251	: 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.
30.6	252	; counter-array
47.2	253	: 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.
30.4	254
47.2	255	=== HTTP response ===
30.4	256
47.2	257	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.
20.24	258
47.2	259	The {{smallcaps}}Json{{/smallcaps}}-Objekt has got the following properties:
30.8	260
20.24	261	; Status
47.2	262	: Indicates whether the servlet request was successful. The value is another {{smallcaps}}Json{{/smallcaps}} object with the following entries:
20.24	263	:; Msg
47.2	264	:: A numerical value that indicates whether the servlet request was successful. Possible values are:
20.27	265	::; 0 (OK)
47.2	266	::: The request was successful.
20.27	267	::; 12 (NO_REQUEST_ID_ERROR)
47.2	268	::: The request did not specify a counter UUID.
20.27	269	::; 13 (NO_COUNTER_TO_UUID_ERROR)
47.2	270	::: No counter with the specified UUID exists.
20.27	271	::; 40 (INTERNAL_ERROR)
47.2	272	::: The counter action was not successful. The type of error cannot be specified more closely.
20.24	273	:; Code
47.2	274	:: An English description of the result (success or error).
20.24	275	; Counter
47.2	276	: Details about the requested counter. The value is another {{smallcaps}}Json{{/smallcaps}} object with the following entries:
20.24	277	:; LastChange
47.2	278	:: 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.
20.24	279	:; LastChangeTimestamp
47.2	280	:: 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.
	281	:; Value
	282	:: The current numerical value of the counter.
	283	:; UUID
	284	:: The UUID of the requested counter.
47.1	285	:; Name
47.2	286	:: The name of the requested counter.
44.5	287
47.2	288	== Changelog ==
44.5	289
47.2	290	This section lists all known versions of this plugin and describes the changes that were made in each version.
44.5	291
44.8	292	=== 2.3.3 ===
44.5	293
47.2	294	* Fixed some spelling mistakes
44.5	295
44.8	296	=== 2.3.2 ===
44.5	297
47.2	298	* Fixed a UI bug: The checkbox //Use global settings// (action //Counter//) now toggles the options below correctly.
	299	* Fixed some spelling mistakes
44.5	300
44.8	301	=== 2.3.1 ===
44.5	302
47.2	303	* Fixed a bug with {{smallcaps}}Mysql{{/smallcaps}} that prevented this plugin from working with that database management system.
44.5	304
44.8	305	=== 2.3.0 ===
44.5	306
47.2	307	* New action: //Variable//
	308	* Lets you select a counter by its name and allows for placeholder variables. This requires an initial value.
	309	* New placeholder variable: //DBCOUNTER(name, initialValue)//. Creates a new counter in case a counter with the given name does not exist yet.
	310	* Added 3 new parameters to the servlet action plugin: //counter-name//, //counter-initial// and //counter-array//.
44.5	311
44.8	312	=== 2.2.0 ===
44.5	313
47.2	314	* Make sure to reset the counter even when its value is only read
	315	* Portal page that adds a new menu entry to the backend: Counter configuration
	316	* Deprecate editing a counter's settings in the workflow action directly
44.5	317
44.8	318	=== 2.1.0 ===
44.5	319
47.2	320	* Modifications for {{formcycle/}} version 6.1.6
	321	* The //CounterPlugin// and //ServletCounterPlugin// had the same name, this resulted in errors
	322	* Fixed an error that resulted in a counter not being resetted correctly
	323	* Add a new property to the {{smallcaps}}Json{{/smallcaps}} object returned by the servlet action plugin: //Counter.LastChangeTimestamp//
	324	* Added a new system variable replacer plugin that lets you access the value of a counter via a variable: //[%DBCOUNTER.name%]//
44.5	325
44.8	326	=== 2.0.0 ===
44.5	327
47.2	328	* Modifications to make the plugin work with {{formcycle/}} version 6.0.2
44.5	329
44.8	330	=== 1.0.1 ===
44.5	331
47.2	332	* Fix a bug where the counter value was not set when retrieved for the first time
44.5	333
44.8	334	=== 1.0.0 ===
44.5	335
47.2	336	* Initial version

Wiki source code of Datenbankzähler-Plugin

Navigation