Workflow "Gehaltsabrechnungen ablegen"

Mit dem folgenden Workflow legen Sie etwa Gehaltsabrechnungen ab, d. h. der Workflow muss immer mit einem Anhang gestartet werden. Auf dieselbe Art und Weise können Sie auch jedes andere Dokument ablegen.

Der Workflow besteht aus folgenden Knoten (in dieser Reihenfolge):

• comment
• Workflow-Debugging
• Metadaten laden
• Log
• Bedingung (Objekte)
• 2x set
• Ist Wert gesetzt
• comment / set
• Ablage
• set
• Metadaten speichern
• comment

Diese Dokumentation beschreibt die Anlage und Parameter / Werte jedes Knotens. Anschließend folgt eine Beschreibung der Funktionsweise jedes Knotens, damit Sie verstehen, welche Aufgaben der jeweilige Knoten erfüllt und wie er im abgebildeten Workflow funktioniert.

Knoten „Kommentar“ erstellen

---

Im 1. Schritt erstellen Sie den Knoten Kommentar.

Parameter befüllen

Der Knoten verfügt über keine Möglichkeit, Parameter anzugeben. Legen Sie den Knoten daher lediglich an.

Funktionsweise des Knotens

Dieser Knoten dient lediglich dazu, den Start des Workflows zu kennzeichnen. Er verschafft einen Überblick, wo der Workflow beginnt.

• Setzen Sie diesen Knoten als Eingangsknoten.
• Vergeben Sie als Anzeigename etwa Workflow wird gestartet.

Knoten „Workflow Debugging“ erstellen

---

Im 2. Schritt erstellen Sie den Knoten Workflow Debugging.

Parameter befüllen

Im Knoten befüllen Sie folgenden Parameter:

• Debug-Modus verwenden

1. Vergeben Sie im Parameter Debug-Modus verwenden etwa folgende Variable als Expression:

   token.variables.starte_mit_debug

   Hinweis: Die Variable starte_mit_debug erwartet einen Wahrheitswert (true oder false). Diesen Wert können Sie etwa mitgeben, indem Sie im Workflow-Editor auf Ausführen klicken und dort die Konfiguration rechts folgendermaßen ergänzen:

   "starte_mit_debug": true

   Vollständiges Beispiel der Konfiguration (Ausführen mit Anhang):

   {
     "sys_acw_attachments": [
       "/agorum/roi/Files/Demo/Willkommen.pdf"
     ],
     "starte_mit_debug": true
   }

Funktionsweise des Knotens

Dieser Knoten versetzt den Workflow in einen Testbetrieb.

• Da die Eingangsvariable nicht gefüllt ist, arbeitet der Knoten mit den Anhängen aus der internen Systemvariable sys_acw_attachments.
• Im obigen Beispiel wird die Datei Willkommen.pdf als Anhang übergeben.
• Mit diesem Anhang arbeitet der Workflow jetzt im Debug-Modus.

Knoten „Metadaten laden“ erstellen

---

Im 3. Schritt erstellen Sie den Knoten Metadaten laden.

Parameter befüllen

Im Knoten befüllen Sie folgende Parameter:

• Filtern der Daten
• Ergebnisvariable

1. Vergeben Sie im Parameter Filtern der Daten etwa folgenden Regex als Expression:

   #{/BeispielMetadatum_/}
   

2. Vergeben Sie im Parameter Ergebnisvariable etwa folgende Variable im Editor:

   MetadatenVariable

Funktionsweise des Knotens

Dieser Knoten filtert nach allen Metadaten, die mit BeispielMetadatum_ beginnen. Die gefilterten Metadaten legt das System anschließend in die Ergebnisvariable MetadatenVariable ab. Sie stehen dort für alle weiteren Knoten zur Verfügung.

Knoten „Log“ erstellen

---

Im 4. Schritt erstellen Sie den Knoten Log.

Parameter befüllen

Im Knoten befüllen Sie folgende Parameter:

• Nachricht
• Parameter (Expression)

1. Vergeben Sie im Parameter Nachricht etwa folgenden Text im Editor:

   Log der geladenen Metadaten
   

2. Vergeben Sie als Parameter (Expression) etwa folgende Variable im Editor:

   token.variables.MetadatenVariable

   Hinweis: Geben Sie die gleiche Variable an, die Sie im Knoten Metadaten laden als Ergebnisvariable angegeben haben. Ansonsten können die geladenen Metadaten nicht im Log ausgegeben werden.

Funktionsweise des Knotens

Dieser Knoten gibt die Nachricht Log der geladenen Metadaten im Log (Protokoll) aus. Als Inhalt des Logs werden die zuvor geladenen Metadaten angezeigt, die das System im Knoten Metadaten laden in die Ergebnisvariable MetadatenVariable geschrieben hat (siehe Schritt 3).

Knoten „Bedingung (Objekte)“ erstellen

---

Im 5. Schritt erstellen Sie den Knoten Bedingung (Objekte).

Parameter befüllen

Im Knoten befüllen Sie folgenden Parameter:

• Selektoren

1. Vergeben Sie etwa folgenden Selektor im Editor:

   [nameExtension=/pdf/i]
   

Funktionsweise des Knotens

Dieser Knoten filtert über den angegebenen Selektor alle Dateien, die als Dateiendung pdf aufweisen. Das i am Ende des Selektors bewirkt, dass etwa auch auf PDF geprüft wird und nicht nur die Kleinschreibung der Dateiendung beachtet wird (pdf).

Der Knoten verfügt zudem über zwei Outlets:

• true
• false

Handelt es sich bei den Anhängen, die dem Workflow übergeben werden, um PDF-Dateien, nimmt das System das Outlet true. Handelt es sich nicht um PDF-Dateien, nimmt es das Outlet false. 

Knoten "set" erstellen

---

Im 6. Schritt erstellen Sie den Knoten set doppelt:

• 1× für das zuvor definierte Outlet true des Knotens Bedingung (Objekte).
• 1× für das zuvor definierte Outlet false des Knotens Bedingung (Objekte).

Parameter befüllen

In beiden set-Knoten befüllen Sie folgende Parameter:

• Schlüssel
• Wert

Knoten „AblagePfadSetzen1“

1. Vergeben Sie im Parameter Schlüssel etwa folgende Variable im Editor:

   AblagePfad

2. Vergeben Sie im Parameter Wert etwa folgenden Wert im Editor:

   PDF
   

Knoten „AblagePfadSetzen2“

1. Vergeben Sie im Parameter Schlüssel etwa folgende Variable im Editor:

   AblagePfad

2. Vergeben Sie im Parameter Wert etwa folgenden Wert im Editor:

   Andere

Funktionsweise der Knoten

Knoten „AblagePfadSetzen1“

Dieser Knoten erzeugt die Variable AblagePfad und weist den Wert PDF zu, sofern der Knoten Bedingung (Objekte) zuvor über das Outlet true verlassen wurde.
 

Knoten „AblagePfadSetzen2“

Dieser Knoten erzeugt die Variable AblagePfad und weist den Wert Andere zu, sofern der Knoten Bedingung (Objekte) zuvor über das Outlet false verlassen wurde.

Knoten „Ist Wert gesetzt“ erstellen

---

Im 7. Schritt erstellen Sie den Knoten Ist Wert gesetzt.

Parameter befüllen

Im Knoten befüllen Sie folgenden Parameter:

• Eingangsvariable

1. Vergeben Sie im Parameter Eingangsvariable etwa folgende Variable im Editor:

   MetadatenVariable.BeispielMetadatum_Benutzer
   

Funktionsweise des Knotens

Dieser Knoten prüft die Variable MetadatenVariable.BeispielMetadatum_Benutzer auf einen Inhalt. Die Variable wurde zuvor durch den Knoten Metadaten laden in Schritt 3 erstellt, hier als Ergebnisvariable. Die Variable enthält wiederum das Metadatum BeispielMetadatum_Benutzer, da über den Knoten Metadaten laden alle Metadaten geladen wurden, die mit BeispielMetadatum_ beginnen.

Knoten „Kommentar“ / „set“ erstellen

---

Im 8. Schritt erstellen Sie erneut die beiden Knoten Kommentar und set.

Parameter befüllen

comment

Der Knoten verfügt über keine Möglichkeit, Parameter anzugeben. Legen Sie den Knoten daher lediglich an.
 

set

Im set-Knoten befüllen Sie folgende Parameter:

• Schlüssel
• Wert

1. Vergeben Sie im Parameter Schlüssel etwa folgende Variable im Editor:

   MetadatenVariable.BeispielMetadatum_Benutzer
   

2. Vergeben Sie als Wert etwa Folgendes im Editor:

   Unbekannt

Funktionsweise der beiden Knoten

comment

Dieser Knoten hat lediglich eine optische Funktion und dient dazu, das Outlet true des vorherigen Knotens Ist Wert gesetzt aus Schritt 9 optisch zu kennzeichnen.

set

Der Knoten weist der Variable MetadatenVariable.BeispielMetadatum_Benutzer den Wert Unbekannt zu. Die Variable wurde zuvor durch den Knoten Metadaten laden in Schritt 3 erstellt, hier als Ergebnisvariable. Die Variable enthält wiederum das Metadatum BeispielMetadatum_Benutzer, da über den Knoten Metadaten laden alle Metadaten geladen wurden, die mit BeispielMetadatum_ beginnen.

Knoten „Ablage“ erstellen

---

Im 9. Schritt erstellen Sie den Knoten Ablage.

Parameter befüllen

Im Knoten befüllen Sie folgende Parameter:

• Name
• Erhalte Dateiendung des ursprünglichen Dateinamens
• Basisordner
• Pfad

1. Geben Sie im Parameter Name etwa folgenden Dokumentenname im Editor an:

   Gehaltsabrechnung ${MetadatenVariable.BeispielMetadatum_Benutzer} ${date:yyyy-MM}
   

2. Aktivieren Sie den Parameter Erhalte die Dateiendung des ursprünglichen Dateinamens.
3. Geben Sie im Parameter Basisordner etwa folgenden Ordner im Editor an:

   /agorum/roi/Files

4. Lassen Sie die Option die obige Eingabe ist eine Suche deaktiviert.
5. Geben Sie im Parameter Pfad etwa folgenden Pfad im Editor an:

   Sample Mandant/Abgelegte Gehaltsabrechnung/${AblagePfad}

Funktionsweise des Knotens

Der Knoten vergibt den Dateinamen Gehaltsabrechnung mit Angabe der Variablen MetadatenVariable.BeispielMetadatum_Benutzer und deren Inhalt sowie des Jahres und des Monats zum Zeitpunkt der Ablage, etwa:

Gehaltsabrechnung Müller 2021-05

Die Dateiendung des übergebenen Anhangs wird beibehalten, also nicht verändert. Da die Eingangsvariable im Knoten nicht angegeben ist, arbeitet der Knoten mit den Anhängen, die sich in der internen Systemvariable sys_acw_attachments befinden.

Als Basisordner wird der Ordner /agorum/roi/Files angegeben. 

Unterhalb dieses Basisordners legt das System den Pfad Mandant/Abgelegte Gehaltsabrechnung/${AblagePfad} an. Die Variable AblagePfad und deren Inhalt stammt aus einem der beiden set-Knoten aus Schritt 6.

Handelt es sich bei dem übergebenen Anhang um eine PDF-Datei, legt das System den Anhang unter folgendem Pfad ab: 

/agorum/roi/Files/Mandant/Abgelegte Gehaltsabrechnung/PDF

Handelt es sich nicht um eine PDF-Datei, legt das System den Anhang unter folgendem Pfad ab: 

/agorum/roi/Files/Mandant/Abgelegte Gehaltsabrechnung/Unbekannt

Knoten „set“ erstellen

---

Im 10. Schritt erstellen Sie erneut den Knoten set.

Parameter befüllen

Im Knoten befüllen Sie folgende Parameter:

• Schlüssel
• Wert

1. Vergeben Sie im Parameter Schlüssel etwa folgende Variable im Editor:

   MetadatenVariable.BeispielMetadatum_Workflow_Status
   

2. Vergeben Sie als Wert etwa Folgendes im Editor:

   Abgelegt

Funktionsweise des Knotens

Der Knoten setzt den Wert der Variable MetadatenVariable.BeispielMetadatum_Workflow_Status auf Abgelegt. Die Variable wurde zuvor in Schritt 3 durch den Knoten Metadaten laden erstellt, hier als Ergebnisvariable. Die Variable enthält wiederum das Metadatum BeispielMetadatum_Workflow-Status, da alle Metadaten geladen wurden, die mit BeispielMetadatum_ beginnen.

Knoten „Metadaten speichern“ erstellen

---

Im 11. Schritt erstellen Sie den Knoten Metadaten speichern.

Parameter befüllen

Im Knoten befüllen Sie folgende Parameter:

• Filtern der Daten
• Datenvariable

1. Geben Sie im Parameter Filtern der Daten etwa folgenden Regex als Expression an:

   #{/BeispielMetadatum_/}
   

2. Geben Sie im Parameter Datenvariable etwa folgende Variable im Editor an:

   MetadatenVariable
   

Funktionsweise des Knotens

Der Knoten filtert zuerst alle Metadaten, die mit BeispielMetadatum_ beginnen. Da die Eingangsvariable nicht gefüllt ist, prüft das System die Anhänge und deren Metadaten, die sich in der internen Systemvariable sys_acw_attachments befinden.

Nach dem Filtern speichert das System die Metadaten in die Datenvariable ab. Die Datenvariable wurde zuvor durch den Knoten Metadaten laden (Ergebnisvariable) in Schritt 3 erstellt.

Knoten „Kommentar“ erstellen

---

Im 12. Schritt erstellen Sie erneut den Knoten Kommentar an.

Parameter befüllen

Der Knoten verfügt über keine Möglichkeit, Parameter anzugeben. Legen Sie den Knoten daher lediglich an.

Funktionsweise des Knotens

Dieser Knoten dient lediglich dazu, das Ende des Workflows zu kennzeichnen.

• Er verschafft einen Überblick, wo der Workflow endet.
• Vergeben Sie als Anzeigename im Knoten etwa Workflow wird beendet.