Allgemeines zu den Workflows
Kundenspezifische Workflows können dank einer generischen Workflow-Engine sehr flexibel erstellt und angepasst werden.
Sie können je nach Objekteigenschaften unterschiedlich aufgesetzt und genutzt werden.
Klassische Anwendungsfälle sind Informationsmails und Bewilligungsschritte mit beliebig vielen Stufen, aber auch (Review-)Tasks, die nach fix definierten Regeln, z.B. periodisch, ausgelöst werden.
Es können jederzeit neue Workflowtypen definiert werden, die nicht unmittelbar mit existierender Funktionalität zusammenhängen. So können zusätzliche Vorstellungen des Kunden flexibel umgesetzt werden, ohne dass Programmieraufwand nötig ist.
Hinweise:
- Das Durchführen eines Workflows ist separat in der Endbenutzer-Dokumentation beschrieben, zeigt aber auch wie das Endresultat der Konfiguration aussehen kann.
- Wichtig ist es zu verstehen, dass es
- Workflowtypen gibt, welche definieren welches die Workflow-Schritte sein werden
- wie auch viele Workflows / Workflow-Instanzen zu diesem Typen, welche sich üblicherweise auf ein bestimmtes Objekt beziehen
Konfigurieren eines neuen Workflowtypen
Nur Nutzer mit Administratorenrechten (Admin / IT Support, siehe Rollen und Rechte) haben das Recht, neue Workflowtypen zu konfigurieren oder bestehende Workflows anzupassen. Sie starten von der Liste der bereits existierenden Abfragetypen (= Workflowtypen), die via "Admin → Modulkonfigurationen → Workflow → Workflowtypen" erreicht werden kann.
Folgende Standard-Workflowtypen werden zu den unterschiedlichen Objekttypen angeboten:
- Verlängerung beantragen (Action)
- Änderung Owner (Action)
- Änderung Risiko-Eigner (Risiko)
- Ereignisvalidierung (im Standard pausiert, da nur für das Modul 'Operationelle Ereignisse' relevant)
Wie bereits existierende Workflowtypen angepasst werden können, beschreibt Kapitel Anpassen eines bestehenden Workflows.
Es besteht die Möglichkeit, existierende Workflowtypen zu kopieren, um das Anlegen von ähnlichen Workflowtypen effizienter zu gestalten. Klicken Sie dazu auf das 'Kopieren'-Icon rechts neben dem zu kopierenden Workflowtyp (ab Version 2.32).
Erfassung der im Workflow involvierten Nutzer (optional)
Sollte es Nutzer(-gruppen / Rollen / Teams o.ä.) geben, auf die Sie in Ihren Workflows häufiger Bezug nehmen, so empfiehlt es sich, diese als dedizierte 'Empfänger' zu hinterlegen. Sie können dann im Workflow auf diese referenzieren und vermeiden redundanten Erfassungsaufwand.
Klicken Sie den Button '+ Neu: Empfänger' unter "Admin → Modulkonfigurationen → Workflow → Empfänger
Im Folgenden wird der Hintergrund bzw. Auswirkung der Eingaben beschrieben (wo nicht selbsterklärend, an anderer Stelle dokumentiert oder irrelevant):
| Feldname | Beschreibung | Kommentar / Querverweise (QV) |
|---|---|---|
| Kann Initiator sein | Nur Empfänger, bei denen dieses Häkchen gesetzt ist, können in der Workflowtyp-Konfiguration als Initiator selektiert werden. | |
Kontroll-Seitwärtsempfänger | Nur Empfänger, bei denen dieses Häkchen gesetzt ist, können als Kontroll-Seitwärtsempfänger in den Empfängergruppen des IKS verwendet werden. | |
Erledigung für andere sichtbar | Gibt es mehrere Pendenzeninhaber, z.B. bei einer Quittierung, dann können Sie mit der (De-)Selektion steuern, ob die Adressaten den Bearbeitungsstand der jeweils anderen sehen können sollen oder nicht. | |
Mitglieder bei Erstellung entfernbar | Wird dieses Häkchen gesetzt, so wird dem Initator eines Workflows gestattet, geplante Empfänger von während dem Workflow zu generierenden Pendenzen schon beim Starten zu löschen. Das System stellt sicher, dass zumindest ein Empfänger vorhanden bleibt. | |
Mitglieder | Mit Klick auf das '+'-Icon erhalten Sie zur Auswahl:
Sie bekommen nur die für Ihre Selektion relevanten Felder angezeigt.
Die Felder und Auswahloptionen sind weitestgehend selbsterklärend, und sie berücksichtigen Ihren individuellen Setup. Neu: Als Optionen für die 'Auflösung' von Mitgliedern werden 'Bei Workflowstart' und 'Bei Schrittstart' angeboten. Diese Funktion bezieht sich auf den gewünschten Zeitpunkt für die Ermittlung des expliziten Users im Fall, dass 'Platzhalter' (z.B. Funktionen oder Benutzerrollen) als 'Mitgliedertyp' verwendet werden. Fazit: Zusätzlich zur expliziten Selektion von Mitarbeitern haben Sie hier eine Vielzahl von Möglichkeiten, die Empfänger dynamisch zu definieren - via Nutzung von Funktionen, Benutzerrollen, Kontakt-Typen der OE (d.h. abhängig von der OE des Workflow-Objektes), etc. Mit der Option 'Mitarbeiter via Expression hinzufügen' können darüber hinaus gehende, individuelle Regeln abgedeckt werden, bspw. wenn ein Zusatzfeld (Custom Field) des Workflows den Empfänger definiert. Soll diese Funktion verwendet werden, sind wir gerne beim Formulieren der Expression behilflich. Mit dem Setzen eines 'Fallback Empfänger' können Sie dem Risiko entgegenwirken, dass keine Pendenz generiert wird, da das System die Regeln nicht anwenden kann oder kein Ergebnis findet. (Beispiel: OE-Leiter ist nicht gesetzt oder es ist gar keine OE vom entsprechenden Level verfügbar.) |
Erfassung Workflowtyp Basisdaten
Folgen Sie der Navigation Admin → Modulkonfigurationen → Workflow → Workflowtypen.
Der Startpunkt für die Erstellung eines individuellen Workflowtypen ist das Klicken des Buttons '+ Neu: Workflowtyp'. Folgende Erfassungsmaske angezeigt:
Im Folgenden wird der Hintergrund bzw. Auswirkung der Eingaben beschrieben:
| Feldname | Beschreibung | Kommentar / Querverweise (QV) | ||||||||||||||||||||||||||||||||||||
|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|
| Name | Geben Sie dem Workflowtypen einen bezeichnenden Namen. | Die Eingabe eines Namens in der Hauptsprache der Instanz ist Pflicht. | ||||||||||||||||||||||||||||||||||||
| Beschreibung | Falls gewünscht, können hier weitergehende Beschreibungen in den angebotenen Sprachen erfasst werden. Es werden nur die Felder angezeigt, die als Systemsprachen für den Mandanten konfiguriert sind. | Diese erscheinen als Mouseover beim Button (falls es einen Triggerbutton gibt). | ||||||||||||||||||||||||||||||||||||
| Text Key | Technische Kurzbezeichnung eines Workflowtyps, auf die dann referenziert werden kann (z.B: "EX_VAL" für Expection Validierungs Workflow). Anwendungsfälle: Spezifische Emailtexte definieren, die für alle gleichartigen Steps dieses Workflows gelten oder aber auch referenzieren auf Instanzen dieses Workflow-Typen (z.B. periodischer Review-Workflow soll 6 Monate nach letztem erfolgreich durchgeführten Review zum Objekt erneut starten). | |||||||||||||||||||||||||||||||||||||
| Betreff editierbar für Erfasser | Per default nicht selektiert. Falls die Option ausgewählt wird, muss ein Endbenutzer beim Starten des Workflows manuell einen Betreff eingeben. | |||||||||||||||||||||||||||||||||||||
| Beschreibung editierbar für Erfasser | Per default nicht selektiert. Falls die Option ausgewählt wird, kann ein Endbenutzer beim Starten des Workflows manuell ein Beschreibung eingeben. | |||||||||||||||||||||||||||||||||||||
| Mehrere Instanzen pro Objekt zulassen | Per default selektiert. Das bedeutet, dass pro Objekt mehrere gleichzeitig laufende Workflows dieses Typs erlaubt sind. (Erfassung nicht für alle Objekte relevant.) | |||||||||||||||||||||||||||||||||||||
| Status | Ausprägungen: Aktiv / Pausiert / Gelöscht Für Neuerfassungen ist 'Aktiv' vorselektiert i.d.R. zutreffend. | |||||||||||||||||||||||||||||||||||||
| Objekt | Üblicherweise beziehen sich die Workflows auf folgende Objekte:
| |||||||||||||||||||||||||||||||||||||
| Trigger | Hier legen Sie fest, wo in der Maske bzw. wann (und implizit durch wen) der Workflow gestartet werden kann bzw. gestartet wird. Je nach Objekt, auf das sich der Workflow bezieht, sind nicht alle Triggerpunkte relevant (nutzbar).
| |||||||||||||||||||||||||||||||||||||
| Erinnerung vor Fälligkeit | Geben Sie eine Anzahl Tage ein, falls Sie eine Erinnerung vor Fälligkeit einer Pendenz wünschen. Die Einstellung ist für den gesamten Workflow bzw. alle Pendenzen daraus gültig. Es erfolgt nur eine einmalige Erinnerung (nächtliche Stapelverarbeitung). | |||||||||||||||||||||||||||||||||||||
| Mahnung bei überfälligem Workflowschritt | Ausprägungen: Täglich / Wöchentlich am Montag Sollte eine Pendenz am vorgegebenen Fälligkeitsdatum noch unbearbeitet sein, wird der Benutzer, bei dem der aktuelle Workflowschritt hängig ist, via Email erinnert. Diese Erinnerungen können an den Arbeitstagen oder auch nur wöchentlich montags verschickt werden. | Zu 'montags': die Erinnerungen werden gebündelt an den Nutzer verschickt, um dessen Aufmerksamkeit für den Inhalt aufrecht zu erhalten ('gefühlten Spam' vermeiden). | ||||||||||||||||||||||||||||||||||||
| Editierbare Objektfelder während Workflow | Ausprägungen: Alle Felder (Default) / Keine Felder / Keine Felder ausser Kommentare / Anhänge Bestimmen Sie, welche Felder des Objektes editierbar sein sollen, wenn dieser Workflow-Typ am Laufen ist. Die Einstellung ist für den gesamten Workflow bzw. alle Pendenzen daraus gültig. (Erfassung nicht für alle Objekte relevant.) | neu ab Version 2.29 | ||||||||||||||||||||||||||||||||||||
| Zurückweisungsoptionen | Hier können Sie definieren, welche Optionen das System dem Nutzer für den Fall einer Zurückweisung anbieten soll. Ausprägungen sind:
Sofern bei 'Editierbare Objektfelder während Workflow' 'Keine Felder...' selektiert wurde, wird als Zurückweisungsoption nur 'Endgültig ablehnen' angeboten. Dies, weil der Fall ansonsten in eine 'Sackgasse' führen könnte, da der Adressat keine Handlungsoptionen (Änderung der Daten) hat. Falls die Selektion 'Endgültig ablehnen / Ablehnen' beinhaltet, wird ein neuer Schritt 'Schritte bei Ablehnung' am Ende der Workflow-Konfiguration hinzugefügt. Dort werden Instruktionen bezüglich dem Schliessen des Workflows erfasst (Details siehe im nächsten Kapitel). | neu ab Version 2.32 Hinweis: "Ablehnen" wird synonym zu "Endgültig ablehnen" verwendet um die Auswahloptionen kürzer zu halten | ||||||||||||||||||||||||||||||||||||
| Wenn keine Entität vorliegt | Hier können Sie definieren, welche Optionen benutzt werden soll, wenn es noch keine entsprechende Objekt gibt. Ausprägungen sind:
| aktuell nur für Objektarten "Dokument" und " Prozess" verfügbar | ||||||||||||||||||||||||||||||||||||
| Tag bei Start | Ermöglicht das Setzen einer Zusatzinformation auf dem Objekt wenn ein Workflow gestartet wurde. Ein Beispiel-Anwendungsfall: Approval-Prozess läuft | neu ab Version 2.29 für Issues | ||||||||||||||||||||||||||||||||||||
| Tag bei Abschluss | Ermöglicht das Setzen einer Zusatzinformation auf dem Objekt wenn ein Workflow erfolgreich abgeschlossen wurde. Ein Beispiel-Anwendungsfall: Approval erteilt | neu ab Version 2.29 für Issues geplant für Actions | ||||||||||||||||||||||||||||||||||||
| Nach Abschluss löschen (T) | Geben Sie eine Anzahl Tage ein, falls Sie Pendenzen aus diesem Workflowtypen nach X Tagen automatisch löschen wollen. Der Batch GeneralHousekeepingJob wird dann nachts entsprechende (abgeschlossene) Workflow-Pendenzen löschen. | neu ab Version 2.29 | ||||||||||||||||||||||||||||||||||||
| Trigger Condition | Wenn ein Workflow nur unter bestimmten Bedingungen gestartet werden darf, so ist das hier zu definieren. Die Bedingungen müssen mit Spring Expression Language geschrieben sein. Folgendes sind übliche Standardfälle, für die wir Ihnen gerne eine entsprechende Bedingung zur Verfügung stellen:
| Sollten Sie die Auslösung des Workflows an eine konkrete Bedingung knüpfen wollen, so sind wir Ihnen mit der Codierung gerne behilflich. | ||||||||||||||||||||||||||||||||||||
| Zusatzfelder | Hier können Sie festlegen, welche Zusatzfelder im Workflow angezeigt werden sollen. Es stehen grundsätzlich alle Felder vom Typ 'Anfrage Zusatzfeld' zur Auswahl. (Welche Felder in welcher Maske angezeigt und/oder editiert werden sollen, wird bei der Definition der Schritte festgelegt.) Definieren Sie für die selektierten Felder:
Mit diesen Angaben übersteuern Sie die Einstellungen, die für den Feldtyp hinterlegt sind (angezeigt in grau, nicht editierbar). Die Übersteuerung gilt nur für den vorliegenden Workflow. | QV: Admin → Modulkonfigurationen → Custom Fields; Filter 'Typ' = 'Anfrage Zusatzfeld' | ||||||||||||||||||||||||||||||||||||
| Initiator | Es besteht die Möglichkeit, für die Definition des Initiators (d.h. wer darf diesen Workflow starten?) entweder auf zuvor angelegte 'Empfänger' zurückzugreifen (siehe QV), oder diesen explizit nur für den vorliegenden Workflow zu definieren. Je nach Selektion von 'Spezifisch definiert' (vorselektiert) bzw. 'Existierenden Empfänger verwenden' ändern sich daher die anschliessenden Eingabefelder. | QV: Admin → Modulkonfigurationen → Workflow → Empfänger | ||||||||||||||||||||||||||||||||||||
Initiator (Drop-Down) (nur angezeigt bei 'Existierenden Empfänger verwenden') | Selektieren Sie den existierenden 'Empfänger', den Sie als Initiator für den vorliegenden Workflow setzen möchten. Es werden nur die Empfänger im Drop-Down angezeigt, bei denen der Flag 'Kann Initiator sein' gesetzt ist. | QV: Admin → Modulkonfigurationen → Workflow → Empfänger |
Speichern Sie die allgemeinen Eingaben, bevor Sie mit der Definition der gewünschten Schritte beginnen, denen der Workflow folgen soll, bzw. generell bevor Sie von der Maske weg navigieren.
Erfassung Workflow Schritte
Nachdem die Grundlagen für den Workflow erfasst sind, sind noch die einzelnen Workflow-Schritte (einer oder mehrere) zu definieren.
Wichtig:
Im Fall, dass das System den Workflow auslöst (siehe oben, 'Trigger'), beinhaltet Schritt 1 die 'Instruktionen' an das System.
Wenn ein Nutzer den Workflow auslöst, beinhaltet Schritt 1 i.d.R. das Eingabeformular, das dem Nutzer bei der Initiierung angezeigt werden soll.
Ab Schritt 2 können Sie definieren, auf welche Standard-Schritte (= Funktionalitäten; Schritt - 'Typ') Sie zurückgreifen wollen:
- Benachrichtigung (= Mail-Notifizierung)
- Bewilligung (= Genehmigung ja / nein)
- Quittierung (= Kenntnisnahme)
- System
Die Eingabefelder beim Schritt-Typ 'System' variieren.
Unabhängig davon sind allenfalls nicht alle Eingabefelder für Ihre Implementierung relevant - Sie können diese im Zweifelsfall ignorieren.
Im Folgenden wird der Hintergrund bzw. Auswirkung der Eingaben beschrieben (wo nicht selbsterklärend oder an anderer Stelle dokumentiert):
| Feldname | Beschreibung | Kommentar / Querverweise (QV) | |||||||||||||||
|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|
| Kollektiv | Hier legen Sie fest, ob jeder Pendenzen-Empfänger seine eigene Pendenz erhalten soll oder ob eine Kollektiv-Pendenz erstellt wird, die alle Empfänger bearbeiten können. | Beispiel-Anwendungsfall: Aus einer Gruppe von 10 Leuten müssen mind. 2 ein Dokument freigeben. Selektieren Sie "Kollektiv" und setzen Sie die Anzahl auf 2, damit Sie ein 4-Augen-Prinzip gewährleisten können. | |||||||||||||||
| Anzahl erforderlicher Einreicher | Nur relevant für Kollektiv-Pendenzen Hier legen Sie fest, wie viele der Pendenzen-Empfänger eine Bewilligung oder eine Quittierung geben müssen, damit der Schritt als erledigt betrachtet wird und der Workflow weitergeht. | ||||||||||||||||
| Custom Mail Prefix Key | Wenn Sie das Feld leer lassen, werden allgemeine Default-Texte verwendet. Eine Prefix-Eingabe ermöglicht Workflow-spezifische Emailtexte. | Wir empfehlen das Definieren von konkreten Texten und helfen Ihnen gerne beim Anlegen. | |||||||||||||||
Geplante Wiedereinreichdauer (Tage) | Nur relevant für den ersten Schritt für den Fall, dass eine Pendenz abgelehnt / zurückgewiesen wird. Hier legen Sie fest, wie viele Tage - beginnend mit der Zurückweisung der Pendenz - dem Nutzer für deren Wiedereinreichung gewährt werden (bevor das 'Mahnverfahren' wie definiert anläuft). | ||||||||||||||||
| Geplante Dauer (Tage) | Hier legen Sie fest, wie viele Tage - beginnend mit der Zuteilung der Pendenz - dem Nutzer für deren Erledigung gewährt werden (bevor das 'Mahnverfahren' wie definiert anläuft). | ||||||||||||||||
Adhoc Mitarbeiter als Empfänger (Typ 'Benachrichtigung') | Hier legen Sie fest, ob beim Starten des Workflows ein spezifischer Mitarbeiter als Empfänger definiert werden darf oder muss. | ||||||||||||||||
System Step Implementation (Typ 'System') | Das System ermöglicht diverse vorprogrammierte System-Steps, die in der automatischen Verarbeitung von Workflows hilfreich sein können:
|
Sie können sich für die Erfassung weiterer Schritte entscheiden (zu erstellen vor oder nach dem vorliegenden Schritt). Vergessen Sie nicht, Ihre Erfassungsarbeit mit 'Speichern: Schritt...' zu sichern.
Danach ist Ihr neuer Workflow fertig und zur Ausführung bereit.
Optional: Schritte bei Ablehnung
Sofern Sie in den Basisdaten konfiguriert haben, dass während des Workflows eine Endgültige Ablehnung (und damit das Beenden des Workflows) möglich ist (Zurückweisungsoption), definieren Sie hier, wie das System sich in diesem Fall verhalten soll. Die Erfassung folgt den gleichen Regeln wie oben beschrieben. Sie können auch hier beliebig viele Schritte konfigurieren. Das System wird Ihnen per Default eine Benachrichtigung an den Anfragesteller hinzufügen, welche unserer Erfahrung nach in der Regel Sinn macht.
Tatsächlich ausgelöste Flows finden Sie unter Admin → Workflows gelistet. Durch Filtern des Workflowtyps gewinnen Sie schnell eine Übersicht über Nutzung und Ablauf Ihres Workflows.
Anpassen eines bestehenden Workflows
Falls Sie bestehende Workflows anpassen wollen, wählen Sie in der Liste der bereits existierenden Abfragetypen das 'Bleistift-Icon' neben dem relevanten Flow. Nehmen Sie die gewünschte Anpassung auf Basis der obigen Beschreibungen vor und speichern Sie Ihre Arbeit. Der aktualisierte Flow wird mit der nächsten Auslösung wirksam.
Tipp:
Um Inkonsistenzen in den Daten oder im Systemverhalten zu vermeiden, empfehlen wir Ihnen, alle pendenten Workflows des vorliegenden Typs zuvor abzuschliessen.
Ausserdem sollten Sie nach der Anpassung "Alle DB und Text Caches leeren" (Admin → IT Support).