8.2 Workflows

Revision as of 10:10, 21 December 2021

Einleitung

In BlueSpice 4.1, workflows are based on BPMN 2.0. Four different types of page-based workflows are already integrated. Their purpose is page reviews to obtain feedback via a vote or to trigger a page approval. In the following, these workflows are therefore called review workflows.

Types of reviews
Workflow type	Participants	Description
Single user approval	1 user	A single user is asked to vote about a page. If a user submits a positive vote, the page is automatically approved.
Expert document control	3 users	After a page has been edited by a specific user, the page is reviewed by an expert and then approved by a user who is responsible for approvals.
Group Feedback	1 group	A group (needs to exist in the group manager) is requested to leave a comment on a page.
Single user feedback	1 user	A user is asked to send a comment regarding a page.

Notifications and reports

When a task gets assigned: When a user needs to complete a workflow task, both a notification and a task are created.
At the end of a worfklow: After a workflow has ended, the initiator receives a notification and an email is sent to a report recipient (as defined at the beginning of the workflow).

Workflow activities

All approval workflows start with a form where the necessary workflow data is entered by the workflow initiator. Each workflow results in one or more workflow activities.

Single user approval

Purpose: Approval of a draft page by a user with approval rights. This workflow only makes sense if the approval function (FlaggedRevs) is activated on a page.

Workflow instances: Only one approval workflow can run per page.

Activity	Description
CollectData	Im ersten Workflow-Schritt werden die Einstellungen des Worfklows vorgenommen: user: user (oder Gruppe, die in der Gruppenverwaltung angelegt ist), die die Begutachtung durchführen soll(en). Anweisungen: Eine Mitteilung an den user oder die usergruppe 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 username angegeben, so muss in der userverwaltung eine Email-Adresse hinterlegt sein, damit der Report versendet werden kann.
PageCheckout	Wenn eine Begutachung läuft, ist die Seite für eine Bearbeitung gesperrt.
PageCheckout	Die Seite wird für die anstehende Abstimmung zur Bearbeitung gesperrt.
UserVote	Der zugewiesene user führt eine Abstimmung durch und stimmt entweder zu oder lehnt ab. Alternativ kann die Aufgabe delegiert werden. Bei einer Ablehnung wird die Begutachtung abgebrochen.
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.

Expert document control

Purpose: Approval of a draft page according to the "4-eyes principle".

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

Activity	Description
CollectData	Im ersten Workflow-Schritt werden die Einstellungen des Worfklows vorgenommen: user: user (oder Gruppe, die in der Gruppenverwaltung angelegt ist), die die Begutachtung durchführen soll(en). Anweisungen: Eine Mitteilung an den user oder die usergruppe 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 username angegeben, so muss in der userverwaltung eine Email-Adresse hinterlegt sein, damit der Report versendet werden kann.
PageCheckout	Die Seite wird für die anstehende Abstimmung zur Bearbeitung gesperrt.
EditPage	Begutachter 1 kann die Seite bearbeiten und schließt die Aufgabe kommentarlos ab.
UserVote	Begutachter 2 und 3 stimmen ab. Sobald ein Begutachter ablehnt, started die Begutachtung erneut mit Begutachter 1.
ApprovePage	Nach Zustimmung von Begutachter 2 und 3 wird die Seite freigegeben.
SendMail	Eine Email-Report wird an die angegebene Email-Adresse versandt.
PageCheckin	Die Seite wird abschließend entsperrt.

Group feedback

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

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

Aktivität	Beschreibung
CollectData	Im ersten Workflow-Schritt werden die Einstellungen des Worfklows vorgenommen: user: user (oder Gruppe, die in der Gruppenverwaltung angelegt ist), die die Begutachtung durchführen soll(en). Anweisungen: Eine Mitteilung an den user oder die usergruppe 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 username angegeben, so muss in der userverwaltung eine Email-Adresse hinterlegt sein, damit der Report versendet werden kann.
GroupFeedback	Alle user 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.

Feedback

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

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

Aktivität	Beschreibung
CollectData	Im ersten Workflow-Schritt werden die Einstellungen des Worfklows vorgenommen: user: user (oder Gruppe, die in der Gruppenverwaltung angelegt ist), die die Begutachtung durchführen soll(en). Anweisungen: Eine Mitteilung an den user oder die usergruppe 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 username angegeben, so muss in der userverwaltung eine Email-Adresse hinterlegt sein, damit der Report versendet werden kann.
PageCheckout	Wenn eine Begutachung läuft, ist die Seite für eine Bearbeitung gesperrt. (Hinweis: In der Qualitätsgesicherten Bearbeitung wird erst nach dem ersten Begutachter gesperrt)´).
UserFeedback	Der zugewiesene user gibt über ein Kommentarfeld ein Feedback ab.
SendMail	Eine Email-Report wird an die angegebene Email-Adresse versandt.

Overview page

Alle Workflows sind auf der Seite Spezial:Workflows overview aufgeführt. Es gibt eine Ansicht der aktuellen Workflows und eine Ansicht aller Workflows: alternativtext=Workflows Übersicht|zentriert|thumb|750x750px|Workflows Übersicht

Tasks

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

How to add a workflow

Die xml-Datei eines BPMN-Diagramms kann durch das Einfügen sogenannter Aktivitäten angepasst werden. Derzeit gibt es folgende definierte Aktivitäten:

Extension: Workflows

Extension: PageCheckout

Extension: BlueSpiceFlaggedRevsConnector

ApprovePage

Beispiel zum erstellen eines neuen Workflows

Technical Reference: Workflows

To submit feedback about this documentation, visit our community forum.

@@ Line 1: / Line 1: @@
 ==Einleitung==
-Workflows basieren in BlueSpice 4.1 auf [[:de:Business_Process_Model_and_Notation|BPMN 2.0]]. Vier verschiedene Arten von seitenbasierten Workflows sind bereits integriert. Ihr Zweck ist es, eine Seite begutachten zu lassen und über eine Abstimmung ein Feedback einzuholen oder eine Seitenfreigabe auszulösen. Im folgenden werden diese Workflows daher Begutachtungen genannt.
+In BlueSpice 4.1, workflows are based on [[:de:Business_Process_Model_and_Notation|BPMN 2.0]]. Four different types of page-based workflows are already integrated. Their purpose is page reviews to obtain feedback via a vote or to trigger a page approval. In the following, these workflows are therefore called review workflows.
 {| class="wikitable" style="width:100%;"
-|+Arten von Begutachtungen
+|+Types of reviews
-! style="width:300px;" |Workflow-Typ
+! style="width:300px;" |Workflow type
-! style="width:100px;" |Beteiligte
+! style="width:100px;" |Participants
-!Beschreibung
+!Description
 |-
 | style="width:300px;" |'''[[Manual:Extension/Workflows#Single user approval|Single user approval]]'''
-| style="width:100px;" |1 Benutzer
+| style="width:100px;" |1 user
-|Ein einzelner Benutzer wird aufgefordert, über eine Seite abzustimmen. Am Ende wird bei einer "Zustimmung" des Begutachters die Seite automatisch freigegeben.
+|A single user is asked to vote about a page.  If a user submits a positive vote, the page is automatically approved.
 |-
 | style="width:300px;" |'''[[Manual:Extension/Workflows#Expert document control|Expert document control]]'''
-| style="width:100px;" |3 Benutzer
+| style="width:100px;" |3 users
-|Nach Bearbeitung einer Seite durch einen bestimmten Benutzer wird die Seite von einem Experten überprüft und über einen Hauptverantwortlichen freigegeben.
+|After a page has been edited by a specific user, the page is reviewed by an expert and then approved by a  user who is responsible for approvals.
 |-
 | style="width:300px;" |'''[[Manual:Extension/Workflows#Goup Feedback|Group Feedback]]'''
-| style="width:100px;" |1 Gruppe
+| style="width:100px;" |1 group
-|Eine in der Gruppenverwaltung existierende Gruppe wird aufgefordert, über eine Seite einen Kommentar abzugeben.
+|A group (needs to exist in the group manager) is requested to leave a comment on a page.
 |-
 | style="width:300px;" |'''[[Manual:Extension/Workflows#Single user feedback|Single user feedback]]'''
-| style="width:100px;" |1 Benutzer
+| style="width:100px;" |1 user
-|Ein einzelner Benutzer wird aufgefordert, über eine Seite einen Kommentar abzugeben.
+|A user is asked to send a comment regarding a page.
 |}
-==Benachrichtigungen und Reports==
+==Notifications and reports==
-*'''Bei der Zuweisung einer Aufgabe:''' Wenn ein Benutzer eine Workflow-Aufgabe durchführen soll, wird sowohl eine Benachrichtigung als auch eine Aufgabe erstellt. Wird die Seite zur Bearbeitung gesperrt,
+*'''When a task gets assigned:''' When a user needs to complete a workflow task, both a notification and a [[Reference:UnifiedTaskOverview|task]] are created.
-*'''Nach Abschluss der Begutachtung:''' Nach Abschluss einer Begutachtung wird der Initiator benachrichtigt und eine Email an einen Reportempfänger verschickt.
+*'''At the end of a worfklow:''' After a workflow has ended, the initiator receives a notification and an email is sent to a report recipient (as defined at the beginning of the workflow).
-==Workflow-Aktivitäten==
+==Workflow activities==
-Alle Begutachtungsworkflows beginnen mit der Eingabe der Workflow-Einstellungen durch einen Benutzer (Workflow-Initiator) und  resultieren in Worfklow-Aktivitäten.
+All approval workflows start with a form where the necessary workflow data is entered by the workflow initiator.  Each workflow results in one or more workflow activities.
 ===Single user approval===
-'''Zweck:''' Freigabe einer Entwurfsseite durch einen Benutzer mit Freigaberechten. Dieser Workflow macht nur Sinn, wenn auf einer Seite die [[Referenz:FlaggedRevs|Freigabe-Funktion]] aktiviert ist.
+'''Purpose:''' Approval of a draft page by a user with approval rights. This workflow only makes sense if the approval function ([[Reference:FlaggedRevs|FlaggedRevs]]) is activated on a page.
-'''Workflow-Instanzen:''' Es kann immer nur ein Freigabe-Worfklow pro Seite laufen.
+'''Workflow instances:''' Only one approval workflow can run per page.
-[[Datei:Handbuch:bpmn-SingleUserApproval.svg|verweis=https://bs4-de.wiki.bluespice.com/wiki/Datei:Handbuch:bpmn-SingleUserApproval.svg|alternativtext=BMMN Diagramm des Freigabe Worfklows.|zentriert|mini|750x750px|BMMN Diagramm des Freigabe Worfklows.]]
+[[Datei:Manual:bpmn-SingleUserApproval.svg|verweis=https://bs4-de.wiki.bluespice.com/wiki/Datei:Manual:bpmn-SingleUserApproval.svg|alternativtext=BMMN Diagramm des Freigabe Worfklows.|zentriert|thumb|750x750px|BMMN Diagramm des Freigabe Worfklows.]]
 {| class="wikitable" style="width:100%;"
-!Aktivität
+!Activity
-!Beschreibung
+!Description
 |-
 |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).
+* ''user:'' user (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.
+* ''Anweisungen:'' Eine Mitteilung an den user oder die usergruppe 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.
+* ''Reportempfänger:'' An diese Email-Adresse wird beim Abschluss der Begutachtung ein Email-Report mit den Resultaten gesendet. Wird hier ein username angegeben, so muss in der userverwaltung eine Email-Adresse hinterlegt sein, damit der Report versendet werden kann.
 |-
 |PageCheckout
@@ Line 57: / Line 57: @@
 |-
 |UserVote
-|Der zugewiesene Benutzer führt eine Abstimmung durch und stimmt entweder zu oder lehnt ab. Alternativ kann die Aufgabe delegiert werden. Bei einer Ablehnung wird die Begutachtung abgebrochen.
+|Der zugewiesene user führt eine Abstimmung durch und stimmt entweder zu oder lehnt ab. Alternativ kann die Aufgabe delegiert werden. Bei einer Ablehnung wird die Begutachtung abgebrochen.
 |-
 |ApprovePage
@@ Line 70: / Line 70: @@
 ===Expert document control===
-'''Zweck:''' Freigabe einer Entwurfsseite nach dem "6-Augen-Prinzip".
+'''Purpose:''' Approval of a draft page according to the "4-eyes principle".
 '''Workflow-Instanzen:''' Es kann immer nur ein Freigabe-Workflow pro Seite laufen.
-[[Datei:Handbuch:bpmn-ExpertDocControl.svg|verweis=https://bs4-de.wiki.bluespice.com/wiki/Datei:Handbuch:bpmn-ExpertDocControl.svg|alternativtext=BPMN Diagramm des Workflows "Qualitätsgesicherte Bearbeitung"|zentriert|mini|550x550px|BPMN Diagramm des Workflows "Qualitätsgesicherte Bearbeitung"]]
+[[Datei:Manual:bpmn-ExpertDocControl.svg|verweis=https://bs4-de.wiki.bluespice.com/wiki/Datei:Manual:bpmn-ExpertDocControl.svg|alternativtext=BPMN Diagramm des Workflows "Qualitätsgesicherte Bearbeitung"|zentriert|thumb|550x550px|BPMN Diagramm des Workflows "Qualitätsgesicherte Bearbeitung"]]
 {| class="wikitable" style="width:100%;"
-!Aktivität
+!Activity
-!Beschreibung
+!Description
 |-
 |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).
+* ''user:'' user (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.
+* ''Anweisungen:'' Eine Mitteilung an den user oder die usergruppe 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.
+* ''Reportempfänger:'' An diese Email-Adresse wird beim Abschluss der Begutachtung ein Email-Report mit den Resultaten gesendet. Wird hier ein username angegeben, so muss in der userverwaltung eine Email-Adresse hinterlegt sein, damit der Report versendet werden kann.
 |-
 |PageCheckout
@@ Line 106: / Line 106: @@
 ===Group feedback===
-'''Zweck:''' Einholen von Feedback von einer Benutzergruppe. Die Gruppe muss in der Gruppenverwaltung angelegt sein.
+'''Zweck:''' Einholen von Feedback von einer usergruppe. Die Gruppe muss in der Gruppenverwaltung angelegt sein.
 '''Workflow-Instanzen:''' Es können unabhängig voneinander mehrere Feedback-Worfklows gleichzeitig auf einer Seite laufen.
-[[Datei:Handbuch:bpmn-GroupFeedback..svg|verweis=https://bs4-de.wiki.bluespice.com/wiki/Datei:Handbuch:bpmn-GroupFeedback..svg|alternativtext=BPMN Diagramm des Workflows "Gruppen-Feedback"|zentriert|mini|450x450px|BPMN Diagramm des Workflows "Gruppen-Feedback"]]
+[[Datei:Manual:bpmn-GroupFeedback..svg|verweis=https://bs4-de.wiki.bluespice.com/wiki/Datei:Manual:bpmn-GroupFeedback..svg|alternativtext=BPMN Diagramm des Workflows "Gruppen-Feedback"|zentriert|thumb|450x450px|BPMN Diagramm des Workflows "Gruppen-Feedback"]]
 {| class="wikitable" style="width:100%;"
 !Aktivität
@@ Line 118: / Line 118: @@
 |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).
+* ''user:'' user (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.
+* ''Anweisungen:'' Eine Mitteilung an den user oder die usergruppe 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.
+* ''Reportempfänger:'' An diese Email-Adresse wird beim Abschluss der Begutachtung ein Email-Report mit den Resultaten gesendet. Wird hier ein username angegeben, so muss in der userverwaltung 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.
+|Alle user 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
@@ Line 130: / Line 130: @@
 === Feedback ===
-'''Zweck:''' Einholen von Feedback eines einzelnen Benutzers zu einer Seite.
+'''Zweck:''' Einholen von Feedback eines einzelnen users zu einer Seite.
 '''Workflow-Instanzen:''' Es können unabhängig voneinander mehrere Feedback-Worfklows gleichzeitig auf einer Seite laufen.
-[[Datei:Handbuch:bpmn-UserFeedback.svg|verweis=https://bs4-de.wiki.bluespice.com/wiki/Datei:Handbuch:bpmn-UserFeedback.svg|alternativtext=BPMN Diagramm des Feedback Worfklows|zentriert|mini|500x500px|BPMN Diagramm des Feedback-Worfklows]]
+[[Datei:Manual:bpmn-UserFeedback.svg|verweis=https://bs4-de.wiki.bluespice.com/wiki/Datei:Manual:bpmn-UserFeedback.svg|alternativtext=BPMN Diagramm des Feedback Worfklows|zentriert|thumb|500x500px|BPMN Diagramm des Feedback-Worfklows]]
 {| class="wikitable" style="width:100%;"
 !Aktivität
@@ Line 142: / Line 142: @@
 |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).
+* ''user:'' user (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.
+* ''Anweisungen:'' Eine Mitteilung an den user oder die usergruppe 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.
+* ''Reportempfänger:'' An diese Email-Adresse wird beim Abschluss der Begutachtung ein Email-Report mit den Resultaten gesendet. Wird hier ein username angegeben, so muss in der userverwaltung eine Email-Adresse hinterlegt sein, damit der Report versendet werden kann.
 |-
 |PageCheckout
@@ Line 150: / Line 150: @@
 |-
 |UserFeedback
-|Der zugewiesene Benutzer gibt über ein Kommentarfeld ein Feedback ab.
+|Der zugewiesene user gibt über ein Kommentarfeld ein Feedback ab.
 |-
 |SendMail
@@ Line 158: / Line 158: @@
 == Overview page==
 Alle Workflows sind auf der Seite ''Spezial:Workflows overview'' aufgeführt. Es gibt eine Ansicht der aktuellen Workflows und eine Ansicht aller Workflows:
-[[Datei:Handbuch:wf-übersicht.png|alternativtext=Workflows Übersicht|zentriert|mini|750x750px|Workflows Übersicht]]
+[[Datei:Manual:wf-übersicht.png|alternativtext=Workflows Übersicht|zentriert|thumb|750x750px|Workflows Übersicht]]
 === Tasks ===
-Benutzer werden über ihre Workflows auf ihrer Benachrichtungsseite sowie auf der Seite [[Manual:Extension/UnifiedTaskOverview|Meine Aufgaben]] über zugewiesene Workflow-Aufgaben informiert.
+user werden über ihre Workflows auf ihrer Benachrichtungsseite sowie auf der Seite [[Manual:Extension/UnifiedTaskOverview|Meine Aufgaben]] über zugewiesene Workflow-Aufgaben informiert.
 ==How to add a workflow==