... |
... |
@@ -1,9
+1,7 @@ |
1 |
1 |
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. |
2 |
2 |
|
3 |
3 |
{{id name="sec_plugin_parameters" /}} |
4 |
|
- |
5 |
5 |
== Using the plugin == |
6 |
|
- |
7 |
7 |
{{id name="fig_plugin_counter"/}} |
8 |
8 |
{{figure image="plugin_counter_en.png"}}Configuration UI of the workflow plugin{{/figure}} |
9 |
9 |
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. |
... |
... |
@@ -10,33
+10,32 @@ |
10 |
10 |
|
11 |
11 |
=== Plugin parameters (Optional) === |
12 |
12 |
|
13 |
|
-; Digits |
|
11 |
+; **Digits** |
14 |
14 |
: 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. |
15 |
|
-; Prefix |
|
13 |
+; **Prefix** |
16 |
16 |
: A string preceeding the serial number |
17 |
|
-; Suffix |
|
15 |
+; **Suffix** |
18 |
18 |
: A string following the serial number |
19 |
19 |
|
20 |
20 |
=== Using the return paramter === |
21 |
21 |
|
22 |
|
-The created serial number can be accessed in further workflow processing via {{code language="none"}}[%$<name of the plugin action>.RESULT%]{{/code}}. |
|
20 |
+The created serial number can be accessed in further workflow processing via {{code}}[%$<name of the plugin action>.RESULT%]{{/code}}. |
23 |
23 |
|
24 |
24 |
{{id name="sec_global_settings" /}} |
25 |
|
- |
26 |
26 |
== Globale plugin settings == |
27 |
27 |
|
28 |
28 |
After installing the plugin the database table for saving the serial numbers needs to be created. For this the following parameters are needed: |
29 |
29 |
|
30 |
|
-; db.connection.name |
|
27 |
+; **db.connection.name** |
31 |
31 |
: Name of the [[database connection>>doc:Formcycle.UserInterface.Data.DBConnections.WebHome]] for which the table should be created. |
32 |
|
-; db.manage.process |
33 |
|
-: 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. |
|
29 |
+; **db.manage.process** |
|
30 |
+: This parameter can have the value {{code}}CREATE{{/code}} or {{code}}DELETE{{/code}}. Saving the plugin configuration leads to either the creation or deletion of the serial number database table. |
34 |
34 |
|
35 |
35 |
=== Structure of the database table === |
36 |
36 |
|
37 |
|
-The database table will be created with the name {{code language="none"}}plugin_project_counter{{/code}} and has the following columns: |
|
34 |
+The database table will be created with the name {{code}}plugin_project_counter{{/code}} and has the following columns: |
38 |
38 |
|
39 |
|
-; project_id |
|
36 |
+; **project_id** |
40 |
40 |
: System ID of the form that has a serial version counter |
41 |
|
-; counter_value |
|
38 |
+; **counter_value** |
42 |
42 |
: value of the serial number counter |