Wiki source code of Seriennummer-Plugin
Hide last authors
author | version | line-number | content |
---|---|---|---|
14.11 | 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) | |
14.10 | 2 | ||
14.11 | 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. | |
2.1 | 4 | ||
7.1 | 5 | {{id name="sec_plugin_parameters" /}} | |
14.8 | 6 | ||
14.11 | 7 | == Using the plugin == | |
14.7 | 8 | ||
9 | {{id name="fig_plugin_counter"/}} | ||
14.11 | 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.UserInterface.MyForms.WorkflowProcessing.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. | ||
14.7 | 12 | ||
14.11 | 13 | === Plugin parameters (Optional) === | |
7.1 | 14 | ||
14.11 | 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 | ||
14.2 | 19 | ; Suffix | |
14.11 | 20 | : A string following the serial number | |
9.1 | 21 | ||
14.11 | 22 | === Using the return paramter === | |
9.1 | 23 | ||
14.11 | 24 | The created serial number can be accessed in further workflow processing via {{code language="none"}}[%$<name of the plugin action>.RESULT%]{{/code}}. | |
9.1 | 25 | ||
2.1 | 26 | {{id name="sec_global_settings" /}} | |
14.2 | 27 | ||
14.11 | 28 | == Globale plugin settings == | |
2.1 | 29 | ||
14.11 | 30 | After installing the plugin the database table for saving the serial numbers needs to be created. For this the following parameters are needed: | |
6.1 | 31 | ||
14.2 | 32 | ; db.connection.name | |
14.11 | 33 | : Name of the [[database connection>>doc:Formcycle.UserInterface.Data.DBConnections.WebHome]] for which the table should be created. | |
14.2 | 34 | ; db.manage.process | |
14.11 | 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. | |
6.1 | 36 | ||
14.11 | 37 | === Structure of the database table === | |
6.1 | 38 | ||
14.11 | 39 | The database table will be created with the name {{code language="none"}}plugin_project_counter{{/code}} and has the following columns: | |
6.1 | 40 | ||
14.11 | 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 |