Typ 3: PowerShell während der Verarbeitung

Ab Edition Enterprise

Komplexe Ordnerstrukturen decken die Vorlagen für Unterordner unter Umständen nicht ab. Für diese Fälle ruft BarcodeOCR während der Verarbeitung, aber vor dem Speichern, ein PowerShell-Skript auf. Das Skript erhält alle Informationen zum Verarbeitungsvorgang, wertet sie ohne Einschränkungen aus und gibt Unterordnerpfad und Dateinamen an BarcodeOCR zurück. BarcodeOCR verwendet diese Werte anschließend beim Speichern der Datei.

Sie richten die Schnittstelle im Schritt Benennen & Sortieren der Arbeitsanweisung ein, mit der Option Verwende ein externes Skript zur Bestimmung der Unterordner.

PowerShell vorbereiten

PowerShell-Skripte müssen vor dem Gebrauch signiert sein, oder Sie passen zunächst die Ausführungsrichtlinie (ExecutionPolicy) an. Ist die Ausführung nicht erlaubt, erscheint ein Eintrag im Fehlerprotokoll, und BarcodeOCR speichert die Ausgabedateien nicht in dem von Ihnen festgelegten Pfad. Siehe PowerShell vorbereiten.

Einsatzbeispiele, etwa das Einsortieren nach erkanntem Text oder nach einem bestimmten Text im Barcode, finden Sie unter Verwende ein externes Skript zur Bestimmung der Unterordner.

Allgemeines

• BarcodeOCR führt die Schnittstelle aus, während es die Speicherung einer Ausgabedatei vorbereitet.
• Die Parameter werden als Datenobjekt übergeben.
• BarcodeOCR wartet, bis das Skript beendet ist, und wertet die zurückgegebenen Werte aus. Sind die Werte nicht leer, verwendet BarcodeOCR sie für die weitere Speicherung.
• Umbenennungen und die Behandlung von Duplikaten, die Sie in der Benutzeroberfläche festgelegt haben, wendet BarcodeOCR trotzdem an.
• Beim Warten auf das Skript gibt es kein Zeitlimit (Timeout).

Parameter

Die Schnittstelle übergibt ein Datenobjekt. Es kann auch Arrays und umfangreiche Texte enthalten.

Allgemeine Parameter

Parameter	Bedeutung	Beispielwerte
ConfigurationName	Name der Arbeitsanweisung	"Test"
ConfigurationGuid	Eindeutige ID (Unique Identifier) der Arbeitsanweisung	cbfc4771-7f73-481e-b1ca-e4b95eb3d605
ConfigurationFilePath	Dateipfad zur Konfigurationsdatei	"C:\ProgramData\Keil IT\BarcodeOCR\AnalyserConfig.xml"
UsedBarcode	Erkannter Barcode, der für die Trennung und Umbenennung verwendet wird	Inhalt des Barcodes, bei Fehlerdateien leer
Result	Wurde die Datei im Ausgabeordner abgelegt?	True = Datei im Ausgabeordner gespeichert, False = Datei im Fehlerordner gespeichert
ErrorReason	Grund, warum das Dokument in den Fehlerordner gelegt wurde	NoBarcode, CorruptedFile, Unknown, Duplicate, NameError
FileProcessStartTime	Zeitpunkt, zu dem die Verarbeitung der Datei gestartet wurde	–
SourceFilePath	Vollständiger Pfad zur Eingangsdatei	C:\Config\dec24748\Tour\Sample.pdf
BackupFilePath	Vollständiger Pfad zur Datei im Sicherungsordner (sofern aktiv)	C:\Config\dec24748\Tour\Backup\Sample_eb3d605.pdf
DestinationFilePath	Vollständiger Pfad zur Ausgabedatei	C:\Config\dec24748\Tour\Error\No_Barcode_1.pdf
Subfolder	Unterordnerstruktur, sofern vorher festgelegt	Subfolder\Sub-Subfolder
NumberOfPages	Anzahl der Seiten des Dokuments	4
NumberOfRemovedPages	Anzahl der Seiten, die die Leerseitenerkennung entfernt hat	0
StartPage	Seitenzahl der ersten Seite im ursprünglichen Stapel	1
EndPage	Seitenzahl der letzten Seite im ursprünglichen Stapel	4

Parameter pro Seite

Die folgenden Informationen werden als Array übergeben, mit einem Eintrag pro Seite des Ausgabedokuments.

Parameter	Bedeutung	Beispielwerte
Number	Seitenzahl	4
RecognizedText	Erkannter Text auf dieser Seite (Modul Texterkennung)	"Lorem ipsum ...."
Barcodes	Liste der erkannten Barcodes auf dieser Seite	Pro Barcode: Typ, Text und X/Y-Koordinaten

Rückgabewerte

• Die Schnittstelle kann zwei Werte an BarcodeOCR zurückgeben, die BarcodeOCR bei der weiteren Verarbeitung berücksichtigt.
• Das Beispielskript vereinfacht diesen Schritt. Es bietet zwei passende Variablen an, die Sie nur noch setzen müssen.
• Gibt das Skript leere Variablen zurück, werden die Werte nicht überschrieben.
• BarcodeOCR protokolliert die zurückgegebenen Werte des Skripts im Ablaufprotokoll.
• Wirft das Skript einen Fehler, ignoriert BarcodeOCR die Ausgabe des Skripts und verarbeitet die Datei nach den Einstellungen der Arbeitsanweisung.

Rückgabewert	Bedeutung	Beispielwerte
SUBFOLDER_NAME	Pfad der Unterordnerstruktur, die verwendet werden soll. Fehlende Ordner legt BarcodeOCR an.	Invoices, Invoices/CustomerName/BranchB
FILE_NAME	Dateiname, der für die Ausgabedatei verwendet werden soll. Das Skript kann ihn überschreiben.	Invoice_VariableFromSQL_Test.pdf