Arbeitsabläufe

Ein Workflow kann auf verschiedene Arten ausgeführt werden, je nach Bedarf

  • Manuell ausgeführt

    Die einfachste Methode, einen Workflow auszuführen, ist direkt im Workflow-Builder selbst. Entweder kann der gesamte Workflow ausgeführt werden oder nur spezifische Schritte.

  • Geplant

    Workflows können so geplant werden, dass sie einmal zu einer bestimmten Zeit oder wiederkehrend zu bestimmten Zeiten ausgeführt werden, entweder über die Benutzeroberfläche oder mit einer CRON-ähnlichen Syntax.

  • Von einer Benachrichtigung aus

    Als Reaktion auf ein Ereignis in Avantra, zum Beispiel eine kritische Überprüfung, kann ein Workflow ausgelöst werden, um das Problem zu beheben.

  • Extern durch einen API-Aufruf

    Über unsere SOAP-API oder unsere Befehlszeilentools können Workflows extern in Avantra gestartet und überwacht werden.

Workflow-Varianten

Um die Ausführung eines Workflows mit Eingabeparametern zu vereinfachen, kann eine Variante erstellt werden, um vordefinierte Eingabeparameter eines Workflows zu speichern. Diese Varianten können dann bei der Ausführung eines Workflows ausgewählt werden.

Verfahren: Erstellen einer neuen Variante

  1. Wählen Sie Menü:Automation[Workflows] und doppelklicken Sie auf den Workflow, dem Sie eine Variante hinzufügen möchten.

  2. Öffnen Sie den Varianten-Tab und klicken Sie auf die Neu-Schaltfläche.

  3. Auf dem nächsten Bildschirm sollten Sie der Variante einen Namen geben, der bei der Ausführung des Workflows verwendet wird, und optional eine Beschreibung angeben, um den Zweck der Variante zu dokumentieren.

  4. Wählen Sie einen Kunden aus, für den diese Variante gilt. Die Auswahl hier beeinflusst die Benutzerberechtigungen zur Interaktion mit dieser Variante bei der Ausführung.

  5. Geben Sie maximal eine Variante mit der Option Standardkonfiguration an, um diese Variante als Standard für jede neue Ausführung festzulegen.

  6. Das Markieren einer Variante als Exportierbar ermöglicht es, die Workflow import and export-Funktion zu nutzen, um diese Variante für ein Backup oder die Verwendung in einem anderen Avantra zu exportieren.

  7. Geben Sie schließlich im Abschnitt Werte die Standardwerte für jeden Eingabeparameter des Workflows an.

  8. Klicken Sie auf die Anwenden-Schaltfläche.

Die Variante ist nun erstellt und kann bei der Ausführung verwendet oder Zeitplänen zugewiesen werden.

Varianten können nur mit eindeutigen Namen erstellt werden, um die Auswahl der richtigen Variante bei der Ausführung zu erleichtern.

Manuelle Ausführung

Das Starten eines Workflows ist in Avantra einfach.

Verfahren: Workflow ausführen

  1. Wählen Sie Menü:Automation[Workflows] und doppelklicken Sie auf den Workflow, den Sie ausführen möchten.

  2. Klicken Sie auf die Ausführen-Schaltfläche.

  3. Wenn der Workflow Eingabeparameter hat:

    • Wählen Sie eine der zuvor erstellten Variants aus, oder

    • Geben Sie die erforderlichen Werte für die Eingabeparameter ein.

  4. Klicken Sie auf die Starten-Schaltfläche.

Das Ausführungsprotokoll erscheint dann. Dieses Fenster kann überwacht oder geschlossen und später im Tab Ausführungen oder im Menü:Automation[Ausführungen] angesehen werden.

Workflows können auch teilweise ausgeführt werden, indem die auszuführenden Schritte ausgewählt und die Ausgewählte ausführen-Schaltfläche geklickt wird.

Bei der teilweisen Ausführung eines Workflows werden, wenn einer oder mehrere Eingaben eines ausgewählten Schrittes von nicht ausgewählten Schritten erzeugt werden, diese Schritt-Eingaben zu Workflow-Eingaben und müssen manuell ausgefüllt werden. Es sollte darauf geachtet werden, dass das richtige Format verwendet wird, um Fehler zu vermeiden.

Workflow-Zeitpläne

Zeitpläne sind eine großartige Möglichkeit, um sicherzustellen, dass regelmäßige Aufgaben automatisch ausgeführt werden. Ein Zeitplan kann entweder über unsere Benutzeroberfläche oder durch die Verwendung einer CRON-ähnlichen Syntax definiert werden, um mehr Kontrolle zu haben.

Verfahren: Einen Zeitplan erstellen

  1. Wählen Sie Menü:Automation[Workflows] und doppelklicken Sie auf den Workflow, den Sie planen möchten.

  2. Öffnen Sie den Zeitpläne-Tab und klicken Sie auf die Neu-Schaltfläche.

  3. Geben Sie im erscheinenden Popup dem Zeitplan einen eindeutigen Namen.

  4. Doppelklicken Sie auf die neu erstellte Zeile, um ihre Eigenschaften zu bearbeiten.

  5. Für Workflows, die Eingaben haben, wählen Sie aus der Liste der vorab erstellten Variants zur Verwendung bei der Ausführung.

  6. Klicken Sie auf die Zeitplan bearbeiten, um Zeitplanzeiten hinzuzufügen und eine Zeitzone einzugeben.

  7. Füllen Sie je nach Bedarf nur einen der Tabs im Dialog aus:

    • Nicht wiederkehrend

      Geben Sie Datum und Uhrzeit an, zu denen dieser Zeitplan in Zukunft ausgeführt wird. Der Zeitplan wird nicht wiederholt.

    • Wiederkehrend

      Geben Sie ein einfaches Wiederholungsmuster für tägliche, wöchentliche, monatliche oder jährliche Aktivitäten mit Start- und Enddatum an.

    • Erweitert

      Verwenden Sie den erweiterten Tab, um genauere oder komplexere Wiederholungsmuster in einer CRON-ähnlichen Syntax anzugeben. Geben Sie 5 Werte ein, die jeweils durch ein Leerzeichen getrennt sind, um das Muster zu bestimmen, z. B. 0 11 1 11 *. Weitere Erläuterungen zu dieser Syntax finden Sie unter unten.

  8. Optional klicken Sie auf die Info-Schaltfläche, um zu überprüfen, wie Avantra den Zeitplan versteht und wann der nächste Lauf stattfinden wird.

  9. Klicken Sie auf die OK-Schaltfläche, um den Zeitplandialog zu schließen.

  10. Bevor Sie auf die Anwenden-Schaltfläche klicken, stellen Sie sicher, dass der Zeitplan aktiv ist, indem Sie das Aktiv-Feld markieren.

Die Zeitplanzeile wird nun als aktiv in der Tabelle angezeigt.

Verständnis des CRON-ähnlichen Zeitplans

Beim Definieren eines Zeitplans ermöglicht der Erweitert-Tab die Spezifikation eines CRON-ähnlichen Zeitplans, z. B. 0 11 * * *. Hier gibt es fünf Werte in einer bestimmten Reihenfolge, die durch ein Leerzeichen getrennt sind, um den Zeitplan zu definieren. Diese Werte werden in der folgenden Tabelle erklärt:

Name

Erlaubte Werte

Erlaubte Sonderzeichen

Minute

0-59

, - * /

Stunde

0-23

, - * /

Tag des Monats

1-31

, - * /

Monat

1-12 oder JAN-DEZ

, - * /

Wochentag

0-7 (0 oder 7 ist Sonntag) oder MON-SO

, - * /

Daher bedeutet 0 11 * * *, dass ein Zeitplan jeden Tag um 11:00 Uhr ausgeführt wird. Hier sind einige weitere Beispiele:

Ausdruck

Bedeutung

0/5 * * * *

Alle 5 Minuten

0 * * * *

Jede Stunde

0,30 * * * *

Alle 30 Minuten

0 11 * * *

Jeden Tag um 11:00 Uhr

0 11 * * MON-FRI

Montag bis Freitag um 11:00 Uhr

0 9-17 * * MON-FRI

Jede Stunde von 9:00 bis 17:00 Uhr von Montag bis Freitag

0 11 1/5 * *

11:00 Uhr alle 5 Tage, beginnend am ersten Tag des Monats

Verwenden Sie immer die Info-Schaltfläche im Zeitplan-Fenster, um den eingegebenen Ausdruck zu validieren.

Überwachung von Workflows

Wenn ein Workflow ausgeführt wird, erscheint ein Dialog mit dem Status des Workflows, welcher Schritt gerade ausgeführt wird und den Ausgaben dieser Schritte während der Ausführung. Dies ist nützlich, um sofortiges Feedback zu erhalten, dass ein Workflow gestartet wurde und ausgeführt wird. Bei kurz laufenden Workflows kann dies verwendet werden, um den Workflow zu überwachen, bis er abgeschlossen ist.

Um jedoch weiterzuarbeiten, während dieser Workflow ausgeführt wird, können Sie dieses Fenster schließen und Ihre Aufgaben fortsetzen, während Avantra diese Schritte im Hintergrund ausführt. Der Status des Workflows kann dann entweder im Tab Ausführungen der Workflow-Details oder im Menü:Automation[Ausführungen] eingesehen werden.

Manuelle Aktivitäten durchführen

Workflows können einen manuellen Schritt enthalten. Wenn ein Workflow einen manuellen Schritt erreicht, wird der Workflow angehalten und wartet darauf, dass ein Benutzer den Workflow fortsetzt oder abbricht.

Um mit einem manuellen Schritt zu interagieren, öffnen Sie die Workflow-Ausführung und drücken Sie einfach die Bestätigen-Schaltfläche.

Einen Workflow stoppen

Workflows können auch gestoppt werden, entweder während ein Schritt ausgeführt wird, wenn ein Schritt fehlgeschlagen ist oder wenn auf die Bestätigung eines manuellen Schrittes gewartet wird. Klicken Sie einfach auf die Ausführung stoppen-Schaltfläche in der Symbolleiste, wenn Sie die Ausführung anzeigen.

Wenn ein Workflow einen Schritt ausführt und die Ausführung stoppen-Schaltfläche gedrückt wird, können die meisten Workflowschritte nicht unterbrochen werden und werden weiterhin verarbeitet. Nach dem Stoppen werden jedoch keine weiteren Schritte gestartet.

Umgang mit Fehlern

Wenn ein Workflow-Schritt mit einem Bei Fehler-Wert von Stoppen - Fragen, ob fortgesetzt werden soll oder einem Wiederholen konfiguriert ist und der Schritt mit einem Fehler fehlschlägt, wird der Workflow angehalten und der Benutzer wird gefragt, wie in dieser Situation vorzugehen ist.

Der Benutzer kann auf die Stoppen-Schaltfläche klicken, um den Workflow vollständig zu stoppen, oder auf die Fortsetzen-Schaltfläche klicken, um dann die Möglichkeit zu haben, diesen Schritt zu überspringen (nützlich, wenn die Aktion manuell durchgeführt werden kann), oder der Schritt kann erneut versucht werden, wenn der Fehler durch einen vorübergehenden Fehler verursacht wurde oder durch Ändern der Workflow-Parameter behoben werden kann. Siehe Ändern von Variablen.

Variablen ändern

Wenn ein Workflow pausiert wird, entweder durch einen manuellen Schritt oder wenn ein Schritt fehlschlägt und fragt, wie der Fehler behoben werden kann, können Sie die Variablen ändern-Schaltfläche in der Symbolleiste verwenden, um die Werte der Workflow-Eingaben (die beim Start des Workflows eingegeben wurden) und die bereits ausgeführten Schritt-Ergebnisse, die in den folgenden Schritten verwendet werden, zu überprüfen und zu ändern, sodass Sie eine Eingabe korrigieren können.

Dies ist sehr nützlich bei der Ausführung größerer Workflows, wenn Sie feststellen, dass Sie ein Passwort oder einen Dateipfad falsch eingegeben haben, was einen Fehler verursacht hat.

Vorsicht ist geboten, wenn in diesem Modus ein Schrittausgang bearbeitet wird, um sicherzustellen, dass das richtige Format verwendet wird, um weitere unerwartete Fehler zu vermeiden.

Benachrichtigungen

Beim Starten eines Workflows können Sie festlegen, wer benachrichtigt wird, wenn Workflow-Ereignisse auftreten, wie z. B. Fehler oder manuelle Schritte, Workflow-Start/-Ende usw. Aktivieren Sie die entsprechenden Kontrollkästchen bei der Konfiguration des Workflows, um die Benachrichtigung einzurichten.