Workflows

imperia bietet die Möglichkeit, den Produktionsprozess eines Dokuments zu Ihrem bestehenden betrieblichen, internen Prozess anzupassen. Jeder Schritt in einem Workflow wie das Erstellen, Bearbeiten, Genehmigen und Veröffentlichen eines Dokuments wird durch einen Schritt (bzw. Workflow-Plug-in) im imperia-Workflow repräsentiert.

Einen Workflow definieren

Ein Workflow besteht aus einem oder mehreren Workflow-Schritten, von denen jeder eine bestimmte Operation durchführt. Nur jeweils für diesen Schritt autorisierte Benutzer können diesen auch durchführen. Alle notwendigen Informationen zu einem Dokument sollten gesammelt werden, während es durch einen Workflow bewegt wird.

Zum Beispiel könnten folgende Schritte einen Workflow darstellen:

Im ersten Schritt werden die Meta-Informationen über ein neues Dokument eingetragen.
Im zweiten Schritt werden die Hauptinhalte der Seite eingetragen.
Im dritten Schritt werden die Hauptinhalte auf SEO-Kompatibilität geprüft.
Im vierten Schritt wird der Teaser für diese Seite gestaltet.
Im fünften Schritt wird das Dokument dem Chefredakteur zur Genehmigung vorgelegt.

Jeder Workflow-Schritt hat zumindest einen Dateneingang und einen Datenausgang. Die Ausgabe eines Workflow-Schritt ist mit dem Eingang des nächsten Workflow-Schritt verbunden. Daraus ergibt sich der Ablauf eines Dokuments durch den Workflow.

Workflow-Schritte

Jeder Workflow-Schritt wird durch ein entsprechendes Workflow-Plug-in realisiert. Es steht ein Standardsatz von Plug-ins zur Verfügung, sobald das kostenpflichtige Add-On Workflow-Editor lizenziert wurde. Weitere kundenspezifische Plug-ins können selbst erstellt oder auf Nachfrage erworben werden, sobald das Add-On Workflow API lizenziert wurde.

Jeder Workflow hat mindestens einen Einstiegspunkt. Alternativ sind mehrere Einstiegspunkte möglich, so dass Dokumente aus verschiedenen Kategorien durch unterschiedliche Wege gehen. Welchen der verfügbaren Einstiegspunkte ein Dokument nimmt, wird in den Rubriken-Eigenschaften festgelegt.

Verbindung der Workflow-Schritte

Die einzelnen Schritte eines Workflows sind miteinander verbunden und das Dokument durchläuft diese in der angegebenen Reihenfolge. Einige Workflow-Schritte können jedoch auch Gabelungen enthalten, um - abhängig vom Inhalt des Dokuments - einen anderen Zweig des Workflows zu durchlaufen. In einigen Workflow-Schritten wie etwa dem Genehmigen-Schritt kann das Dokument auch in einen früheren Schritt zurückgeschickt werden. Das ist sinnvoll, wenn der Prüfer das Dokument ablehnt, weil es falsch oder unvollständig ist.

Ein Datenausgang, der nicht mit dem Eingang eines anderen Workflow-Schritt verbunden ist, fungiert automatisch als Ende eines Workflows oder Workflow-Zweigs. Dokumente, die durch einen solchen Schritt gehen, verlassen den Workflow.

Es gibt nur einen Weg für die Datenausgabe von einem Workflow-Schritt. Es ist jedoch möglich, mittels des Workflow-Plug-ins Kopie erstellen das gesamte Dokument zu duplizieren und so verschiedene Ausgaben zu realisieren.

Die Dokumente werden in einem Workflow unabhängig voneinander gehandhabt, so dass mehrere Dokumente über den gleichen Schritt zur gleichen Zeit gehen können.

Workflow-Manager#

Im Workflow-Manager verwalten Sie alle Worfklows.
Die Workflow-Datei finden Sie unter site/grid/imperia/workflow/data/NAME_DES_WORKFLOWS.

Um zum Workflow-Manager zu gelangen, klicken Sie auf Menü -> Workflow.

Die folgende Seite wird geöffnet:

Workflow-Manager

In dieser Verwaltung können Sie Workflows erstellen, ändern und löschen. Darüber hinaus stellen Sie hier die Berechtigungen für die Workflows ein. Die Seite ist in drei Abschnitte unterteilt:

Button Neuen Workflow anlegen

Siehe Abschnitt Neuen Workflow anlegen.

Workflow-Liste

Dies ist eine Liste aller verfügbaren Workflows. Sie enthält den Namen und die Beschreibung eines jeden Workflows. Weitere Optionen stehen am rechten Ende der Zeile zur Verfügung.

Rechte

In diesem Abschnitt werden die Berechtigungen für die in der Liste markierten Workflows gesetzt. Der Abschnitt ist beim Aufruf eingeklappt, siehe obige Abbildung.
Mehr dazu finden Sie im nächstfolgenden Abschnitt Berechtigungen für einen Workflow ändern.
Im Kapitel Zugriffsrechte für Workflow-Schritte werden die (Gruppen)-Zugriffsrechte "Schreib-, Lese- und Löschrechte" für einzelne Workflow-Schritte erläutert.

Neuen Workflow anlegen#

Um einen Workflow anzulegen, gehen Sie wie folgt vor:

Öffnen Sie den Workflow-Manager unter Menü -> Workflow.
Klicken Sie auf den Button Neuen Workflow anlegen. Es wird folgender Dialog geöffnet:
Tragen Sie den Namen des neuen Workflows ein. Der Name darf nur aus Buchstaben, Ziffern, dem Minus-Zeichen und dem Unterstrich (_) bestehen.
Klicken Sie auf den Button Ok.

Es wird das Grid gestartet, in dem der neue Workflow gestaltet und gespeichert wird.

Berechtigungen für einen Workflow ändern#

Es gibt zwei Möglichkeiten, Berechtigungen für einen oder mehrere Workflow(s) zu ändern.

Alternative 1: Rechte für einen oder mehrere Workflows ändern

Öffnen Sie den Abschnitt Rechte im Workflow-Manager, um die Rechte für mehrere Workflows zu setzen, siehe Abbildung unter Workflow-Manager.
Der Abschnitt Rechte wird geöffnet, siehe folgende Abbildung:
Aktivieren Sie die Checkbox "Alle auswählen" oder wählen Sie die gewünschten Workflows aus.
Wählen Sie dann die gewünschten Gruppen und Rechte aus:
- Gruppen: enthält die Liste aller im System eingerichteten Gruppen, auf die man als angemeldeter Benutzer Zugriff hat.
  Wählen Sie die gewünschte(n) Gruppe(n) aus, für die Sie die Rechte einstellen möchten.
- Rechte verwalten: enthält auf der linken Seite alle verfügbaren Funktionen und auf der rechten Seite alle Rechte, die vergeben werden können.
  - Funktion Rechte hinzufügen (+): Diese Funktion fügt die ausgewählten Rechte den bereits bestehenden Rechten der ausgewählten Gruppen hinzu.
  - Rechte entziehen (-): Hiermit werden die markierten Rechte entzogen.
  - Rechte setzen (=): Diese Funktion setzt die Rechte der ausgewählten GRuppen auf die markierten Rechte. Nicht markierte Rechte werden den Gruppen entzogen.
Klicken Sie auf OK, um die Eingaben zu speichern.

Alternative 2: Rechte für einen Workflow ändern

Wählen Sie die Option Rechte aus dem Drop-down-Menü am Ende der Zeile aus, um die Rechte nur für den ausgewählten Workflow zu ändern.
Folgender Dialog wird geöffnet, um die Rechte einzustellen:
Dort können Sie jeweils die Lese- sowie Schreibrechte für alle bzw. bestimmte Gruppen einstellen. (Standardmäßig ist das Leserecht für alle eingeloggten Gruppen gesetzt.)
Klicken Sie auf OK, um die Eingaben zu speichern.

Workflow bearbeiten#

Workflows werden im Grid bearbeitet. Gehen Sie wie folgt vor:

Öffnen Sie den Workflow-Manager unter Menü -> Workflow.
Klicken Sie auf den Workflow, den Sie bearbeiten möchten.

Es wird das Grid gestartet, in dem der gewählte Workflow bearbeitet werden kann. Die Bedienung des Grids entnehmen Sie bitte dem Kapitel Das Grid.

Workflow löschen#

Um einen Workflow zu löschen, gehen Sie wie folgt vor:

Öffnen Sie den Workflow-Manager unter Menü -> Workflow.
Klicken Sie am Ende der Zeile des zu löschenden Workflows auf Löschen.
Es erscheint eine Sicherheitsabfrage, die Sie mit Okay bestätigen müssen.

Anschließend wird der Workflow gelöscht. Der Button Abbruch bricht die Aktion ab.

Das Grid#

Beim Grid handelt es sich um eine HTML5-Applikation, mit deren Hilfe Workflows innerhalb von imperia erstellt und bearbeitet werden. Das HTML5-Grid erfordert keine zusätzlichen Browser-Plug-ins und wird von allen modernen Browsern unterstützt.

The Grid

Die Bedienungsoberfläche des Grids gliedert sich in folgende Bestandteile:

Plug-in-Menü,
Toolbar und
Arbeitsbereich (Beschreibung siehe Benutzung des Grids).

Auf der linken Seite des Grids befindet sich das Plug-in-Menü. Es enthält alle verfügbaren Workflow-Plug-ins. Die Plug-ins werden durch Icons repräsentiert. Über die Suchfeld Plug-ins suchen... können Sie auch nach Plug-ins suchen.

Bitte beachten

Die Workflow-Plug-ins stehen nur zur Verfügung, nachdem die Lizenz Workflow-Editor aktiviert wurde.

Über das Drop-down-Menü innerhalb des Suchfelds können Sie nach den Plug-ins einer bestimmten Kategorie filtern. Filtern Sie beispielsweise nach Assets, um das Menü auf diejenigen Plug-ins einzuschränken, die sich in einem Upload-Workflow anbieten.

In der Toolbar stehen verschiedene Buttons für Dateioperationen zur Verfügung. Weiterhin wird am rechten Rand der Titel des aktuell geladenen Workflows angezeigt. Die Buttons haben im einzelnen folgende Funktionen:

Button	Funktion
Speichern	Speichert den geladenen Workflow und übernimmt Änderungen.
Speichern unter	Speichert den geladenen Workflow unter einem neuen Namen.
Öffnen	Öffnet die Liste aller eingerichteten Workflows, aus der dann ein Workflow zum Öffnen ausgewählt werden kann.
Neu	Legt einen neuen Workflow an. Es wird der Dialog Workflow anlegen geöffnet. Lesen Sie hierzu den Abschnitt Neuen Workflow anlegen.
Label	Öffnet einen Dialog, in dem Titel und Beschreibung des aktuellen Workflows geändert werden können.
Screenshot	Exportiert den aktuellen Workflow als `.png` Grafikdatei.
Rückgängig	Macht die letzte Aktion rückgängig.
Wiederholen	Führt die Aktion aus, die zuvor rückgängig gemacht wurde.

Benutzung des Grids#

Im Arbeitsbereich (Grid) werden die Workflows erstellt, die aus den einzelnen Workflow-Schritten bestehen. Bei den Workflow-Schritten handelt es sich um Workflow-Plug-ins, die in links in der Liste des Grids zu finden sind. Lesen Sie dazu im Kapitel Workflow-Plug-ins weiter.

Sie können den kompletten Arbeitsbereich bewegen, indem Sie die rechte Maustaste gedrückt halten und bewegen.

Im Folgenden wird Ihnen gezeigt, wie Sie das Grid nutzen können, um einen aus Workflow-Plug-ins bestehenden Workflow zu gestalten.

Workflow-Schritt hinzufügen#

Workflow-Schritte hinzufügen

Um einen neuen Workflow-Schritt zu einem Workflow hinzufügen, ziehen Sie das gewünschte Plug-in aus dem Plug-in-Menü per Drag-and-Drop in den Arbeitsbereich des Grids und positionieren Sie es in einem freien Feld.
Je nach Aufbau eines Workflows kann ein Workflow-Plug-in mehrfach darin vorkommen.

Workflow-Schritte verbinden#

Workflow-Schritte verbinden

Das Verbinden der einzelnen Workflow-Schritte untereinander erzeugt die Wege, die ein Dokument im Workflow gehen kann.
Workflow-Schritte werden mit Hilfe der Maus untereinander verbunden.
Ausgehend vom Datenausgang eines Workflow-Schrittes wird mit gedrückter linker Maustaste eine Verbindung, symbolisiert durch eine Linie, zu einem Dateneingang des folgenden Workflow-Schrittes gezogen. Wird die Maustaste an einem Dateneingang losgelassen, ist die Verbindung etabliert.

Workflow-Schritt verschieben#

Workflow-Verbindungen verschieben

Workflow-Schritte werden innerhalb des Arbeitsbereichs mit der Maus verschoben:

Klicken Sie den entsprechenden Workflow-Schritt an.
Halten Sie die Maustaste gedrückt und verschieben Sie den Workflow-Schritt in ein anderes freies Feld.
Bereits existierende Verbindungen bleiben erhalten.

Verbindungen löschen#

Workflow-Verbindungen löschen

Falls eine falsche Verbindung etabliert wurde, kann diese entweder gelöscht werden:

Rechtsklicken Sie hierfür auf die Verbindung.
Wählen Sie im Kontext-Menü den Eintrag Diese Verbindung löschen.

...oder durch eine korrekte Verbindung ersetzt werden:

Ziehen Sie eine neue Verbindung ausgehend vom gleichen Datenausgang, den auch die falsche Verbindung verwendet zum korrekten Dateneingang.
Beim Loslassen der Maustaste wird die alte Verbindung durch die neue ersetzt.

Workflow-Schritt löschen#

Workflow-Schritt löschen

Markierte Workflow-Schritte werden mit Hilfe der Entf-Taste oder mit Hilfe des Kontextmenüs der rechten Maustaste gelöscht.
Wird ein Workflow-Schritt gelöscht, werden auch die bestehenden Verbindungen zu anderen Workflow-Schritten entfernt.
Um mehrere Workflow-Schritte auf einmal zu löschen, markieren Sie diese, indem Sie sie mit gedrückter Shift-Taste einzeln markieren oder indem Sie mit gedrückter linken Maustaste einen Rahmen um die relevanten Schritte ziehen. Anschließend löschen Sie markierten Workflow-Schritte mittels der Entf-Taste.

Parameter und Zugriffsrechte eines Workflow-Schrittes einstellen#

Parameter

Die Einstellungsmöglichkeiten in dem Eigenschaften-Dialogfenster sind für die einzelnen Plug-ins unterschiedlich. Einige Plug-ins benötigen keine weitere Konfiguration.
Lesen Sie mehr über die Konfigurationsmöglichkeiten der einzelnen Plug-ins im Kapitel Workflow-Plug-ins.

Zugriffsrechte

Für viele Workflow-Schritte kann festgelegt werden, welche Gruppen zum Zugriff auf diesen Schritt berechtigen.

Auf diese Weise lässt sich konfigurieren, dass ein Dokument von dem Schreibtisch eines Benutzers verschwindet, sobald der Workflow-Schritt erreicht ist, auf den er keine Rechte mehr hat. In der gleichen Weise kann das Dokument auf dem Schreibtisch eines anderen Benutzers auftauchen lassen.

Bitte beachten

Die in einem Workflow-Schritt gesetzten Rechte überschreiben die Rechte, die in der Rubrik gesetzt wurden.
Für nicht interaktive Plug-ins werden keine Zugriffsrechte gesetzt, da für diese Plug-ins keine Eingabe vom Benutzer vorausgesetzt wird.

Beispielszenario

Der Benutzer mit der Gruppe Redakteur hat nur Zugriff auf den Workflow-Schritt "Bearbeiten". Sobald er diesen Workflow-Schritt abschließt, verschwindet das Dokument von seinem Schreibtisch. Es erscheint jedoch nun auf dem Schreibtisch des Benutzers mit der Gruppe Chefredakteur, der nur den nächsten Workflow-Schritt "Genehmigen" ausführen darf.

Um die Parameter und Zugriffsrechte einzustellen, gehen Sie wie folgt vor:

Doppelklicken Sie im Arbeitsbereich auf einen Workflow-Schritt, dessen Eigenschaften Sie einstellen wollen.
Dieses Dialogfenster kann auch mit Rechtsklick über das Kontext-Menü geöffnet werden (Option Bearbeiten).
Die folgende Abbildung zeigt exemplarisch das Dialogfenster für das Bearbeiten-Plug-in:

Sie können drei Zugriffsrechte auf einen Workflow-Schritt setzen:

Recht	Beschreibung
Bearbeiten	Eine Gruppe, die Zugriff auf einen Workflow-Schritt mit der Stufe Bearbeiten erlaubt, berechtigt zum Bearbeiten von Dokumenten, die den aktuellen Workflow-Schritt erreichen.
Lesen	Eine Gruppe, die Zugriff auf einen Workflow-Schritt mit der Stufe Lesen erlaubt, berechtigt zum Lesen von Dokumenten, die den aktuellen Workflow-Schritt erreichen.
Löschen	Eine Gruppe, die Zugriff auf einen Workflow-Schritt mit der Stufe Löschen erlaubt, berechtigt zum Löschen von Dokumenten, die den aktuellen Workflow-Schritt erreichen.

Markieren Sie in den entsprechenden Abschnitten eine oder mehrere Gruppen, die auf den gewählten Workflow-Schritt Zugriff der entsprechenden Stufe bekommen sollen.
Mehrere Gruppen werden mit Hilfe der Strg-Taste markiert.
Über die Option von Rubrik erben (Standard-Einstellung) werden die Rechte aus der mit diesem Workflow verknüpften Rubrik übernommen. Die in der Rubrik für einzelne Gruppen konfigurierten Lese-, Schreib- und Löschrechte gelten dann auch für das entsprechende Workflow-Plug-in.

Checkbox Im Dokumentenfortschritt anzeigen: Betrifft die Anzeige des Workflow-Schrittes in der Schreibtischansicht; ist standardmäßg aktiviert.
Klicken Sie auf Ok am unteren Rand des Dialogfensters, um die Einstellungen zu speichern. Der Button Abbruch schließt den Dialog, ohne Änderungen zu speichern.

Migration vom Java-Grid zum HTML5 Grid#

Zur Einführung des HTML5-Grid wurden die Standard- sowie die kostenpflichtigen Workflow-Plug-ins vom vorherigen Format FXML nach HTML migriert. Alle benutzerspezifischen Workflow-Plug-ins müssen ebenfalls migriert werden, damit diese im HTML5-Grid angezeigt werden. Um dies zu erreichen, können Sie das Skript / site_migrate_fxml_to_html.pl verwenden. Jedes benutzerspezifische Plug-in muss dabei einzeln migriert werden.

Ablauf der Migration

Angenommen, Sie haben ein eigenes Plug-in MyCustoms Plugin.fxml.

Installieren Sie die Perl-Module XML::LibXML und XML::LibXSLT

Führen Sie das Migrationsskript unter Angabe des zu migrierenden Plug-ins und des Zielortes aus:

perl site/bin/site_migrate_fxml_to_html.pl imperia/fx2/resources/forms/MyCustomPlugin.fxml  > site/view/imperia/default/controllers/structure/workflow/step/mycustomplugin.html

Wiederholen Sie den Vorgang für all Ihre benutzerdefinierten Plug-ins.

FAQ#

In meinem Workflow-Editor werden keine Plug-ins angezeigt#

Standardmäßig gibt es keine Workflow-Plug-ins im Workflow-Editor. Für die Erstellung oder Bearbeitung Ihres eigenen Workflows müssen Sie die Workflow-Editor-Lizenz erwerben.

Ich habe den Workflow geändert, aber die Änderungen haben keine Auswirkungen#

Änderungen an einem Workflow wirken sich nur auf Dokumente aus, die nach der Änderung erstellt oder re-importiert wurden. Dokumente, die bereits innerhalb eines Workflows sind, also auf dem Schreibtisch sind, durchlaufen den veralteten Workflow.

In einigen Fällen muss der Hermes-Daemon neu gestartet werden, um die Änderungen zu aktivieren. Dies gilt für jeden Workflow, der den Hermes-Daemon in irgendeiner Weise involviert. Beispielsweise in Workflows mit automatisiertem Import.

Möchten Sie Bestandsdokumente dennoch durch einen neuen Workflow laufen lassen (um z.B. neue Metadateien zuzuweisen), befolgen Sie folgende Schritte:

Einen neuen Workflow bauen bzw. einen Standard-Workflow erweitern, sodass hier das Template und das Metafile gesetzt werden.
Diesen Workflow per Skript auf alle – bzw. die relevanten – Rubriken übertragen.
Den Auftritt mit der Option "Workflow" reparsen und automatisiert freischalten.

Nach dem Update auf imperia 9 oder 10 werden unsere benutzerdefinierten Plugins nicht mehr angzeigt#

Eventuell sind Ihre Workflow-Plug-ins noch in dem alten FXML-Format definiert. Im Kapitel Migration vom Java-Grid zum HTML5 Grid erfahren Sie, wie Sie Ihre Workflow-Plug-ins migrieren können.