Freigabeworkflow

Name: agorum core workflow releaseXEyes

Der Freigabeworkflow unterstützt bei der täglichen Freigabe, etwa von diversen Aufgaben oder von Dokumenten, die freigegeben werden sollen.

Mithilfe des Freigabeworkflows können Sie:

• eine Beschreibung der Freigabe eingeben
• Freigabeschritte definieren
• einen oder mehrere Empfänger wählen, die den Workflow in bestimmten Fällen erhalten
• ein Datum für die Eskalation setzen

Den Workflow starten

---

Starten Sie den Freigabeworkflow, damit Sie Freigaben erteilen können.

Eine Beschreibung der Freigabe eingeben

---

Geben Sie eine aussagekräftige Beschreibung für die Freigabe ein, sobald Sie den Workflow gestartet haben.

Mit einer aussagekräftigen Beschreibung finden Sie die Freigabe schneller.

Einen Freigabeschritt definieren

---

Geben Sie beliebig viele Freigabeschritte ein.

• Freigabeschritte spezifizieren die Freigabe näher und beschreiben, was zu tun ist.
• Für jeden Schritt definieren Sie einen oder mehrere Empfänger (Benutzer und / oder Benutzergruppen).
• Der jeweilige Schritt erscheint in der Liste der Workflow-Aufgaben bei diesen Empfängern, wenn Sie auf Workflow starten klicken.
• Das System ordnet die einzelnen Schritte diesen Benutzern zu, sodass diese die Schritte ausführen können.

Einen oder mehrere Empfänger wählen

---

Wählen Sie einen oder mehrere Empfänger (Benutzer und / oder Benutzergruppen), denen der Workflow zugeordnet werden soll, wenn:

• ein Bearbeiter den Workflow freigibt
• ein Bearbeiter den Workflow nicht freigibt
• das Datum für die Freigabe erreicht ist
   
• Der Workflow erscheint in der Liste der Workflow-Aufgaben bei dem jeweiligen Empfänger, wenn ein Benutzer im Workflow auf Ablehnen oder Freigeben klickt.
• Wählen Sie hier keinen Empfänger, gelten Sie selbst als Empfänger.

Ein Datum für die Eskalation setzen

---

Definieren Sie ein Datum, damit das System die Freigabe automatisch überwacht, und klicken Sie dann auf Workflow starten.

Das System weist den Workflow dem Empfänger zu, der oben bei Empfänger, wenn Freigabe eskaliert eingetragen ist, sobald das Datum erreicht ist.

Einen Freigabeschritt einleiten

---

Das System:

• übergibt den zuvor definierten 1. Freigabeschritt an den gewählten Benutzer, nachdem Sie auf Workflow starten geklickt haben
• erstellt parallel einen weiteren Prozessschritt, wenn Sie im Feld Erledigt bis ein Datum gesetzt haben
• überwacht die Freigabe anhand des Datums

 

Schaltfläche „Zurück zum Ersteller“

Ein Bearbeiter kann den Freigabeschritt zurück an den Ersteller geben, wenn der Freigabeschritt etwa einem falschen Benutzer zugewiesen ist.

Der Bearbeiter muss einen Text im Feld Bemerkung Freigeber eingeben, d. h., warum er den Freigabeschritt zurück zum Ersteller gibt.

Beim Ersteller erscheint diese Übersicht:

Der Ersteller:

• gibt den Workflow entweder erneut frei, indem er den korrekten Empfänger in der Bedienoberfläche wählt und auf Workflow starten klickt
• oder er beendet den Workflow an dieser Stelle

Schaltfläche „Ablehnen“

Ein Bearbeiter kann die Freigabe ablehnen, sollte er etwa Fehler in einem Dokument oder Ähnliches entdeckt haben.

Der Bearbeiter kann im Feld Bemerkung Freigeber einen Text eingeben, d. h., warum er den Freigabeschritt ablehnt.

Beim Ersteller erscheint diese Übersicht:

• In der Übersicht der Freigabeschritte sieht der Ersteller neben der Information, dass der Schritt 1 an den Ersteller zurückging, dass Schritt 1 gesperrt ist, d. h. abgelehnt wurde.
• Der Ersteller kann den Workflow freigeben oder beenden.

Schaltfläche „Freigeben“

Der Bearbeiter gibt den Freigabeschritt frei, wenn keine Gründe vorliegen, um einen Freigabeschritt abzulehnen.

• Der Bearbeiter muss in diesem Fall keinen Text in das Feld Bemerkung Freigeber eingeben.
• Nach der Freigabe ruft das System den nächsten Freigabeschritt auf.
• Der Bearbeiter kann diesen Schritt erneut ablehnen, freigeben oder zurück an den Ersteller geben.
• Sind alle Freigabeschritte durchlaufen, erscheint beim Ersteller des Workflows eine Bedienoberfläche mit allen Schritten.
• Der Ersteller kann den Workflow erneut freigeben oder beenden.

Den Freigabeworkflow über Benutzergruppen und ACLs berechtigen

---

Den Freigabeworkflow über Benutzergruppen berechtigen

Tragen Sie als Administrator die Benutzer in Benutzergruppen ein, damit der Freigabeworkflow im Eingang (aktuell) nur bestimmten Benutzern erscheint.

Benutzergruppe	Beschreibung
GRP_Approval_Cleared	An diese Benutzergruppe geht der Workflow, wenn die Freigabe erteilt wurde.
GRP_Approval_Content	Diese Benutzergruppe ist für Schritt 2, die inhaltliche Freigabe, zuständig.
GRP_Approval_Technical	Diese Benutzergruppe ist für Schritt 1, die technische, formale Prüfung der Rechnung, zuständig.
GRP_Approval_Locked	An diese Benutzergruppe geht der Workflow, wenn: die Rechnung gesperrt wurde ein Bearbeiter auf die Schaltfläche Zurück zum Ersteller geklickt hat das System die Eskalation auslöst

So finden Sie die Benutzergruppen:

1. Öffnen Sie links in der Seitenleiste Administration und dann Gruppen.
2. Öffnen Sie den Pfad:

   Gruppen/Workflow/Approval_Workflow

Für das Berechtigen von Benutzergruppen siehe Berechtigungen in der Administration verwalten.

Den Freigabeworkflow über ACLs berechtigen

Über eine bestimmte ACL schränken Sie den Workflow für bestimmte Benutzer ein.

Im Standard ist der Workflow für alle Benutzer sichtbar.

ACL	Beschreibung
ACL_agorum.workflow.releaseXEyes	Steuert, welche Benutzer den Workflow sehen können.

So finden Sie die ACL:

1. Öffnen Sie links in der Seitenleiste Administration und dann ACLs/Rechte.
2. Öffnen Sie den Pfad:

   ACLs/Rechte/agorum.workflow.releaseXEyes

Für das Berechtigen von Benutzern siehe Berechtigungen in der Administration verwalten.

Den Freigabeworkflow als Subworkflow verwenden

---

Ein Entwickler oder Administrator kann den Freigabeworkflow als Subworkflow in einen Hauptworkflow einbinden.

• Zu diesem Zweck steht der Freigabeworkflow als Test-Workflow in der Bedienoberfläche der zu ladenden Workflows zur Verfügung.
• Sie finden diesen dort unter dem Namen agorum.workflow.test.releaseXEyes.

Um einen der beiden Knoten releaseXEyes und releaseXEyes1 verwenden zu können, müssen Sie nach dem Aufruf des Workflow-Editors einen dieser beiden Knoten als Einstiegsknoten definieren.

Beide Knoten verfügen über die Default-Werte und Default-Felder:

• Beschreibung der Freigabe
• Freigabeschritte

Je nachdem, welches Feld gefüllt ist, verhält sich der Knoten anders.

Knoten „releaseXEyes“

• Befüllen Sie im Workflow die Beschreibung und mindestens 1 Freigabeschritt (Default-Werte), wie in diesem Knoten konfiguriert, lädt das System beim Start des Workflows direkt den 1. Freigabeschritt.
• Ein Bearbeiter kann hier direkt die Bemerkung zum 1. Freigabeschritt eingeben.

Knoten „releaseXEyes1“

• Definieren Sie im Workflow nur die Beschreibung der Freigabe oder nur einen Freigabeschritt (Default-Werte), wie in diesem Knoten konfiguriert, lädt das System beim Start des Workflows keine Freigabeschritte und Beschreibungen, d. h. die Oberfläche und deren Felder sind nicht gefüllt
• Ein Bearbeiter muss die Freigabeschritte und die Beschreibung der Freigabe nach dem Start des Workflows in der Oberfläche manuell hinzufügen.

Den Freigabeworkflow per JavaScript starten

---

Der Freigabeworkflow agorum.workflow.releaseXEyes benötigt beim Aufruf Parameter.

• Die Parameter können Sie nicht per JavaScript übergeben.
• Zu diesem Zweck übernimmt ein weiterer Workflow namens agorum.workflow.releaseXEyes.start das Mapping von Variablen in diese Parameter.
• Ein Entwickler kann den Workflow agorum.workflow.releaseXEyes.start von außen per JavaScript aufrufen, etwa vom Fileworkflow aus.
• Sie finden diesen Workflow in der Bedienoberfläche der zu ladenden Workflows unter dem Namen agorum.workflow.releaseXEyes.start.

Parameter des Workflows

Der Workflow enthält einen Knoten mit diesen Parametern:

Den Workflow per JavaScript aufrufen

Das folgende JavaScript ruft die Parameter des Workflows auf und übergibt sie:

/* global folder, object, parameters */

/**
// Testbereich: Hier lässt sich das Skript mit dem mitgelieferten Testdokument aus der ZIP-Datei starten. Die Parameter weiter unten können Sie frei einstellen.
​​​​​​// 
let object = require('common/objects').find('/agorum/roi/customers/agorum.workflow.releaseXEyes/testdaten/test-freigabe.txt');
let parameters = {
  workflow: 'agorum.workflow.releaseXEyes.start'
};
/**/

let datum = new Date();
datum.setDate(datum.getDate() + 7); // maximal 7 Tage für die Freigabe

// Voraussetzungen
let workflow = require('common/workflow');

workflow.start(parameters.workflow, {
  sys_acw_attachments: [object.UUID],
  // Empfänger, wenn nicht freigegeben
  notReleaseRecipient: [
    // 'group:GRP_Approval_Locked' // Das ist aus dem Vorgänger-Freigabeworkflow
    'user:roi'
  ],
  // Empfänger, wenn freigegeben
  releaseRecipient: [
    // 'group:GRP_Approval_Cleared' // Das ist aus dem Vorgänger-Freigabeworkflow
    'user:roi'
  ],
  stepsList: [
    {
      //"_id": "cc806ee0-c939-11eb-ae27-02420a0a0013",
      step: 'Technische Freigabe',
      stepText: 'Bitte die Rechnung formal prüfen',
      // Empfänger für den Workflowschritt
      stepRecipient: [
        //'group:GRP_Approval_Technical' // Das ist aus dem Vorgänger-Freigabeworkflow
        'user:roi'
      ]
    },
    {
      step: "Inhaltliche Freigabe",
      stepText: 'Bitte die Rechnung inhaltlich prüfen',
      // Empfänger für den Workflowschritt
      stepRecipient: [
        // 'group:GRP_Approval_Content' // Das ist aus dem Vorgänger-Freigabeworkflow
       'user:roi'
      ]
    }
  ],
  // Wenn die Schaltfläche "Zurück zum Ersteller" angeklickt wird, geht der Workflow an diese Benutzergruppe zurück,
  // da beim automatischen Start immer der Benutzer "roi" der Ersteller ist
  backToCreator: [ 
    // 'group:GRP_Approval_Locked'  // Das ist aus dem Vorgänger-Freigabeworkflow
   'user:roi'
  ],
  // Empfänger, wenn Workflow eskaliert
  escalationRecipient: [
    // 'group:GRP_Approval_Locked'  // Das ist aus dem Vorgänger-Freigabeworkflow
    'user:roi'
  ],
  doneBy: datum,
  releaseText: '<p>Bitte Rechnung freigeben</p>\n' 
  
});

datum;