...
Workflows sind ein Werkzeug, um bestimmte Aktionen in einer definierten zeitlichen Abfolge und Abhängigkeitskette auf einen Datensatz auszuführen.
Workflow erstellen
Öffnen Sie das Shop-Dashboard
Öffnen Sie die Workflow-Tabelle in der Kachel "Workflow"
Klicken Sie in der Toolbar
aufauf Plus
Speichern Sie den Datensatz
Übersicht der Einstellungen
Name | Beschreibung |
---|---|
Workflow | Bezeichnung des Workflows |
Erlaubte Callbacktypen | Wählen Sie hier die Tabellen aus, für deren Datensätze Sie den Workflow verwenden möchten |
Workflow bearbeiten
Öffnen Sie einen Workflow-Datensatz
Klicken Sie in der Toolbar
auf
- Step anlegen: Hier können neue Steps angelegt werden.
- Element löschen: Elemente (Schritte & Verknüpfungen zwischen Schritten) können über diesen Button gelöscht werden.
- Step bearbeiten: Wird ein Schritt ausgewählt, erscheint dieser Button bei dem jeweiligen Schritt. Bei Klick auf den Button öffnet sich ein Modal mit verschiedenen Konfigurationsmöglichkeiten
Step bearbeiten
Jeder Schritt besitzt Parameter, die unabhängig von der Funktion des Schritts sind ("Ist erster Schritt" - "Zugriff für Anwender erlaubt").
In Abhängigkeit zum gewählten "Callback", werden dem Formular weitere Felder hinzugefügt (In diesem Fall ist der Callback "E-Mail an Anwender versenden". Das Formular wird um "Betreff der E-Mail" und "Inhalt der E-Mail" erweitert.
...
auf das Fork-Symbol, um die grafische Diagrammansicht zum Konfigurieren des Workflows zu öffnen
Workflows bestehen aus Steps. Sie können in der Diagrammansicht Steps anlegen, verknüpfen, bearbeiten oder löschen.
Step anlegen / bearbeiten
Klicken Sie in der Toolbar auf Plus, um einen neuen Step anzulegen
In der Diagrammansicht erscheint ein neues Kästchen mit der Beschriftung "Step"
Sie können das Kästchen frei verschieben, dies hat auf die Ausführung des Workflows keinen Einfluss und dient der Übersichtlichkeit
Wählen Sie ein Kästchen aus und klicken Sie in der Toolbar auf das Stift-Symbol, um den Step zu bearbeiten
Übersicht der Einstellungen
Name | Beschreibung |
---|---|
Ist erster Schritt |
Diese Option schließt aus, dass ein Workflow jemals an einem anderen Punkt dieses Workflows einsteigen kann. Bei einem Bestell-Workflow wäre das in der Regel der Workflow Step "bestellt".
Markiert den Schritt, der bei einer Workflow-Ausführung als Erster ausgeführt wird. Die Option darf nur bei einem Schritt des Workflows gesetzt sein. |
Ist letzter Schritt |
Bewirkt, dass der Workflow nach Abschluss dieses Steps als abgeschlossen gilt. Diese Option sollte bei Schritten gewählt werden, die den Workflow terminieren. | |
Bezeichnung | Frei wählbarer Name |
. Wird bei der Workflow-Ausführung dargestellt. | |
Beschreibung | Frei wählbare Beschreibung. Wird bei der Workflow-Ausführung dargestellt. |
Wartezeit bis zum automatischen Ausführen |
Definiert die automatisierte, zeitgesteuerte Logik der Workflows. Die Option "niemals als |
Cron" sorgt dafür, dass der jeweilige Schritt von der automatisierten Abarbeitung ausgeschlossen wird. |
Alle anderen Optionen greifen bei einer zeitgesteuerten Automation, Bezugspunkt ist dabei immer der vorhergehende Step. Das bedeutet, dass alle gepflegten Werte außer "niemals als |
Cron" |
für erste Steps irrelevant sind. Beispiele für die Automation sind: |
|
|
|
|
| |
Wird ab diesem Tag ausgeführt | Definiert ein Datum, ab dem |
der Step ausgeführt werden darf. Der Step wird erst ausgeführt, wenn das Datum |
erreicht ist. |
Hier kann Verarbeitungs-Logik für den Workflow Step gewählt werden.
Beispiele für Verarbeitungs-Logik sind:
- Lieferschein erstellen - es wird ein Lieferschein für den mit dem Workflow assoziierten Job erstellt.
- Bestellbestätigung versenden - Übersicht und Bestätigung einer Bestellung werden per Mail an den Besteller und an eine optionale E-Mail-Kopie-Empfänger Adresse gesendet.
... und viele mehr.
Workflow Steps verknüpfen
Steps können über die grafische Workflow Oberfläche verknüpft werden. Diese Verknüpfungen sind unidirektional und legen die Abfolge der Abarbeitung fest.
Hierzu genügt es mit der linken Maustaste auf den Namen gedrückt einen Pfeil vom Ursprungsstep zum Zielstep zu ziehen.
"Erstellen von Druckdaten" wird nicht ausgeführt, bevor der vorherige Step abgeschlossen wurde und die konfigurierte Wartezeit erreicht wurde oder der Step 2 manuell gestartet wurde.
...
Achtung:
| |
Callback | Definiert die Verarbeitungslogik, die auf den entsprechenden Datensatz angewandt wird. |
Icon (Font-Awesome) | Ein Icon, das bei der Workflow-Ausführung dargestellt wird. |
Farbe | Die Schriftfarbe eines Badges, wenn der aktuelle Workflow-Schritt bei einem Datensatz dargestellt wird. |
Hintergrundfarbe | Die Hintergrundfarbe eines Badges, wenn der aktuelle Workflow-Schritt bei einem Datensatz dargestellt wird. |
Auslösen für Frontend-Anwender erlauben | Erlaubt das Auslösen des Steps im CMS oder Shop, wenn dort entsprechend konfiguriert. |
Ansehen für Frontend-Anwender erlauben | Erlaubt das Ansehen des Steps im CMS oder Shop, wenn dort entsprechend konfiguriert. |
Tabelle für Filter | Eine Tabelle, aus der im Feld "Filter auswählen" im Anschluss ein dort veröffentlichter Filter gewählt werden kann. |
Filter auswählen | Bei gewähltem Filter wird der Step nur automatisch ausgeführt, wenn der zugrunde liegende Datensatz im Ergebnis der Filters vorkommt. |
Übersicht der Callbacks
Name | Mögliche Callbacktypen | App |
---|---|---|
Erzeuge Kunden-Ausgaben | Ausgaben (Release) | blueprint-core |
E-Mails aus Kampagne in Spooler übertragen | Kampagnen (MailCampaign) | campaign-core |
Gespoolte E-Mails aus Kampagne versenden | Kampagnen (MailCampaign) | campaign-core |
Call to action - Bestellung | Artikel (shopArticle), Bestellungen (shopOrder) | shop-core |
Lieferschein erstellen | Bestellungen (shopOrder) | shop-core |
Rechnung erstellen | Bestellungen (shopOrder) | shop-core |
Druckdaten erstellen | Bestellungen (shopOrder) | shop-core |
Bestellten Artikel deaktivieren | Bestellartikel (shopOrderArticle) | shop-core |
Bestellten Artikel aktivieren | Bestellartikel (shopOrderArticle) | shop-core |
Rechnung versenden | Bestellungen (shopOrder) | shop-core |
Bestellbestätigung versenden | Bestellungen (shopOrder) | shop-core |
Vorkassenmail versenden | Bestellungen (shopOrder) | shop-core |
Sende Mailvorlage an Anwender aus Session Article | Warenkorbartikel (shopSessionArticle) | shop-core |
Sende Mail an Anwender | Kunden (shopUser) | shop-core |
E-Mail an Lieferant | Bestellungen (shopOrder) | shop-core |
E-Mail an Kunde versenden | Bestellungen (shopOrder) | shop-core |
Call to action | Bestellungen (shopOrder) | workflow-core |
E-Mail an Jemanden versenden | alle | workflow-core |
Neuen Workflow starten (nach Rolle) | alle | workflow-core |
Callbacks können ihre eigenen Einstellungen definieren, diese können beim Bearbeiten eines Steps im Reiter "Einstellungen" bearbeitet werden, sofern Einstellungen für den gewählten Callback verfügbar sind.
Steps verknüpfen
Steps können über die Diagrammansicht verknüpft werden und damit in eine zeitliche und kausale Abhängigkeit zueinander gesetzt werden.
Klicken Sie mit der Maus auf den Namen eines Kästchens, halten Sie die linke Maustaste gedrückt und ziehen auf ein anderes Kästchen.
Es scheint ein Pfeil zwischen den beiden Kästchen.
Der Step am Ende des Pfeils wird damit nach dem Step am Anfang des Pfeils ausgeführt.
Steps lassen sich so in beliebiger Reihenfolge aneinander schalten. Hierbei ist folgendes zu beachten, dass es :
Es gibt keine echte Parallelisierung
...
, d.h. es wird immer nur ein Step pro Workflow-Warteschlange gleichzeitig ausgeführt
...
und die
...
Step-Abfolge bei der Ausführung verläuft immer linear
...
Aufgrund dieses linearen Verlaufs der ausgeführten Schritte ist es auch nicht möglich, mehrere Bedingungen für Schritt 4 im oberen Beispiel einzustellen. Schritt 4 wird ausgeführt, sobald entweder Step 2 oder Step 3 erfolgreich beendet wurden. Es findet also keine Prüfung statt, dass beide zulaufenden Steps 2 und 3 erfolgreich beendet sein müssen. Dies wäre auch gar nicht möglich, da entweder Step 2 oder Step 3 ausgeführt werden, nicht aber beide.
Workflow Step löschen
Um einen Workflow Step zu löschen genügt ein Klick auf den zu löschenden Step und anschließend ein Klick auf den Button "Element löschen".
Man braucht hier keine Bedenken haben das System selbst zu beeinträchtigen. Allerdings wird der Workflow bei einem Wegfall von Verknüpfungen (Pfeile in der Workflow Oberfläche) an der Stelle des gelöschten Step abgebrochen und sollte vor allem im Live Betrieb schnellst möglich wieder zusammen gefügt werden.
...
.
Sofern die Steps automatisiert ausgeführt werden (Feld "Wartezeit bis zum automatischen Ausführen"), entscheidet die Wartezeit und ein evtl. gewählter Filter darüber, welcher Schritt als Nächstes ausgeführt wird.
Bei der manuellen Ausführung ("niemals als Cron") kann der Anwender selbst entscheiden, welcher Step als Nächstes ausgeführt wird.
Step löschen
Wählen Sie ein Kästchen aus und klicken Sie in der Toolbar auf das Mülleimer-Symbol, um den Step zu löschen
Konsistenz von Workflows
Workflows dürfen nicht mehr verwendet werden, sobald sie in Warteschlangen eingesetzt werden. Aus diesem Grund sind folgende Bearbeitungsfunktionen in diesem Fall in der Diagrammansicht deaktiviert:
Anlegen neuer Steps
Löschen von Steps
Verknüpfen von Steps
Ändern der Felder "Ist erster Schritt", "Ist letzter Schritt" und "Callback" eines Steps
Bei notwendigen Änderungen kann der Workflow kopiert und angepasst werden.
Info |
---|
Workflow Warteschlange, ... Schritte und ... Schritt-EinstellungenDie Tabellen "Workflow Warteschlange", "Workflow Schritte" und "Workflow Schritt-Einstellungen" sind technischer Natur und können sollten von Anwendern höchstens zur Prüfung betrachtet werden. Änderung an deren Inhalt sollten bei Bedarf nur von Technikern oder unter deren Aufsicht durchgeführt werden. |
Workflow-Schritte und Callbacktypen
Um einen Workflow konfigurieren zu können, sollte zunächst ein Datensatz in der "Workflows"-Tabelle angelegt werden. Diesem Workflow können ein frei wählbarer Name und optionale Callbacktypen zugewiesen werden.
Diese Callbacktypen reduzieren die Anzahl der im Workflow konfigurierbaren Schritte. Handelt es sich beispielsweise um einen Workflow, der Bestellbestätigungen versendet, macht es somit u.U. wenig Sinn Workflow-Schritte wählbar zu machen, die Editordaten verarbeiten. Das Feld "Erlaubte Callbacktypen" bietet somit eine Whitelist für Workflow-Schritte. Ist das Feld leer, sind alle Schritte wählbar. Besitzt ein Workflow-Schritt keine Callbacktypen, so wird er immer aufgelistet.
...
in Ausnahmefällen von geschulten Anwenden vorgenommen werden. |