8.2 Workflow

Version vom 2. November 2022, 13:44 Uhr

Workflows basieren in BlueSpice 4 auf BPMN 2.0. Vier verschiedene Standard-Workflows sind bereits integriert. Ihr Zweck ist es, eine Seite begutachten zu lassen und ein einfachesFeedback einzuholen oder über eine Abstimmung eine Seitenfreigabe auszulösen. Im Folgenden werden diese Workflows daher Begutachtungen genannt.

Arten von Workflows[Bearbeiten | Quelltext bearbeiten]

Arten von Workflows
Workflow	Typ	Beteiligte	Beschreibung
Freigabe	Freigabe	1 Benutzer	Ein einzelner Benutzer wird aufgefordert, über eine Seite abzustimmen. Am Ende wird bei einer "Zustimmung" des Begutachters die Seite automatisch freigegeben.
Qualitätsgesicherte Bearbeitung	Freigabe	3 Benutzer	Nach Bearbeitung einer Seite durch einen bestimmten Benutzer wird die Seite von einem Experten überprüft und über einen Hauptverantwortlichen freigegeben.
Gruppen-Feedback	Standard	1 Gruppe	Eine in der Gruppenverwaltung existierende Gruppe wird aufgefordert, über eine Seite einen Kommentar abzugeben.
Feedback	Standard	1 Benutzer	Ein einzelner Benutzer wird aufgefordert, über eine Seite einen Kommentar abzugeben.

Hinweis:Es kann immer nur ein Workflow des Typs "Freigabe" auf einer Seite aktiv sein. Standard-Workflows können unabhängig davon mehrfach aktiv sein.

Standard Workflows[Bearbeiten | Quelltext bearbeiten]

Alle Begutachtungsworkflows beginnen mit der Eingabe der Workflow-Einstellungen durch einen Benutzer (Workflow-Initiator) und resultieren in vorgegebenen Worfklow-Aktivitäten.

Freigabe[Bearbeiten | Quelltext bearbeiten]

Zweck: Freigabe einer Entwurfsseite durch einen Benutzer mit Freigaberechten. Dieser Workflow macht nur Sinn, wenn auf einer Seite die Freigabe-Funktion aktiviert ist.

Workflow-Instanzen: Es kann immer nur ein Freigabe-Worfklow pro Seite laufen.

BMMN Diagramm des Freigabe Worfklows.

Aktivität	Beschreibung
CollectData	Im ersten Workflow-Schritt werden die Einstellungen des Worfklows vorgenommen: Benutzer: Benutzer (oder Gruppe, die in der Gruppenverwaltung angelegt ist), die die Begutachtung durchführen soll(en). Anweisungen: Eine Mitteilung an den Benutzer oder die Benutzergruppe zur Durchführung der Begutachtung. Reportempfänger: An diese Email-Adresse wird beim Abschluss der Begutachtung ein Email-Report mit den Resultaten gesendet. Wird hier ein Benutzername angegeben, so muss in der Benutzerverwaltung eine Email-Adresse hinterlegt sein, damit der Report versendet werden kann.
PageCheckout	Die Seitenbearbeitung für Wikibenutzer wird gesperrt. Während der Workflow läuft, kann nur der Benutzer mit der Workflow-Aufgabe die Seite bearbeiten.
UserVote	Der zugewiesene Benutzer führt eine Abstimmung durch und akzeptiert die Seite oder lehnt sie ab. Alternativ kann die Aufgabe delegiert werden. Bei einer Ablehnung wird der nächste Schritt (ApprovePage) übersprungen.
ApprovePage	Bei einer Zustimmung wird die Seite freigegeben.
SendMail	Eine Email-Report wird an die angegebene Email-Adresse versandt.
PageCheckin	Die Seite wird abschließend entsperrt.

BPMN ansehen

Qualitätsgesicherte Bearbeitung[Bearbeiten | Quelltext bearbeiten]

Zweck: Freigabe einer Entwurfsseite nach dem "4-Augen-Prinzip".

Workflow-Instanzen: Es kann immer nur ein Freigabe-Workflow pro Seite laufen.

BPMN Diagramm des Workflows "Qualitätsgesicherte Bearbeitung"

Aktivität	Beschreibung
CollectData	Im ersten Workflow-Schritt werden die Einstellungen des Worfklows vorgenommen: Benutzer: Benutzer der eine Begutachtung durchführen soll. Es müssen drei Benutzer angegeben werden: Editor (Bearbeiter), Reviewer (Prüfer), Approver (Genehmiger) Anweisungen: Eine Mitteilung an die Benutzer, damit diese die Aufgabe verstehen. Reportempfänger: An diese Email-Adresse wird beim Abschluss der Begutachtung ein Email-Report mit den Resultaten gesendet. Wird hier ein Benutzername angegeben, so muss in der Benutzerverwaltung eine Email-Adresse hinterlegt sein, damit der Report versendet werden kann.
PageCheckout	Die Seite wird für die anstehende Abstimmung zur Bearbeitung für Wikibenutzer gesperrt. Nur Editor (1. Workflow-Teilnehmer) und Reviewer (2. Workflow-Teilnehmer) können die Seite bearbeiten.
EditPage	Der zugewiesene Editor kann die Seite bearbeiten und die Aufgabe kommentarlos abschließen.
UserVote	Nachdem der Editor-Schritt abgeschlossen ist, kann der Reviewer die Seite bearbeiten und eine Stimme abgeben. Alternativ kann die Aufgabe delegiert werden. Wenn die Abstimmung positiv ist (=akzeptiert), wird der Workflow fortgesetzt. Wenn der Reviewer ablehnt, geht der Workflow zurück zum Editor.
PageCheckin	Nachdem der Reviewer eine positive Stimme abgegeben hat (akzeptieren), wird die Seite eingecheckt und der Workflow wird fortgesetzt.
PageCheckout	In diesem Schritt wird die Seite für die Bearbeitung vollständig gesperrt. Der Approver kann die Seite nicht ändern, muss jedoch die Workflow-Aufgabe abschließen oder delegieren.
ApprovePage	Nachdem der Approver die zugewiesene Aufgabe abgeschlossen hat, wird die Seite vom Status "Entwurf" auf "freigegeben" gesetzt, wenn sich die Seite im Status "Entwurf" befand (nur wenn der Genehmiger die Seite akzeptiert hat). Wenn nicht, wird dieser Schritt übersprungen.
SendMail	Eine Email-Report wird an die angegebene Email-Adresse versandt.
PageCheckin	Die Seite wird abschließend entsperrt.

BPMN ansehen

Gruppenfeedback[Bearbeiten | Quelltext bearbeiten]

Zweck: Einholen von Feedback von einer Benutzergruppe. Die Gruppe muss in der Gruppenverwaltung angelegt sein.

Workflow-Instanzen: Es können unabhängig voneinander mehrere Feedback-Worfklows gleichzeitig auf einer Seite laufen.

BPMN Diagramm des Workflows "Gruppen-Feedback"

Aktivität	Beschreibung
CollectData	Im ersten Workflow-Schritt werden die Einstellungen des Worfklows vorgenommen: Benutzer: Benutzer (oder Gruppe, die in der Gruppenverwaltung angelegt ist), die die Begutachtung durchführen soll(en). Anweisungen: Eine Mitteilung an den Benutzer oder die Benutzergruppe zur Durchführung der Begutachtung. Reportempfänger: An diese Email-Adresse wird beim Abschluss der Begutachtung ein Email-Report mit den Resultaten gesendet. Wird hier ein Benutzername angegeben, so muss in der Benutzerverwaltung eine Email-Adresse hinterlegt sein, damit der Report versendet werden kann.
GroupFeedback	Alle Benutzer in der zugewiesenen Gruppe geben über ein Kommentarfeld ein Feedback ab. Hierbei handelt es sich um einen parallelen Workflow, das heißt, die Reihenfolge der Rückmeldungen ist egal.
SendMail	Eine Email-Report wird an die angegebene Email-Adresse versandt.

BPMN ansehen

Feedback[Bearbeiten | Quelltext bearbeiten]

Zweck: Einholen von Feedback eines einzelnen Benutzers zu einer Seite.

Workflow-Instanzen: Es können unabhängig voneinander mehrere Feedback-Worfklows gleichzeitig auf einer Seite laufen.

BPMN Diagramm des Feedback-Worfklows

Aktivität	Beschreibung
CollectData	Im ersten Workflow-Schritt werden die Einstellungen des Worfklows vorgenommen: Benutzer: Benutzer (oder Gruppe, die in der Gruppenverwaltung angelegt ist), die die Begutachtung durchführen soll(en). Anweisungen: Eine Mitteilung an den Benutzer oder die Benutzergruppe zur Durchführung der Begutachtung. Reportempfänger: An diese Email-Adresse wird beim Abschluss der Begutachtung ein Email-Report mit den Resultaten gesendet. Wird hier ein Benutzername angegeben, so muss in der Benutzerverwaltung eine Email-Adresse hinterlegt sein, damit der Report versendet werden kann.
UserFeedback	Der zugewiesene Benutzer gibt über ein Kommentarfeld ein Feedback ab.
SendMail	Eine Email-Report wird an die angegebene Email-Adresse versandt.

BPMN ansehen

Übersichtsseiten[Bearbeiten | Quelltext bearbeiten]

Alle Workflows sind auf der Seite Spezial:Workflows overview aufgeführt. Es gibt eine Ansicht der aktuellen Workflows und eine Ansicht aller Workflows:

Workflows Übersicht

Tasks[Bearbeiten | Quelltext bearbeiten]

Benutzer werden über ihre Workflows auf ihrer Benachrichtungsseite sowie auf der Seite Meine Aufgaben über zugewiesene Workflow-Aufgaben informiert.

Benachrichtigungen[Bearbeiten | Quelltext bearbeiten]

Auslöser[Bearbeiten | Quelltext bearbeiten]

Es gibt zwei Arten von Ereignissen, die eine Benachrichtigung auslösen:

generisch: Benachrichtigungen erfolgen für jeden Workflow-/Aktivitätstyp
basierend auf einer Aktivität: Aktivitäten selbst können entscheiden, zusätzliche Benachrichtigungen zu senden

Auslöser	Empfänger	Generisch	Bemerkungen
Aufgabe beginnt (wird zugewiesen)	Alle zugewiesene Benutzer	ja	Wird nur für den Typ UserInteractiveActivity ausgelöst, d.h. nur für Aktivitäten, denen Benutzer zugewiesen sind.
Workflow abgebrochen (manuell oder automatisch)	Initiator and all users that were assigned to the current task at time of aborting (not users who were assigned on previous tasks)	ja
Workflow beendet (nur nach Erreichen des Endpunkts, also kein Abbruch)	Initiator	ja
DueDateClose (2 Tage vor dem Erreichen des Fälligkeitsdatums)	Initiator und alle derzeitig zugewiesene Benutzer	ja
Workflow abgelaufen	Initiator and all currently assigned users	ja	Expiration is just a type of workflow abort, so the same notification as for abort will be sent with the reason explaining that the workflow expired.
Aufgabe delegiert	Benutzer, an den die Aufgabe delegiert weurde	nein	Auf die Aktivität UserVote beschränkt. Nach dem Delegieren gilt der neu zugewiesene Benutzer als zugewiesen und erhält alle weiteren Benachrichtigungen, die an zugewiesene Benutzer gehen.

Senden der Benachrichtigungen[Bearbeiten | Quelltext bearbeiten]

Benutzer können in ihren Einstellungen auswählen, ob sie E-Mail-Benachrichtigungen abonnieren möchten. Alle Benutzer erhalten automatisch Wiki-Benachrichtigungen.
Wiki-Benachrichtigungen werden sofort nach dem Auslösen versendet, während E-Mail-Benachrichtigungen asynchron bei der Ausführung von runJobs.php versendet werden. Dies gilt für Benachrichtigungen im Allgemeinen, nicht nur für Workflows.

Workflows auslösen (Trigger)[Bearbeiten | Quelltext bearbeiten]

Workflows können entweder manuell auf jeder Wiki-Seite oder nur unter bestimmten Bedingungen über individuelle Workflow-Trigger gestartet werden. Mit Triggern kann auch definiert werden, in welchen Namensräumen sowohl manuelle als auch automatische Workflows verfügbar sind.

Liste aller Workflow-Aktivitäten[Bearbeiten | Quelltext bearbeiten]

Die xml-Datei eines BPMN-Diagramms kann durch das Einfügen sogenannter Aktivitäten angepasst werden, um einen angepassten Workflow zu erstellen. Derzeit stehen folgende Aktivitäten zur Verfügung:

Erweiterung: Workflows

CustomForm: sammelt Daten für den Workflow, basierend auf einem benutzerdefinierten Formular (Erweiterung Forms).
EditPage: ermöglicht einen nicht-seitenbasierten Workflow.
EditRequest: fordert die Bearbeitung einer Seite durch einen Benutzer ein.
UserVote: fordert die Abstimmung eines einzelnen Benutzers ein.
GroupVote: sammelt Abstimmungen von einer Benutzergruppe. Die Abstimmung erreicht über einen Schwellenwert sein Ende.
UserFeedback: fordert das Feedback eines einzelnen Benutzers ein.
GroupFeedback: sammelt das Feedback von einer Benutzergruppe.
SendMail: sendet nach Abschluss einer Workflow-Aktion einen E-mail Bericht.
SetTemplateParams: ermöglicht das Hinzufügen oder Ändern eines Wikitext-Vorlagenaufrufs auf einer Seite.

Erweiterung: PageCheckout

PageCheckOut: Ermöglicht das Auschecken (und damit Sperren) einer Seite während eines Workflows.
PageCheckIn: Ermöglicht das Einchecken (und damit Entsperren) einer Seite während eines Workflows.

Erweiterung: BlueSpiceFlaggedRevsConnector

ApprovePage: Führt eine Seitenfreigabe während des Workflows durch.

Berechtigungen[Bearbeiten | Quelltext bearbeiten]

Folgende Berechtigungen werden von der Erweiterung Workflows eingesetzt:


Berechtigung	enthalten in Rolle	Beschreibung
workflows-view	reader	ermöglicht das Anzeigen von Workflow-Elementen, einschließlich des Auflistens von Workflows (z. B. das Anzeigen von laufenden Workflows auf der Seite) Benutzer kann die Seite Spezial:Workflows_overview sehen
workflows-execute	editor, reviewer, admin	ermöglicht das Starten eines Workflows und das Ausführen einer Aufgabe
workflows-admin	admin	ermöglicht das Abbrechen, Wiederherstellen und Verwalten aller Workflows Benutzer kann die Seite MediaWiki:WorkflowTriggers sehen und bearbeiten

Technische Referenz: Workflows

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

@@ Zeile 32: / Zeile 32: @@
 |}
 {{Hinweisbox|boxtype=Hinweis|icon=|Note text=Es kann immer nur ein Workflow des Typs "Freigabe" auf einer Seite aktiv sein. Standard-Workflows können unabhängig davon mehrfach aktiv sein.|bgcolor=}}
-==Benachrichtigungen und Reports==
-*'''Bei der Zuweisung einer Aufgabe:''' Wenn ein Benutzer eine Workflow-Aufgabe durchführen soll, wird sowohl eine Benachrichtigung als auch eine Aufgabe erstellt.
-*'''Nach Abschluss der Begutachtung:''' Nach Abschluss einer Begutachtung wird der Initiator benachrichtigt und eine Email an einen Reportempfänger verschickt.
-*'''Bei Abbruch eines Workflows:'''
-** Benachrichtigung wird an Benutzer mit einer ausstehenden Workflow-Aufgabe gesendet
-** Benachrichtigung wird an den Workflow-Ersteller gesendet
-** Teilnehmer vergangener oder zukünftiger Schritte erhalten keine Benachrichtigung
 ==Standard Workflows==
@@ Zeile 78: / Zeile 69: @@
 |}
+<span><br /></span>
 {{Icon|bi bi-arrow-right-circle|||}}  [https://github.com/wikimedia/mediawiki-extensions-BlueSpiceDistributionConnector/blob/4.1.3/workflow/UserApproval.bpmn BPMN ansehen]
@@ Zeile 123: / Zeile 114: @@
 |}
+<span><br /></span>
 {{Icon|bi bi-arrow-right-circle|||}}  [https://github.com/wikimedia/mediawiki-extensions-BlueSpiceDistributionConnector/blob/4.1.3/workflow/DocumentControl.bpmn BPMN ansehen]
@@ Zeile 150: / Zeile 141: @@
 |}
+<span><br /></span>
 {{Icon|bi bi-arrow-right-circle|||}}  [https://github.com/wikimedia/mediawiki-extensions-Workflows/blob/4.1.1/workflow/GroupFeedback.bpmn BPMN ansehen]
@@ Zeile 177: / Zeile 168: @@
 |}
+<span><br /></span>
 {{Icon|bi bi-arrow-right-circle|||}}  [https://github.com/wikimedia/mediawiki-extensions-Workflows/blob/4.1.1/workflow/UserFeedback.bpmn BPMN ansehen]
@@ Zeile 187: / Zeile 178: @@
 Benutzer werden über ihre Workflows auf ihrer Benachrichtungsseite sowie auf der Seite [[Referenz:UnifiedTaskOverview|Meine Aufgaben]] über zugewiesene Workflow-Aufgaben informiert.
-== Workflows auslösen ==
+== Benachrichtigungen ==
+=== Auslöser ===
+Es gibt zwei Arten von Ereignissen, die eine Benachrichtigung auslösen:
+* '''generisch:''' Benachrichtigungen erfolgen für jeden Workflow-/Aktivitätstyp
+* '''basierend auf einer Aktivität:''' Aktivitäten selbst können entscheiden, zusätzliche Benachrichtigungen zu senden
+{| class="wikitable" style=""
+!Auslöser
+!Empfänger
+!Generisch
+!Bemerkungen
+|-
+|'''Aufgabe beginnt'''
+(wird zugewiesen)
+|Alle zugewiesene Benutzer
+|ja
+|Wird nur für den Typ ''UserInteractiveActivity'' ausgelöst, d.h. nur für Aktivitäten, denen Benutzer zugewiesen sind.
+|-
+|'''Workflow abgebrochen'''
+(manuell oder automatisch)
+|Initiator and all users that were assigned to the current task at time of aborting (not users who were assigned on previous tasks)
+|ja
+|
+|-
+|'''Workflow beendet'''
+(nur nach Erreichen des Endpunkts, also kein Abbruch)
+|Initiator
+|ja
+|
+|-
+|'''DueDateClose'''
+(2 Tage vor dem Erreichen des Fälligkeitsdatums)
+|Initiator und alle derzeitig zugewiesene Benutzer
+|ja
+|
+|-
+|'''Workflow abgelaufen'''
+|Initiator and all currently assigned users
+|ja
+|Expiration is just a type of workflow abort, so the same notification as for abort will be sent with the reason explaining that the workflow expired.
+|-
+|'''Aufgabe delegiert'''
+|Benutzer, an den die Aufgabe delegiert weurde
+|nein
+|Auf die Aktivität ''UserVote'' beschränkt. Nach dem Delegieren gilt der neu zugewiesene Benutzer als zugewiesen und erhält alle weiteren Benachrichtigungen, die an zugewiesene Benutzer gehen.
+|}
+=== Senden der Benachrichtigungen ===
+* Benutzer können in ihren Einstellungen auswählen, ob sie E-Mail-Benachrichtigungen abonnieren möchten.  Alle Benutzer erhalten automatisch Wiki-Benachrichtigungen.
+* Wiki-Benachrichtigungen werden sofort nach dem Auslösen versendet, während E-Mail-Benachrichtigungen asynchron bei der Ausführung von runJobs.php versendet werden. Dies gilt für Benachrichtigungen im Allgemeinen, nicht nur für Workflows.
+== Workflows auslösen (Trigger) ==
 Workflows können entweder manuell auf jeder Wiki-Seite oder nur unter bestimmten Bedingungen über individuelle [[Handbuch:Erweiterung/Workflows/Triggers|Workflow-Trigger]] gestartet werden. Mit Triggern kann auch definiert werden, in welchen Namensräumen sowohl manuelle als auch automatische Workflows verfügbar sind.
@@ Zeile 193: / Zeile 238: @@
 Die xml-Datei eines BPMN-Diagramms kann durch das Einfügen sogenannter Aktivitäten angepasst werden, um einen angepassten Workflow zu erstellen. Derzeit stehen folgende Aktivitäten zur Verfügung:
+<span><br /></span>
 '''Erweiterung: Workflows'''
@@ Zeile 206: / Zeile 251: @@
 * [[Handbuch:Erweiterung/Workflows/Activity/SetTemplateParams|SetTemplateParams]]: ermöglicht das Hinzufügen oder Ändern eines Wikitext-Vorlagenaufrufs auf einer Seite.
+<span><br /></span>
 '''Erweiterung: PageCheckout'''
@@ Zeile 212: / Zeile 257: @@
 * [[Handbuch:Erweiterung/Workflows/Activity/PageCheckIn|PageCheckIn]]: Ermöglicht das Einchecken (und damit Entsperren) einer Seite während eines Workflows.
+<span><br /></span>
 '''Erweiterung: BlueSpiceFlaggedRevsConnector'''
 *[[Handbuch:Erweiterung/Workflows/Activity/ApprovePage|ApprovePage]]: Führt eine Seitenfreigabe während des Workflows durch.