Einführung in den agorum core fileworkflow

Der agorum core fileworkflow ist ein durch Regeln konfigurierbarer Workflow für ein Objekt. Das System prüft anhand der Bedingungen in den hinterlegten Regeln, welche Bedingungen zutreffen. Alle Regeln mit dieser Bedingung führt das System aus. Dadurch können Sie beliebig viele Regeln auf ein Objekt in einem einzigen Fileworkflow-Aufruf ausführen.

Regeln

Das System:

arbeitet alle Regeln von oben nach unten ab (rekursiv)
geht im Zweig tiefer, sofern eine Bedingung greift, ansonsten überspringt es den gesamten Zweig
arbeitet alle dahinter liegende Aktionen nacheinander ab, sofern mehrere Bedingungen greifen

Hinweis: Durch die rekursive Ausführung der Regeln ist deren Reihenfolge wichtig.

Der fileworkflow läuft immer in einer kompletten Transaktion ab. Erstellen Sie etwa eine Ablageregel, die Ordnerstrukturen erstellt, und möchten Sie im Anschluss durch den fileworkflow Metadaten per JavaScript auf die neuen Ordner setzen, schlägt das Setzen der Metadaten fehl. Das System erstellt die Ordnerstrukturen erst, wenn der komplette fileworkflow durchgelaufen ist.

Um die Metadaten setzen zu können, verwenden Sie nach Erstellung der Ordnerstrukturen durch den fileworkflow etwa:

einen Workflow
einen Worker

agorum core fileworkflow aufrufen

Sie rufen den agorum core fileworkflow unterschiedlich auf:

automatisch durch agorum core docform
per Aktiven Ordner
als Aktion / per JavaScript im agorum core explorer
per JavaScript-API
per REST-API

Als Aktion / per JavaScript im agorum core smart assistant konfigurator

/* global sessionController, sessionControllerAdmin, folder, objects, data */

let workflows = require('common/workflows');
//                              Workflow, das übergebene Objekt, Name des Workflows der in der Liste angezeigt wird, Übergabeparameter an den Workflow als Object
//                              Beispiel für Parameter {para1: 'Text', para2: true, para3: 22.12}
let instance = workflows.start('FileWorkflow2', objects, 'FileWorkflow2 - Fileworkflow2JS',{});

let activities = instance.getRightwardRelationObjects('WORKFLOWRELATION');

activities && activities[0];

Eine Dokumentenregel öffnen

Öffnen Sie links in der Seitenleiste Weitere Apps und dann FileWorkflow Dokumentenregeln.

Ergebnis: Die Dokumentenregeln öffnen sich.

Oberfläche der Fileworkflow Dokumentenregeln

Übersicht des Regelbaums
Bedingungen einer Regel
Konkrete Regel

Eine Regel mit Bedingung anlegen

Klicken Sie rechts unter Regeln auf Neu und dann auf Neue Bedingung.

Eine Regel anlegen
Wählen Sie im Feld Attribut ein Attribut / Metadatum.

Attribut/ Metadatum für Bedingung
wählen

• Das System fasst mehrere Bedingungen mit UND zusammen.
• Das System prüft mehrere Zeilen mit Metadaten mit ODER.

Tipp: Klicken Sie in die nächste Zeile, um ein weiteres Metadatum hinzuzufügen.
Klicken Sie in die Zeile neben dem Metadatum für die Eingabe eines Wertes.

Der Wert kann ein freier Text oder eine RegExp sein.

Beispiel
Das System soll prüfen:

• ob das Metadatum DocFormType den Wert MusterfirmaEingangsRechnung ODER MusterfirmaEingangsRechnungABC hat. Trifft einer der beiden Werte zu, ist die Bedingung wahr (siehe Abbildung Wert zum Attribut hinzufügen)
• ob der Name des übergebenen Objektes mit RE beginnen (siehe Abbildung Weitere Bedingung als RegExp).

Wert zum Attribut hinzufügen

Weitere Bedingung als RegExp

Ergebnis: Zwei Bedingungen existieren, die das System mit UND verknüpft.

Beispiele für RegExp in Bedingungen

RegExp	Beschreibung
.+	Besitzt einen Wert und ist vorhanden. Es kann auch ein leerer String vorhanden sein.
^RE.*	Beginnt mit RE, beliebige Zeichen können folgen.
audit\|document	Fragt zwei Werte mit ODER ab (anstatt eine neue Zeile zu schreiben).
.*\.pdf	Muss mit .pdf enden (hier alles kleingeschrieben).
12345	Muss den festen Wert 12345 haben.
-	Leer oder nicht vorhanden.
^[7][0-9]{4,4}$	Muss mit 7 beginnen, dann folgen 4 Zahlen.
!^[7][0-9]{4,4}$	Dreht die Regel dank führendem ! um, bringt wahr zurück, wenn der Wert nicht der Regel entspricht.

Sonderzeichen

Haben Sie etwa Ihren Dokumententypen mit Sonderzeichen erstellt, etwa Rechnung (ohne Positionen), müssen Sie diese im fileworkflow abfangen, da ansonsten der fileworkflow nicht greift und Ihre Dokumente nicht verschiebt:

Rechnung \(ohne Positionen\)

Pfade

Geben Sie mehrere Pfade an, wertet das System diese mit ODER.

Klicken Sie in der Bedingung im Abschnitt Pfad in die Zeile.
Klicken Sie rechts auf .

Ergebnis: Der Explorer öffnet sich.

Pfad wählen
Navigieren Sie zu dem gewünschten Pfad und klicken Sie auf Öffnen.

Ergebnis: Das System schreibt den Pfad automatisch in das Feld.

Aktivieren Sie rechts die Einstellung rekursiv, gilt die Bedingung für alle Pfade, die sich unterhalb des gewählten Pfads befinden.

Eine Gruppe anlegen

In einer Gruppe können Sie Regeln zusammenfassen und einen Benutzer angeben, mit dem das System alle Regeln unterhalb der Gruppe ausführt.

Die neue Gruppe erscheint im Baum unter der aktuellen Position. Sie können sie im Baum per Drag-and-drop an die gewünschte Position verschieben.

Kicken Sie links im blauen Balken auf Neue Gruppe, um den Namen der Gruppe zu ändern:

Name der Gruppe ändern

Wählen Sie im Feld Benutzer einen Benutzer, mit dem das System alle Regeln unterhalb dieser Gruppe ausführt.
Das System führt den fileworkflow mit dem Benutzer aus, mit dem er gestartet wurde (Standardverhalten), wenn Sie das Feld leer lassen (Standard).

Eine Gruppe bearbeiten

Klicken Sie mit der rechten Maustaste auf eine Gruppe.
Wählen Sie im Kontextmenü eine Aktion.

Eine Gruppe bearbeiten

Die gewählte Aktion wirkt sich auf alle darunterliegenden Gruppen und Regeln aus.

Eine Regel aufstellen

siehe Ablaufregeln des agorum core fileworkflows

Wenn Sie Probleme mit dem fileworkflow haben

fileworkflow funktioniert nicht

Funktioniert einer Ihrer fileworkflows nicht und verarbeitet ein ausgewähltes Dokument nicht wie gewünscht, kann dies verschiedene Ursachen haben:

Eine Bedingung trifft nicht auf das Dokument zu.
Eine Namensumbenennung ist falsch aufgebaut.
Das JavaScript innerhalb eines fileworkflows funktioniert nicht.
Gewünschte/ benötigte Metadaten sitzen nicht auf dem Dokument. Der fileworkflow kann das Dokument nicht bearbeiten.

Verwenden Sie die Ansicht des Ablageworkflows unter der Objektinformation Ihres Dokuments, um den Fehler ausfindig zu machen:

Suchen Sie das Dokument.
Öffnen Sie die Objekt-Info des Dokuments.
Scrollen Sie zum Abschnitt Vernüpft mit.

Die Protokolle zu den fileworkflows heißen:
```
<Dateiname bei fileworkflowstart> (Ablageworkflow 2)
```
Öffnen Sie diese über das Kontextmenü und die Aktion Details anzeigen.
Öffnen Sie die Ansicht.

Ergebnis: Diverse Informationen zum fileworkflow-Start erscheinen:

• Startzeit des fileworkflows
• Angehängtes Objekt
• Active rules log
• Endzeit des fileworkflows

Der Bereich Active rules log zeigt an, welche Bedingungen / Regeln zum Dokument gepasst (MATCH) oder nicht gepasst (MISS KEY) haben.

Active rules log

Finden Sie in dieser Ansicht keine Lösung, liegt das Problem in der Regel an Ihrem Skript. Verwenden Sie einen Testlauf Ihres Skripts, um Ihr Dokument direkt zu korrigieren.

Sie können auch im agorum core support tool prüfen, welches Problem genau vorliegt:

Fehlersuche im Support Tool

Selbst wenn kein roter Fehler in der Baumstruktur erscheint, kann ein Fehler unter den Logs vorhanden sein.

Active Folders
Die Sub Statistics stellen aufgesplittete Logs von Aktiven Ordner-Gruppierungen dar. Etwa landen in der Action: Scriptfolder Logs von Aktiven Ordnern, die ein JavaScript ausführen.

Einzelne Aktive Ordner-Konfigurationen erscheinen hier nicht.

DocForm
docform liest Metadaten aus einem PDF aus. Ein typisches Beispiel sind Rechnungen, deren Positionswerte, Rechnungsnummer oder Gesamtbetrag das System ausliest.

Das agorum core support tool überwacht die Engine, den Process und den Split-Prozess.

Workflow
Auch in den Workflow-Logs können je nach Ihrer Konfiguration und Nutzung des neuen Workflows Informationen vorhanden sein.