Handbuch:Erweiterung/Workflows/Tutorial

← Erweiterung/Workflows

 

Anleitung zum Erstellen eines benutzerdefinierten Workflows

Zusätzlich zu den eingebauten Workflows können Benutzer ihre eigenen Workflows im Wiki erstellen. Die Funktionalität der Workflows basiert auf den derzeit implementierten Workflow-Elementen. Beachten Sie, dass derzeit nicht alle Elemente des BPMN-Standards von der Workflows-Erweiterung unterstützt werden.

Schritte zum Erstellen eines benutzerdefinierten Workflows

So erstellen Sie einen Workflow:

1. Definieren des erforderlichen Workflows mit den notwendigen Schritten und Aktivitäten
2. Erstellen einer Seite mit der Erweiterung .bpmn. Idealerweise wird diese Seite im MediaWiki-Namensraum erstellt, um die Bearbeitungsrechte auf Wiki-Administratoren zu beschränken.
3. Bearbeiten Sie die Seite im Modus Diagramm bearbeiten oder klicken Sie auf das Stiftsymbol.

   

   Bearbeiten Menü

4. Fügen Sie ein Startereignis, Aktivitäten, Gateways (optional) und ein Endereignis hinzu. Die folgenden BPMN-Elemente werden unterstützt:
   • Ereignisse: Start- und Endereignis
   • Gateways: derzeit sind nur parallele Gateways möglich
   • Aktivitäten: BlueSpice hat einen eigenen Satz von Aktivitäten. Siehe die vollständige Liste.
   • Darüber hinaus können Sie den Workflow an eine bestimmte Seitenrevision binden. (Dies ist z. B. für Genehmigungsworkflows erforderlich).
5. Speichern Sie das BPMN-Diagramm.
6. Sollen beim Starten eines Workflows Daten gesammelt werden, die in der Workflow-Ausführung berücksicht werden müssen, dann wird zusätzlich eine Formularseite mit der Erweiterung .form angelegt.
7. Fügen Sie einen Workflow-Auslöser hinzu.
8. Testen Sie den Workflow: Der Workflow ist nun im Wiki verfügbar. Sie sollten testen, ob die folgenden Funktionen verfügbar sind:
   • Der Workflow kann in den im Workflow-Auslöser definierten Namensräumen gestartet werden (falls es hier Einschränkungen gibt).
   • Der Workflow wird ausgelöst.
   • Der Workflow ist in der Übersichtsseite der Workflows aufgelistet.
   • Der zugeordnete Benutzer hat eine Aufgabe erhalten.
   • Der Workflow wird in allen möglichen Szenarien korrekt abgeschlossen (im Falle von Gateways).

Beispiel 1 (einfach): Unterschrift auf einer Seite einholen

Definition des Workflows

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

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

Workflow erstellen

​Hierzu erstellen wir eine Seite mit der Erweiterung .bpmn:

1. Klicken Sie auf die Neu-Schaltfläche des Wikis und geben Sie den Seitennamen mit der Erweiterung .bpmn 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.
   4. Verbinden Sie das StartEvent mit der Aktivität User feedback.
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.
   8. Verbinden Sie die Aktivität User feedback mit der Aktivität Edit wiki page.
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.

   

   Workflow Banner

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

   

   Eingefügte Unterschrift

Beispiel 2 (fortgeschritten): Klassifizierung einer Wikiseite

Workflow definieren

Angenommen, wir möchten einen Workflow erstellen, der die Klassifizierung einer Wikiseite abfragt.

Basierend auf der Klassifizierung des Dokuments sendet er entweder eine E-Mail an ein Mitglied der Rechtsabteilung oder fügt zunächst einen Klassifizierungseintrag auf einer Wikiseite hinzu nd sendet die E-Mail anschließend an die Rechtsabteilung.

Der beschriebene Workflow besteht aus vier Aktivitäten und einem Gateway.

Klassifizierungsworkflow

Erforderliche Workflow-Komponenten

Um den Workflow zu erstellen, sind folgende Schritte erforderlich:

1. Erstellen Sie die benutzerdefinierte Workflow-Definition:
   MediaWiki:Klassifizierungsworkflow.bpmn
2. Erstellen Sie ein Initiierungsformular, das vor dem Senden der Aufgabe einige Informationen zum Workflow hinzufügt:
   MediaWiki:InhaltsklassifizierungInit.form
3. Erstellen Sie ein Klassifizierungsformular, mit dem der zugewiesene Benutzer das Dokument klassifizieren kann:
   MediaWiki:Inhaltsklassifizierung.form
4. Erstellen Sie die Wiki-Seite Meldungen Klasse B, die Vorfälle der Klasse B erfasst.
5. Fügen Sie dem Wiki einen Workflow-Trigger hinzu, der definiert, wo und wie der Workflow gestartet werden soll.
6. Testen Sie den Workflow.

Benutzerdefinierte Workflow-Definition erstellen

Erstellen wir zunächst eine Seite mit dem Namen MediaWiki:Klassifizierungsworkflow.bpmn. Sie öffnet den Workflow-Editor.

Workflow-Editor

• Fügen Sie Ihrem Diagramm die folgenden Formen hinzu (fahren Sie mit der Maus über die Symbole in der Werkzeugleiste, um die Namen der einzelnen BPMN-Elemente anzuzeigen).
• Verbinden Sie jedes Element mit einem Pfeil.
• Klicken Sie auf jede Form, um die erforderlichen Informationen einzugeben:

1. Ein Benutzerdefiniertes Formular zum Starten des Workflows.
   1. Name: Initiierungsformular
   2. Formulartyp: On-wiki-Form
   3. Titel des Formulars: MediaWiki:InhaltsklassifizierungInit.form
   4. Verwendung als Initialisierer: Ja
2. Ein weiteres Benutzerdefiniertes Formular zur Klassifizierung der Seite, auf der der Workflow ausgeführt wird.
   1. Name: Klassifizierungsformular
   2. Formulartyp: On-wiki-Form
   3. Titel des Formulars: MediaWiki:Inhaltsklassifizierung.form
   4. Verwendung als Initialisierer: Ja
   5. Eigenschaften:
      1. Zugewiesener_Benutzer: {{ROOTPAGENAME:{{#show:{{FULLPAGENAME}}|?Verantwortlich|link=none|default=WikiSysop}}}}
      2. Laufzeit: {{#time:YmdHis|jetzt + 7 Tage}}

         

         Klassifizierungsformular

         KlassifizierungSehen wir diese Aktivität genauer an. Sie verfügt neben der Formularreferenz über einige zusätzliche Eigenschaften:
         • zugewiesener Benutzer: Die Eigenschaft zugewiesener_Benutzer ist obligatorisch, da die Workflow-Engine wissen muss, welcher Benutzer abgefragt werden soll. In diesem Fall verwenden wir Wikitext-Magie, um den zugewiesenen Benutzer aus dem Kontext zu berechnen. Der Wert besteht aus einer Kombination aus einer Wikitext-Variablen und einer Parserfunktion (diese Parserfunktion wird von der Semantic MediaWiki-Erweiterung definiert, die hier als Abhängigkeit betrachtet werden kann). Die Parserfunktion {{#show}} versucht, einen Benutzernamen aus einer semantischen Eigenschaft abzurufen, die auf der Seite, auf der der Workflow gestartet wird, gesetzt sein kann oder nicht. Falls keine passenden Informationen gefunden werden, wird auf WikiSysop zurückgegriffen (vorausgesetzt, ein solcher Benutzer ist im Wiki vorhanden). Die Variable {{ROOTPAGENAME}} ermöglicht es, den Namespace „Benutzer“ zu entfernen, wenn der gesuchte Wert beispielsweise Benutzer:JaneDoe statt nur JaneDoe lautet.
         • Laufzeit: Die Eigenschaft Laufzeit ist ebenfalls obligatorisch. Alle benutzerbezogenen Aktivitäten benötigen ein Fälligkeitsdatum. Ist die laufende Aktivität überfällig, beendet die Workflow-Engine den Workflow. In diesem Fall implementieren wir das Konzept von „Liegetagen“, da wir kein absolutes Fälligkeitsdatum haben, sondern dieses ab dem Zeitpunkt des Aktivitätsstarts mithilfe der Parserfunktion {{#time}} berechnen.
         • Klassifizierung: Die Eigenschaft Klassifizierung ist zufällig. Sie muss angegeben werden, damit das Formular sie festlegen und der Workflow-Kontext darauf zugreifen kann. Wir hätten einen Standardwert angeben können, möchten ihn aber leer lassen.
3. Ein Gateway, das die Klassifizierungsauswahl des Benutzers verarbeitet.
   1. Name: Inhaltsklassifizierung.Klassifizierung (Hinweis: Der Name muss mit dem Namen des Formulars und seiner Eigenschaft übereinstimmen, die im vorherigen Schritt ausgewertet wurde.)
   2. Name des Konnektors zur Aktivität „E-Mail senden“: Klasse_A
   3. Name des Konnektors zur Aktivität „Klasse B erfassen“: Klasse_B
4. Eine Aktivität „E-Mail senden“ nach der Klassifizierungsauswahl „Klasse_A“.
   1. Name: E-Mail senden
   2. Eigenschaften:
      1. Empfänger: legal@mycompany.com (ersetzen Sie die E-Mail-Adresse, die benachrichtigt werden soll)
      2. Betreff: Neuer Inhalt "{{{Inhaltsklassifizierung.Klassifizierung}}}": {{FULLPAGENAME}}
      3. Text: {{{Inhaltsklassifizierung.Zugewiesener_Benutzer}}} hat die Seite [[{{FULLPAGENAME}}]] als "{{{Inhaltsklassifizierung.Klassifizierung}}}" klassifiziert.

         

         Aktivität "E-mail senden"

5. Eine Aktivität „Wiki-Seite bearbeiten“ nach der Klassifizierung „Klasse B“ Auswahl. Verknüpfen Sie es mit der Aktivität „E-Mail senden“ aus Schritt 5.
   1. Name: Datensatz Klasse B
   2. Zu bearbeitende Wiki-Seite: Datensätze der Klasse B (Titel der Wiki-Seite, der der Inhalt vorangestellt wird)
   3. Benutzer: {{ROOTPAGENAME:{{#show:{{FULLPAGENAME}}|?Verantwortlich|link=none|default=WikiSysop}}}} (Benutzer, der im Versionsverlauf der angehängten Wiki-Seite angezeigt wird)
   4. Inhalt: *[[{{FULLPAGENAME}}]] wurde von [[Benutzer:{{{Inhaltsklassifizierung.Zugewiesener_Benutzer}}}}]] als {{{Inhaltsklassifizierung.Klassifizierung}}} klassifziert. (Text, der der Wiki-Seite hinzugefügt wird)
   5. Kleine Änderung: Sie können die Standardeinstellung beibehalten oder diese Einstellung deaktivieren. Kleine Änderungen lösen in der Regel keine Benachrichtigungen aus, wenn Wiki-Benutzer „Bearbeitungsereignisse“ abonniert haben (allgemeine Informationen zu kleineren Änderungen finden Sie unter mediawiki.org).
   6. Bearbeitungsmodus: Voranstellen (im Gegensatz zur Optioin Anhängen werden die Einträge auf der Seite Datensätze der Klasse B in absteigender Reihenfolge angezeigt).
6. Fügen Sie das Endereignis nach der Aktivität E-Mail senden hinzu.
7. Speichern Sie das Diagramm.

Startformular erstellen

Das Startformular ermöglicht die Interaktion mit dem Benutzer, der den Workflow startet. Es erklärt, was beim Start des Workflows passiert, und ermöglicht das Hinzufügen eines Kommentars, um Kontext zur Benutzeraufgabe zu liefern.

Genau wie die BPMN-Workflow-Definition erstellen wir auch dieses Formular im Namensraum MediaWiki.

So erstellen Sie das Startformular:

1. Erstellen Sie die Seite MediaWiki:InhaltsklassifizierungInit.form. Der Formulareditor öffnet sich.
2. Klicken Sie auf Formularelemente > ...Anderes und ziehen Sie ein Element Label in den Bearbeitungsbereich.

   

   Formular "InhaltsklassifizierungInit"

3. Klicken Sie auf eine beliebige Stelle auf das Label-Element im Bearbeitungsbereich, um den Element-Inspektor zu öffnen. Fügen Sie Folgendes hinzu:
   1. Name: intro
   2. Beschriftung: Klicken Sie auf "Start", um eine Person mit Fachkenntnissen um eine Einstufung zu bitten. Sie können unten eine Anweisung hinterlassen.
4. Wechseln Sie von ... Anderes zu Eingaben und fügen Sie ein Textbereich-Element hinzu. Ziehen Sie es unter das Intro-Feld. Fügen Sie Folgendes hinzu:
   1. Name: kommentar
   2. Beschriftung: Kommentar
5. Speichern Sie das Formular.

Klassifizierungsformular erstellen

Nun benötigen wir ein Formular, mit dem der zugewiesene Benutzer während der Workflow-Ausführung eine Klassifizierung auswählen kann.

So erstellen Sie das Klassifizierungsformular:

1. Erstellen Sie die Seite MediaWiki:Inhaltsklassifizierung.form .
2. Wählen Sie den Eingabetyp Dropdown aus und ziehen Sie ihn in den Bearbeitungsbereich.
3. Klicken Sie irgendwo in die Zeile des hinzugefügten Elements, um den Element-Inspektor zu öffnen. Fügen Sie Folgendes hinzu:
   1. Name: Klassifizierung
   2. Beschriftung: Klassifizierung

      

      Klassifizierungsformular

4. Wechseln Sie im Element-Inspektor zu den Optionen. Fügen Sie Folgendes hinzu:
   1. Daten: Klasse_A (der Datenname muss mit der Konnektorbezeichnung des Gateways in der BPMN-Workflow-Definition übereinstimmen).
   2. Beschriftung (Label): Klasse A
5. Klicken Sie im Reiter Optionen auf Option hinzufügen:
   1. Daten: Klasse B (der Datenname muss mit der Konnektorbezeichnung des Gateways in der BPMN-Workflowdefinition übereinstimmen).
   2. Beschriftung (Label): Klasse B
6. Speichern Sie das Formular.

Klassifizierungsoptionen

Wiki-Seite „Meldungen Klasse B“ erstellen

Da wir den Workflow anweisen, alle als Klasse B klassifizierten Seiten aufzuzeichnen, müssen wir sicherstellen, dass diese Seite im Wiki vorhanden ist. Daher erstellen wir einfach die Seite Klasse B-Datensätze und speichern sie leer. Da wir in der Workflow-Definition festgelegt haben, dass alle Vorfälle der Klasse B dieser Seite vorangestellt hinzugefügt werden, ist es nicht sinnvoll, dieser Seite weitere Inhalte hinzuzufügen.

Wir haben nun alle Elemente, um den Workflow zu starten. Wir können nun hierfür auch den benötigten Workflow-Trigger definieren.

Workflow-Auslöser erstellen

Damit der Workflow im Wiki angezeigt wird, müssen wir einen Trigger definieren:

1. Klicken Sie im Menü Globale Aktionen auf Workflow-Trigger.
2. Klicken Sie auf Neuen Auslöser hinzufügen.
3. Wählen Sie im Dropdown-Menü die Option „Manuell“.
4. Klicken Sie auf Fortfahren.
5. Definieren Sie die Einstellungen für den Workflow-Trigger:
   • Name: Klassifizierung (Name, der im Workflow-Auswahlmenü angezeigt wird)
   • Beschreibung: Klassifiziert ein Dokument als Klasse A oder Klasse B (Erläuterung der Funktion dieses Workflows)
   • Zu startender Workflow: Klassifizierungsworkflow
   • Anfangsdaten für den Workflow (optional): Standardkommentarvorschlag. Sie können dieses Feld leer lassen.
   • Bedingungen (optional): Sie können auswählen, in welchen Namensräumen der Workflow zur Auswahl angezeigt wird. Wenn kein Namensraum angegeben ist, kann der Workflow in allen Namenesräumen ausgelöst werden.
6. Klicken Sie auf Speichern.

Ihr Workflow ist nun bereit zum Testen.

Workflow testen

Sie sollten testen, ob die folgenden Funktionen verfügbar sind:

• Der Workflow kann in den im Workflow-Trigger definierten Namensräumen gestartet werden (sofern hier Einschränkungen bestehen).
• Der Workflow wird ausgelöst.
• Der Workflow wird in der Workflows-Übersicht (Spezial:Workflows_overview) angezeigt.
• Der zugewiesene Benutzer hat eine Aufgabe erhalten.
• Der Workflow wird in Fall A und B korrekt abgeschlossen.

PDF-Ausschluss - Start

---

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

PDF-Ausschluss - Ende

Im Wiki abgetrennter Bereich, dessen Inhalte über spezielle Berechtigungen gelesen und bearbeitet werden können. Einen Namensraum erkennt man an einem Präfix vor dem Artikeltitel.

Formatierungssprache für Wikiseiten. Der Wikitext kann im Quelltextmodus angesehen und bearbeitet werden.

Set von Wiki-Erweiterungen, mit dem strukturierte Daten erstellt und abgefragt werden können.