...
- Öffnen Sie das Shop-Dashboard
- Öffnen Sie die Workflow-Tabelle in der Kachel "Workflow"
- Klicken Sie in der Toolbar auf
- 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.
...
- , um die grafische Diagrammansicht zum Konfigurieren des Workflow zu öffnen
Workflow 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 , 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, die 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 , 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".
Bei automatisierten Workflows darf es diesen Schritt nur ein Mal geben.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 |
Enthält 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. Beispiele für die Automation sind: |
|
|
|
|
|
| Wird ab diesem Tag ausgeführt |
| Definiert ein Datum |
| , ab dem der Step ausgeführt werden darf. Vorher wird dieser Step ignoriert, aber nicht übersprungen. |
| Callback |
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.
Definiert die Verarbeitungslogik, die auf den entsprechenden Datensatz angewandt wird. |
| Icon (Font-Awesome) |
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.
Die Steps lassen sich in beliebiger Reihenfolge aneinander schalten. Hierbei ist zu beachten, dass es keine echte Parallelisierung gibt (es wird immer nur ein Step pro Workflow-Warteschlange gleichzeitig ausgeführt) und die Schritt-Abfolge bei der Ausführung immer linear verläuft. Im vorherigen Beispiel hängen die Steps "Nachbestellen des Artikels" & "Druckdaten versenden" vom Step "Erstellen von Druckdaten" ab. Diese werden bei der Ausführung des Workflows aber nicht beide parallel aktiviert sondern es ist nur ein aktiver Folge-Step von "Erstellen von Druckdaten" möglich - entweder "Nachbestellen des Artikels" oder "Druckdaten versenden". Sofern die Steps automatisch starten entscheidet die Wartezeit der Schritt-Einstellungen darüber, welcher Schritt gewählt wird. Eine Entscheidung über den Anwender ist hier möglich, wenn für die Wartezeit der verzweigten Schritte "niemals als Cron" gewählt wird. Diese Einstellung sorgt dafür, dass die Schritte nie über den Automatismus ausgeführt werden.
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.
| Info | ||
|---|---|---|
| ||
Die Tabellen "Workflow Warteschlange", "Workflow Schritte" und "Workflow Schritt-Einstellungen" sind technischer Natur und können von Anwendern höchstens zur Prüfung betrachtet werden. Änderung an deren Inhalt sollten 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.
| 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 | Callbacktypen | |
|---|---|---|
| Call to Action - Bestellung | shopArticle, shopOrdercallActionStep | |
| Call to Action | -createCustomerNestedRelease | |
| Erzeuge Kundenausgaben | shopUser, shopSessionArticle, shopSessionArticleNestedReleasecreateDeliveryNote | |
| Lieferschein erstellen | shopArticle, shopOrdercreateInvoice | |
| Rechnung erstellen | shopArticle, shopOrdercreateMailCampaign | |
| E-Mail-Kampagne erstellen | mailCampaign, mailRecipient, mailTemplatecreatePrintFile | |
| Druckdaten erstellen | shopArticle, shopOrder, shopSessionArticlecreateShipmentLabel | |
| Versandschein erstellen | shopArticle, shopOrder, shopSessionArticle, shopDeliveryMethod, shopDeliveryTimedisableOrderArticle | |
| Bestellten Artikel deaktivieren | shopArticle, shopOrder, shopOrderArticleenableOrderArticle | |
| Bestellten Artikel aktivieren | shopArticle, shopOrder, shopOrderArticleexportOrder | |
| Bestellung exportieren | shopArticle, shopCompany, shopOrder, shopOrderArticle, shopSessionArticle, shopSuppliermailOrderConfirmation | |
| Bestellbestätigung versenden | shopArticle, shopOrder, shopOrderArticle, shopUser, mailRecipientmailOrderSupplier | |
| E-Mail an den Lieferant des Artikels versenden | shopOrder, shopOrderArticle, shopSupplier, shopUser, mailRecipient | |
| mailShopSessionArticleUser | E-Mail an den Kunden des Session Artikels versenden | mailRecipient, mailControlTemplate, shopOrder, shopOrderArticle, shopSessionArticle, shopSupplier, shopUsermailShopUser |
| E-Mail an einen Kunden versenden | mailControlTemplate, shopUsermailSomeone | |
| E-Mail an jemanden versenden | -mailSpoolerCampaignPush | |
| E-Mails aus einer Kampagne in den Spooler aufnehmen | mailCampaign, mailRecipientmailSpoolerCampaignSend | |
| E-Mails einer Kampagne aus dem Spooler versenden | mailCampaign, mailRecipientmailSupplier | |
| E-Mail an einen Lieferanten versenden | shopOrder, shopSupplier | mailUser|
| E-Mail an einen Kunden versenden | shopGuest, shopOrder, shopUsertriggerWorkflowByRole | |
| Neuen Workflow starten (nach Rolle) | - |
Steps verknüpfen
Steps können über die Diagrammansicht verknüpft werden und damit in eine zeitliche 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:
- Es gibt keine echte Parallelisierung gibt, 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
- 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 entscheiden, welcher Step als Nächstes ausgeführt wird
Workflow Step löschen
- Wählen Sie ein Kästchen aus und klicken Sie in der Toolbar auf , um den Step zu löschen
| Info | ||
|---|---|---|
| ||
Die Tabellen "Workflow Warteschlange", "Workflow Schritte" und "Workflow Schritt-Einstellungen" sind technischer Natur und können von Anwendern höchstens zur Prüfung betrachtet werden. Änderung an deren Inhalt sollten nur von Technikern oder unter deren Aufsicht durchgeführt werden. |