Handbuch:Erweiterung/Workflows

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 einfaches Feedback einzuholen oder über eine Abstimmung eine Seitenfreigabe auszulösen. Im Folgenden werden diese Workflows daher Begutachtungen genannt.

Arten von Workflows

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

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

Freigabe

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, der die Begutachtung durchführen soll. 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 ist nun gesperrt (auch für die freigebende Person).
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. Die Abstimmung löst eine Email an den Initiator aus.
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

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: Bearbeiter (keine Rechteprüfung), Begutachter (keine Rechteprüfung), Freigabeberechtigter (Freigaberechte werden geprüft)) 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 der Bearbeiter (1. Workflow-Teilnehmer) kann die Seite während des Checkouts bearbeiten. Während der Begutachter (2. Workflow-Teilnehmer) seine Aufgabe durchführt, ist der Workflow noch immer für den Bearbeiter ausgecheckt (für den Fall, dass der Begutachter eine weitere Bearbeitung anfordert).
EditPage	Der zugewiesene Bearbeiter kann die Seite bearbeiten und die Aufgabe abschließen.
UserVote	Nachdem der Bearbeiter-Schritt abgeschlossen ist, kann der Begutachter 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 Begutachter ablehnt, geht der Workflow zurück zum Bearbeiter. Die Abstimmung löst eine Email an den Initiator aus.
PageCheckin	Nachdem der Begutachter akzeptiert hat, wird die Seite eingecheckt und der Workflow wird fortgesetzt.
PageCheckout	In diesem Schritt wird die Seite für die Bearbeitung gesperrt. Der Freigabeberechtigte kann die Seite nicht ändern, muss jedoch die Workflow-Aufgabe abschließen oder delegieren.
ApprovePage	Nachdem der Freigabeberechtigte 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 Freigabeberechtigte 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

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

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

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

Aufgaben

Die Beteiligten werden von den Workflows auf ihrer Benachrichtungsseite sowie auf der Seite Meine Aufgaben über zugewiesene Workflow-Aufgaben informiert.

Meine Aufgaben

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

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.
UserVote	Initiator	ja	Nach einer Abstimmung erhält der Initiator eine E-Mail.
Workflow abgebrochen (manuell oder automatisch)	Initiator und alle Benutzer, die der laufenden Aufgabe zugewiesen sind, wenn der Workflow abgeborchen wird. Benutzer mit bereits abgeschlossenen Aufgaben werden nicht benachrichtigt.	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 derzeit zugewiesene Benutzer	ja
Workflow abgelaufen	Initiator und alle derzeit zugewiesene Benutzer	ja	Der Ablauf ist nur eine Art von Workflow-Abbruch, daher wird die gleiche Benachrichtigung wie beim Abbruch gesnedet. Die Begründung teilt mit, dass der Workflow abgelaufen ist.
Aufgabe delegiert	Benutzer/in, an die/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 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

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

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

Workflows anpassen

Workflows können direkt im Wiki als Seiten mit der Erweiterung .bpmn erstellt werden. Bestehende Workflows können oftmals mit xml-Kenntnis direkt im Wiki angepasst werden.

Ab BlueSpice 4.5 können Workflows auch über einen Workflow-Editor angepasst werden.

XML anpassen

Gruppen-Feedback

• Gruppen-Feedback anpassen: Standardmäßig wird dieser Workflow automatisch abgeschlossen, wenn genau 3 Mitglieder der ausgewählten Feedback-Gruppe ein Feedback abgegeben haben, egal wie groß die Gruppe ist. In einer Anpassung können Sie den Schwellenwert anpassen (z.B. Abschluss des Workflows, wenn n Mitglieder oder wenn n% der Mitglieder der Gruppe ihr Feedback abgegeben haben).
  Beispiel Gruppen-Feedback anpassen

Tutorial: Workflow-Activity "EditPage"

• Klassifizierung einer Seite Beispiel für eine Anpassung des BPMN-xml (mit Änderung des Seiteninhalts einer anderen, vordefinierten Seite)

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

Technische Referenz: Workflows

---

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