Zuletzt bearbeitet vor 4 Monaten
von Margit Link-Rodrigue

AutoDoc:BlueSpiceSocialResolve und Handbuch:Erweiterung/Workflows/Gruppen-Feedback anpassen: Unterschied zwischen den Seiten

(Unterschied zwischen Seiten)
VisuellWikitext
K (1 Version importiert)
 
K ((Benutzername entfernt) (Logbucheinzelheiten entfernt))
 
Zeile 1: Zeile 1:
==DescriptionMsg==
== Ziel ==
{{AutoDocDescriptionMsg
In diesem Beispiel wird der Workflow ''Gruppen-Feedback'' so angepasst, dass der '''Schwellenwert der Benutzerzahl''' angepasst wird. Dieser Schwellenwert definiert, wann der Workflow vom System abgeschlossen wird.
|name = BlueSpiceSocialResolve
|desc = {{int:bs-socialresolve-desc
}}
}}
==License==
{{AutoDocLicense
|name = GPL-3.0-only
}}
==Requirements==
{{AutoDocRequirements
|mediawiki = {{AutoDocVersion
|name = MediaWiki
|version = 1.35.0
}}
|extensions = {{AutoDocVersion
|name = BlueSpiceFoundation
|version = 4.0
}}
{{AutoDocVersion
|name = BlueSpiceSocial
|version = 4.0
}}
}}
==Permissions==
{{AutoDocPermissions
|permissions = {{AutoDocPermission
|name = social-resolve
|type = namespace
|roles = editor
|desc = {{int:right-social-resolve
}}
}}
}}
==ApiModules==
{{AutoDocApiModules
|APIModules = {{AutoDocCallback
|name = bs-socialresolve-tasks
|callback = \BlueSpice\Social\Resolve\Api\Task\Resolve
}}
}}
==Hooks==
{{AutoDocHooks
|Hooks = {{AutoDocCallback
|name = [https://www.mediawiki.org/wiki/Manual:Hooks/BSEntityConfigAttributeDefinitions BSEntityConfigAttributeDefinitions]
|callback = \BlueSpice\Social\Resolve\Hook\BSEntityConfigAttributeDefinitions\AddResolve::callback
}}
{{AutoDocCallback
|name = [https://www.mediawiki.org/wiki/Manual:Hooks/BSEntityConfigDefaults BSEntityConfigDefaults]
|callback = \BlueSpice\Social\Resolve\Hook\BSEntityConfigDefaults\IsResolvable::callback
}}
{{AutoDocCallback
|name = [https://www.mediawiki.org/wiki/Manual:Hooks/BSEntityGetFullData BSEntityGetFullData]
|callback = \BlueSpice\Social\Resolve\Hook\BSEntityGetFullData\AddResolve::callback
}}
{{AutoDocCallback
|name = [https://www.mediawiki.org/wiki/Manual:Hooks/BSEntitySetValuesByObject BSEntitySetValuesByObject]
|callback = \BlueSpice\Social\Resolve\Hook\BSEntitySetValuesByObject\AddResolve::callback
}}
{{AutoDocCallback
|name = [https://www.mediawiki.org/wiki/Manual:Hooks/BSFoundationRendererMakeTagAttribs BSFoundationRendererMakeTagAttribs]
|callback = \BlueSpice\Social\Resolve\Hook\BSFoundationRendererMakeTagAttribs\AddResolveClassToEntityRenderer::callback
}}
{{AutoDocCallback
|name = [https://www.mediawiki.org/wiki/Manual:Hooks/BSSocialEntityGetActions BSSocialEntityGetActions]
|callback = \BlueSpice\Social\Resolve\Hook\BSSocialEntityGetActions\AddResolve::callback
}}
{{AutoDocCallback
|name = [https://www.mediawiki.org/wiki/Manual:Hooks/BSSocialEntityListRenderEntity BSSocialEntityListRenderEntity]
|callback = \BlueSpice\Social\Resolve\Hook\BSSocialEntityListRenderEntity\RenderShortWhenResolved::callback
}}
{{AutoDocCallback
|name = [https://www.mediawiki.org/wiki/Manual:Hooks/BSSocialModuleDepths BSSocialModuleDepths]
|callback = \BlueSpice\Social\Resolve\Hook\BSSocialModuleDepths\AddModules::callback
}}
}}


== Schritte ==
# '''Ursprüngliches ''BPMN''''' aus Github ins Wiki übertragen.
# '''Schwellenwert''' für benötigtes Benutzerfeedbacks festsetzen.
#'''Workflow-Trigger''' definieren.
# '''Testen''' des Workflows.
== Anleitung ==
=== BPMN übertragen ===
So übertragen Sie den ursprünglichen BPMN-Prozess ins Wiki:
# '''Gehen''' Sie zur [https://github.com/wikimedia/mediawiki-extensions-Workflows/blob/4.1.1/workflow/GroupFeedback.bpmn Github-Seite für den Workflow "Gruppen-Feedback"].
# '''Kopieren''' Sie das XML.
# '''Erstellen''' Sie die Seite ''MediaWiki:GruppenFeedbackTeam.bpmn''
# '''Kopieren''' Sie das XML in den Quelltext der neuen ''bpmn''-Seite.
# '''Speichern''' Sie die Seite.[[Datei:Gruppen-Feedback anpassen Github.png|alternativtext=XML kopieren|zentriert|mini|750x750px|XML kopieren]]
{{Hinweisbox|boxtype=Hinweis|icon=|Note text=Die Links zu den BPMN-Dokumenten für die 4 Standard-Workflows finden Sie bei den einzelnen Workflow-Beschreibungen auf der [[Handbuch:Erweiterung/Workflows|Workflows Hilfeseite]].|bgcolor=}}
=== Schwellenwert festsetzen ===
So ändern Sie den Schwellenwert der Benutzeranzahl. Dieser bestimmt den Abschluss des Workflows:
# '''Wechseln''' Sie auf der soeben erstellten Seite in den Bearbeitungsmodus.
# '''Definieren''' Sie im Element ''<wf:threshhold>'' den ''Wert'' und die ''Einheit'' für die Berechnung des Workflow-Abschlusses.  <span /><br />Wenn der Workflow nach Feedback von 50% der Mitglieder der Gruppe abgeschlossen werden soll, geben Sie an:<syntaxhighlight lang="text">
<wf:threshold>
<wf:type>complete</wf:type>
<wf:value>50</wf:value>
<wf:unit>percent</wf:unit>
</wf:threshold>
</syntaxhighlight>Alternatives Beispiel - Workflow-Abschluss, wenn 4 Mitglieder in der Gruppe ihre Aufgabe erledigt haben:<syntaxhighlight lang="text">
<wf:threshold>
<wf:type>complete</wf:type>
<wf:value>4</wf:value>
<wf:unit>users</wf:unit>
</wf:threshold>
</syntaxhighlight>
# '''Speichern''' Sie die Seite.
#
=== Workflow-Trigger definieren ===
Damit der Workflow ausgewählt werden kann, muss ein entsprechender Auslöser (Trigger) im Wiki vorhanden sein.
So erstellen Sie den Trigger:
# '''Klicken''' Sie auf ''Workflow Triggers'' im Menü ''Globale Aktionen''.
# '''Klicken''' Sie auf Neuen Auslöser hinzufügen.
# '''Wählen''' Sie aus dem Auswahlfeld die Option ''Manuell''.[[Datei:Gruppen-Feedback trigger manuell.png|alternativtext=Manuellen Trigger wählen|zentriert|mini|550x550px|Manuellen Trigger wählen]]<span /><br />
# '''Definieren''' Sie die Einstellungen für den Workflow-Auslöser:
#* ''Name:'' Name, der im Auswahlmenü für den Workflow angezeigt wird.
#* ''Beschreibung'': Erklärung der Funktion und Besonderheiten dieses Triggers.
#* ''Zu startender Workflow'': Workflow, der durch diesen Trigger ausgelöst wird. In unserem Fall ''GroupFeedbackTeam''.
#* ''Anfangsdaten'' für den Workflow (alle Angaben sind optional):  - Gruppe: Es ist sinnvoll, hier eine vordefinierte Gruppe anzugeben. Diese sollte von der Mitgliederanzahl auf den im Workflow gesetzten Schwellenwert abgestimmt sein.  - Anweisungen: Diese werden den Benutzern in der zugewiesenen Aufgabe zum besseren Verständnis angezeigt.  - Bericht senden: Hier kann eine beliebige E-Mail-Adresse angegeben werden. Der Empfänger wird zum Abschluss des Workflows benachrichtigt. (Der Initiator des Workflows bekommt automatisch eine Benachrichtigung und muss hier nicht gesondert angegeben werden).
#* ''Bedingungen'' (Conditions): In welchen Namensräumen der Workflow zur Auswahl angezeigt wird.  [[Datei:Gruppen-Feedback trigger-einstellungen.png|alternativtext=Trigger-Einstellungen|zentriert|mini|499x499px|Trigger-Einstellungen]]
# '''Klicken''' Sie ''Speichern.''
=== Workflow testen ===
Der Workflow steht nun im Wiki zur Verfügung. Lösen Sie einen Test-Workflow aus. Testen Sie, ob folgende Funktionalität vorhanden ist:
* Der Workflow steht in den im Workflow-Trigger definierten Namensräumen zur Verfügung (falls es hier Einschränkungen gibt).
* Der Workflow wird ausgelöst.
* Der Workflow wird in der Workflows-Übersicht angezeigt.
* Die Gruppenmitglieder erhalten eine Aufgabe.
* Der Workflow schließt nach der Erreichung des gesetzten Schwellenwerts ab.

Version vom 13. Dezember 2022, 16:00 Uhr

Ziel

In diesem Beispiel wird der Workflow Gruppen-Feedback so angepasst, dass der Schwellenwert der Benutzerzahl angepasst wird. Dieser Schwellenwert definiert, wann der Workflow vom System abgeschlossen wird.

Schritte

  1. Ursprüngliches BPMN aus Github ins Wiki übertragen.
  2. Schwellenwert für benötigtes Benutzerfeedbacks festsetzen.
  3. Workflow-Trigger definieren.
  4. Testen des Workflows.

Anleitung

BPMN übertragen

So übertragen Sie den ursprünglichen BPMN-Prozess ins Wiki:

  1. Gehen Sie zur Github-Seite für den Workflow "Gruppen-Feedback".
  2. Kopieren Sie das XML.
  3. Erstellen Sie die Seite MediaWiki:GruppenFeedbackTeam.bpmn
  4. Kopieren Sie das XML in den Quelltext der neuen bpmn-Seite.
  5. Speichern Sie die Seite.
    XML kopieren
    XML kopieren
Hinweis:Die Links zu den BPMN-Dokumenten für die 4 Standard-Workflows finden Sie bei den einzelnen Workflow-Beschreibungen auf der Workflows Hilfeseite.


Schwellenwert festsetzen

So ändern Sie den Schwellenwert der Benutzeranzahl. Dieser bestimmt den Abschluss des Workflows:

  1. Wechseln Sie auf der soeben erstellten Seite in den Bearbeitungsmodus.
  2. Definieren Sie im Element <wf:threshhold> den Wert und die Einheit für die Berechnung des Workflow-Abschlusses.
    Wenn der Workflow nach Feedback von 50% der Mitglieder der Gruppe abgeschlossen werden soll, geben Sie an:
    		<wf:threshold>
			<wf:type>complete</wf:type>
			<wf:value>50</wf:value>
			<wf:unit>percent</wf:unit>
		</wf:threshold>
    Alternatives Beispiel - Workflow-Abschluss, wenn 4 Mitglieder in der Gruppe ihre Aufgabe erledigt haben:
    		<wf:threshold>
			<wf:type>complete</wf:type>
			<wf:value>4</wf:value>
			<wf:unit>users</wf:unit>
		</wf:threshold>
  3. Speichern Sie die Seite.

Workflow-Trigger definieren

Damit der Workflow ausgewählt werden kann, muss ein entsprechender Auslöser (Trigger) im Wiki vorhanden sein.

So erstellen Sie den Trigger:

  1. Klicken Sie auf Workflow Triggers im Menü Globale Aktionen.
  2. Klicken Sie auf Neuen Auslöser hinzufügen.
  3. Wählen Sie aus dem Auswahlfeld die Option Manuell.
    Manuellen Trigger wählen
    Manuellen Trigger wählen

  4. Definieren Sie die Einstellungen für den Workflow-Auslöser:
    • Name: Name, der im Auswahlmenü für den Workflow angezeigt wird.
    • Beschreibung: Erklärung der Funktion und Besonderheiten dieses Triggers.
    • Zu startender Workflow: Workflow, der durch diesen Trigger ausgelöst wird. In unserem Fall GroupFeedbackTeam.
    • Anfangsdaten für den Workflow (alle Angaben sind optional): - Gruppe: Es ist sinnvoll, hier eine vordefinierte Gruppe anzugeben. Diese sollte von der Mitgliederanzahl auf den im Workflow gesetzten Schwellenwert abgestimmt sein. - Anweisungen: Diese werden den Benutzern in der zugewiesenen Aufgabe zum besseren Verständnis angezeigt. - Bericht senden: Hier kann eine beliebige E-Mail-Adresse angegeben werden. Der Empfänger wird zum Abschluss des Workflows benachrichtigt. (Der Initiator des Workflows bekommt automatisch eine Benachrichtigung und muss hier nicht gesondert angegeben werden).
    • Bedingungen (Conditions): In welchen Namensräumen der Workflow zur Auswahl angezeigt wird.
      Trigger-Einstellungen
      Trigger-Einstellungen
  5. Klicken Sie Speichern.

Workflow testen

Der Workflow steht nun im Wiki zur Verfügung. Lösen Sie einen Test-Workflow aus. Testen Sie, ob folgende Funktionalität vorhanden ist:

  • Der Workflow steht in den im Workflow-Trigger definierten Namensräumen zur Verfügung (falls es hier Einschränkungen gibt).
  • Der Workflow wird ausgelöst.
  • Der Workflow wird in der Workflows-Übersicht angezeigt.
  • Die Gruppenmitglieder erhalten eine Aufgabe.
  • Der Workflow schließt nach der Erreichung des gesetzten Schwellenwerts ab.
Abgerufen von „https://de.wiki.bluespice.com/w/index.php?title=AutoDoc:BlueSpiceSocialResolve&oldid=6588“
Keine Kategorien vergebenBearbeiten

Diskussionen