Änderungen von Dokument Workflow

Von 78.1 nach 78.2 Von 85.5 nach 86.1

Von Version 78.2

bearbeitet von nlo
am 28.07.2021, 15:26

Änderungskommentar: Es gibt keinen Kommentar für diese Version

Auf Version 85.5

bearbeitet von gru
am 29.07.2021, 10:55

Änderungskommentar: Es gibt keinen Kommentar für diese Version

Rohform
Im Layout

Zusammenfassung

Seiteneigenschaften (2 geändert, 0 hinzugefügt, 0 gelöscht)

Details

Seiteneigenschaften

Dokument-Autor

@@ -1,1 +1,1 @@
--XWiki.nlo
++XWiki.gru

Inhalt

@@ -6,7 +6,8 @@
  {{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}}
--{{id name="fig_workflow_example_submit"/}}
++{{id name="
++"/}}
  {{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}}
  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.
@@ -18,7 +18,7 @@
  == Workflowgraph ==
  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]]
--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. Treffen mehrere Ereignisse zu, werden die entsprechenden Verarbeitungsketten der Reihe nach von links nach rechts ausgeführt.
++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. Beispielsweise 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 zum Beispiel abhänging von den Formulareingaben aufsplitten. Diese Abzweigungen werden über [[Bedingungen>>doc:Formcycle.Designer.Workflow.FlowControl.Condition.WebHome]] realisiert. So kann beispielsweise der Workflow so konfiguriert werden, dass eine E-Mail nur dann versendet wird, wenn der Antragsteller auch eine E-Mail angegeben hat. Wenn dies nicht der Fall ist, kann zum Beispiel 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 Ausfü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. Treffen mehrere Ereignisse gleichzeitig zu, werden die entsprechenden Verarbeitungsketten der Reihe nach von links nach rechts ausgeführt.
  {{id name="sec_graph_default"/}}
@@ -37,9 +37,9 @@
  == Oberfläche ==
--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.
++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. Allgemeine Informationen zur Werkzeugleiste sind [[hier>>doc:Formcycle.Designer.WebHome]] zu finden.
--Wird eine Workflowkonfiguration geändert, aber nicht gespeichert und später wird der Workflowdesigner für diesen Workflow neu geladen, erscheint ein Dialog, mit dem der alte Stand wiederherstellgt werden kann. Die ungespeicherte Workflowkonfiguration wird in den [[Arbeitsbereich>>||anchor="sec_component_main"]] geladen. Diese ist allerdings noch nicht gespeichert. Erst wenn der Nutzer auf //Speichern// klickt wird diese Workflowkonfiguration gespeichert.
++Wird eine Workflowkonfiguration geändert, aber nicht gespeichert und später wird der Workflowdesigner für diesen Workflow neu geladen, erscheint ein Dialog, mit dem der alte Stand wiederhergestellt werden kann. Die ungespeicherte Workflowkonfiguration wird in den [[Arbeitsbereich>>||anchor="sec_component_main"]] geladen. Diese ist allerdings noch nicht gespeichert. Erst wenn der Nutzer auf //Speichern// klickt, wird diese Workflowkonfiguration gespeichert.
  {{id name="sec_component_main"/}}
@@ -48,7 +48,7 @@
  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:
  * 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.
--* 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.
++* 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.
  In beiden Fällen entsteht eine neue Verarbeitungskette mit dem gewählten Ereignis. Verarbeitungsketten können mit einem Klick auf deren Namen umbenannt werden. Unterhalb des Namens kann diesen auch eine Beschreibung hinzugefügt werden.
@@ -55,9 +55,10 @@
  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:
  * 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.
--* 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.
++* 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.
--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.
++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.
++Die Ja/Nein-Label von Bedingungen können umbenannt werden, indem man auf diese klickt.
  ==== Elemente des Workflowgraphen ====
@@ -144,62 +144,66 @@
  === Buttons & Ereignisse ===
--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
++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 haben daher ihre eigen Kategorie in der [[Elementauswahl>>||anchor="sec_component_element_selection"]].
  {{id name="sec_elements_events_buttons"/}}
  ==== Buttonergnisse ====
++Für jeden [[Button>>doc:Formcycle.Designer.Form.FormElements.Button.WebHome]] im Formular, der zum //Absenden// oder //Speichern// verwendet wird, gibt es ein entsprechendes Ereignis in der [[Elementauswahl>>||anchor="sec_component_element_selection"]]. Diese Buttonereignisse können dann ganz einfach in den Workflowgraphen gezogen werden. Somit kann für jeden Button eine eigene Verarbeitungskette definiert werden. Weitere Informationen zu Buttonereignissen sind [[hier>>doc:Formcycle.Designer.Workflow.Events.SubmitButton.WebHome]] und [[hier>>doc:Formcycle.Designer.Workflow.Events.SubmitButtonAdvanced.WebHome]] zu finden.
++
  {{id name="sec_elements_events_other"/}}
--==== weitere Ereignisse ====
++==== Weitere Ereignisse ====
--{{id name="sec_elements_actions"/}}
++Neben den Buttonereignissen gibt es noch folgende Ereignisse:
--=== Aktionen ===
++; [[Benutzerdefinierte Ereignisse>>doc:Formcycle.Designer.Workflow.Events.Custom.WebHome]]
++: Ein benutzerdefiniertes Ereignis tritt nicht automatisch ein, sondern muss im Workflow ausgelöst werden.
--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.
++; [[Datum und Uhrzeit>>doc:Formcycle.Designer.Workflow.Events.DateAndTime.WebHome]]
++: Dieses Ereignis tritt ein, sobald ein benutzerdefinierter fester oder berechneter Zeitpunkt eintritt.
--* Die gleiche Logik greift auch im Platzhalterdialog bei den zu Verfügung stehenden Aktionsplatzhaltern.
++; [[Double-Opt-In bestätigen>>doc:Formcycle.Designer.Workflow.Events.DoubleOptInConfirmed.WebHome]]
++: Sobald ein Nutzer auf einen vorher generierten Double-Opt-In Link klickt und damit den Double-Opt-In Prozess bestätigt, tritt dieses Ereignis ein.
--Referenziert eine Aktion auf Dateien einer vorigen Aktion, geht diese Referenz verloren, wenn die Aktion in eine andere Verarbeitungskette geschoben wird.
++; [[Einladung fehlgeschlagen>>doc:Formcycle.Designer.Workflow.Events.InvitationFailed.WebHome]]
++: Tritt ein, wenn beim Versenden einer Einladungsmail ein Fehler auftritt.
--{{id name="sec_elements_flow_control"/}}
++; [[Einladung versendet>>doc:Formcycle.Designer.Workflow.Events.InvitationSent.WebHome]]
++: Tritt ein, wenn eine Einladungsmail zu einem Formular versandt wurde.
--=== Steuerung ===
++; [[Nach Statuswechsel>>doc:Formcycle.Designer.Workflow.Events.AfterStateChange.WebHome]]
++: Dieses Ereignis tritt einmalig ein, nachdem der Vorgang nach einem Statuswechsel für eine gewisse Zeit in einem bestimmten Status verweilt hat.
--Ja/Nein-Label von Bedingungen können umbenannt werden.
++; [[Workflow-Fehler>>doc:Formcycle.Designer.Workflow.Events.WorkflowError.WebHome]]
++: Dieses Ereignis tritt ein, sobald im Workflow an irgendeiner Stelle ein unbehandelter Fehler auftritt.
--{{id name="sec_elements_endpoints"/}}
++{{id name="sec_elements_actions"/}}
--=== Endpunkte ===
++=== Aktionen ===
--==== Status-Endpunkte ====
++Eine Liste sämtlicher Workflowaktionen ist [[hier>>doc:Formcycle.Designer.Workflow.Actions.WebHome]] zu finden.
--==== Aktions-Endpunkte ====
++{{id name="sec_elements_flow_control"/}}
--{{id name="sec_differences_old_workflow"/}}
++=== Steuerung ===
--== Unterschiede zur alten Status- & Aktionsverarbeitung ==
++Eine Liste sämtlicher Steuerungselemente ist [[hier>>doc:Formcycle.Designer.Workflow.FlowControl.WebHome]] zu finden.
--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.
++{{id name="sec_elements_endpoints"/}}
++=== Status ===
--== Beschreibung des neuen Workflows ==
++Status beschreiben den Zustand eines Vorgangs und definieren, wer auf disesen Zugriff hat. Weitere Information zu Status sind [[hier>>doc:Formcycle.Designer.Workflow.States.WebHome]] zu finden.
--* Verarbeitungsketten ... jeweils ein Ereignis auslösend
--* Ereignisse grob beschreiben und auf Unterseite verlinken
--* Aktionen grob Möglichkeiten beschreiben und auf Aktionen verlinken
--* Bedingungen und Fehlerelemente grob beschreiben und auf Aktionen verlinken
--* Endpunkte grob beschreiben und auf Aktionen verlinken
--* Funktionsweise der Status kurz erklären, evtl. auf Unterseiten verlinken. Erwähnen, dass Status jetzt auch versioniert sind.
--* 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.
++{{id name="sec_differences_old_workflow"/}}
--Hinweise von Andre:
++== Unterschiede zur alten Status- und  Aktionsverarbeitung ==
--* 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.
++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- und 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 über Status ausgelöst. Zudem sind die Status des neuen Workflows mit der Formularversion versioniert, d.h. jede Formularversion kann unterschiedliche Status besitzen. Der Status //Eingegangen// ist der Standardstatus und kann weiterhin nicht gelöscht und auch nicht mehr umbenannt werden.
--TODO auf Unterseiten:
++== TODO auf Unterseiten ==
  * Aktionen des neuen WF sollten immer auch auf die alten verlinken und umgekehrt.
  * Bei den Aktionen sollte immer auch im ersten Satz stehen, in welcher Gruppe sie sind