Wiki source code of Seriennummer-Plugin

Show last authors
1 [[**Plugin download**>>url:https://customer.formcycle.eu/index.php/apps/files/?dir=/FORMCYCLE%20-%20Plugins%20Customer/plugin-bundle-counter&fileid=10348||target="_blank"]] (requires login)
2
3 This workflow plugin allows for the creation of serial numbers per form. Created Serialnumber will be persisted in a database table. After the [[installation>>doc:Formcycle.SystemSettings.UserInterface.SystemPlugins.WebHome]] the [[globale plugin settings>>||anchor="sec_global_settings"]] need to set correctly. This plugin is subject to additional charge.
4
5 {{id name="sec_plugin_parameters" /}}
6
7 == Using the plugin ==
8
9 {{id name="fig_plugin_counter"/}}
10 {{figure image="plugin_counter_en.png"}}Configuration UI of the workflow plugin{{/figure}}
11 In order to use the plugin a new [[workflow>>doc:Formcycle.Designer.Workflow.WebHome]] action of type **Create serial number** needs to be created. With every execution of this action the value of the serial number counter will be updated. If there is not yet a serial number for this form than it will be created.
12
13 === Plugin parameters (Optional) ===
14
15 ; Digits
16 : Is used for defining a fixed number of digits for the serial number. If the created serial number does not have enough digits the missing digits will be filled with zeros.
17 ; Prefix
18 : A string preceeding the serial number
19 ; Suffix
20 : A string following the serial number
21
22 === Using the return paramter ===
23
24 The created serial number can be accessed in further workflow processing via {{code language="none"}}[%$<name of the plugin action>.RESULT%]{{/code}}.
25
26 {{id name="sec_global_settings" /}}
27
28 == Globale plugin settings ==
29
30 After installing the plugin the database table for saving the serial numbers needs to be created. For this the following parameters are needed:
31
32 ; db.connection.name
33 : Name of the [[database connection>>doc:Formcycle.UserInterface.Data.DBConnections.WebHome]] for which the table should be created.
34 ; db.manage.process
35 : This parameter can have the value {{code language="none"}}CREATE{{/code}} or {{code language="none"}}DELETE{{/code}}. Saving the plugin configuration leads to either the creation or deletion of the serial number database table.
36
37 === Structure of the database table ===
38
39 The database table will be created with the name {{code language="none"}}plugin_project_counter{{/code}} and has the following columns:
40
41 ; project_id
42 : System ID of the form that has a serial version counter
43 ; counter_value
44 : value of the serial number counter