Wiki-Quellcode von Workflow

Verstecke letzte Bearbeiter

version	line-number	content
1.1	1	WIP
1.2	2
2.1	3	{{content/}}
1.2	4
40.1	5	{{id name="fig_workflow_overview"/}}
47.1	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}}
9.1	7
40.1	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}}
33.5	11
55.1	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 Absendebutton, 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 erfassten Formulardaten.
2.1	13
46.2	14	{{id name="sec_graph"/}}
40.1	15
43.1	16	== Workflowgraph ==
30.2	17
40.1	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]]
45.1	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.
32.1	20
55.2	21	{{id name="sec_graph_default"/}}
	22
48.2	23	=== Standardverhalten ===
	24
55.2	25	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 Standardverhalten greift auch, wenn ein Formular mit einem Button abgesendet wurde, für welchen nicht explizit ein Workflowereignis mit Verarbeitungskette im Workflowgraphen definiert wurde.
33.4	26
55.2	27	{{id name="sec_graph_summary"/}}
	28
48.2	29	=== Zusammengefasst ===
	30
48.3	31	Jeder Workflowgraph kann aus mehreren //Verarbeitungsketten// bestehen. Der Workflow kann aber auch keine Verarbeitungskette besitzen, dann greift das [[Standardverhalten>>\|\|anchor="sec_graph_default"]].
52.3	32	Jede Verarbeitungskette beginnt mit einem [[Ereignis>>\|\|anchor="sec_elements_events"]], danach folgen [[Workflowelemente>>\|\|anchor="sec_elements"]] wie [[Aktionen>>\|\|anchor="sec_elements_actions"]] und [[Bedingungen>>doc:Formcycle.Designer.Workflow.FlowControl.Condition.WebHome]]. Die Aktionen werden von ob nach unten betrachtet ausgeführt. Bedingungen auf dem Pfad werden entsprechend des Umgebungs- und Vorgangszustandes ausgewertet. Die Verarbeitungskette endet immer in einem [[Endpunkt>>\|\|anchor="sec_elements_endpoints"]]. Teilverarbeitungsketten können einen eigenen Endpunkt definieren.
49.1	33
46.3	34	{{id name="sec_components"/}}
40.1	35
44.1	36	== Oberfläche ==
19.1	37
58.1	38	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"]], [[Werkzeug->>\|\|anchor="sec_component_tool_bar"]] & [[Statusleiste>>\|\|anchor="sec_component_status_bar"]], welche im Folgenden kurz vorgestellt werden sollen. Allgemeine Informationen zur Werkzeugleiste sind [[hier>>doc:Formcycle.Designer.WebHome]] zu finden.
21.1	39
46.4	40	{{id name="sec_component_main"/}}
40.1	41
43.1	42	=== Arbeitsbereich ===
19.1	43
52.2	44	Der Arbeitsbereich stellt den [[Workflowgraphen>>\|\|anchor="sec_graph"]] dar. Jederzeit können dem Workflowgraphen neue [[Ereignisse>>\|\|anchor="sec_compontents_events"]] hinzugefügt werden. Es gibt zwei Möglichkeiten dem Workflowgraphen ein neues Ereignis hinzuzufügen:
55.2	45
65.1	46	* Ein Ereignis wird aus der [[Elementauswahl>>\|\|anchor="sec_component_element_selection"]] am linken Rand per Drag & Drop in den Arbeitsbereich auf das Plus-Sysmbol {{ficon name="plus-circle-outline"/}} am Anfang des Workflowgraphen gezogen.
	47	* Es wird auf Plus-Symbol {{ficon name="plus-circle-outline"/}} am Anfang des Workflowgraphen geklickt. Daraufhin öffnet sich ein Kontextmenü über welches das Ereignis ausgewählt werden kann.
58.6	48
52.2	49	In beiden Fällen entsteht eine neue Verarbeitungskette mit dem gewählten Ereignis.
46.1	50
66.1	51	Verarbeitungsketten können überall da neue [[Workflowelemente>>\|\|anchor="sec_compontents"]] hinzugefügt werden, wo sich ein sog. Droppunkt {{ficon name="circle-outline"/}} befindet. Dies ist auf zwei verschiedene Arten möglich:
55.2	52
66.1	53	* Ein Workflowelement wird aus der [[Elementauswahl>>\|\|anchor="sec_component_element_selection"]] am linken Rand per Drag & Drop in den Arbeitsbereich auf den gewünschten Droppunkt {{ficon name="circle-outline"/}} in der Verarbeitungskette gezogen.
	54	* Es wird auf den gewünschten Droppunkt {{ficon name="circle-outline"/}} geklickt. Daraufhin öffnet sich ein Kontextmenü über welches das Workflowelement ausgewählt werden kann.
52.3	55
67.1	56	Wenn eine neue Verarbeitungskette durch das Anlgen eines [[Ereignisses>>\|\|anchor="sec_elements_events"]] erstellt wurde, erhält diese Verarbeitungskette standardmäßig den Status-Endpunkt //Eingegangen//. [[Endpunkte>>\|\|anchor="sec_elements_endpoints"]] können aus Verarbeitungsketten entfernt werden. Jede Verarbeitungskette, muss allerdings wenigstens einen Endpunkt besitzen. Ein neuer Endpunkt kann hinzugefügt werden indem dieser aus der [[Elementauswahl>>\|\|anchor="sec_component_element_selection"]] auf einen Droppunkt {{ficon name="circle-outline"/}} innerhalb der Verarbeitungskette oder auf den aktuellen Endpunkt der (Teil-)Verarbeitungskette gezogen wird. Wurde der Endpunkt der gesamten Verarbeitungskette gelöscht, kann auch ein neuer Enpukt definiert werden, in dem auf den Platzhalter für den Endpunkt geklickt wird. Daraufhin öffnet sich ein Kontextmenü über welches ein Endpunkt ausgewählt werden kann.
58.7	57
59.2	58	==== Elemente des Workflowgraphen ====
	59
63.2	60	Um die Eigenschaften eines [[Workflowelements>>\|\|anchor="sec_elements"]] des Workflowgraphen anzuzeigen, muss auf das entsprechende Workflowelement geklickt werden. Sämtliche Eigenschaften des Elementes werden daraufhin rechts neben dem Workflowgraphen in den [[Elementeigenschaften>>\|\|anchor="sec_component_element_properties"]] dargestellt und können dort angepasst werden. Workflowelemente können innerhalb und zwischen Verarbeitungsketten verschoben werden.
59.2	61
61.1	62	Wird der Cursor über eine Workflowelement im Workflowgraphen bewegt erscheinen über diesem folgende zusätzliche Optionen:
	63
63.1	64	; {{icon name="trash"/}} Löschen
61.1	65	: Löscht das gewählte Workflowelment
	66
63.1	67	; {{icon name="ban"/}} Deaktivieren
62.1	68	: Deaktiviert das gewählte Workflowelement. Wird ein [[Ereignis>>\|\|anchor="sec_elements_events"]] deaktiviert, dann ist dessen gesamte Verarbeitungskette deaktiviert.
61.1	69
63.1	70	; {{ficon name="content-copy"/}} Duplizieren
62.1	71	: Dupliziert das gewählte Workflowelement. Die Kopie wird unterhalb des Originals in den Workflowgraphen eingefügt. [[Ereignisse>>\|\|anchor="sec_elements_events"]] könnne nicht dupliziert werden.
61.1	72
63.1	73	; {{icon name="info-circle"/}} Kurzinfo
63.3	74	: Gibt eine Zusammenfassung des Workflowelmentes. Für [[Ereignisse>>\|\|anchor="sec_elements_events"]] beinhaltet dies die Angabe der durch das Ereignis bereitgestellten Werte. für das Ereignis //Double-Opt-In// bestätigt wird bspw. bereitgestellt in welcher Verarbeitungskette der Double-Opt-In initialisiert wurde. Für [[Aktionen>>\|\|anchor="sec_elements_actions"]] werden die Konfigurationsparameter und deren Werte sowie die Rückgabewerte bei Erfolg bzw.Fehler aufgelistet. Die Aktion //Datenbank-Abfrage// gibt bspw. bei Erfolg das Result dieser Abfrage zurück. Mit diesen Rückgabewerten von Ereignissen oder Aktionen kann im weiteren Verlauf des Workflowgraphen also in nachfolgenden Aktione gearbeitet werden.
61.1	75
46.6	76	{{id name="sec_component_element_selection"/}}
40.1	77
43.1	78	=== Elementauswahl ===
19.1	79
70.2	80	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 {{ficon name="circle-outline"/}} innerhalb der Verarbeitungsketten hinzugefügt werden (siehe [[Arbeitsbereich>>\|\|anchor="sec_component_main"]]). In der Elementauswahl sind sämtliche Elemente Verfügbar, die im Workflwo verwendet werden können. Um ein Element im Workflowgraphen im [[Arbeitsbereich>>\|\|anchor="sec_component_main"]] zu verwenden, muss es auf einen möglichen Droppunkt ({{ficon name="circle-outline"/}}) im Workflowgraphen im [[Arbeitsbereich>>\|\|anchor="sec_component_main"]] gezogen werden. Abhängig vom Typ des Workflowelementes stehen unterschiedliche mögliche Droppunkte zur Verfügung. Ereginsse können bspw nur am Anfang des Workflowgraphen ({{ficon name="plus-circle-outline"/}}) angehangen werden. Die Workflowelmente sind in unterschiedliche Kategorien aufgeteilt. Wird der Cursor über den oberen rechten Rand der Elementauswahl bewegt, werden die Elementkategorien sichtbar. Die Elemente sind in folgende Kategorien unterteilt:
23.2	81
70.2	82	* Buttons
	83	* Ereignisse
	84	* Aktionen
	85	* Steuerung
	86	* Status
69.1	87
71.1	88	Die Elementauswahl kann mit einem Klick auf die gewählte Kategorie begrenzt werden. Ein nochmaliger Klick sorgt dafür, dass diese Beschränkung wieder aufgehoben wird. Wird die //Strg//-Taste unter Windows bzw. die //Ctrl//-Taste unter MacOS gehalten, können mehrere Kategorien auf einmal ausgewählt werden. Für detailliertere Informationen zu den einzelnen Elementen innerhalb der Kategorien siehe [[Workflowelemente>>\|\|anchor="sec_elements"]].
70.2	89
	90
46.6	91	{{id name="sec_component_element_properties"/}}
45.2	92
43.1	93	=== Elementeingenschaften ===
19.1	94
73.1	95	Abhängig vom [[Workflowelement>>\|\|anchor="sec_elements"]], welches gerade im [[Arbeitsbereich>>\|\|anchor="sec_component_main"]] ausgewählt ist, ändert sich der Inhalt der //Elementeigenschaften//, welche rechts neben dem Arbeitsbereich dargestellt werden. In den Elementeigenschaften sind sämtliche Parameter eines Elements konfigurierbar. So kann hier bspw. in der Aktion [[E-Mail>>doc:Actions.EMail.WebHome]] der Absender, Empfänger, Betreff, Inhalt etc. definiert werden. Wenn die Elementeigenschaften nicht nötig sind, können diese auch über das Pfeil-Symbol am linken Rand der Elementeigenschaften eingeklappt werden.
	96
46.6	97	{{id name="sec_component_tool_bar"/}}
45.2	98
43.1	99	=== Werkzeugleiste ===
28.1	100
58.8	101	* Speichern
58.10	102	{{id name="sec_component_tool_bar_validate"/}}
58.8	103	* Validieren
	104	* Ansichtsoptionen
	105	* Mehr...
	106	* Öffnen/Vorschau
	107
46.6	108	{{id name="sec_component_status_bar"/}}
45.2	109
43.1	110	=== Statusleiste ===
19.1	111
58.9	112	* Navigation
	113	* formularinformationen
	114
44.2	115	{{id name="sec_elements"/}}
45.2	116
44.2	117	== Workflowelemente ==
	118
	119	{{id name="sec_elements_events"/}}
45.2	120
70.2	121	=== Buttons & Ereignisse ===
44.2	122
70.2	123	Eregnisse bilden den Beginn von Arbeitsketten und können abhängig vom Typ auf unterschiedliche Art& Weise ausgelöst werden. Eine besondere, weil häufig verwendete, Form von Ereignissen sind [[Buttonereignisse>>\|\|anchor="sec_elements_events_buttons"]]. Diese Ereignisse sind daher
70.1	124
70.2	125	{{id name="sec_elements_events_buttons"/}}
73.1	126
70.2	127	==== Buttonergnisse ====
	128
	129	{{id name="sec_elements_events_other"/}}
73.1	130
70.1	131	==== weitere Ereignisse ====
	132
44.2	133	{{id name="sec_elements_actions"/}}
45.2	134
44.2	135	=== Aktionen ===
	136
70.1	137	{{id name="sec_elements_flow_control"/}}
	138
	139	=== Steuerung ===
	140
45.1	141	{{id name="sec_elements_endpoints"/}}
45.2	142
44.2	143	=== Endpunkte ===
	144
70.1	145	==== Status-Endpunkte ====
73.1	146
70.1	147	==== Aktions-Endpunkte ====
58.11	148
72.1	149	{{id name="sec_differences_old_workflow"/}}
73.1	150
72.1	151	== Unterschiede zur alten Status- & Aktionsverarbeitung ==
	152
	153	Sowohl im neuen Workflow als auch in der alten [[Status- & Aktionsverarbeitung>>doc:Formcycle.Designer.Workflow.LegacyWorkflow.WebHome]] gibt es Status. Vorgänge können in beiden Workflows einen Status annehmen. In der alten Status- & Aktionsverarbeitung werden Verarbeitungsketten in den einzelnen Status definiert. Zustandsabhängige Entscheidungen können über Bedingungen an den Aktionen realisiert werden, insbesondere unter Verwendung der Aktion //Statuswechsel//. Verarbeitungsketten werden also über Status ausgelöst. Im neuen Workflow sind Status lediglich Endpunkte. Status beschreiben den Zustand eines Vorgangs und definieren, wer auf disesen Zugriff hat, mehr nicht. Verarbeitungsketten werden über Ereignisse und nicht mehr Status ausgelöst.
	154
2.1	155	== Grobe Beschreibung ==
	156
	157	* Grundkonzepte
	158	* alter und neuer Workflow ansprechen
	159
	160	Verlinkung auf alten Workflow (Der alte Workflow wird in einer Unterkategorie positioniert und enthält dort alle bisherigen Unterseiten unverändert.)
	161
2.2	162	== Beschreibung des neuen Workflows ==
2.1	163
2.3	164	* Verarbeitungsketten ... jeweils ein Ereignis auslösend
	165	* Ereignisse grob beschreiben und auf Unterseite verlinken
2.1	166	* Aktionen grob Möglichkeiten beschreiben und auf Aktionen verlinken
	167	* Bedingungen und Fehlerelemente grob beschreiben und auf Aktionen verlinken
2.3	168	* Endpunkte grob beschreiben und auf Aktionen verlinken
58.4	169	* Funktionsweise der Status kurz erklären, evtl. auf Unterseiten verlinken. Erwähnen, dass Status jetzt auch versioniert sind.
	170	* Kopieren, Deaktivieren, Löschen-Icon an Ereignissen und Aktionen
	171	* Info-Icon (welches an jedem Ereignis / Aktion sich befindet) beschreiben: Enthält Beschreibung, Zusammenfassung der Konfiguration, Rückgabewerte mit Platzhaltern, mögliche auftretende Fehler (=> auf Platzhalter [$%LAST_ERROR%] [%$Aktion.ERROR_CODE%] etc. hinweisen und verlinken) sowie durch Daten, welche bei jedem Fehler zur Verfügung gestellt werden.
2.1	172
1.2	173	Direkt darunter kommen alle Elemente des Workflows
	174
2.1	175	Hinweise von Andre:
1.3	176
2.1	177	* 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.
	178	* Treffen mehrere Ereignisse zu, werden die entsprechenden Verarbeitungsketten der Reihe nach von links nach rechts ausgeführt.
	179	* 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.
	180	* Es gibt eine Validierung des gesamten Workflows. Formular wird offline geschaltet, wenn invalider Workflow gespeichert wird.
	181	* 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.
58.2	182	* 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.
58.3	183	** Die gleiche Logik greift auch im Platzhalterdialog bei den zu Verfügung stehenden Aktionsplatzhaltern.
58.4	184	* Referenziert eine Aktion auf Dateien einer vorigen Aktion, geht diese Referenz verloren, wenn die Aktion in eine andere Verarbeitungskette geschoben wird.
	185	* Umbenannt werden kann: Name der Verarbeitungskette und Ja/Nein-Label von Bedingungen durch Klick auf den Namen. Zudem kann durch Klick die Beschreibung geändert werden.
58.5	186	* Bei der Redo/Undo-Funktionalität werden alle Änderungen an der Struktur des Workflows berücksichtigt. Nicht berücksichtigt werden Änderungen rechts im Properties-Panel.
1.4	187
40.1	188	TODO auf Unterseiten:
1.4	189
2.1	190	* Aktionen des neuen WF sollten immer auch auf die alten verlinken und umgekehrt.
	191	* Bei den Aktionen sollte immer auch im ersten Satz stehen, in welcher Gruppe sie sind
	192	* 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.