Durchsuchbare Dokumentation aufrufen | Zurück zur Dokumentationsübersicht
Navigation: Dokumentationen agorum core > agorum core für Entwickler > agorum core workflow 3.0
Workflows einrichten
Sie müssen Workflows einrichten, damit Benutzer Workflows verwenden können.
In agorum core workflow 3.0 richten Sie Ihre Workflows im Workflow-Editor ein und können die Workflows nach der Einrichtung jederzeit wieder bearbeiten.
Icons
Diese Icons begegnen Ihnen in agorum core, wenn Sie mit Workflows arbeiten und sie einrichten:
Workflow-Definition
Workflow-Instanz
Workflow-Prozess
Workflow-Token/UI
Workflow-Log
Workflow-Ordner
Die Funktionsweise eines Workflows
- Ein Workflow durchläuft mehrere Schritte.
- Ein Schritt wird als Knoten bezeichnet und als Box im Workflow-Editor visuell dargestellt.
- Ein Workflow besteht aus einem Eingangsknoten. Der Eingangsknoten definiert, wo der Workflow startet.
- Ein Knoten (ausgenommen Eingangsknoten) besitzt einen Eingang (Inlet) und Ausgang (Outlet) oder mehrere Ein- und Ausgänge. Über einen Eingang steuert das System den Knoten an, über einen Ausgang steuert der Knoten hingegen weitere Knoten im Workflow an.
Wenn Sie agorum core herunterfahren
- Fahren Sie agorum core herunter, während ein Workflow aktiv ist, gehen Workflowschritte, die auf eine Eingabe oder Aktion warten (etwa ui-Knoten, wait-Knoten) nicht verloren, sondern stoppen.
- Eingegebene Daten in einer grafischen Oberfläche zu diesem Zeitpunkt speichert das System nicht.
- Fahren Sie agorum core wieder hoch, kann der Benutzer mit der Eingabe in der Oberfläche fortfahren.
- Alle anderen Workflowschritte aktivieren sich erst wieder nach dem Hochfahren.
Hinweise:
-
Erstellen Sie Ein- und Ausgänge, geben Sie diesen einen anderen Namen als Default. Dieser Name ist durch das System vorbelegt.
-
Alle In- und Outlets der Knoten sind case-sensitive. Definieren Sie etwa ein Outlet namens Ausgang, müssen Sie etwa in Skripts ebenfalls das Outlet Ausgang verwenden.
Damit Benutzer einen Workflow verwenden können, müssen Sie:
- einen Workflow erstellen
- einen Knoten hinzufügen
- die Knoten miteinander verbinden
- einen Knoten als Eingangsknoten definieren
- den Workflow deployen
Einen Workflow erstellen
- Öffnen Sie links in der Seitenleiste Weitere Apps und dann workflow editor.
Ergebnis: Eine Übersicht aller bereits vorhandenen Workflows erscheint. - Klicken Sie auf Neuen Workflow erstellen.
- Wählen Sie eine Konfiguration.
- Vergeben Sie einen Namen für den neuen Workflow.
- Klicken Sie auf Erstellen.
Ergebnis: Der Workflow-Editor öffnet sich.
Parameter eines Workflows
Die Parameter eines Workflows befinden sich links im Abschnitt Einstellungen.
| Parameter | Beschreibung | Hinweis |
|---|---|---|
| In mehrere Sprachen übersetzen | Legt automatisch Übersetzungsdateien an und speichert die im Editor eingegebenen Texte in die Dateien. | Die Sprache ändern Sie über Aktionen > Sprache für die Übersetzung wechseln. |
| Kann direkt gestartet werden | Ermöglicht den Start eines Workflow über die Kopfleiste. | Benutzer muss zusätzlich in folgendem ACL gesetzt sein: acw > ACL_acworkflow_start |
| Benötigt mindestens einen Anhang | Workflow benötigt mindestens einen Anhang (beliebiges Dokument oder beliebigen Ordner), damit Sie ihn über das Kontextmenü starten können. Sie können über den smart assistant konfigurator steuern, dass Benutzer nur bestimmte Workflows oder Dokumententypen starten dürfen. |
Benutzer muss zusätzlich in folgendem ACL gesetzt sein: acw > ACL_acworkflow_start Workflow erscheint im Kontextmenü nicht zur Auswahl, wenn der Anhang fehlt. |
| Recht (ACL) auswählen | Erzeugt automatisch die angezeigte ACL, wenn Sie den Workflow erstellen. Mit der ACL können Sie Benutzern und Benutzergruppen Zugriff auf diesen Workflow geben. |
Für Informationen zu diesem Parameter siehe Einzelne Workflows berechtigen. |
Im Workflow-Editor navigieren
| Aktion | Taste |
|---|---|
| Bewegen | Linke Maustaste gedrückt halten und bewegen. |
| Zoomen | Mausrad scrollen. |
| Knoten markieren | Rechte Maustaste über Knoten betätigen. |
| Knoten kopieren | Knoten mit linker Maustaste markieren (oder Auswahlrahmen ziehen) und rechte Maustaste betätigen. |
| Knoten einfügen | Rechte Maustaste an leerer Stelle betätigen. Beim Einfügen übernimmt der Editor vorhandene Konfigurationen und Parameter als auch zugehörige Skripte, Endpunkte und Verbindungen zwischen den Knoten. |
Einen Knoten hinzufügen
- Klicken Sie auf
.
- Wählen Sie einen Knoten mit
.
Für eine Beschreibung aller vorhandenen Knoten siehe Übersicht vorhandener Knoten. - Doppelklicken Sie in der freien Fläche des Editors, um den Knoten hinzuzufügen.
Das System setzt den ersten Knoten als Eingangsknoten. - Vergeben Sie einen Namen für den Knoten und optional einen Anzeigenamen in den gleichnamigen Feldern.
- Überprüfen Sie die verfügbaren Parameter und geben Sie die gewünschten Einstellungen an.
Tipps:
-
Bauen Sie den Workflowfluss wie ein Diagramm auf, d. h. ordnen Sie die Knoten eines Workflows von oben nach unten an.
-
Aus optischen Gründen können in den Dokumentationen Beispiele, in denen die Knoten von links nach rechts angeordnet sind, auftauchen.
Die Knoten miteinander verbinden
- Bewegen Sie die Maus über den Ausgang (
) eines Knotens. - Ziehen Sie eine Verbindung zum Eingang (
) eines Knotens.
Die Verbindung zwischen Knoten lösen
- Klicken Sie den Ausgang eines Knotens an.
- Ziehen Sie ihn mit gedrückter linker Maustaste in die freie Fläche des Workflow-Editors.
Einen Knoten als Eingangsknoten definieren
- Klicken Sie auf eine freie Fläche im Workflow-Editor.
- Wählen Sie einen Knoten als Eingangsknoten.
Einen Knoten bearbeiten
- Markieren Sie im angezeigten Workflow den Knoten, den Sie bearbeiten möchten.
Ergebnis: Die Einstellungen des Knotens werden angezeigt. Im Tab Allgemein sehen Sie die Schaltfläche Knoten bearbeiten, wenn der Knoten bearbeitbar bzw. ein Subworkflow ist. - Klicken Sie auf die Schaltfläche Knoten bearbeiten.
Ergebnis: Die Workflow-Definition des ausgewählten Knotens wird in einem neuen Fenster geöffnet. Sie können die Einstellungen prüfen oder bearbeiten.
Einen Knoten löschen
- Markieren Sie im angezeigten Workflow den Knoten, den Sie bearbeiten möchten.
Ergebnis: Die Einstellungen des Knoten werden angezeigt. Im Tab Allgemein sehen Sie die Schaltfläche Knoten löschen. - Klicken Sie auf die Schaltfläche Knoten löschen.
- Bestätigen Sie die Sicherheitsfrage, ob Sie den Knoten wirklich löschen wollen, mit Ja.
Ergebnis: Der Knoten wird aus dem Workflow gelöscht. Sie können den Knoten über die Toolbox erneut hinzufügen und neu einrichten.
Den Workflow deployen
Sie müssen den Workflow produktiv schalten, damit andere Benutzer oder Module den erstellten Workflow verwenden können.
- Klicken Sie im Workflow-Editor oben in der Aktionsleiste auf Speichern.
- Klicken Sie auf Ausführen, um den Workflow zu testen und Fehler zu vermeiden.
Ergebnis: Die Prozessübersicht öffnet sich. - Klicken Sie auf Workflow deployen, wenn der Test erfolgreich war.
Ergebnis: Sie können den Workflow jetzt produktiv einsetzen.
Sie können außerdem:
- Subworkflows einrichten, die als Knoten in einem anderen Workflow eingebunden werden
- einen vorhandenen Workflow über Aktionen > Duplizieren vervielfältigen
- einen Workflow und dessen Daten im Protokoll (Log) prüfen
Einen Workflow in verschiedenen Versionen deployen
Fügen Sie in einem Workflow Knoten hinzu oder entfernen Sie diese, oder ändern Sie Skripte innerhalb der Knoten, erhöhen Sie mit der Änderung die Version eines Workflows, damit die alte Version noch lauffähig und intakt bleibt.
- Benutzer können mit der alten Version des Workflows weiterarbeiten, ohne dass Fehlermeldungen entstehen.
- Das System verwendet die neue Version des Workflows erst, sobald ein Benutzer den Workflow über die Kopfleiste oder das Kontextmenü startet.
- Führen Sie die Änderungen an Ihrem Workflow durch.
- Erhöhen Sie die Version Ihres Workflows mit
. - Speichern und deployen Sie den Workflow.
Hinweis: Duplizieren Sie einen Workflow, setzt sich die Version des kopierten Workflows auf 1 zurück.
Einen Workflow in der Prozessübersicht einsehen und testen
In der Prozessübersicht:
- sehen Sie alle Workflows, die aktuell produktiv sind
- können Sie Workflows testen
Die Oberfläche ist identisch mit der Oberfläche, die ein Benutzer sieht, wenn er mit Workflows arbeitet. Im Gegensatz zur Ansicht, die ein Benutzer sieht, verschwindet jedoch ein Workflow nicht aus der Prozessübersicht, wenn der Workflow einen bestimmten Prozessschritt / Knoten erreicht. Als Administrator können Sie stets alle Workflows in jedem Prozessschritt einsehen.
Tipp: Sie können den Prozessschritt in der Prozessübersicht beenden, wenn Sie einen delay- oder wait-Knoten verwenden, indem Sie den Prozessschritt markieren, die rechte Maustaste anklicken und im Kontextmenü Trigger Timer verwenden.