Handbuch:Erweiterung/Workflows/Workflow-Editor

Einfache Workflows lassen sich direkt im Wiki mit einem Workflow-Editor anlegen.

Der Workflows-Editor

Hier sind mindestens folgende zwei Schritte erforderlich:

1. Hinzufügen der Workflow-Aktivitäten im Workflow-Editor
2. Einrichten des Workflow-Auslösers (=Workflow-Trigger)
   

​Nach dem Einrichten eines manuellen Workflow-Triggers kann der Workflow von Benutzern auf einer Wikiseite ausgelöst werden.

Beispiel: Unterschrift auf einer Seite einholen

Zur Einführung sehen wir uns einen einfachen Worfklow an:

Nach Fertigstellung einer Seite (z.B. eines Protokolls) wird die Unterschrift des Abteilungsleiters John Doe eingefordert.

erforderliche Workflow-Schritte

​Workflow erstellen

Wir benötigen eine Workflow-Definition mit zwei Workflow-Aktivitäten:

1. User feeback (request signature): John Doe erhält eine Feedback-Aufgabe. Eine Feedback-Aufgabe fügt der Seite einen Banner hinzu. Um die Aufgabe abzuschließen, gibt John Doe sein Feedback ab (zum Beispiel: "zur Kenntnis genommen").
   

   Workflow Banner
2. Edit wiki page (add signature): Nach Abschluss der Feedback-Aufgabe fügt der Workflow der Seite automatisch die Wiki-Unterschrift von J. Doe hinzu.
   

   Eingefügte Unterschrift

Hierzu erstellen wir eine Seite mit der Erweiterung .bpmn:

1. Klicken Sie auf die Neu-Schaltfläche des Wikis und geben Sie den Seitennamen ein, z.B. Unterschrift.bpmn.
   

   Seite über die "Neu"-Schaltfläche erstellen
2. Klicken Sie auf Fertig.
3. Öffnen Sie die Seite im Bearbeitungs-Modus. Das Diagramm zeigt bereits die Start-Aktivität an.
4. Fügen Sie die Aktivität User feedback hinzu.
   

   Aktivität "User feedback"
   1. Öffnen Sie das Dialogfeld für die Aktivität (über Doppel-Klick) und geben Sie den Namen der Aktivität ein (z.B. "request signature" oder "Signatur anfordern"),
   2. Fügen Sie den Benutzernamen sowie eine Anweisung hinzu (z.B. "Sign this page" oder "Seite unterschreiben")
      

      Dialogfenster für Aktivität "User feedback"
   3. Klicken Sie auf Speichern.
5. Fügen Sie die Aktivität Edit wiki page hinzu und verbinden Sie es mit der vorhergehenden Aktivität.
   

   Aktivität "Edit wiki page"
   1. Öffnen Sie das Dialogfeld für die Aktivität (über Doppel-Klick) und geben Sie den Namen der Aktivität ein (z.B. "add signature" oder "Seite unterschreiben"),
   2. Geben Sie die Seite an, auf der die Unterschrift hinzugefügt werden soll. Im Normalfall ist das die Seite, auf der der Workflow ausgelöst wird. Hierfür verwenden Sie als Platzhalter das Magische Wort {{FULLPAGENAME}}.
   3. Geben Sie den Benutzernamen für die Unterschrift an. (Hinweis: Im nächsten Beispiel sehen wir, wie der Benutzername beim Auslösen des Workflows über ein Formular eingegeben werden kann, aber in diesem Beispiel geben wir der Einfachheit halber den Namen direkt im Workflow ein, da immer dieselbe Person unterschreibt).
   4. Geben Sie als Inhalt (Content) vier Tilden ein. Diese erzeugen im Wiki automatisch die Unterschrift des angegebenen Benutzers.
   5. Markieren Sie die Änderung (also das Einfügen der Unterschrift auf der Seite) als kleine Änderung (Minor revision), wenn sie keine Benachrichtigung oder Anzeige als letzte Änderung auf Übersichtsseiten im Wiki auslösen soll.
   6. Wählen Sie als Bearbeitungsmodus (Edit mode) Append. Dies fügt die Unterschrift am Ende der Seite ein.
      

      Dialogfenster für Aktivität "Edit wiki page"
   7. Klicken Sie auf Speichern.
6. Fügen Sie ein EndEvent hinzu und verbinden Sie es mit der vorhergehenden Aktivität.
   

   EndEvent
7. Speichern Sie die Seite.

Der Workflow sollte nun so aussehen:

Fertiger Workflow

Der Workflow kann nun im Wiki genutzt werden.

Als nächsten Schritt aktivieren wir den Workflow im Wiki.

Workflow-Auslöser erstellen

Damit der Workflow nun auf einer Seite genutzt werden kann, müssen wir noch einen Auslöser anlegen:

1. Klicken Sie auf Globale Aktionen > Workflow-Triggers.
2. Klicken Sie auf Neuen Auslöser hinzufügen.
3. Wählen Sie Manuell als Typ aus.
   

   Manuellen Workflow-Auslöser erstellen
4. Richten Sie den Workflow-Auslöser ein:
   1. Geben Sie den Namen ein, so wie im Workflow-Menü auf der Seite angezeigt werden soll.
   2. Geben Sie eine kurze Beschreibung ein, so wie sie im Workflow-Menü auf der Seite angezeigt werden soll (optional).
   3. Wählen Sie den Workflow Unterschrift als zu startenden Workflow aus.
   4. Geben Sie als Bedingung an, in welchen Namensräumen der Workflow zur Verfügung stehen soll (optional). Wenn keine Bedingung angegeben wird, steht der Workflow automatisch in allen Inhaltsnamensräumen zur Verfügung.
      

      Auslöser einrichten

Workflow anwenden

Der Workflow durchläuft folgende Schritte:

1. Workflow starten: Benutzer mit Bearbeitungsrechten im Wiki können nun den Workflow starten, um eine Unterschrift von J. Doe einzufordern. Hierzu wird der Workflow zum Beispiel auf einer Protokollseite über den entsprechenden Menüpunkt ausgelöst.
   

   Workflow starten
   Es erscheint ein Startdialog. Da es in unserem hier kein hinterlegtes Formular zur Dateneingabe gibt, kann der Dialog mit Fertig abgeschlossen werden.
   

   Workflow starten
   Der zugewiesene Benutzer J. Doe erhält eine Email und es erscheint eine Aufgabe in seinem Benutzermenü im Wiki.
2. Workflow-Aufgabe ausführen: J. Doe überprüft die Seite und führt über den blauen Banner seine zugewiesene Feedback-Aufgabe aus. Es ist möglich, dass im Banner nicht der Name angezeigt wird, sondern der Name einer dem Workflow zugewiesenen Systemnachricht. Diese können Sie im Wiki anlegen.
   

   Workflow Banner
3. Unterschrift wird zur Seite hinzugefügt: Die Wiki-Unterschrift wird automatisch an das Ende des Seiteninhalts angehängt.
   

   Eingefügte Unterschrift

---

Feedback zur Dokumentation ist im Community-Forum möglich.