Overview
BarcodeOCR offers several interfaces for your own scripts and programs. Use them to inform or automate downstream processes or to sort your documents individually.
Please note that we cannot support you in developing your own scripts for your individual requirements. If you are interested, we offer fee-based development of scripts or extensions of BarcodeOCR.
The five interfaces
| Type | Interface | Called | Configured in BarcodeOCR | Typical use case |
|---|---|---|---|---|
| Type 1 | .bat script or .exe application | after saving an output file | Advanced step | Further processing per output file |
| Type 2 | .bat script or .exe application | after processing an input file | Advanced step | Further processing of multiple output files after an input file has been processed |
| Type 3 | PowerShell script (subfolder script) | during processing | Naming and sorting step | Specifying a subfolder path or overwriting the file name |
| Type 4 | PowerShell script | after processing | Advanced step | Further processing per output file, with more options and more information |
| Type 5 | PowerShell script | before an input file is processed | Advanced step | Skipping certain files, general preprocessing, assigning the file to a different configuration |
Before you use a PowerShell interface (types 3 to 5), you need to prepare PowerShell.
Sample scripts
During installation, BarcodeOCR places several sample scripts in the "Script Samples" folder in the installation folder. The scripts already prepare the passed parameters and are a good starting point for your own logic.
The sample script External Application - Powershell write all parameters to file.ps1 writes all passed information to a text file. This shows you all available data fields, for example:
- the configuration used (name and unique ID)
- whether the file was processed successfully and, if not, the error reason
- the barcode used
- the processing time
- the location of a backup, if one was created
- the target path and any subfolders created
- the number of pages and the page numbers from the original document
- for each individual page:
- the page number
- the recognized text (if the corresponding option is set)
- the recognized barcodes (text, type and position)
For the exact fields passed, see Type 4.