Durchsuchbare Dokumentation aufrufen

Zurück zur Dokumentationsübersicht

Freigabeworkflow

Für welche Version verfügbar?
• agorum core pro

Hinweis: Diese Dokumentation bezieht sich auf die aktuellste Version des Plugins. Aktualisieren Sie das hier beschriebene Plugin, um die Dokumentation verwenden zu können.

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:

Übersicht: Freigabeworkflow

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.

Eine Beschreibung der Freigabe eingeben

Einen Freigabeschritt definieren

Geben Sie beliebig viele Freigabeschritte ein.

Einen Freigabeschritt definieren

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:

Einen oder mehrere Empfänger auswählen

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.

Ein Datum für die Eskalation setzen

Einen Freigabeschritt einleiten

Das System:

 
Einen Freigabeschritt einleiten
 

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:

Bedienoberfläche bei Auswahl "Zurück zum Ersteller"

Der Ersteller:

Hinweis: In der Bedienoberfläche, in der Sie die Empfänger wählen können, ist jetzt Ihr eigener Ersteller zu sehen, sofern Sie dort zuvor keine Empfänger angegeben haben.

Eingetragener Ersteller bei erneuter Freigabe
 

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:

Bedienoberfläche bei Auswahl Abgelehnt

Schaltfläche „Freigeben“

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

Anzeige aller Schritte und deren Status

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
Benutzergruppen des Freigabeworkflows

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
ACL des Freigabeworkflows

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.

Den Freigabeworkflow als Subworkflow verwenden

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:

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

Knoten „releaseXEyes“

Aufruf des 1. Freigabeschritts mit Eingabe der Bemerkung

Knoten „releaseXEyes1“

Den Freigabeworkflow per JavaScript starten

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

Workflow agorum.workflow.releaseXEyes.start

Parameter des Workflows

Der Workflow enthält einen Knoten mit diesen Parametern:

Parameter des Workflows

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;