| ... |
... |
@@ -1,1
+1,42 @@ |
| 1 |
|
-Das Plugin ermöglicht das Erstellen von Seriennummern pro Projekt. Erstellte Seriennummern werden in einer speziellen Datenbanktabelle abgelegt. |
|
1 |
+Dieses Verarbeitungsplugin ermöglicht das Erstellen von Seriennummern pro Formular. Erstellte Seriennummern werden in einer speziellen Datenbanktabelle abgelegt. Nach der [[Installation>>doc:Formcycle.SystemSettings.UserInterface.SystemPlugins.WebHome]] müssen zunächst [[globale Plugineinstellungen>>||anchor="sec_global_settings"]] gesetzt werden. |
|
2 |
+ |
|
3 |
+{{id name="sec_plugin_parameters" /}} |
|
4 |
+== Verwendung des Plugins == |
|
5 |
+ |
|
6 |
+{{id name="fig_plugin_counter"/}} |
|
7 |
+{{figure image="plugin_counter_de.png"}}Konfigurationsoberfläche der Pluginaktion{{/figure}} |
|
8 |
+ |
|
9 |
+Um das Plugin zu verwenden muss in der [[Aktionsverarbeitung>>doc:Formcycle.UserInterface.MyForms.WorkflowProcessing.WebHome]] eine Aktion des Typs **Create serial number** erstellt werden. Mit jeder Ausführung dieser Aktion durch Statuswechsel wird der Wert des Seriennummernzählers aktualisiert. Gibt es noch keinen Zähler für das Formular so wird angelegt. |
|
10 |
+ |
|
11 |
+=== Pluginparameter (Optional) === |
|
12 |
+ |
|
13 |
+; Stellenanzahl |
|
14 |
+: Dient der Festlegung einer festen Stellenanzahl für die Seriennummer. Besitzt die erzeugte Nummer weniger Stellen, dann werden die fehlenden Stellen mit Nullen aufgefüllt. |
|
15 |
+; Präfix |
|
16 |
+: Eine Zeichenkette, die der Seriennummer vorangestellt wird |
|
17 |
+; Suffix |
|
18 |
+: Eine Zeichenkette, die der Seriennummer angehangen wird |
|
19 |
+ |
|
20 |
+=== Verwendung des Rückgabewertes === |
|
21 |
+ |
|
22 |
+Auf die erzeugte Seriennummer kann innerhalb der weiteren Verarbeitung wie folgt zugegriffen werden: {{code language="none"}}[%$<Name der Pluginaktion>.RESULT%]{{/code}} |
|
23 |
+ |
|
24 |
+{{id name="sec_global_settings" /}} |
|
25 |
+ |
|
26 |
+== Globale Plugineinstellungen == |
|
27 |
+ |
|
28 |
+Nach der [[Installation>>doc:Formcycle.SystemSettings.UserInterface.SystemPlugins.WebHome]] des Plugins muss die Datenbanktabelle für das Speichern der Seriennummer angelegt werden. Hierzu sind folgende Parameter nötig: |
|
29 |
+ |
|
30 |
+; db.connection.name |
|
31 |
+: Name der angelegten [[Datenbankverbindung>>doc:Formcycle.UserInterface.Data.DBConnections.WebHome]], in der die Countertabelle angelegt werden soll. Dieser Name bezieht sich auf den Namen der Verbindung, die unter //Daten > DB-Verbindungen// angelegt wurde. |
|
32 |
+; db.manage.process |
|
33 |
+: Dieser Parameter kann die Werte {{code language="none"}}CREATE{{/code}} oder {{code language="none"}}DELETE{{/code}} annehmen. Beim Speichern der Pluginkonfiguration wird die Datenbanktabelle abhängig vom Wert dieses Parameters entweder //erstellt// ({{code language="none"}}CREATE{{/code}}) oder //gelöscht// ({{code language="none"}}DELETE{{/code}}). |
|
34 |
+ |
|
35 |
+=== Aufbau der Datenbanktabelle === |
|
36 |
+ |
|
37 |
+Die Datenbanktabelle wird mit dem Namen {{code language="none"}}plugin_project_counter{{/code}} angelegt und besitzt zwei Spalten: |
|
38 |
+ |
|
39 |
+; **project_id** |
|
40 |
+: System-ID des Formulars, zu welcher ein Seriennummernzähler zugeordnet ist |
|
41 |
+; **counter_value** |
|
42 |
+: Wert des Seriennummernzählers |