Wiki source code of Workflows

Last modified by Jannis Klein on 2024/08/13 07:44

Show last authors
1 {{aagon.floatingbox/}}
2
3 Im Arbeitsbereich //Workflows// können Sie alle Workflow-Vorlagen verwalten sowie die Workflow-Engines und -Instanzen steuern.
4
5 {{aagon.infobox}}
6 Sollten Ihnen noch keine Workflow-Pakete und -Instanzen angezeigt werden, müssen Sie erst einmal [[Produkte installieren>>doc:AESB.19.Workspaces.Produkte.WebHome||anchor="#HProdukteinstallieren"]].
7 {{/aagon.infobox}}
8
9 Der Arbeitsbereich unterteilt sich in die Liste der Workflow-Vorlagen, die Liste der Workflow-Engines und -Instanzen sowie den Bereich mit Detailinformationen zu Ihrer jeweiligen Auswahl.
10
11 An dieser Stelle soll kurz der Unterschied zwischen Workflow-Vorlagen und Workflow-Instanzen erläutert werden: Bei einer Workflow-Vorlage handelt es sich in AESB um den Ablaufplan eines konkreten Workflows mit allen Variablen und Argumenten (z.B. Transformation von Daten eines Quell-Formats in ein bestimmtes Ziel-Format). Aus einer Workflow-Vorlage kann dann entweder eine Workflow-Instanz oder eine Ondemand-Workflow-Definition erzeugt werden. Eine Ondemand-Workflow-Definition gruppiert dabei eine gewisse Anzahl einzelner Ondemand-Workflow-Instanzen. Sowohl die Workflow-Instanzen als auch die Ondemand-Workflow-Definitionen werden von der sogenannten Workflow-Engine ausgeführt.
12
13 {{figure}}
14 (% style="text-align:center" %)
15 [[image:Übersicht_Workflow_Workspace.png||alt="Arbeitsbereich zur Workflow-Verwaltung"]]
16
17 {{figureCaption}}
18 Arbeitsbereich zur Workflow-Verwaltung
19 {{/figureCaption}}
20 {{/figure}}
21
22 Bedienen lässt sich der Workflow-Arbeitsbereich über die Buttons in der Ribbonleiste oder das Kontextmenü.
23
24 = Workflow-Vorlagen verwalten =
25
26 In der Liste der Workflow-Vorlagen sehen Sie das Workflow-Vorlagen-Repository mit allen verfügbaren Workflow-Instanzen und -Vorlagen, die Sie verwalten können. Diese können Sie nutzen, um Workflow-Engines und -Instanzen zu erstellen.
27
28 == Vorlagen-Repository verwalten ==
29
30 Bei Auswahl des Vorlagen-Repositorys oder eines Ordners stehen Ihnen folgende Funktionen zur Verfügung:
31
32 |=**Button**|=**Funktionen**
33 |Hinzufügen (Workflow-Vorlage)|Öffnet das Dialogfenster zum Erstellen einer neuen Workflow-Vorlage.
34 |Importieren (Workflow-Vorlage)|Öffnet das Datei-Verzeichnis zur Auswahl der Workflow-Vorlage (XAML-Datei), die importiert werden soll.
35 |Hinzufügen (Ordner)|Öffnet das Dialogfenster zum Erstellen eines neuen Vorlagenordners.
36 |Umbenennen (Ordner)|Öffnet das Dialogfenster zum Umbenennen des ausgewählten Vorlagenordners.
37 |Löschen (Ordner)|Löscht den ausgewählten Ordner (nur bei leeren Ordnern möglich).
38 |Handbuch|Öffnet die Webseite [[https:~~/~~/doc.aagon.com/bin/view/AESB>>https://doc.aagon.com/bin/view/AESB]] im Standard-Browser.
39
40 == Workflow-Vorlagen verwalten ==
41
42 Bei Auswahl einer Workflow-Vorlage stehen Ihnen folgende Funktionen zur Verfügung:
43
44 |=**Funktion**|=**Bedeutung**
45 |Hinzufügen (Workflow-Instanz)|Öffnet das Dialogfenster zum Erstellen einer neuen Workflow-Instanz.
46 |Hinzufügen (Ondemand-Definition)|Öffnet das Dialogfenster zum Erstellen einer neuen Ondemand-Definition.
47 |Im Workflow-Editor bearbeiten (Workflow-Vorlage)|Startet die Bearbeitung der ausgewählten Workflow-Vorlage im Workflow-Editor. Detaillierte Informationen zur Nutzung sind im Abschnitt Workflow-Editor zu finden.
48 |Löschen (Workflow-Vorlage)|Löscht die ausgewählte Workflow-Vorlage.
49 |Umbenennen (Workflow-Vorlage)|Öffnet das Dialogfenster zum Umbenennen der ausgewählten Workflow-Vorlage.
50 |Duplizieren (Workflow-Vorlage)|Erstellt eine Kopie der ausgewählten Workflow-Vorlage.
51 |Exportieren (Workflow-Vorlage)|Öffnet das Datei-Verzeichnis zur Auswahl des Ordners, in den die Workflow-Vorlage als XAML-Datei exportiert werden soll.
52 |Historie leeren (Workflow-Vorlage)|Löscht die Änderungshistorie für die ausgewählte Workflow-Vorlage.
53
54 = Workflow-Änderungshistorie verwalten =
55
56 Die Änderungshistorie einer Workflow-Vorlage ist ein detailliertes Verzeichnis, in dem alle Änderungen an der Workflow-Vorlage dokumentiert werden. Dort können Sie sehen, wann eine Änderung durchgeführt wurde, welcher Benutzer die Änderung durchgeführt hat und welche Einstellungen oder Konfigurationen konkret geändert wurden.
57
58 In der nachfolgenden Grafik sehen Sie eine beispielhafte Änderung der Metadaten, bei welcher der Name und die Beschreibungen auf englischer und deutscher Sprache verändert wurden.
59
60 {{figure}}
61 (% style="text-align:center" %)
62 [[image:Workflow_Historie.png||alt="Beispiel einer Änderungshistorie" height="288" width="487"]]
63
64 {{figureCaption}}
65 Beispiel einer Änderungshistorie
66 {{/figureCaption}}
67 {{/figure}}
68
69 Sie haben mit den Buttons oben rechts im Detailfenster der Historie bei jedem Eintrag die Möglichkeit, sich die alte Workflow-Vorlage im Workflow-Editor anzeigen zu lassen, die Workflow-Vorlage auf einen alten Stand zurückzusetzen oder den ausgewählten Eintrag einzeln aus der Historie zu löschen.
70
71 = Workflow-Instanz oder Ondemand-Definition aus einer Workflow-Vorlage erstellen =
72
73 Aus einer Workflow-Vorlage lässt sich sowohl eine Workflow-Instanz als auch die Ondemand-Workflow-Definition erstellen, welche die einzelnen Ondemand-Workflow-Instanzen gruppiert. Der Unterschied zwischen diesen beiden Workflow-Arten liegt in ihrer Anwendung bzw. ihrer Laufzeit:
74
75 * Workflow-Instanzen sind auf eine lange bzw. endlose Laufzeit ausgelegt. Sie können über die AESB Console gestartet und gestoppt werden. Daher sind sie in der Liste unter einer Workflow-Engine einzeln aufgeführt.
76 * Ondemand-Workflow-Instanzen sind auf eine kurze bzw. begrenzte Laufzeit ausgelegt. Sie werden automatisch von Anwendungen gestartet und beenden sich anschließend selber. Daher werden sie als Ondemand-Definition unter einer Workflow-Engine zusammengefasst, die sich grundsätzlich nur aktivieren bzw. deaktivieren lassen.
77
78 Für die Erstellung einer Workflow-Instanz oder einer Ondemand-Workflow-Definition gibt es mehrere Möglichkeiten.
79
80 * __**EMPFOHLEN:**__ Ziehen Sie die Workflow-Vorlage, die als Konfigurationsvorlage verwendet werden soll, per Drag-and-Drop zu der Workflow-Engine, auf der der Workflow laufen soll. Wählen Sie anschließend aus, ob aus der Workflow-Vorlage eine Workflow-Instanz oder eine Ondemand-Definition erstellt werden soll.
81
82 {{figure}}
83 (% style="text-align:center" %)
84 [[image:Workflow-Instanz_Auswahl.png||alt="Auswahl bei der Erstellung einer Workflow-Instanz"]]
85
86 {{figureCaption}}
87 Auswahl bei der Erstellung einer Workflow-Instanz
88 {{/figureCaption}}
89 {{/figure}}
90
91 Alternativ können Sie eine Workflow-Instanz oder Ondemand-Definition auch über folgende Wege erstellen:
92
93 * Wählen Sie aus dem Workflow-Vorlagen-Repository die Workflow-Vorlage aus, die als Konfigurationsvorlage verwendet werden soll. Klicken Sie dann in der Ribbonleiste entweder im Abschnitt //Workflow-Instanz// oder im Abschnitt //Ondemand-Definition //auf den Button //Hinzufügen.//
94 * Wählen Sie aus der Liste der Workflow-Engines die Workflow-Engine aus, auf der der Workflow laufen soll. Klicken Sie dann in der Ribbonleiste entweder im Abschnitt //Workflow-Instanz// oder im Abschnitt //Ondemand-Definition //auf den Button //Hinzufügen.//
95
96 Nun öffnet sich das Dialogfenster zum Erstellen einer neuen Workflow-Instanz oder einer neuen Ondemand-Definition.
97
98 {{aagon.infobox}}
99 Abhängig davon, welche der genannten Möglichkeiten Sie gewählt haben, sind die Angaben zur Workflow-Engine und der Vorlage zur Erstellung der Workflow-Instanz bereits vorhanden.
100 {{/aagon.infobox}}
101
102 == Workflow-Instanz erstellen ==
103
104 Geben Sie im nächsten Schritt in den Feldern die benötigten Angaben für die Workflow-Instanz an.
105
106 |**Feld**|**Benötigte Angabe**
107 |Workflow-Engine|Workflow-Engine, auf der die Workflow-Instanz laufen soll.
108 |Vorlage|Konfigurationsvorlage, deren Einstellungen für die Workflow-Instanz verwendet werden sollen.
109 |Name der Instanz|Frei wählbarer Name, mit dem die Workflow-Instanz in der Liste angezeigt wird.{{aagon.infobox}}Im Namen der Workflow-Instanz dürfen keine Leerzeichen enthalten sein.{{/aagon.infobox}}
110 |Starttyp|Einstellung bestimmt, ob die Workflow-Instanz bei einem Supervisor- oder System-Neustart A//utomatisch// auch neustartet oder //Manuell //gestartet werden muss.
111 |Nach dem Speichern starten|Checkbox bestimmt, ob die Workflow-Instanz nach dem Speichern und Erstellen direkt gestartet werden soll oder nicht (nur möglich, wenn Workflow-Engine auch gestartet ist).
112 |Argumente|Liste aller erforderlichen und optionalen Argumente des Workflows. Für erforderliche Argumente muss ein Wert vergeben werden. Optionale Argumente können aktiviert werden und einen individuellen Wert erhalten. Wird ihnen kein Wert zugewiesen, wird ggf. der in den Workflow-Eigenschaften vergebene Standard-Wert verwendet.
113
114 == Ondemand-Definition erstellen ==
115
116 Geben Sie im nächsten Schritt in den Feldern die benötigten Angaben für die Ondemand-Definition an.
117
118 {{figure}}
119 (% style="text-align:center" %)
120 [[image:Workflow-Instanz_erstellen.png||alt="Erstellung einer neuen Ondemand-Definition"]]
121
122 {{figureCaption}}
123 Fenster zur beispielhaften Erstellung einer neuen Ondemand-Definition
124 {{/figureCaption}}
125 {{/figure}}
126
127 |(% style="width:135px" %)**Feld**|(% style="width:941px" %)**Benötigte Angabe**
128 |(% style="width:135px" %)Workflow-Engine|(% style="width:941px" %)Workflow-Engine, auf der die Ondemand-Definition laufen soll.
129 |(% style="width:135px" %)Vorlage|(% style="width:941px" %)Konfigurationsvorlage, deren Einstellungen für die Ondemand-Definition verwendet werden sollen.
130 |(% style="width:135px" %)Name|(% style="width:941px" %)Frei wählbarer Name, mit dem die Ondemand-Definition in der Liste angezeigt wird.{{aagon.infobox}}Im Namen der Ondemand-Definition dürfen keine Leerzeichen enthalten sein.{{/aagon.infobox}}
131 |(% style="width:135px" %)Aktivieren|(% style="width:941px" %)Checkbox bestimmt, ob die Ondemand-Definition nach dem Speichern und Erstellen direkt aktiviert werden soll.
132 |(% style="width:135px" %)Argumente|(% style="width:941px" %)Liste aller erforderlichen und optionalen Argumente des Workflows. Für erforderliche Argumente muss ein Wert vergeben werden. Optionale Argumente können aktiviert werden und einen individuellen Wert erhalten. Wenn ihnen kein individueller Wert zugewiesen wird, wird der Standard-Wert verwendet. Dieser Wert kann auch undefiniert sein, sofern in den Workflow-Eigenschaften kein Wert vergeben wurde.
133
134 = Workflow-Engines und -Instanzen steuern =
135
136 In der Liste der Workflow-Engines und -Instanzen werden Ihnen alle vorhandenen Workflow-Engines mit ihren untergeordneten Workflow-Instanzen und Ondemand-Definitionen angezeigt, die Sie steuern können. Die Steuerung ist über die Ribbonleiste oder das Kontextmenü möglich.
137
138 == Workflow-Engine steuern ==
139
140 Bei Auswahl einer Workflow-Engine haben Sie folgende Möglichkeiten:
141
142 |**Funktion**|**Bedeutung**
143 |Starten (Alle Workflow-Instanzen)|Startet alle nicht aktiven Workflow-Instanzen, die der ausgewählten Workflow-Engine untergeordnet sind.
144 |Stoppen (Alle Workflow -Instanzen)|Stoppt alle aktiven Workflow-Instanzen, die der ausgewählten Workflow-Engine untergeordnet sind.
145 |Neustarten (Alle Workflow -Instanzen)|Beendet alle Workflow-Instanzen, die der ausgewählten Workflow-Engine untergeordnet sind und startet sie anschließend neu.
146 |Hinzufügen (Workflow-Instanz)|Öffnet das Dialogfenster zum Erstellen einer neuen Workflow-Instanz.
147 |Aktivieren (Ondemand-Definitionen)|Aktiviert alle nicht aktiven Ondemand-Definitionen, die der ausgewählten Workflow-Engine untergeordnet sind.
148 |Deaktivieren (Ondemand-Definitionen)|Deaktiviert alle aktiven Ondemand-Definitionen, die der ausgewählten Workflow-Engine untergeordnet sind.
149 |Hinzufügen (Ondemand-Definition)|Öffnet das Dialogfenster zum Erstellen einer neuen Ondemand-Definition.
150
151 {{figure}}
152 (% style="text-align:center" %)
153 [[image:Workflow_Engines_steuern.png||alt="Workflow-Engine steuern"]]
154
155 {{figureCaption}}
156 Workflow-Engine steuern
157 {{/figureCaption}}
158 {{/figure}}
159
160 == Workflow-Instanz steuern ==
161
162 Bei Auswahl einer Workflow-Instanz stehen Ihnen folgende Funktionen zur Verfügung:
163
164 |**Funktion**|**Bedeutung**
165 |Starten|Startet die Workflow-Instanz.
166 |Stoppen|Stoppt die Workflow-Instanz.
167 |Neustarten|Beendet die Workflow-Instanz und startet sie anschließend neu.
168 |Bearbeiten|Startet den Bearbeitungsmodus zur Anpassung der verschiedenen Einstellungen für die Workflow-Instanz.{{aagon.infobox}}Wenn Änderungen am Namen vorgenommen werden, müssen ggf. auch die Routing-Einstellung in den zugehörigen Microservice-Vorlagen angepasst werden.{{/aagon.infobox}}
169 |Löschen|Löscht die ausgewählte Workflow-Instanz.
170 |Verschieben|Verschiebt die markierte Workflow-Instanz zu einer anderen Workflow-Engine (muss bereits vorhanden sein).
171
172 == Ondemand-Workflow-Definition steuern ==
173
174 |(% style="width:142px" %)**Funktion**|(% style="width:934px" %)**Bedeutung**
175 |(% style="width:142px" %)Stoppen (Alle Workflow-Instanzen)|(% style="width:934px" %)Stoppt alle aktiven Workflow-Instanzen, die der Workflow-Engine untergeordnet sind, in deren Verzeichnis Sie sich befinden.
176 |(% style="width:142px" %)Bearbeiten|(% style="width:934px" %)Startet den Bearbeitungsmodus zur Anpassung der verschiedenen Einstellungen für die Ondemand-Definition.{{aagon.infobox}}Wenn Änderungen am Namen vorgenommen werden, müssen ggf. auch die Routing-Einstellung in den zugehörigen Microservice-Vorlagen angepasst werden.{{/aagon.infobox}}
177 |(% style="width:142px" %)Löschen|Löscht die ausgewählte Ondemand-Definition.
178 |(% style="width:142px" %)Aktivieren/Deaktivieren|Aktiviert/deaktiviert die ausgewählte Ondemand-Definition.
179 |(% style="width:142px" %)Verschieben|Verschiebt die markierte Ondemand-Definition zu einer anderen Workflow-Engine (muss bereits vorhanden sein).
© Aagon GmbH 2025
Besuchen Sie unsere neue Aagon-Community