Durchsuchbare Dokumentation aufrufen

Zurück zur Dokumentationsübersicht

Dokumententypen definieren

Nachdem Sie Ihre Metadaten im System angelegt haben, ordnen Sie diese sogenannten Dokumententypen zu, da die von Ihnen angelegten Metadaten derzeit noch keinen Bezug zu einer Konfiguration im System haben. Indem Sie die Metadaten den Dokumententypen zuordnen, teilen Sie dem System mit, wann welche Metadaten interessant sind.

Einen Dokumententypen anlegen


Einen Dokumententypen können Sie auf zwei Arten anlegen:

Einen Dokumententypen über die Datei „metadata-collection.yml“ anlegen

Dieser Weg ist technisch anspruchsvoller, da Sie die Dokumententypen direkt in einer Datei anlegen.

  1. Öffnen Sie links in der Seitenleiste Explorer.
  2. Öffnen Sie die Datei metadata-collectiom.yml in Ihrem Konfigurationsprojekt:

    Eigene Dateien‎/Administration‎/customers‎/<Ihr Konfigurationsprojekt>/yml/metadata-collection.yml
  3. Erweitern Sie diese Datei anhand der Dokumentation metadata-collection.yml definieren.

Einen Dokumententypen über die Bedienoberfläche anlegen


Dieser Weg ist technisch weniger anspruchsvoll, da Sie die Dokumententypen rein über die Bedienoberfläche in agorum core anlegen.

  1. Öffnen Sie links in der Seitenleiste Weitere Apps und dann docform Dokumententypen.
  2. Klicken Sie rechts im Abschnitt Dokumententypen auf Neuer Typ.

    Ergebnis: Ein leerer Dokumententyp mit der Bezeichnung Neuer Typ erscheint.
  3. Ändern Sie den Namen des Dokumententypen (siehe Abbildung Namen des Dokumententypen ändern).

     
    Namen des Dokumententypen ändern
  4. Nehmen Sie weitere Einstellungen für den Dokumententypen vor und fügen Sie Metadaten hinzu.

    Tipp: Sie können mit Sonderzeichen arbeiten. Verwenden Sie zusätzlich einen fileworkflow, müssen Sie diesen dort mit einem Schrägstrich kennzeichnen.

    Beispiel
    Sie erstellen einen Dokumententypen namens Rechnung (ohne Positionen). Kennzeichnen Sie den fileworkflow in diesem Fall mit Rechnung \(ohne Positionen\).

Weitere Einstellungen für den Dokumententypen

Einstellung/Schaltfläche Beschreibung
Neues Feld

Definiert Metadaten zum Dokumententypen (siehe Ein Metadatum hinzufügen).

Neue Verifizierung

Aktiviert Verifizierungen (siehe Eine Verifizierung aktivieren).

Das Modul docform verify muss aktiviert sein.

Neue Position Liest Positions- oder Tabellenwerte aus einem Dokument (siehe Eine Position definieren).

Das Modul docform positions muss aktiviert sein.
Verarbeitung Standard
Das System zieht die Daten aus dem Text des Dokuments.

ZUGFeRD
Das System zieht die Daten aus dem Dokumententyp ZUGFeRD.

Das Modul ZUGFeRD muss aktiviert sein.

Ein Metadatum hinzufügen


Das System unterscheidet zwischen normalen Metadaten und variablen Metadaten. Variable Metadaten kommen in Positionen / Tabellen vor (siehe Eine Position definieren).

So fügen Sie ein normales Metadatum hinzu:

  1. Klicken Sie im Dokumententypen auf Neues Feld.

    Ergebnis: Der Dialog erweitert sich um Felder.
  2. Ändern Sie den Namen des neuen Feldes im Kopfabschnitt Neues Feld.
  3. Befüllen Sie die Felder.
Ein Metadatum hinzufügen

 

Feld/Einstellung Beschreibung Beispiel
interner Name Definiert den internen Namen des Metadatums.

Das Metadatum muss bereits über den Metadatendesigner oder über metadata.yml angelegt sein und mit diesem identisch sein (inklusive Präfix).
acmf_rechnungsNummer
Datentyp Definiert den Datentyp des Metadatums.

Das Metadatum muss bereits über den Metadatendesigner oder über metadata.yml angelegt sein und mit diesem Datentyp identisch sein.
Zeichenkette (alphanumerisch)
Vorbelegung (optional) Definiert eine Vorbelegung.
  • Greift, wenn Sie bei einem Dokument ein bestimmtes Metadatum nicht auslesen, allerdings einen Standardwert gesetzt haben möchten.
  • Liest das System während eines docform-Trainings aus einem Dokument dieses Metadatums aus, priorisiert es immer den ausgelesenen Wert.
Es können Skripte sowie normale Daten hinterlegen.

Skript
Setzt das aktuelle Tagesdatum:
js: new Date();

Hinweis: Zum Umgehen von Zeitzonenthemen addiert docform 11 Stunden auf den angegebenen Zeitpunkt und verwendet das entstehende Datum als Basis.

Beispiel
Wenn Sie ein Dokument vormittags auslesen, etwa um 9:11 Uhr, und die Vorbelegung greift, setzt docform das aktuelle Datum. Wenn Sie das Dokument jedoch am Nachmittag auslesen, etwa um 15:40 Uhr, setzt docform das Datum des nächsten Tages.

Um dies zu umgehen, verwenden Sie folgenden Code:

js: let d = new Date(); d.setHours(0); d;
Liest aus übergeordneten Metadaten die Daten aus und baut sie zu einem String zusammen:
js: docformdemo_ganzzahl + ' - ' + docformdemo_dezimalzahl;
Dezimalzahl
10.01
Datenquelle (optional) Definiert, woher die anzuzeigenden Daten stammen (siehe Eine Datenquelle verwenden).

Eignet sich besonders für Metadaten, die Sie mit einer CSV-Datei definiert haben.
MAIN_MODULE_MANAGEMENT/customers/docformSchulung/Data/acmf_rechnungsNummer
Extraktion Definiert Extraktoren zum Auslesen der Daten (siehe Eine Extraktion verwenden). Datum frei formatieren (Parameter)
Parameter (je nach Extraktor optional) Definiert Parameter in Bezug auf Extraktoren (siehe Extraktoren und Parameter). yyyy MM dd
de
Optionen Aktiviert
Das Metadatum ist optional.

Definieren Sie ein Metadatum als optional:
  • liest docform das Metadatum aus, unabhängig vom Wert des Metadatums
  • reicht docform die Dokumente an den fileworkflow weiter und legt sie ab, unabhängig davon, ob docform das Metadatum auslesen konnte

Deaktiviert
Das Metadatum ist Pflicht.

Definieren Sie ein Metadatum als Pflicht:
  • liest docform das Metadatum nur aus, wenn ein Wert zum Metadatum existiert
  • verleibt das Dokument im Audit
  • legt das System das Dokument nicht ab

Eine Datenquelle verwenden

Soll die docform-Oberfläche Dokumente manuell auslesen, können Sie die Eingabe von Feldern erleichtern, in dem Metadaten sich auf Datenquellen beziehen. D. h. Ihre Benutzer müssen sich keine Werte für die Felder ausdenken, sollten die Informationen nicht auf dem Dokument zu finden sein, sondern erhalten Vorschläge, was sie in das Feld eintragen oder auswählen können.

Tragen Sie im Feld Datenquelle einen MetaDB-Pfad ein, der auf eine solche Datenquelle verweist, etwa auf eine CSV-Quelle, damit Ihre Benutzer diese Vorschläge erhalten.

Die Datenquelle ist nur interessant, wenn ein Dokument im Audit hängen bleibt, weil das System einen Wert nicht auslesen konnte. Haben Sie eine Datenquelle angegeben, erhält der Benutzer im Audit also Vorschläge zu den Werten innerhalb der Felder. Unter diesen Werten kann er wählen.

Hinweis: Die Datenquelle ist als Eingabehilfe zu verstehen. Es findet kein Abgleich zwischen einem von docform ausgelesenen Wert und der Datenquelle statt. Zudem kann der Benutzer, egal ob die Eingaben eingeschränkt wurden oder nicht, einen beliebigen Wert in das Feld eintragen. Nicht nur der Ausleseprozess von docform, sondern auch das Audit gleichen die Felder nicht ab.

Eine Extraktion verwenden

Damit docform die relevanten Informationen auslesen kann, arbeiten Sie mit Auslesekästchen. Das bedeutet, Sie markieren in einem Training einen bestimmten Papierbereich und teilen dem System mit, dass es diesen Bereich auslesen soll.

Durch die Extraktoren stehen bei diesem Auslesemechanismus weitere Möglichkeiten zur Verfügung (siehe Extraktoren und Parameter).

Eine Position definieren


Hinweis: Sie benötigen das Modul agorum core docform positions und müssen es aktivieren, damit Sie eine Position definieren können.

Positionen sind immer variabel, d. h. Sie können nicht vorhersagen, ob 5 oder 230 Positionen auf einer Rechnung stehen. Diese Variabilität fangen Sie über Positionen ab.

Über die Schaltfläche Neue Position definieren Sie eine Position im Dokument, etwa bei einer Eingangsrechnung ein gekaufter Artikel, der aus einer Artikelnummer, einem Artikelnamen, der Menge, einem Einzelpreis und einem Verkaufspreis besteht.

Feld Beschreibung
interner Name Definiert die Bezeichnung für die Position.
Optionen Aktiviert
Die Position ist optional.

Definieren Sie eine Position als optional:
  • liest docform die Position aus, unabhängig vom Wert der Position
  • reicht docform die Dokumente an den fileworkflow weiter und legt sie ab, unabhängig davon, ob docform die Position auslesen konnte

Deaktiviert
Die Position ist Pflicht.

Definieren Sie eine Position als Pflicht:
  • liest docform die Position nur aus, wenn ein Wert zur Position existiert
  • verleibt das Dokument im Audit
  • legt das System das Dokument nicht ab

Innerhalb einer Position können Sie beliebig viele Felder sowie eine Verifizierung definieren.

Ein Metadatum des Typs „list“ einpflegen


Haben Sie während der Erstellung der Metadaten das Keyword list verwendet, tragen Sie die Metadaten in der metadata.yml nicht anhand des internen Namens ein. Stattdessen lassen Sie das Präfix weg.


Beispiel

//Eintrag in der metadata.yml
_prefix: dem_
...

invoice_items:
 displayName: Rechnungspositionen
 list:
   number:
     displayName: Nummer
     type: long
   description:
     displayName: Bezeichnung
     type: string 

Diese Metadaten pflegen Sie aufgrund des list-Formats wie folgt in den Dokumententypen ein:

Darstellung von Positionsdaten

Eine Verifizierung aktivieren


Hinweis: Sie benötigen das Modul agorum core docform verify und müssen es aktivieren, damit Sie eine Verifizierung aktivieren können.

Die Verifizierung dient zur Überprüfung von Werten oder der Auslesung der Felder. Sie können damit etwa:

Besteht das Dokument die Verifizierung nicht, geht das Dokument in den Audit.

Klicken Sie auf Neue Verifizierung, können Sie verschiedene Felder befüllen:

Feld Beschreibung
interner Name Definiert eine Bezeichnung für die Verifizierung.
Verifizierung Definiert die Verifizierungsmethode.
Parameter Definiert notwendige Parameter.


Beispiel 1: Netto- und Mehrwertsteuerbetrag gleich dem Bruttobetrag

Prüft, ob der Netto- und Mehrwertsteuerbetrag zusammen den Bruttobetrag ergeben. Dadurch verifizieren Sie, dass kein Fehler in der Rechnung vorliegt und die OCR die Zahlen genau erfasst hat.

Netto- und Mehrwertsteuerbetrag gleich dem Bruttobetrag


Beispiel 2: Summe der Positionen gleich dem Gesamt-Nettobetrag

Prüft, ob die Summe der Positionen dem Gesamt-Nettobetrag entspricht.

Summe der Positionen gleich dem Gesamt-Nettobetrag


Beispiel 3: Verifizierung mit Datenquelle

Sie können direkt eine Datenquelle bei der Verifizierung definieren. Über die Verifizierungsart prüft das System, ob die Datenquelle mindestens ein Ergebnis, genau ein Ergebnis oder einen festen Wert zurückliefert.

Feld Wert
Name der Verifizierung Beliebiger Wert.

Das System zeigt diesen Namen beim Fehlschlagen in agorum core docform an, er beschreibt die Art des Fehlers.
interner Name Beliebiger, jedoch eindeutiger Wert.
Verifizierung Etwa Datenquelle (genau ein Ergebnis).
Parameter

Aufbau des Parameters

  1. Pfad zur Datenquelle in der MetaDB (siehe Beispiel Metadatum mit einem JS-Handler).
  2. Beliebige Daten zum Übergeben an das Skript, pro Zeile ein Argument (key:value).

key
Name, wie ihn das Skript verwendet.

value
Interner Name aus dem Dokumententyp

Beispiel

MAIN_MODULE_MANAGEMENT/customers/agorum/Data/verifySupplier 
lieferantNr:ac_supplier
  • ac_supplier_nr ist ein Feld im Dokumententyp. Der in agorum core docform ausgelesene Wert wird dem Verify-Skript übergeben.
  • Sie können im Skript die Parameter über parameters.filter abfragen.

 

Verifizierung mit Datenquelle

Der DataHandler muss eingerichtet werden und auf eine JavaScript-Datei oder andere Datenquelle verweisen.


Beispiel einer dazugehörigen JavaScript-Datei

/* global sc, sca, query, parameters, command */

let items = [
  {
    text: 'Lieferant 4618006174',
    value: '4618006174'
  }
];
let filter = parameters.filter;
if (command === 'read') {
  items = items.filter(item => item.value === filter.lieferantNr);
}
items;

Dieses Beispiel prüft eine statische Lieferantennummer. Wenn diese vorhanden ist, wird items befüllt. items wird nun an agorum core docform verify zurückgegeben mit der Aussage Datenquelle (mindestens ein Ergebnis geprüft). Hier kann beliebiger JavaScript-Code ausgeführt werden.

Einen Dokumententypen löschen


Das Löschen eines Dokumententypen ist abhängig davon, wie Sie den Dokumententypen angelegt haben.


Dokumententyp über die Datei metadata-collection.yml angelegt

  1. Öffnen Sie links in der Seitenleiste Explorer.
  2. Öffnen Sie die Datei metadata-collection.yml in Ihrem Konfigurationsprojekt:

    Eigene Dateien‎/Administration‎/customers‎/<Ihr Konfigurationsprojekt>/yml/metadata-collection.yml
  3. Entfernen Sie die entsprechende metadata collcetion oder den usage docform.
  4. Speichern Sie.
  5. Öffnen Sie links in der Seitenleiste Weitere Apps und dann docform Dokumententypen.
  6. Klicken Sie mit der rechten Maustaste auf den zu löschenden Dokumententypen.
  7. Wählen Sie Entfernen.
  8. Speichern Sie.


Dokumententyp über die Bedienoberfläche angelegt

  1. Öffnen Sie links in der Seitenleiste Weitere Apps und dann docform Dokumententypen.
  2. Klicken Sie mit der rechten Maustaste einen Dokumententypen an.
  3. Wählen Sie Entfernen.