Kommt ein WAL in einen Blog
Am 4. Juni 2018 erblickte die ST4 Version 2018 das Licht der Welt und mit ihr die wohl umfangreichste Neuerung seit der Einführung des Page Layout Designers im Jahre 2012: Der SCHEMA ST4 Workflow Designer. Schon knapp drei Monate später erschien mit dem Service Pack 1 auch noch die SCHEMA Workflow Automation Library, deren zungenbrecherische Qualitäten zur beliebten Abkürzung WAL geführt haben.
Designer? Library? Automation? WAL? Wer soll da noch durchblicken und was hat das mit meinen Workflows zu tun?
Ich habe mir zu Beginn dieselben Fragen gestellt. Heute vergleiche ich die Erstellung eines Workflows gerne mit dem Mixen von Cocktails, um den zugegebenermaßen recht abstrakten Begriffen im Workflow-Umfeld mehr Haptik zu verleihen. Und nachdem ich dieses Gleichnis bereits in einem Vortrag auf der SCHEMA Conference 2019 vorstellen durfte, wollte ich die Gelegenheit nutzen, meine Workflow-Cocktails auch unseren Blog-Lesern schmackhaft zu machen.
Um die Grundlagen des Cocktailmixens zu lernen, wollen wir einmal gemeinsam einen Workflow-Cocktail mit der WAL kreieren. Der Workflow soll die in einem nicht ganz so hypothetischen Szenario immer wieder erforderlichen Schritte für eine Ausleitung von Texten zur Übersetzung bündeln und automatisieren. Der Ablauf soll wie folgt sein:
- Auswahl von Quell- und Zielsprache durch den Redakteur
- Automatische Überprüfung des gewählten Teilbaums mit Schematron
- Automatische Freigabe der Quellsprache
- Automatische Ausleitung der Quellsprache in die Zielsprache für das TMS
Passend zum Thema der Internationalisierung nenne ich diesen Workflow Cocktail den „PAN AM“.
Die Zutaten
Für einen guten Cocktail sowie auch einen Workflow benötigen wir zunächst Zutaten. Für Cocktails verwenden wir Säfte, Obst und Gewürze. Bei Workflows sind unsere Zutaten verschiedene Skripte. Ein Workflow-Skript ist ein kleiner, abgeschlossener Funktionsbaustein, der beispielsweise eine Aktion wie die Freigabe, Versionierung oder die Änderung eines Metadatums durchführen kann. Mit dem Workflow Designer stehen Ihnen bereits eine ganze Reihe von vordefinierten Skripten zur Verfügung, die sie in Workflows beliebig kombinieren können, um ihren Wunsch-Cocktail herzustellen. Soll es ein wenig mehr sein, erhält man mit der Workflow Automation Library (WAL) weitere, fortgeschrittene Skripte, mit denen sich dem ambitionierten Barkeeper noch weitreichendere Möglichkeiten eröffnen, komplexere Workflows zu kreieren.
Für unseren PAN AM benötigen wir folgende Zutaten(/Skripte):
1 Stk Skript Schematron.Report (Workflow Automation Library)
1 Stk Skript TMS.Export (Workflow Automation Library)
1 Stk Skript Release (Workflow Designer)
3 Stk Automatische Aufgaben
3 Stk Fehlerzustände
Das Rezept
Alle Zutaten der Welt sind nutzlos, wenn wir sie nicht zu einem geschmackvollen Ganzen zusammenführen können - mit einem Rezept. Bei einem Workflow bestimmt das Modell, in welcher Art unsere Zutaten zusammenkommen. Wie bei allen guten Rezepten ist auch bei Workflows meist wichtig, in welcher Reihenfolge wir unsere Zutaten verknüpfen, um ein geschmack- und sinnvolles Resultat zu erzielen.
Zunächst bauen wir uns mit dem Workflow Designer das grobe Modell des PAN AM zusammen. Es besteht im Wesentlichen aus den drei zentralen Schritten, die wir als Zustände modellieren.
Der grobe Ablauf des PAN AM im Workflow Designer
Der Anwender kann den Workflow jetzt von einem Zustand in den nächsten weiterschalten, bis er am Ende angelangt ist. Da wir eigentlich einen weitestgehend automatisch ablaufenden Workflow erreichen wollen, verwenden wir für jeden Schritt statt eines Zustands eine automatische Aufgabe. Diese laufen automatisch ab.
Der PAN AM mit automatischen Aufgaben
Der Alkohol
Jeder gute Cocktail braucht Alkohol. Der sorgt für den Geschmack und zudem dafür, dass man am Tag danach auch noch merkt, was man so alles in sich hineingeschüttet hat - gewissermaßen das Cocktail-Gedächtnis. Diese Rolle übernehmen in SCHEMA ST4 die Felder. Sie können ihrem Workflow beliebig viele Felder hinzufügen, um alle im Verlauf des Workflows anfallende Informationen jederzeit zu speichern und wieder zu lesen.
Dafür fügen wie unserem grob gemixten PAN AM Felder hinzu, die Eingaben des Redakteurs beim Start unseres Workflows aufnehmen sollen:
- SourceLang : Quellsprache der Übersetzung
- TargetLang : Zielsprache der Übersetzung
- Node : zu übersetzendes Projekt
Zusätzlich brauchen wie noch einige Felder, die keine Eingaben des Benutzers, sondern die Ergebnisse unserer automatisierten Funktionen aufnehmen
- Success : Hier speichert das Schematron Skript, ob die Prüfung erfolgreich war
- Report : Hier speichert das Schematron Skript den HTML Prüfungsreport
- Document : Das zur Prüfung verwendete Produktionsdokument (blaues Buch)
Alle für den PAN AM benötigten Felder im Workflow Designer
Mixen
Jeder professionelle Barkeeper bereitet seine Zutaten vor der Verwendung immer passend zum Cocktail vor, bspw. viertelt er eine Limette oder schäumt Säfte auf.
Auch wir müssen unsere Zutaten, die Skripte, vor der Verwendung präparieren. Die meisten Skripte verfügen über Parameter, die steuern, wie genau die konkrete Funktion ablaufen soll. Um beispielsweise das Skript zur Freigabe in unserem PAN AM zu verwenden, müssen wir als Parameter festlegen, welcher Knoten freizugeben ist und in welcher Sprache eine Freigabe erfolgen soll.
Das Skript „Redaktionelle Freigabe“ mit befüllten Parametern. Es wird der mit dem Workflow verbundene Knoten (3) freigeben, als freizugebende Sprache verwenden wir die im Workflow hinterlegte Quellsprache (2). Außerdem geben wir immer im Teilbaummodus frei (4)
Nachdem wir auch noch unsere weiteren Zutaten wie den Schematron Report und den TMS Export vorbereitet haben, können wir sie unserem Workflow-Cocktail hinzufügen, indem wir die parametrierten Skripte an die richtigen automatischen Aufgaben anhängen.
Die Dekoration
Mit Dekorationen wie Schirmchen, Spießen mit Obststückchen oder bunten Trinkhalmen sprechen wir unsere trinkfesten Kunden emotional an und signalisieren gleichzeitig die von uns bevorzugte Art des Verzehrs. Bei Workflows nutzen wir dazu Eingabefelder, die den Anwendern die Verwendung unserer Workflow-Cocktails durch eingängige Benutzeroberflächen erleichtern bzw. dessen Verwendung bestimmen. Dazu selektieren wir den ersten Übergang unseres Workflows und wählen dort die durch den Anwender einzugebenden Felder aus.
Ausgewählte Felder zur Eingabe durch den Benutzer im ersten Übergang
Die Kirsche auf der Sahne
Zuletzt verfeinern wir den PAN AM noch um einige kleinere Details. Bei der Verwendung von automatischen Aufgaben bzw. dort ausgeführten Skripten kann es zu Situationen kommen, in denen Fehler oder Abbrüche auftreten. Eine Freigabe kann zum Beispiel wegen mangelnder Berechtigungen fehlschlagen oder die Schematron-Prüfung wegen Verstößen gegen einzelne Regeln abbrechen. In diesem Fall benötigt man entsprechende Kompensationshandlungen, die es dem Redakteur ermöglichen, das aufgetretene Problem zu sehen und mit dem Workflow kontrolliert weiterzuarbeiten. Für den PAN AM wollen wir daher in separate Fehlerzustände übergehen, an denen der Anwender den Workflow entweder beenden oder nach manuellen Korrekturen fortsetzen kann. Speziell für die automatische Schematron-Prüfung fügen wir noch eine Entscheidung („Prüfung erfolgreich“) hinzu, in der wir das vom Schematron-Skript befüllte Feld Schematron.Success abfragen und ggf. in unseren Fehlerzustand übergehen.
Damit haben wir unseren ersten gemeinsamen Workflow-Cocktail gemixt. Der Drink kann nun auf den Bartresen gestellt und durch den Kunden verzehrt werden. Im ST4 Workflow Designer geben wir dazu den Workflow frei, was Ihn für alle ST4 Anwender sichtbar und verwendbar macht.
Schlusswort
Aller Anfang ist schwer. Eine gewisse Einarbeitungszeit ist schon nötig, um dem komplexen Werkzeug Workflow Designer + WAL Herr zu werden und interessante Workflows und Automatismen zu entlocken. Aber ich verspreche Ihnen, dass Sie sich mit jedem gemixten Cocktail weiter verbessern und schon bald Ihre eigenen Kreationen zaubern können. Willkommen in der Welt der Workflow-Barkeeper.
Über Pierre Hain
Pierre Hain ist seit 2004 in der SCHEMA tätig. Seine Schwerpunkte sind die Konzeption, Betreuung und Implementierung technisch anspruchsvoller Projekte und Schnittstellen rund um das Produkt SCHEMA ST4. Den Abschluss als Diplom-Medieninformatiker erwarb er an der Berufsakademie Mannheim.
Andere Artikel von Quanos
Das könnte Sie auch interessieren
Technische Doku von überall: SCHEMA ST4 ist ab sofort webbasiert verfügbar
Unser Redaktionssystem SCHEMA ST4 steht ab sofort webbasiert zur Verfügung – als ST4 Web Author. Technische Doku kann…
5 Beispiele für automatisierte Technische Dokumentation
Technische Dokumentation ist eine aufwändige Angelegenheit. Gut, wenn das Redaktionswerkzeug umfangreiche Hilfsmittel…
ST4 und Kontextsensitive Hilfe: Die perfekte Kombination
„Drückt man auf F1, dann öffnet sich die Hilfe!“ Das ist heute die Standard-Erwartung bei jeglicher Software. Standar…