| ... |
... |
@@ -1,23
+1,41 @@ |
| 1 |
|
-Dieses Verarbeitungsplugin ermöglicht das Erstellen von Seriennummern pro Projekt. 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. |
|
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 |
2 |
|
| 3 |
3 |
{{id name="sec_plugin_parameters" /}} |
|
4 |
+ |
| 4 |
4 |
== Verwendung des Plugins == |
| 5 |
5 |
|
| 6 |
|
-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 dieses Formular um eins nach oben gezählt. Gibt es noch keinen Zähler für das Formular so wird dieser mit dem Wert 1 angelegt. |
|
7 |
+{{id name="fig_plugin_counter"/}} |
|
8 |
+{{figure image="plugin_counter_de.png"}}Konfigurationsoberfläche der Pluginaktion{{/figure}} |
| 7 |
7 |
|
|
10 |
+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. |
|
11 |
+ |
|
12 |
+=== Pluginparameter (Optional) === |
|
13 |
+ |
|
14 |
+; Stellenanzahl |
|
15 |
+: 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. |
|
16 |
+; Präfix |
|
17 |
+: Eine Zeichenkette, die der Seriennummer vorangestellt wird |
|
18 |
+; Suffix |
|
19 |
+: Eine Zeichenkette, die der Seriennummer angehangen wird |
|
20 |
+ |
|
21 |
+=== Verwendung des Rückgabewertes === |
|
22 |
+ |
|
23 |
+Auf die erzeugte Seriennummer kann innerhalb der weiteren Verarbeitung wie folgt zugegriffen werden: {{code language="none"}}[%$<Name der Pluginaktion>.RESULT%]{{/code}} |
|
24 |
+ |
| 8 |
8 |
{{id name="sec_global_settings" /}} |
|
26 |
+ |
| 9 |
9 |
== Globale Plugineinstellungen == |
| 10 |
10 |
|
| 11 |
11 |
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: |
| 12 |
12 |
|
| 13 |
|
-; **db.connection.name** |
|
31 |
+; db.connection.name |
| 14 |
14 |
: 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. |
| 15 |
|
-; **db.manage.process** |
| 16 |
|
-: Dieser Parameter kann die Werte {{code}}CREATE{{/code}} oder {{code}}DELETE{{/code}} annehmen. Beim Speichern der Pluginkonfiguration wird die Datenbanktabelle abhängig vom Wert dieses Parameters entweder //erstellt// ({{code}}CREATE{{/code}}) oder //gelöscht// ({{code}}DELETE{{/code}}). |
|
33 |
+; db.manage.process |
|
34 |
+: 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}}). |
| 17 |
17 |
|
| 18 |
18 |
=== Aufbau der Datenbanktabelle === |
| 19 |
19 |
|
| 20 |
|
-Die Datenbanktabelle wird mit dem Namen {{code}}plugin_project_counter{{/code}} angelegt und besitzt zwei Spalten: |
|
38 |
+Die Datenbanktabelle wird mit dem Namen {{code language="none"}}plugin_project_counter{{/code}} angelegt und besitzt zwei Spalten: |
| 21 |
21 |
|
| 22 |
22 |
; **project_id** |
| 23 |
23 |
: System-ID des Formulars, zu welcher ein Seriennummernzähler zugeordnet ist |