Protokolle und Logs

So verfolgst Du Workflow-Ausführungen, prüfst Fehlerfälle und ergänzt eigene Log-Einträge.

Alle Ausführungen von Workflows werden in VARIO Cloud protokolliert, um Abläufe nachvollziehbar zu machen – was insbesondere bei Fehlern oder unerwartetem Verhalten nützlich ist.

Voraussetzung:

Damit ein Workflow protokolliert wird, muss er aktiviert und mindestens einmal ausgeführt worden sein – z. B. durch das Anlegen eines Angebots im Fall unseres Beispiel-Workflows.

Die Logs bleiben so lange erhalten, bis der Workflow erneut bearbeitet und gespeichert wird. Solange ein Workflow nur deaktiviert wird, bleiben die Protokolle erhalten.

Die Protokolle (Logs) sind an mehreren Stellen einsehbar:

• im Workflow selbst (im Bearbeitungsbereich),

• im Datagrid der Workflows (im Menüpunkt Workflows),

• im Datensatz, der in dem Workflow mit einbezogen wurde (z. B. Angebot oder Adresse).

Tipp für selbst definierte Logs

Mithilfe von ctx.services.logger.info(…) kann im Skript eines Elements ein eigener Log-Hinweis zum Element angegeben werden.

Dieser ist nach Ausführung des Workflows im Log des Elements zu sehen.

Protokolle im Workflow

Wähle einen Workflow aus und klicke auf den Button “Ausführungen”. Hier werden alle bisherigen Ausführungen des Workflows aufgelistet. Es stehen Dir zwei Möglichkeiten zur Verfügung, auf denen auch die Protokollansichten in anderen Bereichen basieren:

1. Möglichkeit: Auswahl der Elemente

1

Durch aufklappen des grünen Pfeils werden die einzelnen Elemente des durchlaufenden Pfads angezeigt. Bei Workflows mit mehreren Pfaden werden nur die Elemente protokolliert, die im konkreten Durchlauf tatsächlich ausgeführt wurden.

2

Beim Anklicken eines Elements öffnet sich ein Pop-Up-Fenster mit den Details und dem dazugehörigen Skript. Im Reiter “Logs” findest Du die Protokolleinträge für dieses Element.

3

Durch das Anklicken eines Log-Eintrags werden zusätzliche Debug-Informationen eingeblendet. Die JSON-Daten lassen sich über das Symbol bequem in die Zwischenablage übernehmen.

2. Möglichkeit: Übersicht des Workflow-Ablaufs

1

Wähle eine der Workflow-Ausführungen aus, um den konkreten Ablauf im Workflow-Diagramm anzeigen zu lassen. Der Pfad wird grün dargestellt, solange der Workflow an diesen Stellen erfolgreich durchlaufen wurde. Tritt ein Fehler auf, wird der entsprechende Abschnitt rot markiert. Elemente, die sich noch in Bearbeitung befinden – etwa bei offenen Benutzeraktionen – erscheinen blau.

2

Mit einem Doppelklick auf eines der Elementen öffnet sich ein Fenster mit den Details und dem zugehörigen Skript. Im Reiter “Logs” werden die Protokolleinträge zu dem Element angezeigt.

3

Beim Anklicken eines einzelnen Log-Eintrags wird eine Detailansicht mit Debug-Informationen eingeblendet. Diese kannst Du über das Symbol bequem in die Zwischenablage übernehmen.

4

In der Ansicht des Workflow-Verlaufs werden über den Button “Protokoll” in den Reiter “Logs” die gesamten Protokolle aller Elemente dieser Ausführung übersichtlich aufgelistet.

5

Über den Auge-Symbol kannst Du ebenfalls die Angaben und die Logs zu den einzelnen Elementen einsehen.

6

Mit dem Button “Aktualisieren” in der Workflow-Ansicht kannst Du die Darstellung neu laden, falls die Workflow-Ausführung noch nicht abgeschlossen ist und sich der Status ggf. geändert hat.

Protokolle im Workflow-Datagrid

1

Öffne die Workflowverwaltung im Menüpunkt “Workflows”.

2

Klappe einen aktiven Workflow über den grünen Pfeil auf. Dir werden nun die bisherigen Ausführungen dieses Workflows aufgelistet.

3

Wähle eine Ausführungen aus, um den Workflow-Verlauf im Detail anzuzeigen. Die verfügbaren Optionen zur Protokollanzeige entsprechen denen, die im oberen Abschnitt beschrieben werden.

Protokolle im Datensatz

Über die Aktionen innerhalb eines Datensatzes kannst Du gezielt die Workflow-Instanzen einsehen, in denen der jeweilige Datensatz einbezogen oder verwendet wurde. Im Fall unseres Beispiel-Workflows “Lieferungs- und Zahlungsmodalitäten für Angebote” kannst Du die Protokolle direkt in einem geöffneten Angebot einsehen, dessen Erstellung unseren aktiven Workflow ausgelöst hat.

Öffne dazu den entsprechenden Datensatz, z. B. das Angebot, und klicke auf dem Button “Aktionen”. Dort stehen Dir zwei Möglichkeiten zur Verfügung:

1. Möglichkeit – Workflow-Instanzen

1

Wähle die Aktion “Workflow-Instanzen”. Hier werden alle Workflow-Instanzen aufgelistet, bei denen der aktuelle Datensatz als Auslöser oder Beteiligter eingebunden war.

2

Über die Symbole kannst Du eine unterbrochene Workflow-Instanz entweder manuell fortsetzen oder komplett abbrechen.

3

Mit einem Klick auf den grünen Pfeil kannst Du die gewünschte Instanz aufklappen. Darunter werden die durchlaufenen Elemente dieser Instanz angezeigt.

4

Wähle eine Instanzen aus, um Dir den grafischen Workflow-Verlauf darstellen zu lassen. Die verfügbaren Optionen zur Protokollanzeige entsprechen denen, die im Abschnitt “Protokolle im Workflow” beschrieben werden.

2. Möglichkeit – Neuste Workflow-Instanzen

1

Wähle die Aktion “Neuste Workflow-Instanz”. Es werden alle Logs zur letzten Workflow-Instanz angezeigt, die den aktuellen Datensatz betreffen.

2

Wähle einen der Logs aus, um Dir die Detailinformationen zum jeweiligen Eintrag anzeigen zu lassen. Über die Workflow-Instanzen-ID kannst Du Dir den grafischen Workflow-Verlauf der Instanz in einem neuen Tab öffnen. Die verfügbaren Optionen zur Protokollanzeige entsprechen denen, die im Abschnitt “Protokolle im Workflow” beschrieben werden.