Flow Editor
Übersicht
Der Flow Editor ist Dreh und Angelpunkt jedes Flows, da Sie hier die Gruppen- und Steps verwalten, konfigurieren und anordnen. Zudem können Sie hier detaillierte Automationseinstellungen, Änderungshistorie uvm. einsehen.
Folgend ist eine übliche Ansicht eines einfachen Flows dargestellt, welche in einzelne Sektionen aufgeteilt und erläutert wird.
Detaillierte Dokumentationen
Diese Seite dient als Einstieg und Überblick zum Flow Editor. Detaillierte Informationen zu einzelnen Sektionen und Funktionen sind jeweils an den entsprechenden Stellen verlinkt.
1 - Aktionsleiste
In der Aktionsleiste haben Sie Zugriff auf alle Einstellungen die den gesamten Flow betreffen.
1 - Flow ausführen
Die einfachste Möglichkeit einen Flow auszuführen ist die manuelle Ausführung des Flows.
Dokumentation zu Flow manuell ausführen
2 - Planen
In den meisten Fällen werden Flows automatisiert, d.h. zeitgesteuert ausgeführt.
Dokumentation zu Flow zeitgesteuert ausführen
3 - URL-Trigger
Es ist möglich, den Flow mittels einer URL zu starten. Damit kann man durch Aufruf einer bestimmten URL z.B. durch externe Tools steuern, wann ein Flow ausgeführt wird.
Oft wird dies auch als Webhook bezeichnet.
Dokumentation zu Flow per URL antriggern
4 - Flow sperren/freigeben
Soll ein Flow bearbeitet werden, muss dieser zuerst gesperrt werden.
Dies dient dazu, dass nur ein einziger Nutzer gleichzeitig an dem Flow arbeiten kann und keine kruden Zustände durch simultane arbeiten auftreten.
5 - Testmodus
Testvariablen überschreiben bei aktiviertem Testmodus die Werte normaler Flow-Variablen z.B. bei Step-Vorschau, Mapper oder manueller Flow-Ausführung. Bei Zeitplanung oder URL-Trigger greifen die normalen Werte der Flow-Variablen. Testvariablen werden für die aktuelle Session gespeichert und beim Entsperren oder Logout wieder gelöscht.
Beta-Feature
Der Testmodus steht derzeit als beta-Feature in allen Basis-Paketen zur Verfügung.
Wozu braucht man das?
Nachdem ein Flow produktiv im Einsatz ist, kommt man manchmal in die Situation, dass man den Flow mit einer ganz bestimmten Variable manuell ausführen möchte. Entweder um etwas neues auszuprobieren, oder z.B. eine einzelne Bestellung anhand der OrderID abzurufen. Dafür könnte man auch ganz einfach wie bisher die Flow-Variable entsprechend ändern.
Wo ist das Problem?
Leider vergißt man manchmal, diesen Testwert wieder aus der Flow-Variable zu entfernen. Das führt dann im schlimmsten Fall dazu, dass der Flow dann automatisiert mit immer der gleichen "vergessenen" Testvariable ausgeführt wird.
Testmodus als Lösung gegen das "Vergessen"
Dieses Problem wird durch den Testmodus und die Testvariablen adressiert. Das Risiko, dass man vergisst einen Wert wieder zurück zu ändern wird minimiert. Die Testvariablen werden nur temporär in der Session gespeichert und wirken sich nur auf Aktionen aus, die man im Browser macht (z.B. manuelle Flow-Ausführung, Step-Vorschau, Mapper Konfiguration). Der eigentliche Wert der Flow-Variablen bliebt unverändert. Ein per Zeitplanung automatisierter Flow sieht nur die normalen Flow-Variablen, jedoch nicht die Testvariablen. Vergisst man den Testmodus zu deaktivieren oder die Testvariable zu entfernen, dann ist das nicht schlimm, denn der Flow sieht bei normaler Ausführung z.B. per Zeitplanung nur die normalen Variablen.
6 - Änderungshistorie
Für Kunden ab Plus Paket gibt es die Möglichkeit der Versionierung für Flows. Damit kann man Zwischenstände von Flows wegspeichern (Snapshots), um später ggf. wieder zu einem bestimmten Stand zurückzurollen (Rollback). Änderungen können mit einem Kommentar versehen werden, um auch später noch nachzuvollziehen was geändert wurde.
Hat man z.B. eine versehentliche Änderung gemacht, kann man über einen Klick die Basis-Version wiederherstellen. Die Basis-Version ist die letzte Version vor der Änderung (dargestellt durch einen grünen Punkt).
Automatische Versionierung
Zusätzlich zur manuellen Speicherung eigener Versionen werden beim Sperren des Flows automatische Versionen erzeugt. Hierbei wird geprüft ob Änderungen zur Basisversion vorhanden sind und nur im Fall einer Abweichung ein Autosave generiert.
Die maximale Anzahl der Autosaves ist auf 25 begrenzt. Wird diese Zahl überschritten werden automatisch die ältesten Autosaves wieder gelöscht.
Timeline der Änderungshistorie
Alle erstellten Versionen sind in einer Timeline verfügbar. Die aktualle Basisversion ist grün hervorgehoben. Zudem besteht die Möglichkeit zur besseren Übersicht der selbst gespeicherten Versionen alle Autosaves auszublenden.
Basisversion wiederherstellen
Diese Option stellt die letzte gespeicherte Verion wieder her und macht alle seit dem vorgenommenen Änderungen wieder rückgängig.
7 - Flow Eventlogs
Das Eventlog ist eine Historie aller vergangener Runs und deren Status. Hier können also vorherige Durchläufe noch einmal rekapituliert und im Zweifel Fehler gesucht werden.
8 - Dokumentationsansicht
Diese Ansicht stellt eine "druckbare" Version des Flows dar. Diese dient dem Zweck, dass man alle Elemente des Flows übersichtlich auf einer Seite sieht.
Der Vorteil dieser Ansicht ist, dass man die Browsersuche (Strg + F) nutzen kann, um bestimmte Elemente des Flows zu finden. Auch ist es theoretisch möglich, sich diese Seite als PDF zu Dokumentationszwecken abzuspeichern.
9 - Flow-Hilfe
Damit erreichen Sie inerhalb von Synesty Studio diese Handbuchseite.
10 - Weitere Einstellungen
Datenfluss-Graph
Der Datenfluss-Graph stellt die Verknüpften Step-Outputs grafisch dar. Damit kann man sehen, welcher Step welchen Output von anderen Steps konsumiert.
Cache leeren
Bei Klick auf Step-Vorschau werden die Daten in einem Cache zwischengespeichert, und bei einer Step-Vorschau in einem späteren Step wiederverwendet. Damit wird vermieden, dass alle Daten immer wieder neu geladen werden müssen, was z.B. einer langsamen API länger dauern kann. Um diesen Cache zu leeren und wieder frische Daten zu erhalten, können Sie diese Funktion benutzen. Alternative: ein Klick auf Flow-Variablen speichern oder Speichern im Step hat den gleichen Effekt. Dabei wird der Cache auch geleert.
Zeige aufrufende Flows
Damit kann man alle Flows anzeigen, die den aktuellen Flow mit einem FlowExecutingStep oder FlowTrigger Step aufrufen. Siehe auch Andere Flows aufrufen.
Flow+ konfigurieren
Siehe Flow+
In Projekt kopieren / verschieben
Damit können Sie einen Flow in ein anderes Projekt kopieren oder verschieben. Es ist dabei auch möglich einen anderen Workspace zu wählen.
Duplizieren
Diese Funktion dupliziert den aktuellen Flow und alle enthaltenen Steps. Das ist praktisch, um einmal erstellte Flows einfach wiederzuverwenden.
Exportieren
Ein Flow kann damit in eine Datei exportiert werden und anschließend wieder importiert werden. Das ist praktisch, um z.B. ein Backup eines Flows anzulegen, dass man zu einem späteren Zeitpunkt wieder importieren kann.
Debug Modus
Wenn der Debug-Mode aktiviert ist, dann werden alle FTP/HTTP-Requests für die nächsten 3 Runs mitgeschrieben ("geloggt"). Im Eventlog kann man daraufhin den Debug-Log als Datei herunterladen.
In dieser Datei findet man alle HTTP-Requests / API-Calls und die gesamte (S)FTP Kummunikation, die im Hintergrund der Steps ausgeführt wurde.
Automatische Deaktivierung nach 3 Runs
Nach den nächsten 3 Ausführungen wird der Debug-Mode automatisch wieder deaktiviert. Das ist notwendig, da der HTTP-Log enorme Systemlast und Speicherverbrauch erzeugt und diese nur zur Fehlersuche verwendet werden soll. Der HTTP-Log im Eventlog ist nur für kurze Zeit nach der Ausführung verfügbar (max. 2 Tage). Danach wird die Datei gelöscht und kann nicht mehr heruntergeladen werden.
2 - Flowgraph (Gruppen)
Hier können Gruppen hinzugefügt, entfernt, verknüpft und verschoben werden.
Dokumentation zu Flowgraph
3 - Stepliste (Steps)
Hier sind die aktuellen Steps aufgelistet, welche in der aktuell im Flowgraph gewählten Stepgruppe enthalten sind.
1 - Gruppenname und -beschreibung (bearbeiten)
Hier wird der Gruppenname und die Beschreibung der Gruppe angezeigt. Wird auf den entsprechenden Wert geklickt, kann der entsprechende Wert geändert werden.
2 - Alle Steps bearbeiten
Es wird eine Liste mit allen Steps der aktuellen Gruppe angezeigt, in der folgende Step-Einstellungen alle auf einmal angepasst werden können:
- Position
- Name
- Farbe
- Version
- Aktivieren oder pausieren
- Kopieren (in eine andere Gruppe oder in einen anderen Flow)
- Löschen
3 - Stepliste
Mit Klick auf einen Step kann dieser konfiguriert, verschoben oder eine Vorschau getriggert werden.
4 - Step hinzufügen
Es kann sowohl am Ende der Stepliste als auch zwischen zwei Steps ein neuer Step hinzugefügt werden.
4 - Konfiguration (Step- / Gruppenkonfiguration)
Hier wird, je nachdem was ausgewählt wurde, die Konfiguration angezeigt.
Stepkonfiguration
1 - Stepname und -beschreibung (bearbeiten)
Hier wird der Stepname und die Beschreibung des Steps angezeigt. Wird auf den entsprechenden Wert geklickt, kann der entsprechende Wert geändert werden.
2 - Stepeinstellungen
Step austauschen
Es besteht die Möglichkeit einen Step durch einen anderen auszutauschen (anstatt den aktuellen Step zu löschen, den neuen hinzuzufügen und an diese Stelle zu schieben).
Gibt es (namentlich und Datentyp) identische Inputs, werden diese vom "neuen" Step übernommen.
Step duplizieren
Dupliziert den aktuellen Step in eine gewünschte Gruppe des Flows und fügt diesen dann am Ende der Stepliste an.
Step in anderen Flow kopieren
Verschiebt den Step in einen anderen Flow in eine gewünschte Gruppe ein.
Zeige ähnliche Steps
Es wird eine Liste von Flows angezeigt, wo der aktuelle Step ebenfalls verwendet wird.
In Zwischenablage kopieren
Kopiert den aktuellen Step inkl. aller aktuellen Einstellungen in die Zwischenablage und kann z.B. in einen anderen Account/Workspace wieder eingefügt werden.
Step entfernen
Löscht den Step aus dem Flow (nicht umkehrbar)
3 - Step-Vorschau
Hier wird eine Vorschau der Ausführung eines Steps angetriggert und anschließend eine Vorschau des Stepergebnisses angezeigt.
4 - Step speichern
Speichert die aktuell getätigten Einstellungen des Steps.
5 - Stepinput(s)
Jeder Step besitzt unterschiedlichste Inputs welche - sofern nicht optional - konfiguriert werden müssen. Dabei gibt es unterschiedlichste Arten wie die Inputs zu konfigurieren sind, diese reichen von einfachen Texteingaben, über Selektboxen bis hin zu eigenen Mappern.
6 - Input verknüpfen
Oftmals gibt es Inputs, welche auf ein Output eines vorherigen Steps angewiesen sind.
Mittels Klick auf den Button wird eine Liste aller vor diesem Step befindlichen, kompatiblen Steps angezeigt welche mit dem Input verknüpft werden können.
7 - Inputeinstellungen
Eine Liste mit folgenden Optionen
In Flow Variable umwandeln
Wandelt den aktuellen Input in eine Flow Variable um.
Zurücksetzen
Setzt den Input auf den Defaultwert zurück. (= Der Wert welcher direkt nach dem hinzufügen des Steps gesetzt ist)
8 - Erweiterte Optionen anzeigen
Viele Steps besitzen neben den "Hauptinputs" noch weitere Einstellmöglichkeiten, welche hier zu finden sind. Hierbei handelt es sich i.d.R. um "Profi-Einstellungen" die selten einer Anpassung bedürfen.
5 - Seitenleiste (Variablen etc.)
1 - Flowbeschreibung
Es ist empfehlenswert Ihre Flows mit einer aussagekräftigen Beschreibung zu versehen. Hierzu steht ein Editor mit reichlichen Formatierungsmöglichkeiten zur Verfügung.
2 - Flow Variablen
In Flow Variablen können Sie Werte hinterlegen, die Sie in mehreren Steps benötigen. Man spricht dann häufig von auslagern.
Häufig verwendet man Variablen für Zugangsdaten wie URLs, die von mehreren Steps verwendet werden (z.B. URLDownload).
Dokumentation zu Flow Variablen
3 - Flow Outputs
Output Variablen sind auch eine fortgeschrittene Funktion, die nur im Zusammenhang mit dem Flow-in-Flow Feature eine Rolle spielt, wenn der Flow von einem anderen Flow aufgerufen wird.
Dokumentation zu Flow Outputs
6 - Step hinzufügen Leiste
Diese Leiste taucht auf, wenn im Flow ein Step hinzugefügt oder ausgetauscht werden soll.
1 - Stepsuche
Mittels Schlagwörtern kann ein gewünschter Step gesucht werden. Dabei wird sowohl der Stepname als auch die Beschreibung durchsucht. Im Zweifel macht es also auch Sinn nach möglichen Umschreibungen/Synonymen zu suchen.
Mit Klick auf "Zeige alle Steps" wird eine Übersicht aller aktuell verfügbaren Steps angezeigt, welche nach zugehörigem Add-On kategoriesiert sind.
2 - Step aus Zwischenablage einfügen
Hier kann ein Step (und all seine kopierten Einstellungen) als JSON-String in den Flow eingefügt werden. Diesen JSON-String kann zuvor in den Step-Einstellungen kopiert werden. Das kann man z.B. nutzen, um Step-Einstellungen im Team zu teilen und wiederzuverwenden.
3 - Stepvorschläge
Je nach vorangehenden Steps, wird eine Liste von Stepvorschlägen angezeigt. Ein Klick auf einen Vorschlag genügt um den entsprechenden Step hinzuzufügen.