Steps

Was ist ein Step?

Ein Step bezeichnet einen einzelnen Baustein eines Flows.

  • Jeder Step kann über Parameter konfiguriert werden, wodurch man das Verhalten bei der Ausführung beeinflussen kann.
  • Ein Step hat ein oder mehrere Ausgabe Werte, die hier als Output bezeichnet werden.
  • Ein Step kann Outputs von vorherigen Steps als Input verwenden (wir bezeichnen dies als "Verdrahten bzw. Verknüpfen von Step-Outputs und Step-Inputs")

Step hinzufügen

Über den  Button können Steps zu einem Flow hinzugefügt werden, die man aus einer Liste auswählen kann. Die Liste der angezeigten Steps ist dabei kontextsensitiv auf Basis der vorherigen Steps. Wenn der gewünschte Step nicht in der Liste sein sollte, geben Sie bitte einen Suchbegriff ein und es werden Ihnen entsprechend passende Steps angezeigt.

Konfiguration von Steps

Durch Klick auf die Stepbox kann die Konfiguration eines Steps vorgenommen werden. Die meisten Steps sind über Text- oder Dropdown-Felder konfigurierbar, um die entsprechenden Input-Parameter einzustellen.

Hinweis

Zuvor muss allerdings der Flow zur Bearbeitung durch Klick auf den  Button gesperrt werden.

Steps mit Accounts / Verbindungen

Alle Steps, die mit externen Systemen kommunizieren, greifen dabei auf Accounts zu, die sie unter Meine Verbindungen einrichten. Damit der Step funktioniert, muss erst ein Account mit Zugangsdaten für das externe System, z.B. plentymarkets oder Amazon Seller Central, angelegt werden, damit er im Step verwendet werden kann. Man erkennt das am Step-Input account und der entsprechenden Auswahlbox.

Hinweis

Wenn noch kein Account vorhanden ist, muss dieser erst angelegt werden. Klicken Sie dazu auf den Button "Neue Verbindung erstellen" in der Liste.

Verknüpfen von Step-Outputs und Step-Inputs

Ein wichtiger Aspekt von Steps ist, dass für einen Input auch Outputs vorheriger Steps verwendet werden können. Das heißt, dass man die Step-Outputs und Step-Inputs miteinander "verdrahten" kann. Beim Hinzufügen eines neuen Steps, wird dieser automatisch mit dem Output des vorherigen Steps verknüpft. Diese automatische Verknüpfung funktioniert unter folgenden Voraussetzungen:

  • Der erste Output des vorherigen Steps ist vom Typ: SPREADSHEET, SPREADSHEETLIST, FILE oder FILELIST
  • Der neu hinzugefügte Step erwartet einen passenden Input vom Typ: SPREADSHEET, SPREADSHEETLIST, FILE oder FILELIST

Steps "verdrahten"

Das graue Icon  bedeutet, dass der 2. Step einen Output des 1. Steps als Input benutzt. Diese "Verdrahtung" von Step-Outputs- und Step-Inputs ist ein elementares Konzept bei der Erstellung von Flows. Jeder Step kann Outputs von vorherigen Steps verarbeiten.

Verknüpfung durch automatische Auswahl

Es besteht die Möglichkeit einen Stepinput durch Klick auf "Automatisch verknüpfen" zu "verdrahten". Hierbei werden die vorherigen Steps der Reihe nach durchgegangen und der erste kompatible Output verknüpft.

Verknüpfung durch manuelle Auswahl

Ein Step kann auch manuell mit dem Button neu verknüpft werden. Bei Klick auf diesen Button kann ein vorheriger Step-Output für die Verknüpfung gewählt werden.

Wann ist eine manuelle Verknüpfüng notwendig?

Es gibt verschiedene Fälle, wo eine manuelle Verknüpfung notwendig ist:

  • die automatische Verknüpfung beim Hinzufügen eines Steps, verknüpft ihn immer mit dem vorherigen Step. Wenn dies nicht gewünscht ist, dann kann manuell dieser neu verknüpft werden
  • die automatische Verknüpfung konnte nicht angewendet werden.
  • Sie wollen einfach einen anderen Step-Output verwenden, als sie dies ursprünglich getan hatten.

Verknüpfung durch Verschieben

Wenn man einen Step innerhalb eines Flows verschiebt, dann hat man unmittelbar danach die Möglichkeit den Input neu mit dem Output des vorhergehenden Steps zu verknüpfen. Das spart vor allem Zeit beim erstellen von Flows, wo man in der Regel sehr oft Steps hinzufügt und verschiebt.

Step Outputs

Unterhalb eines jeden Steps sehen sie einen kleinen Pfeil. Durch Klick darauf gelangen Sie zu den Output-Informationen.

Hier werden alle Outputs des Steps aufgelistet und beschrieben. Das ist hilfreich, um den Namen Variable herauszufinden, wenn man den Output des Steps in einem Freemarker-Skript verwenden will (siehe Scripting).

Bei einigen Steps werden auch sog. Meta-Daten angezeigt (z.B. der SearchDatastore). Das sind Informationen zu einzelnen Feldern wie z.B. denen eines Datastores oder eines Mappers.

Step Outputs in Freemarker Skripten verwenden

Um die Variablennamen von Step-Outputs herauszufinden, um diese dann z.B. im TextHTMLWriter oder TextHTMLWriterMultiOutput zu verwenden, gibt es folgende Möglichkeiten:

Plus-Buttons nutzen

Dadurch werden automatisch immer die jeweils korrekten Variablennamen genommen und oft auch hilfreicher Beispiel-Code eingefügt, welcher angepasst werden kann.

Auf den kleinen Pfeil unten an den Steps klicken, um Informationen zu den Step-Outputs anzuzeigen

Dort werden die Outputs des Steps beschrieben und dort sieht man auch wie die entsprechende Freemarker-Variable heißt.

Laufzeit Eigenschaften

Laufzeit Eigenschaften sind spezielle Variablen, die dynamische Informationen enthalten, die nur zur Laufzeit des Flows gültig sind.

Laufzeit VariableBeschreibung
prop_lastruntimeDer Startzeitpunkt der letzten zeitgeplanten und erfolgreichen Ausführung (Wann startete der letzte Run durch die Zeitplan?)
prop_lastruntime_allDer Startzeitpunkt der letzten Ausführung unabhängig von Auslöser oder Status. Mit anderen Worten: das ist die Startzeit des Runs, egal ob dieser zeitgeplant, URL-getriggert, erfolgreich oder fehlerhaft war.
prop_actualruntimeDie geplante Ausführungszeit des Flows (entspricht der eingestellten Nächsten Ausführung)
prop_intervalminutesDas eingestellte Intervall des Flows
current_timestampDer jeweils aktuelle Zeitpunkt beim Start des Flows
jobnameDer Name des Flows
job_idDie ID des Flows
job_uniquenameEine systemweit eindeutige ID des Flows, die selbst vergeben werden kann und der Short-URL beim URLTrigger (siehe weiter unten) entspricht.
customer_idDie ID ihres Kundenaccounts
customer_nameDer Name ihres Kundenaccounts
flow_run_idDie ID (UUID) des aktuellen Runs, die bei jeder Ausführung dynamisch erzeugt wird und eindeutig ist.
flow_runmodeGibt an ob der Flow aktuell im PREVIEW / NORMAL / CONFIGURATION (z.B.: Mapper) ausgeführt wird. (Expertenfeature)
prop_debugmode_enabledGibt an ob der Flow im Debugmodus ausgeführt wurde

Laufzeit Eigenschaften als Template-Variable

Laufzeit Variablen stehen in einigen Steps (z.B. TextHTMLWriter) auch als Template-Variable zur Verfügung.

Dies wird häufig genutzt, um dynamische Dateinamen mit einem Datum zu generieren.

Step-Inputs in Flow-Variablen umwandeln

Flow-Variablen dienen dazu, oft benötigte Parameter/Werte wieder zu verwenden. Ein häufiges Beispiel ist ein Dateiname der in mehreren Steps verwendet wird (z.B. FTP-Download, (CSV,Excel,XML...)-Datei erstellenund anschließender (FTP-)Upload der Datei). Dazu gibt es eine praktische Funktion, um aus einem Step-Input eine Flow-Variable zu erstellen.

Die erstellte Flow-Variable V1 wird jetzt im Step verwendet und kann damit auch in weiteren Steps verwendet werden (siehe Verdrahten von Step-Outputs und Step-Inputs). Ein Beispiel wie der Flow nach nach dem "verdrahten" aussehen könnte:

Step Vorschau

Das  Symbol an jedem Step erlaubt sich eine Vorschau der Ausführung eines Steps anzusehen. Das ist praktisch, um einen Step erstmal zu testen.

Achtung:

Die Vorschau führt alle vorherigen Steps welche der aktuelle Step zur Verarbeitung benötigt aus, damit auch immer die notwendigen Inputs vorhanden sind. Vor allem wenn diese vorherigen Steps sehr lange dauern oder schreibende Prozesse beinhalten, sollte man beim Testen aufpassen und eventuell durch einbau eines Zeilenlimits oder ähnliches die Vorschau beschleunigen.

Steps innerhalb des Flows verschieben

Die Reihenfolge der Steps kann durch verschieben mit der Maus verändert werden.

Step Funktionen

Über den Menü Button am Step, können Sie verschiedenste Funktionen anwenden

Step austauschen

Es kann vorkommen das man einen Step durch einen anderen (meist ähnlichen Step, oder neuere Version des gleichen Steps) austauschen muss. Wenn Sie den neuen Step gewählt haben, wird versucht so viele gefüllte Step-Inputs des "alten" Steps in den neuen zu übernehmen. Hierbei wird geschaut ob der neue Step Inputs mit gleichem Namen hat und die alten Werte auf den neuen Step übertragen.
Bitte prüfen Sie nach dem Austauschen jeweils noch einmal Ihre Konfiguration

Step duplizieren

Man kann einen Step mit den aktuellen Einstellungen duplizieren. Das ist praktisch, wenn man den gleichen Step mehrmals innerhalb eines Flows benötigt.

Steps in einen anderen Flow kopieren

Hin und wieder kommt es vor, dass man einen Step nahezu identisch in einem anderen Flow wiederverwenden möchte. Besonders beim Step Mapper kann das sehr hilfreich sein, wenn man ein sehr großes oder aufwändiges Mapping erstellt hat. In diesem Fall kann man die "Step in Flow kopieren" Funktion verwenden. Der Step wird dabei mit all seinen Einstellungen ans Ende des gewählten Flows (und der gewählten Gruppe) kopiert.

Zeige ähnliche Steps

Möchte man wissen, wo der selbe Step sonst noch verwendet wird, nutzt man diese Funktion. Es wird folgend eine Liste von Flows angezeigt, wo der aktuelle gewählte Step ebenfalls verwendet wird.

Stepkonfiguration als Preset speichern

Es besteht die Möglichkeit einen Step mit seinen kompletten Einstellungen als Preset zu speichern. Dieses Preset können Sie folgend in allen anderen (gleichen) Steps in jedem Flow (innerhalb des Workspaces) anwenden. Das ist besonders dann praktisch, wenn Sie für bestimmte Steps immer wieder die gleichen Einstellungen vornehmen, z.B. einen Mapper der Daten auf ein von Ihnen festgelegten "Goldstandard" mappt.

Sie können entweder ein neues Preset anlegen oder aber ein ausgewähltes Preset mit den aktuellen Einstellungen überschreiben.

Preset anwenden

Hier können bereits abgespeicherte Presets auf den aktuellen Step angewandt werden. Dabei werden alle aktuell im Step gespeicherten Einstellungen mit denen aus dem Preset überschrieben!

Stepkonfiguration in Zwischenablage kopieren

Ein sehr praktisches Feature, um sehr schnell einen Step (mitsamt der aktuellen Einstellungen) zu kopieren und wiederzuverwenden (ähnlich wie bei "Step duplizieren"), allerdings wird der Step in die Zwischenablage kopiert und man kann diesen Step ganz einfach (egal in welchem Flow) beim "Step hinzufügen" auswählen. Hierfür wird nicht ein Step aus den Stepvorschlägen gewählt, sondern

Step entfernen

Hier kann der Step aus dem Flow entfernt werden.

Alle Steps bearbeiten

Über den Button "Alle Steps bearbeiten", erreichen Sie eine Massenbearbeitungsansicht für alle Steps.

Damit können Sie Aktionen für viele Steps gleichzeitig durchführen.

  • Steps umbenennen
  • Steps farblich markieren
  • Position ändern
    • durch Ziehen per Drag & Drop
    • durch Eingabe der Position
    • nach ganz oben oder ganz unten durch den kleinen Pfeil
  • Steps pausieren
  • Steps in anderen Flow kopieren
  • Steps in andere Gruppe verschieben (sofern mehrere Stepgruppen im Flow aktiviert sind)
  • Steps löschen (Hinweis: Die gleichzeitige Auswahl von Kopieren und Löschen entspricht einem Verschieben. Es wird erst kopiert und dann gelöscht)
  • Step Version ändern