Durchsuchbare Dokumentation aufrufen

Zurück zur Dokumentationsübersicht

Aktiven Ordner einrichten

Ein agorum core active folder ist ein Ordner, der von einem Prozess überwacht wird (Aktiver Ordner). Dieser Prozess startet automatisch jede Minute und überprüft, ob ein neues Dokument in diesem Ordner abgelegt wurde und reicht dieses an agorum core docform, an ein JavaScript oder an einen FileWorkflow weiter. Zudem werden Aktive Ordner zusätzlich ausgelöst, wenn in dem Ordner auf oberster Ebene ein neues Objekt gelegt wird. Aktive Ordner finden Verwendung bei Scan-Eingängen, Mailarchiven oder anderweitigen Ordnern.

Sie können etwa definieren, ob das System Dokumente aus einem Ordner:

Zudem können Sie definieren, ob das System diese importierten Dokumente an ein JavaScript übergibt und Sie etwa Notizen verschicken, Systemflags darauf setzen, Berechnungen anstellen, einen Workflow starten und vieles mehr.

Diese unterschiedlichen Anwendungsfälle basieren auf unterschiedlichen Konfigurationen. Diese Dokumentation beschreibt, wie Sie einen Aktiven Ordner erstellen, der

Der letzte Fall unterscheidet zwischen dem Prozess DocForm - Trennen (um ein einzelnes PDF aufzusplitten) und dem normalen Prozess DocForm (um Metadaten aus PDFs auszulesen).

Allgemeine Hinweise:

  • Setzen Sie stets nur eine einzige Aktiver Ordner-Konfiguration auf einen Ordner.

  • Wenn Sie zwei Aktive Ordner-Konfigurationen auf ein und denselben Ordner setzen, wird die erste Konfiguration automatisch überschrieben.

  • Die hier beschriebenen Konfigurationsmöglichkeiten Ablageassistant und Workflow starten stellen veraltete Konfigurationen dar.

Hinweise zu docform:

  • Aktivieren Sie die dazugehörigen docform-Module, wenn Sie einen docform-Prozess erstellen möchten.

  • Scannen Sie Dokumente ein, die aus mehr als 30 Seiten bestehen, lassen Sie diese zuerst in einen DocForm Trennen-Ordner laufen.

  • Dokumente, die direkt in einen DocForm Verarbeiten-Ordner gelangen, versucht die OCR am Stück zu verarbeiten. Besteht Ihr Dokument hierbei aus mehr als 30 Seiten, kann die OCR in einen Time-out laufen. Stellen Sie in einem solchen Fall vorab einen DocForm Trennen-Ordner ein. Hierbei splittet das System von vornherein jedes Dokument in seine Einzelseiten und schickt jede davon getrennt an die OCR. Dadurch umgehen Sie den Time-out.

Einen Aktiven Ordner erstellen


Im ersten Schritt benötigen Sie einen Ordner, dem Sie einen Automatismus auferlegen.
  1. Öffnen Sie links in der Seitenleiste Explorer.
  2. Öffnen Sie Ihr Konfigurationsprojekt:
    Eigene Dateien‎/Administration‎/customers‎/<Ihr Konfigurationsprojekt>
  3. Legen Sie über die Datei structure-basis.yml einen neuen Ordner an.

    Die Namensgebung erfolgt nach Ihrem Konfigurationsziel.
  4. Öffnen Sie links in der Seitenleiste Weitere Apps und dann Aktive Ordner.

    Ergebnis: Die Übersicht der Aktiven Ordner öffnet sich.
  5. Klicken Sie rechts im Bereich Konfigurationen auf Neue Konfiguration und wählen Sie eine Konfiguration.

     
    Neue Konfiguration für Aktiven Ordner erstellen


    Ablageassistent
    Nicht mehr verwenden, da veraltet.

    DocForm - Verarbeiten
    Liest Metadaten aus PDFs aus.

    DocForm - Trennen
    Splittet ein PDF (Stapelscan) in mehrere PDFs.

    FileWorkflow
    Verschiebt anhand einer vorgegebenen Oberfläche Dokumente, benennt sie um und erstellt CSV-Dateien.

    Workflow starten
    Nicht mehr verwenden, da veraltet.

    Skript ausführen
    Startet ein JavaScript, dem Sie die neu abgelegten Dokumente überreichen.

    Ergebnis: Die neue Konfiguration erscheint in der Liste und öffnet sich links.

     
    Beispiel anhand der Konfiguration DocForm - Verarbeiten

    Tipp: Ändern Sie zuerst den Titel. Markieren Sie hierzu die Titelbezeichnung in der blauen Leiste.

    Hinweis: Eventuell liegen im System bereits bestehende Konfigurationen von Aktiven Ordnern vor. Diese können von einer individuellen Konfiguration oder von installierten Plugin stammen und erscheinen hier in einer Liste.

Ablageassistent


Hinweis: Dieser Prozess ist veraltet. Verwenden Sie die Konfiguration FileWorkflow oder Skript ausführen.

DocForm - Verarbeiten


Der undefined>agorum core docform-Prozess erkennt Dokumententypen und liest die dafür definierten Metadaten automatisiert aus diesen Dokumententypen aus.

In dem folgenden Beispiel wurde der Titel bereits angepasst (Musterfirma GmbH - Rechnungseingang) und einige Felder wurden ausgefüllt (Details zu den Einstellungen siehe Workflow starten).

Einstellung DocForm - Verarbeiten

DocForm - Trennen


Diese Einstellung bezieht sich auf das Modul agorum core docform split und dient dazu, eingescannte Stapelscans in deren Einzeldokumente aufzutrennen. Anschließend verschiebt das System die neuen PDF-Dokumente in einen weiteren Ordner. Dies kann etwa ein anschließender DocForm-Verarbeiten-Prozess sein, der auf dem Dokument wichtig stehende Informationen ausliest und als Metadaten abspeichert.

Anhand der möglichen Einstellungen können Sie die Trennung von Dokumenten oder das Zusammen von Dokumentenseiten einem Benutzer überlassen. Alternativ setzen Sie einen automatischen Prozess (siehe Feste Seitenzahl (optional) und Mindestalter (s) (optional)).

In dem folgenden Beispiel wurde der Titel bereits angepasst (DocFormLite - Trennung automatisch) und einige Felder wurden ausgefüllt.

Einstellung DocForm - Trennen

Basisordner (Pflichtfeld)

Wandelt den hier angegebenen Ordner in einen Aktiven Ordner. Sobald Sie die restlichen Pflichtfelder ausgefüllt haben, speichern Sie Ihre Einstellungen.

Das System erstellt bei einem solchen docform-Ordner automatisch zwei Unterordner.

Unterordner Beschreibung
queue
  • In diesem Unterordner legt das System automatisch docform-Dokumente ab, die es aufgrund der angegebenen Kapazität nicht sofort ausliest und in docform anzeigt.
  • Das System baut die Queue automatisch ab.
work
  • In diesem Unterordner legt docform die zu trennenden Dokumente automatisch ab.
  • Ein Benutzer oder das System trennt diese anschließend.

Hinweise:

  • Entfernen oder verschieben Sie keine Dokumente in die Unterordner, da es sonst zu Fehlern in der Konfiguration des Aktiven Ordners kommen kann. Schützen Sie diese Ordner etwa durch Leserechte.

  • Sollte die Konfiguration in einen Fehler laufen, löschen Sie die Konfiguration im Modul Aktive Ordner und anschließend die Unterordner samt darin liegenden Dokumenten und erstellen die Konfiguration anschließend neu.

Um Dokumente in docform abzulegen, verschieben Sie die von docform ausgelesenen Dokumente in den von Ihnen gewählten Basisordner:

<Basisordner für docform> //In diesem Ordner, also auf Ebene von den drei Unterordnern, fügen Sie Dokumente ein!
- work
- queue

Zielordner (Pflichtfeld)

Definiert einen Ablageordner (Zielordner).

Kapazität (Pflichtfeld)

Definiert die maximal mögliche Anzahl darstellbarer Seiten im agorum core docform trennen-Fenster.

Maximal mögliche Anzahl darstellbarer Seiten im agorum core docform trennen-Fenster

Feste Seitenzahl (optional)

Aktiviert einen automatisch ausgeführten Split-/Merge-Automatismus.

Sortierung (optional)

Definiert, ob das System im Split-Ordner abgelegte Dokumente nach Dateiname (Name), Erstelldatum oder Änderungsdatum des Inhalts sortiert.

Der Benutzer muss nach Import der gewünschten Dokumente auf die Schaltfläche Aktualisieren klicken, damit diese Einstellung aktiv wird.

ACL (Pflichtfeld)

Definiert, welche Benutzer den Split-Prozess dieses Aktiven Ordners ausführen können.

Die gewählte ACL muss nicht mit der ACL des Split-Ordners übereinstimmen.

Mindestalter (s) (optional)

Führt einen automatischen Trenn-Prozess durch.


Beispiel eines Anwendungsfalls
Mehrere Dokumente einer Maschine sollen zusammengefügt werden. Erstellt diese in bestimmten Zeiteinheiten verschiedene Dateien, können Sie diese mit dieser Einstellung zu einer verbinden.

Hinweise:

  • Nehmen Sie diese Einstellung nur dann vor, wenn Sie manuell alle Möglichkeiten trainiert und alle Trainings abgeschlossen haben.

  • Vergessen Sie Trainings, legt das System aufgrund der gesetzten Zeiteinheit nicht zusammengehörige Dokumente als eines ab.

  • Die Angabe eines Mindestalters unter einer Minute ist nicht zielführend, da der Aktive Ordner einmal pro Minute prüft, ob Dokumente zum Verarbeiten vorliegen.

Filter (optional)

Spezifiziert den Ordner auf bestimmte Trennseiten-Trainings hin. Diese Spezifizierung setzen Sie mit einem Regulären Ausdruck (Regular Expressions) um, der auf ein oder mehrere Trennseiten-Trainings passt.

Beispiel:
M01.*
Es werden nur Definitionen beginnend mit M01 berücksichtigt.
M01_Trennseite würde angenommen werden, M02_Trennseite nicht.

Eingabedaten (optional)

siehe DocForm - Verarbeiten

Zusätzliche Parameter (optionale Angabe)

Falls Sie den agorum core ocr tuner verwenden.

FileWorkflow


Überwacht den hier eingetragenen Ordner und schickt jedes dort ankommende Dokument an einen agorum core fileworkflow.

Einstellung FileWorkflow

Workflow starten


Hinweise

  • Dieser Prozess ist veraltet. Verwenden Sie die Einstellung Skript ausführen, um einen eigenen Workflow zu starten.

  • Die nachfolgende Beschreibung ist nur für Kunden gedacht, die bereits bestehende Konfigurationen verwenden.

Startet veraltete Standardworkflows für neu in dem Ordner abgelegte Dokumente.

Einstellung Workflow starten

 

Feld Beschreibung
Basisordner Definiert den Ordner, der als agorum core active folder dient.
Workflow Definiert den Workflow, den das System pro Dokument ausführt.
Bezeichnung Definiert den Namen des Workflows.

Der Workflow erhält den Namen des Dokuments, für den er gestartet wird.

Standard
${name}
Parameter hinzufügen Fügt zusätzliche Parameter hinzu.

Geben Sie Parameter als String an.
Parameter entfernen Entfernt Parameter.

Basisordner (Pflichtfeld)

Wandelt den hier angegebenen Ordner zu einem Aktiven Ordner um. Sobald Sie die restlichen Pflichtfelder ausgefüllt haben, speichern Sie Ihre Einstellungen.

Das System erstellt bei einem solchen docform-Ordner automatisch drei Unterordner.

Unterordner Beschreibung
audit In diesem Unterordner legt docform automatisch Dokumente ab, deren:
  • Metadaten erfolgreich ausgelesen, aber vom System nicht in andere Ordner abgelegt werden können (durch einen FileWorkflow getriggert)
  • Metadaten unvollständig ausgelesen wurden, etwa, weil docform Pflichtfelder nicht auslesen konnte oder die Qualität der ausgelesenen Metadaten schlechter als gewünscht ist (Dokument verbleibt dann im Audit, damit Benutzer die Metadatenwerte korrigieren können)
  • Verifizierung negativ ausgefallen ist

Details zum Audit siehe Korrekturen im Audit vornehmen.
queue In diesem Unterordner legt docform automatisch Dokumente ab, die es aufgrund der angegebenen Kapazität nicht sofort auslesen und in docform anzeigen konnte.

Das System arbeitet diese Queue automatisch ab.
train In diesem Unterordner legt docform automatisch Dokumente ab, die nicht bekannt sind.

Hinweise:

  • Entfernen oder verschieben Sie keine Dokumente in die Unterordner, da es sonst zu Fehlern in der Konfiguration des Aktiven Ordners kommen kann. Schützen Sie diese Ordner etwa durch Leserechte.

  • Sollte die Konfiguration in einen Fehler laufen, löschen Sie die Konfiguration im Modul Aktive Ordner und anschließend die Unterordner samt darin liegenden Dokumenten und erstellen die Konfiguration anschließend neu.

Um Dokumente in docform abzulegen, verschieben Sie die von docform ausgelesenen Dokumente in den von Ihnen gewählten Basisordner:

<Basisordner für docform> //In diesem Ordner, also auf Ebene von den drei Unterordnern, fügen Sie Dokumente ein!
- work
- queue
- train

Kapazität (Pflichtfeld)

Definiert die Anzahl an dargestellten, zu bearbeitenden Dokumenten in docform.

Einstellung Kapazität

ACL Audit (Pflichtfeld)

Definiert, welche Benutzer Dokumente im Audit bearbeiten können.

Die gewählte ACL muss nicht mit der ACL des Eingangsordners übereinstimmen.

ACL Training (Pflichtfeld)

Definiert, welche Benutzer Dokumente im Trainingsschritt bearbeiten können.

Die gewählte ACL muss nicht mit der ACL des Eingangsordners übereinstimmen.

Filter (optionale Angabe)

Definiert, welche Trainings für diesen Ordner das System überprüft.

Tragen Sie eine Regular Expression (RegExp) ein, etwa:

M01.*
// Es werden nur Definitionen beginnend mit M01 berücksichtigt. M01_Trennseite würde angenommen werden, M02_Trennseite nicht. 

Öffnen Sie ein im Training stehendes Dokument, sehen Sie in dem blau markierten Abschnitt alle im System vorhandenen docform-Trainings. Durch den gesetzten Filter greift docform zur Identifizierung der Dokumente nur auf die Trainings zurück, die auf den eingetragenen RegExp-Ausdruck passen.

Einstellung Filter

Eingabedaten (optionale Angabe)

Einstellung Beschreibung
Automatisch (PDF, dann OCR) Reicht ein Dokument mit Textinformationen an docform.
Nur OCR Sendet jedes Dokument dieses Aktiven Ordners an die OCR, um einen neuen Text auszulesen.
  • Textinformationen müssen nicht vorhanden sein.
  • Bei digital erstellten Dokumenten ist dieser Schritt nicht notwendig.
  • Verwenden Sie diese Einstellung, wenn die OCR-Qualität Ihres Scanners unzureichend ist (das System liest Metadaten dann nur schlecht aus) oder Sie verschiedene Scanner mit unterschiedlichen OCR-Implementierungen verwenden.
  • Diese Einstellung kann den docform-Prozess verlangsamen.
Nur PDF-Text Überprüft Dokumente nicht auf Textinformationen.
Nur Barcodes Liest Dokumente nur anhand eines Strichcodes aus und sortiert diese.
PDF-Text und Barcodes Kombiniert die Einstellungen Nur PDF-Text und Nur Barcodes.

Typ (optionale Angabe)

Der docform-Prozess gleicht wie üblich vorhandene Trainings mit dem neuen Dokument ab, wenn Sie hier einen vorhandenen Dokumententypen wählen.

Herkunft (optionale Angabe)

Definiert die Herkunft für verschiedene docform-Ordner, die gezielt nach Lieferant aufgebaut sind.

Die Herkunft gilt für jedes in diesem Ordner abgelegten Dokuments.

Zusätzliche Parameter (optionale Angabe)

Falls Sie den agorum core ocr tuner verwenden.

Skript ausführen


Startet ein JavaScript, das pro Minute den Inhalt des Aktiven Ordners durchgeht und die darin enthaltenen Objekte verarbeitet. Sie müssen hierzu im JavaScript definieren, wie das System die Dokumente bearbeitet:

Hinweis: Bei der Verarbeitung der Aktiven Ordner in Verbindung mit einem Skript läuft im Hintergrund minütlich ein CronJob und arbeitet alle Aufgaben jedes Aktiven Ordners ab, d. h. es existiert nur ein CronJob für alle Aktiven Ordner. Sollte ein CronJob für einen Aktiven Ordner länger benötigen, weil das System etwa zu viele Daten importiert, dann arbeitet der CronJob alle anderen Aufgaben erst ab, wenn das System den Import durchgeführt hat. Der CronJob startet währenddessen nicht erneut.

Einstellung Skript ausführen

Ordner

Definiert einen Ordner, den das System überwacht und pro Minute dort abgelegte Objekte an ein JavaScript leitet (vorausgesetzt, das JavaScript ist nicht mehr aktiv).

Skript

Definiert das aufzurufende Skript.

/* global folder, parameters */
// folder verweist auf den von Ihnen gesetzten Aktive Ordner - siehe Ordner-Einstellung
// parameters enthält alle von Ihnen manuell definierten Parameter

let objects = require('common/objects');
let mailAutoMover = require('./MailAutoMover');

folder.items().forEach(function(item) {
  if (!item.getRFC822Header) {
..
..

Definieren Sie per JavaScript eine maximale Bearbeitungszahl, sofern das System in den gewählten Aktiven Ordner minütlich Tausende an Dokumenten hinterlegt. Dadurch bleibt Ihr Skript beherrschbar und Sie laufen in keinen Out-of-Memory-Fehler:

/* global Packages, sc, folder, parameters */

/**
let objects = require('common/objects');

let folder = objects.find('/agorum/roi/Files/XMLSAMPLE/Eingang');

// Hole pro Durchlauf max. 1000 UUIDs
// So können letztlich beliebig viele Objekte im Ordner sein
let result = objects.query('inpath:' + folder.ID + ' classname:fileobject NOT nameextension:xml').limit(1000).search('uuid');

result.rows.map(function(row) {
...
}

Verwenden Sie NICHT die Funktion items, da Sie hier keine Einschränkung vornehmen können:

folder.items().forEach(function(item) {
  if (new Date().getTime() - item.lastModifyDate.getTime() < 15000) {
    // skip files, when not older than 15 seconds
    return;
  }

Skript in Transaktion ausführen

Sie können ein JavaScript auf zwei Arten in einer Transaktion ausführen:


Selbstständig in einem JavaScript
Sie können die Transaktion selbstständig in einem JavaScript unter Verwendung der JavaScript-Bibliothek common-transaction ausführen.


Einstellung aktivieren
Aktivieren Sie diese Option, damit sich Ihr Skript automatisch in einer Transaktion mit allen zu bearbeitenden Objekten ausführt.

Parameter-Eingabe

Sie können ein JavaScript mehrmals in agorum core verwenden, indem Sie etwa pro Aktivem Ordner, der das JavaScript verwendet, verschiedene Parameter übergeben, die das System diesem Skript weiterreicht.

Im Falle eines Aktiven Ordners sieht die Einstellung etwa wie folgt aus:

Eingegebene Parameter

Auf diese Parameter greifen Sie im JavaScript durch die Verwendung von parameters.<Parametername> zu:

/* global folder, parameters */

let objects = require('common/objects');

let target = objects.find(parameters.zielordner);
let targetProtokol = objects.tryFind(parameters.zielordnerProtokoll)

Hinweis: Das JavaScript stoppt die aktuelle Bearbeitung der Objekte, wenn Sie den agorum core-Server herunterfahren. Ist agorum core wieder einsatzfähig, aktiviert sich im Hintergrund erneut der JavaScript-Prozess und bearbeitet die ausstehenden Dateien.

Filter in der Suche verwenden


In der Suche können Sie den Filter Aktive Ordner verwenden, um gezielt nach Informationen zu den Aktiven Ordnern zu suchen. Sie können etwa nach dem aktiven Ordnertyp oder generell nach aktiven Ordnern suchen.

Filter im in der Suche verwenden

Einen Aktiven Ordner löschen


Sollten Sie Ihre Konfiguration neu aufsetzen und einen Aktiven Ordner neu anlegen wollen, gehen Sie nach dieser Reihenfolge vor:

  1. Löschen Sie Ihre Konfiguration für den Aktiven Ordner.
  2. Löschen Sie den Ordner im Explorer.
  3. Legen Sie einen neuen Ordner an oder starten Sie die Datei structure-basis.yml Ihres Konfigurationsprojektes.
  4. Legen Sie eine neue Konfiguration für einen Aktiven Ordner an.

Einen Scan verzögert zu agorum core docform leiten


Manche Scanner scannen noch, während die Datei bereits für agorum core docform sichtbar ist. Das führt dazu, dass eine Verarbeitung aufgrund der unvollständigen Datei nicht möglich ist.

Um dies zu beheben, erstellen Sie ein Zwischenverzeichnis, das bei einem neu importierten Objekt ein JavaScript aufruft. Dieses verschiebt das gescannte Dokument erst nach einem gewissen Alter in den eigentlichen agorum core docform-Ordner.

  1. Erstellen Sie ein JavaScript und legen Sie es etwa in dieser Ordnerstruktur ab:
    Eigene Dateien/roi/Administration/customers/<Konfigurationsprojekt>/js/aktiver Ordner/scan-eingang.js
  2. Fügen Sie folgenden Code in das eben erstelle JavaScript. Die fett markierten Zeiten können Sie anpassen:
    /* global folder, parameters */
    let objects = require('common/objects');
    let transaction = require('common/transaction');
    
    let target = objects.find(parameters.target);
    let curTime = new Date().getTime();
    
    folder.items().forEach(item => {
      // move files to target, when they are older than 120 seconds
      if (curTime - item.lastModifyDate.getTime() > 120 * 1000) {
        transaction(()  => {
          objects.remove(item);
          objects.add(item, [ target ]);
        });
      }
    });
  3. Erstellen Sie neues Zwischenverzeichnis. Hierzu legen Sie etwa unter Dateien einen neuen Ordner namens Scaneingang an.
  4. Öffnen Sie links in der Seitenleiste Weitere Apps und dann Aktive Ordner.

    Ergebnis: Die Übersicht der Aktiven Ordner öffnet sich.
  5. Erstellen Sie eine neue Konfiguration für Skript ausführen.
  6. Füllen Sie die Einstellungen dieser Konfiguration aus:

    a) Wählen Sie als Ordner den zuvor angelegten Scaneingang.
    b) Wählen Sie als Skript das eben erstellte JavaScript.
    c) Fügen Sie den neuen Parameter target hinzu. Den Wert setzen Sie auf Ihren docform-Pfad, etwa /agorum/roi/Files/<Scaneingang.docform|Ihr docform-Ordner>.
  7. Entfernen Sie den Haken bei der Einstellung Skript in Transaktion durchführen.
  8. Erstellen Sie eine weitere Konfiguration für DocForm - Verarbeiten. Verweisen Sie in dieser auf den Ordner Scaneingang.docform.

    Ergebnis:

    • Das System scannt in den Ordner Scaneingang.
    • Das Skript verschiebt die Dokumente in den Ordner Scaneingang.docform, sobald diese älter als 120 Sekunden sind. Anschließen folgt der normale docform-Prozess.

​​​​