Wiki-Quellcode von Workflow

Zeige letzte Bearbeiter
1 WIP
2
3 {{content/}}
4
5 {{id name="fig_workflow_overview"/}}
6 {{figure image="workflow_overview_marked_de.png" clear="h1"}}Den größten Platz des //Workflowdesigners// nimmt der [[Arbeitsbereich>>||anchor="sec_component_main"]] in der Mitte (1) ein. Dieser stellt die Verarbeitung des Formulars grafisch in Form des //Workflowgraphen// dar. Links neben dem Arbeitsbereich befindet sich die [[Elementauswahl>>||anchor="sec_component_element_selection"]] (2), welche sämtliche Aktionen, Ereignisse und weitere Steuerungselemente auflistet. Neue Elemente können einfach per Drag & Drop aus der Elementauswahl in die Verarbeitung gezogen werden. Die Eigenschaften einzelner Elemente im Arbeitsbereich werden rechts neben diesem in den [[Elementeigenschaften>>||anchor="sec_component_element_properties"]] dargestellt. Über diesen Bereichen befindet sich die [[Werkzeugleiste>>||anchor="sec_component_tool_bar"]] (4) des Workflowdesigners. Unterhalb des Arbeitsbereichs befindet sich eine [[Statusleiste>>||anchor="sec_component_status_bar"]] (5) mit Information zur aktuellen Verarbeitung.{{/figure}}
7
8
9 {{id name="fig_workflow_example_submit"/}}
10 {{figure image="workflow_example_submit_de.png" clear="h1"}}Beispiel einer Verarbeitungskette für das Absenden eines Formulars über den Absendebutton //btnSubmit// im Formular.{{/figure}}
11
12 Der Workflowdesigner ermöglicht es, die Verarbeitung von Formularen auf eine intuitive und visuelle Weise per Drag & Drop zu erstellen. Die Verarbeitung von Formularen wird als ein ereignisbasiertes Flussdiagramm dargestellt. Dieses Flussdiagramm wird im Folgenden als der [[**Workflowgraph**>>||anchor="sec_graph"]] bezeichnet. Innerhalb des //Workflowgraphen// werden einzelne Verarbeitungsketten angelegt, welche durch Ereignisse ausgelöst werden. Ereignisse sind etwa der Klick auf einen Absendeknopf, das Bestätigen eines Double-Opt-In-Vorgangs oder das Überschreitung eines definierten Zeitpunktes. Abzweigungen innerhalb des Graphen stellen Entscheidungen oder Bedingungen dar. Durch diese Bedingungen können unterschiedliche Aktionen ausgeführt werden, abhängig vom Status eines Vorgangs und/oder den Eingaben eines Endnutzers.
13
14 {{id name="sec_graph"/}}
15
16 == Workflowgraph ==
17
18 Der //Workflowgraph// stellt das Herzstück des Workflowdesigners dar, mit welchem die Verarbeitung eines Formulars grafisch repräsentiert wird und bearbeitet werden kann. Der Beginn einer jeden Verarbeitung ist mit dem {{formcycle/}}-Symbol markiert. [[image:workflow_start.png]]
19 Der Workflow ist von oben nach unten zu lesen und besteht aus einzelnen //Verarbeitungsketten//. Jede Verarbeitungskette beginnt mit einem [[Ereignis>>||anchor="sec_elements_events"]], welches diese auslöst. Bspw. kann der Klick auf einen bestimmten Button im Formular eine Verarbeitungskette starten, in welcher eine [[E-Mail>>doc:Formcycle.Designer.Workflow.Actions.EMail.WebHome]] an den Antragsteller gesendet wird. Wie man an diesem Beispiel sieht, werden innerhalb von Verarbeitungsketten [[Aktionen>>||anchor="sec_elements_actions"]] ausgeführt. Diese Verarbeitungsketten können komplexer werden und sich bspw. abhänging von den Formulareingaben aufsplitten. Diese Abzweigungen werden über [[Bedingungen>>doc:Formcycle.Designer.Workflow.FlowControl.Condition.WebHome]] realisiert. So wird bspw. nur eine E-Mail versendet, wenn der Antragsteller auch eine E-Mail angegeben hat. Wenn dies nicht der Fall ist, wird bspw. ein PDF des Formulars erstellt und dieses dem Antragsteller zurückgegeben. Wie man sieht führen Bedingungen dazu, dass sich eine Verarbeitungskette in zwei //Teilverarbeitungsketten// aufteilt. Jede Verarbeitungskette muss in einem [[Endpunkt>>||anchor="sec_elements_endpoints"]] enden. In der Regel ist ein solcher Endpunkt ein [[Status>>doc:Formcycle.Designer.Workflow.States.WebHome]] in dem sich der Vorgang nach Aursführung der Verarbeitung befinden soll. Im Fall von Bedingungen werden die dadurch entstandenen Teilverarbeitungsketten nach Ausführung der geünschten Aktionen wieder zusammen geführt (siehe [[Abbildung>>||anchor="fig_workflow_example_submit"]]). Jede Teilverarbeitungskette kann allerdings auch einen eigenen Endpunkt definieren. Das hier vorgestellte Beispiel ist in der [[Abbildung>>||anchor="fig_workflow_example_submit"]] als Verarbeitungskette im Arbeitsbereich des Workflowdesigner dargestellt.
20
21 {{id name="sec_graph_default"}}
22 === Standardverhalten ===
23
24 Neue erstellte Formulare haben keinen konfigurierten Workflow, d.h. es ist keine Ereignis-Verarbeitungskette im Workflowgraphen enthalten. Alles was im Arbeitsbereich des Workflowdesigners zu sehen ist, ist das {{formcycle/}}-Symbol, welches den Beginn der Verarbeitung darstellt. In einem solchen Fall landen abgesendete Vorgänge immer im Status //Eingegangen//, auch wenn dies nicht explizit im Workflowgraphen konfiguriert ist. Dies ist das Standardverhalten von {{formcycle/}}, wenn kein Workflow konfiguriert wurde. Diese Standardverahlten greift auch, wenn ein Formular mit einem Button abgesendet wurde, für welchen nicht explizit ein Workflowereignis im Workflowgraphen definiert wurde.
25
26 === Zusammengefasst ===
27
28 Jeder Workflowgraph kann aus mehreren //Verarbeitungsketten// bestehen. Der Workflow kann aber auch keine Verarbeitungskette besitzen, dann greift das [[Standardverhalten>>||anchor="sec_graph_default"]].
29
30 Jede Verarbeitungskette beginnt mit einem Ereignis, danach folgen Workflowelemente wie Aktionen und Bedingungen. Die Verarbeitungskette endet immer in einem Endpunkt. Teilverarbeitungsketten können einen eigenen Endpunkt definieren.
31
32 {{id name="sec_components"/}}
33
34 == Oberfläche ==
35
36 Wie in der [[Abbildung>>||anchor="fig_workflow_overview"]] zu sehen, besteht der Workflowdesigner aus den folgenden Komponente: [[Arbeitsbereich>>||anchor="sec_component_main"]], [[Elementauswahl>>||anchor="sec_component_element_selection"]], [[Elementeigenschaften>>||anchor="sec_component_element_properties"]] & [[Statusleiste>>||anchor="sec_component_status_bar"]], welche im Folgenden kurz vorgestellt werden sollen. Über diesen Bereichen befindet sich die [[Werkzeugleiste>>||anchor="sec_component_tool_bar"]] des Workflowdesigners (Allgemeine Informationen zur Werkzeugleiste sind [[hier>>doc:Formcycle.Designer.WebHome]] zu finden).
37
38 {{id name="sec_component_main"/}}
39
40 === Arbeitsbereich ===
41
42 Der Arbeitsbereich stellt den [[Workflowgraphen>>||anchor="sec_graph"]] dar. Jeder zeit können dem Workflowgraphen neue Ereignisse hinzugefügt werden. Dies kann auf zwei Dies Geschieht entweder über einen Klick auf das Plus-Symbol [[image:workflow_plus.png]]
43
44 {{id name="sec_component_element_selection"/}}
45
46 === Elementauswahl ===
47
48 Die Elementauswahl kann über das Pfeilsymbol am Rand eingeklappt werden, wodurch mehr Platz für den Arbeitsbereich entsteht. Dem Workflowgraphen können trotzdem neue Elemente mit einem Klick auf die sog. Droppunkte [[image:workflow_drop_point.png]] innerhalb der Verarbeitungsketten hinzugefügt werden.
49
50 {{id name="sec_component_element_properties"/}}
51
52 === Elementeingenschaften ===
53
54 {{id name="sec_component_tool_bar"/}}
55
56 === Werkzeugleiste ===
57
58 {{id name="sec_component_status_bar"/}}
59
60 === Statusleiste ===
61
62 {{id name="sec_elements"/}}
63
64 == Workflowelemente ==
65
66 {{id name="sec_elements_events"/}}
67
68 === Ereignisse ===
69
70 {{id name="sec_elements_actions"/}}
71
72 === Aktionen ===
73
74 {{id name="sec_elements_endpoints"/}}
75
76 === Endpunkte ===
77
78 == Grobe Beschreibung ==
79
80 * Grundkonzepte
81 * alter und neuer Workflow ansprechen
82
83 Verlinkung auf alten Workflow (Der alte Workflow wird in einer Unterkategorie positioniert und enthält dort alle bisherigen Unterseiten unverändert.)
84
85 == Beschreibung des neuen Workflows ==
86
87 * Verarbeitungsketten ... jeweils ein Ereignis auslösend
88 * Ereignisse grob beschreiben und auf Unterseite verlinken
89 * Aktionen grob Möglichkeiten beschreiben und auf Aktionen verlinken
90 * Bedingungen und Fehlerelemente grob beschreiben und auf Aktionen verlinken
91 * Endpunkte grob beschreiben und auf Aktionen verlinken
92
93 Direkt darunter kommen alle Elemente des Workflows
94
95 Hinweise von Andre:
96
97 * Jeder Verarbeitungskette muss auf einen Endpunkt enden. Wird z.B. eine Bedingung am Ende einer Verarbeitungskette verwendet, muss sowohl im Ja-Fall als auch Nein-Fall sich ein Endpunkt befinden.
98 * Treffen mehrere Ereignisse zu, werden die entsprechenden Verarbeitungsketten der Reihe nach von links nach rechts ausgeführt.
99 * Eine Ausführung des Workflows ist fehlerhaft, wenn eine Aktion in einem Fehler endete und dieser Fehler nicht behandelt wurde (Abschlusseite: "Oops". Andernfalls ist die Ausführung des Workflows erfolgreich.
100 * Es gibt eine Validierung des gesamten Workflows. Formular wird offline geschaltet, wenn invalider Workflow gespeichert wird.
101 * Wird ein Workflow geändert, nicht gespeichert und neu geladen, erscheint ein Dialog, mit dem der alte Stand wiederherstellgt werden kann. Dabei wird nicht gespeichert, sondern erst, wenn der Nutzer auf Speichern klickt.
102
103 TODO auf Unterseiten:
104
105 * Aktionen des neuen WF sollten immer auch auf die alten verlinken und umgekehrt.
106 * Bei den Aktionen sollte immer auch im ersten Satz stehen, in welcher Gruppe sie sind
107 * Bei Legacy Aktionen sollte dies gernerell darüber stehen in einem Hinweisfeld. Die Aktionen , welche schon in der Version 6 deprecated waren, sollten dies dann extra im Text erwähnt bekommen.
108 * Von Andre: Bei einigen Aktionen können Dateien ausgewählt werden, die von anderen Aktionen erzeugt werden. Dabei können alle Aktionen ausgewählt werden, die potentiell vor der Aktion ausgeführt werden können. Z.B. wenn "Aktion A -> Bedingung(ja=Aktion B,nein=Aktion C), Aktion D" konfiguriert ist, dann kann in D Aktion A ausgewählt werden, diese kommt immer von A. Aber auch sowohl B als auch C können ausgewählt werden, weil je nach Ausgang der Bedingung B oder C vor D kommen können. In Aktion C kann aber nicht B ausgewählt werden, weil B nie vor C kommen kann.