JavaScript-Bibliothek agorum.docform/js/docform

Die Bibliothek docform.js bietet Funktionen zur Verarbeitung, Erkennung und Extraktion von Daten aus Dokumenten. Durch verschiedene Betriebsmodi kann gezielt entschieden werden, ob eine schnelle, blockierende oder asynchrone Verarbeitungsweise angewandt wird.

Funktionen

match()

Die Funktion match dient zur Extraktion von Metadaten aus einem Dokument. Durch den Einsatz von Filtern und verschiedenen Betriebsmodi kann die Funktion sowohl synchron als auch asynchron arbeiten, um die gewünschte Datenverarbeitung zu ermöglichen.

 

Syntax

match(object, parameters)

 

Parameter

Parameter	Beschreibung	Pflicht	Standard
object (agorum.Object)	Das Objekt, aus dem die Daten extrahiert werden sollen.	ja	-
parameters (Object)	Ein Objekt zur Konfiguration der Datenextraktion mit folgenden Angaben: mode (string): Der Verarbeitungsmodus: 'wait': Blockierende Verarbeitung mit optionalem OCR. 'fast': Schnelle Verarbeitung ohne OCR, nur eingebetteter Text. 'async': Nicht blockierende, asynchrone Verarbeitung. filter (string): Der Name eines Filters zur gezielten Datenextraktion.	nein	Der Standardmodus ist 'wait'.

 

Beispiel 

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

let docform = require('/agorum/roi/customers/agorum.docform/js/docform');

let object = objects.find(module.id).firstParent.getItem('Willkommen.pdf');

let match = docform.match(object, { mode: 'async' });

 

Rückgabewerte

Die Funktion gibt ein Objekt mit Schlüssel-Wert-Paaren der extrahierten Metadaten zurück. Wenn im asynchronen Modus das Dokument, aus dem die Metadaten extrahiert werden sollen, noch nicht bereit ist, gibt die Funktion ein leeres Objekt oder undefined zurück.

 

Exceptions

Es kann ein Fehler auftreten, wenn das angegebene Dokument nicht existiert.