No edit summary Tag: 2017 source edit |
No edit summary |
||
| Line 1: | Line 1: | ||
== | ==Introduction== | ||
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. | 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. | ||
| Line 27: | Line 27: | ||
==Notifications and reports== | ==Notifications and reports== | ||
*'''When a task gets assigned:''' When a user needs to complete a workflow task, both a notification and a [[Reference:UnifiedTaskOverview|task]] are created. | *'''When a task gets assigned:''' When a user needs to complete a workflow task, both a notification and a [[Reference:UnifiedTaskOverview|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). | *'''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). | ||
| Line 38: | Line 38: | ||
'''Workflow instances:''' Only one approval workflow can run per page. | '''Workflow instances:''' Only one approval workflow can run per page. | ||
[[ | [[File:Manual:bpmn-SingleUserApproval.svg|center|thumb|750x750px|BPMN diagram of a "Single user approval" workflow|alt=BPMN diagram of a "Single user approval" workflow]] | ||
{| class="wikitable" style="width:100%;" | {| class="wikitable" style="width:100%;" | ||
!Activity | !Activity | ||
!Description | !Description | ||
|- | |- | ||
|CollectData | | CollectData | ||
| | |In the first workflow step, the workflow initiator enters the settings: | ||
* '' | *''User:'' user who is assigned to the task. | ||
* '' | *''Instructions:'' A comment/instructions for the user that should help to complete the task. | ||
* '' | *''Send report to:'' 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 | |PageCheckout | ||
| | |The page is locked for the upcoming vote for editing. | ||
|- | |- | ||
|UserVote | |UserVote | ||
| | |The assigned user carries out a vote and either agrees to the page or rejects it. Alternatively, the task can be delegated. In the event of a rejection, the workflow will be terminated. | ||
|- | |- | ||
|ApprovePage | | ApprovePage | ||
| | |If the user has agreed, the page is set to an approved state. | ||
|- | |- | ||
|SendMail | |SendMail | ||
| | |An email report is sent to the report recipient who was specified in the first step. | ||
|- | |- | ||
|PageCheckin | |PageCheckin | ||
| | |The page is unlocked. | ||
|} | |} | ||
| Line 74: | Line 71: | ||
'''Workflow-Instanzen:''' Es kann immer nur ein Freigabe-Workflow pro Seite laufen. | '''Workflow-Instanzen:''' Es kann immer nur ein Freigabe-Workflow pro Seite laufen. | ||
[[ | [[File:Manual:bpmn-ExpertDocControl.svg|verweis=https://bs4-de.wiki.bluespice.com/wiki/File:Manual:bpmn-ExpertDocControl.svg|alternativtext=BPMN Diagramm des Workflows "Qualitätsgesicherte Bearbeitung"|center|thumb|550x550px|BPMN Diagramm des Workflows "Qualitätsgesicherte Bearbeitung"]] | ||
{| class="wikitable" style="width:100%;" | {| class="wikitable" style="width:100%;" | ||
!Activity | !Activity | ||
!Description | ! Description | ||
|- | |- | ||
|CollectData | |CollectData | ||
|Im ersten Workflow-Schritt werden die Einstellungen des Worfklows vorgenommen: | |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). | *''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. | *''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. | *''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 | | PageCheckout | ||
|Die Seite wird für die anstehende Abstimmung zur Bearbeitung gesperrt. | |Die Seite wird für die anstehende Abstimmung zur Bearbeitung gesperrt. | ||
|- | |- | ||
| Line 110: | Line 107: | ||
'''Workflow-Instanzen:''' Es können unabhängig voneinander mehrere Feedback-Worfklows gleichzeitig auf einer Seite laufen. | '''Workflow-Instanzen:''' Es können unabhängig voneinander mehrere Feedback-Worfklows gleichzeitig auf einer Seite laufen. | ||
[[ | [[File:Manual:bpmn-GroupFeedback..svg|alternativtext=BPMN Diagramm des Workflows "Gruppen-Feedback"|center|thumb|450x450px|BPMN Diagramm des Workflows "Gruppen-Feedback"]] | ||
{| class="wikitable" style="width:100%;" | {| class="wikitable" style="width:100%;" | ||
!Aktivität | !Aktivität | ||
!Beschreibung | !Beschreibung | ||
|- | |- | ||
|CollectData | | CollectData | ||
|Im ersten Workflow-Schritt werden die Einstellungen des Worfklows vorgenommen: | | 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). | *''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. | *''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. | *''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 | |GroupFeedback | ||
| Line 129: | Line 126: | ||
|} | |} | ||
=== Feedback === | ===Feedback=== | ||
'''Zweck:''' Einholen von Feedback eines einzelnen users 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. | '''Workflow-Instanzen:''' Es können unabhängig voneinander mehrere Feedback-Worfklows gleichzeitig auf einer Seite laufen. | ||
[[ | [[File:Manual:bpmn-UserFeedback.svg|alternativtext=BPMN Diagramm des Feedback Worfklows|center|thumb|500x500px|BPMN Diagramm des Feedback-Worfklows]] | ||
{| class="wikitable" style="width:100%;" | {| class="wikitable" style="width:100%;" | ||
!Aktivität | !Aktivität | ||
| Line 142: | Line 139: | ||
|Im ersten Workflow-Schritt werden die Einstellungen des Worfklows vorgenommen: | |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). | *''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. | *''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. | *''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 | |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)´). | |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 | | UserFeedback | ||
|Der zugewiesene user gibt über ein Kommentarfeld ein Feedback ab. | |Der zugewiesene user gibt über ein Kommentarfeld ein Feedback ab. | ||
|- | |- | ||
| Line 156: | Line 153: | ||
|} | |} | ||
== Overview page== | ==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: | Alle Workflows sind auf der Seite ''Spezial:Workflows overview'' aufgeführt. Es gibt eine Ansicht der aktuellen Workflows und eine Ansicht aller Workflows: | ||
[[ | [[File:Manual:wf-übersicht.png|center|thumb|750x750px|Workflows Übersicht|link=Special:FilePath/Manual:wf-übersicht.png]] | ||
=== Tasks === | === Tasks=== | ||
user 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. | ||
| Line 168: | Line 165: | ||
'''Extension: Workflows''' | '''Extension: Workflows''' | ||
* [[Manual:Extension/Workflows/Activity/CustomForm|CustomForm]] | *[[Manual:Extension/Workflows/Activity/CustomForm|CustomForm]] | ||
* [[Manual:Extension/Workflows/Activity/UserVote|UserVote]] | *[[Manual:Extension/Workflows/Activity/UserVote|UserVote]] | ||
* [[Manual:Extension/Workflows/Activity/GroupVote|GroupVote]] | *[[Manual:Extension/Workflows/Activity/GroupVote|GroupVote]] | ||
* [[Manual:Extension/Workflows/Activity/UserFeedback|UserFeedback]] | *[[Manual:Extension/Workflows/Activity/UserFeedback|UserFeedback]] | ||
* [[Manual:Extension/Workflows/Activity/GrouppFeedback|GroupFeedback]] | *[[Manual:Extension/Workflows/Activity/GrouppFeedback|GroupFeedback]] | ||
* [[Manual:Extension/Workflows/Activity/SendMail|SendMail]] | *[[Manual:Extension/Workflows/Activity/SendMail|SendMail]] | ||
* [[Manual:Extension/Workflows/Activity/EditRequest|EditRequest]] | *[[Manual:Extension/Workflows/Activity/EditRequest|EditRequest]] | ||
'''Extension: PageCheckout''' | '''Extension: PageCheckout''' | ||
* [[Manual:Extension/Workflows/Activity/PageCheckOut|PageCheckOut]] | *[[Manual:Extension/Workflows/Activity/PageCheckOut|PageCheckOut]] | ||
* [[Manual:Extension/Workflows/Activity/PageCheckIn|PageCheckIn]] | *[[Manual:Extension/Workflows/Activity/PageCheckIn|PageCheckIn]] | ||
'''Extension: BlueSpiceFlaggedRevsConnector''' | '''Extension: BlueSpiceFlaggedRevsConnector''' | ||
* [[Manual:Extension/Workflows/Activity/ApprovePage|ApprovePage]] | *[[Manual:Extension/Workflows/Activity/ApprovePage|ApprovePage]] | ||
Beispiel zum erstellen eines neuen Workflows | Beispiel zum erstellen eines neuen Workflows | ||
Revision as of 10:23, 21 December 2021
Introduction
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.
| 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 | In the first workflow step, the workflow initiator enters the settings:
|
| PageCheckout | The page is locked for the upcoming vote for editing. |
| UserVote | The assigned user carries out a vote and either agrees to the page or rejects it. Alternatively, the task can be delegated. In the event of a rejection, the workflow will be terminated. |
| ApprovePage | If the user has agreed, the page is set to an approved state. |
| SendMail | An email report is sent to the report recipient who was specified in the first step. |
| PageCheckin | The page is unlocked. |
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:
|
| 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:
|
| 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:
|
| 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:
File:Manual:wf-übersicht.png
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
Beispiel zum erstellen eines neuen Workflows
