Handbuch:Erweiterung/Workflows/Workflow-Editor: Unterschied zwischen den Versionen

Keine Bearbeitungszusammenfassung
Keine Bearbeitungszusammenfassung
Zeile 1: Zeile 1:
Einfache Workflows lassen sich direkt im Wiki mit einem Workflow Editor anlegen. Hier sind mindestens folgende Schritte erforderlich:
Einfache Workflows lassen sich direkt im Wiki mit einem Workflow-Editor anlegen.
[[Datei:WfE im Bearbeitungsmodus.png|alternativtext=Ansicht des geöffneten Workflow-Editors am Beispiel "Unterschrift einholen"|zentriert|mini|650x650px|Der Workflows-Editor]]


# Erstellung einer Wikiseite mit der Erweiterung <code>.bpmn</code> (zum Beispiel über die "Neu"-Schaltfläche"): [[Datei:WfE Seite erstellen.png|alternativtext=Textfeld zur Erstellung der Seite Unterschrift.bpmn|zentriert|mini|350x350px|Seite über die "Neu"-Schaltfläche erstellen]]
# Hinzufügen der Workflow-Schritte
# Einrichten des Workflow-Triggers


Hier sind mindestens folgende zwei Schritte erforderlich:


# Hinzufügen der Workflow-Aktivitäten im Workflow-Editor
# Einrichten des Workflow-Auslösers (=Workflow-Trigger)<br />
​Nach dem Einrichten eines manuellen Workflow-Triggers kann der Workflow von Benutzern auf einer Wikiseite ausgelöst werden.


​Nach dem Einrichten des Workflow-Triggers kann der Workflow auf einer Wikiseite ausgelöst werden.
== Beispiel: Unterschrift auf einer Seite einholen ==
 
== Beispiel: Unterschrift auf einer Seite einfordern ==
Zur Einführung sehen wir uns einen einfachen Worfklow an:
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.  
Nach Fertigstellung einer Seite (z.B. eines Protokolls) wird die Unterschrift des Abteilungsleiters John Doe eingefordert.  
[[Datei:WfE BPMN Unterschrift.png|zentriert|mini|450x450px]]
[[Datei:WfE BPMN Unterschrift.png|zentriert|mini|500x500px|alternativtext=BPMN-Diagramm mit zwei Schritten|erforderliche Workflow-Schritte]]
 
=== ​Workflow erstellen ===
Wir benötigen eine Workflow-Definition mit zwei Workflow-Aktivitäten:
 
# '''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").[[Datei:WF User feedback Banner.png|alternativtext=Banner with action link |zentriert|mini|750x750px|Workflow Banner]]
# '''Edit wiki page (add signature):''' Nach Abschluss der Feedback-Aufgabe fügt der Workflow der Seite automatisch die Wiki-Unterschrift von J. Doe hinzu.[[Datei:Unterschrift John Doe.png|alternativtext=Wiki Unterschrift mit Name und Zeitstempel|zentriert|mini|Eingefügte Unterschrift]]
 
 
'''Hierzu erstellen wir eine Seite mit der Erweiterung <code>.bpmn</code>:'''
 
#'''Klicken''' Sie auf die Neu-Schaltfläche des Wikis und geben Sie den Seitennamen ein, z.B. <code>Unterschrift.bpmn</code>. [[Datei:WfE Seite erstellen.png|alternativtext=Textfeld zur Erstellung der Seite Unterschrift.bpmn|zentriert|mini|350x350px|Seite über die "Neu"-Schaltfläche erstellen]]
# '''Klicken''' Sie auf ''Fertig''.
# '''Öffnen''' Sie die Seite im Bearbeitungs-Modus. Das Diagramm zeigt bereits die Start-Aktivität an.
# '''Fügen''' Sie die Aktivität ''User feedback'' hinzu.[[Datei:WfE select User feedback .png|alternativtext=Ausschnitt der Editorleiste|zentriert|mini|192x192px|Aktivität "User feedback" ]]
## '''Ö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"),
## '''Fügen''' Sie den Benutzernamen sowie eine Anweisung hinzu (z.B. "Sign this page" oder "Seite unterschreiben")[[Datei:WfE Dialogfeld User feedback.png|alternativtext=Dialogfenster mit Beispielwerten aus den beschriebenen Schritten|zentriert|mini|450x450px|Dialogfenster für Aktivität "User feedback"]]
## '''Klicken''' Sie auf ''Speichern''.
# '''Fügen''' Sie die Aktivität ''Edit wiki page'' hinzu und verbinden Sie es mit der vorhergehenden Aktivität.[[Datei:WfE select Edit wiki page.png|alternativtext=Ausschnitt der Editorleiste|zentriert|mini|Aktivität "Edit wiki page" ]]
## '''Ö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"),
## '''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 [[mediawikiwiki:Help:Magic_words/de#Seitennamen|Magische Wort]] <code><nowiki>{{FULLPAGENAME}}</nowiki></code>.
## '''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).
## '''Geben''' Sie als Inhalt (Content) vier Tilden ein. Diese erzeugen [[mediawikiwiki:Help:Signatures/de|im Wiki automatisch die Unterschrift]] des angegebenen Benutzers.
## '''Markieren''' Sie die Änderung (also das Einfügen der Unterschrift auf der Seite) als kleine Änderung ([[mediawikiwiki:Help:Minor_edit|Minor revision]]), wenn sie keine Benachrichtigung oder Anzeige als letzte Änderung auf Übersichtsseiten im Wiki auslösen soll.
## '''Wählen''' Sie als Bearbeitungsmodus (Edit mode) ''Append''. Dies fügt die Unterschrift am Ende der Seite ein. [[Datei:WfE dialog for "Edit wiki page".png|alternativtext=Dialogfenster mit Beispielwerten aus den beschriebenen Schritten|zentriert|mini|450x450px|Dialogfenster für Aktivität "Edit wiki page"]]
## '''Klicken''' Sie auf ''Speichern''.
# '''Fügen''' Sie ein ''EndEvent'' hinzu und verbinden Sie es mit der vorhergehenden Aktivität.[[Datei:WfE End event.png|alternativtext=Ausschnitt aus der Workflow-Editorleiste mit dem Menüpunkt EndEvent|zentriert|mini|EndEvent ]]
# '''Speichern''' Sie die Seite.
 
Der Workflow sollte nun so aussehen:[[Datei:WfE BPMN Unterschrift.png|zentriert|mini|500x500px|alternativtext=BPMN-Diagramm mit zwei Schritten|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:


# '''Klicken''' Sie auf ''Globale Aktionen > Workflow-Triggers''.
# '''Klicken''' Sie auf ''Neuen Auslöser hinzufügen''.
# '''Wählen''' Sie ''Manuell'' als Typ aus.[[Datei:wFe Trigger hinzufügen.png|alternativtext=Dialogfenster zur Auswahl des Trigger-Typs|zentriert|mini|550x550px|Manuellen Workflow-Auslöser erstellen]]
# '''Richten''' Sie den Workflow-Auslöser ein:
## '''Geben''' Sie den Namen ein, so wie im Workflow-Menü auf der Seite angezeigt werden soll.
## '''Geben''' Sie eine kurze Beschreibung ein, so wie sie im Workflow-Menü auf der Seite angezeigt werden soll  (optional).
## '''Wählen''' Sie den Workflow ''Unterschrift'' als zu startenden Workflow aus.
## '''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. [[Datei:WfE Trigger einrichten.png|alternativtext=Dialogfenster mit den Parametern für den Workflow "Unterschrift"|zentriert|mini|550x550px|Auslöser einrichten]]


Hierzu erstellen wir einen Workflow mit zwei Workflow-Schritten :
=== Workflow anwenden ===
Der Workflow durchläuft folgende Schritte:


# User Feeback: 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 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. [[Datei:Wf starten.png|alternativtext=Dialogfenster zum Starten des Workflows "Unterschrift einholen"|zentriert|mini|500x500px|Workflow starten]]Es erscheint ein Startdialog. Da es in unserem  hier kein hinterlegtes Formular zur Dateneingabe gibt, kann der Dialog mit ''Fertig'' abgeschlossen werden.[[Datei:Wf starten ohne Formular.png|alternativtext=automatischer Startdialog|zentriert|mini|450x450px|Workflow starten]]Der zugewiesene Benutzer J. Doe erhält eine Email und es erscheint eine Aufgabe in seinem Benutzermenü im Wiki.
# Nach Abschluss der Feedback-Aufgabe fügt der Workflow
# '''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 [[Handbuch:Erweiterung/Workflows/Gruppen-Feedback anpassen#Systemnachricht erstellen|Name einer dem Workflow zugewiesenen Systemnachricht.]] Diese können Sie im Wiki anlegen.[[Datei:WF User feedback Banner.png|alternativtext=Banner with action link |zentriert|mini|750x750px|Workflow Banner]]
# '''Unterschrift wird zur Seite hinzugefügt:''' Die Wiki-Unterschrift wird automatisch an das Ende des Seiteninhalts angehängt.[[Datei:Unterschrift John Doe.png|alternativtext=Wiki Unterschrift mit Name und Zeitstempel|zentriert|mini|Eingefügte Unterschrift]]

Version vom 30. Oktober 2024, 12:16 Uhr

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

Ansicht des geöffneten Workflow-Editors am Beispiel "Unterschrift einholen"
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.

BPMN-Diagramm mit zwei Schritten
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").
    Banner with action link
    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.
    Wiki Unterschrift mit Name und Zeitstempel
    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.
    Textfeld zur Erstellung der Seite 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.
    Ausschnitt der Editorleiste
    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 mit Beispielwerten aus den beschriebenen Schritten
      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.
    Ausschnitt der Editorleiste
    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 mit Beispielwerten aus den beschriebenen Schritten
      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.
    Ausschnitt aus der Workflow-Editorleiste mit dem Menüpunkt EndEvent
    EndEvent
  7. Speichern Sie die Seite.

Der Workflow sollte nun so aussehen:

BPMN-Diagramm mit zwei Schritten
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.
    Dialogfenster zur Auswahl des Trigger-Typs
    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.
      Dialogfenster mit den Parametern für den Workflow "Unterschrift"
      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.
    Dialogfenster zum Starten des Workflows "Unterschrift einholen"
    Workflow starten
    Es erscheint ein Startdialog. Da es in unserem hier kein hinterlegtes Formular zur Dateneingabe gibt, kann der Dialog mit Fertig abgeschlossen werden.
    automatischer Startdialog
    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.
    Banner with action link
    Workflow Banner
  3. Unterschrift wird zur Seite hinzugefügt: Die Wiki-Unterschrift wird automatisch an das Ende des Seiteninhalts angehängt.
    Wiki Unterschrift mit Name und Zeitstempel
    Eingefügte Unterschrift




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