Running

Use Boxes Editor for testing and basic one-off running of recognition. Choose one of available OCR engines to run recognition.

Example of run parameters screen in Boxes Editor.

For continues processing use Reco utility to run recognition in automated or semi-automated mode. When executed with "--help" parameter it does no processing but prints all available parameters and they default values instead.

Example of parameters accepted by Reco utility.

Reco Utility

Parameters listed in the order of importance.

"-i=" parameter is for providing input image file name or multiple input file pattern.
For example: -i=input/*.tif will read all TIFF files inside input/ directory relative to where reco utility is.

"-o=" parameter is for output file name(s). You can also use macro inserts in output file name.
For example: "-o=output{date}_{time}_{count}.xml" will produce output file in a form of "output_2016-10-31_050504_1.xml".

All available macro inserts:

Macro inserts are case-sensitive.

"-type" is output type. Available values are: csv, xml, json. Only one value allowed per execution.
For example: "-type=xml"

"-project" parameter is path to project file created using Boxes Editor.
For example: "-project=C:\box\files\invoices.box"

"-engine=" defaults to "ink". It is default OCR engine. Other option is "tesseract".
For example: "-engine=tesseract"

"-lang=" defaults to "English". Spanish, German, French, Italian, Portuguese are also supported.

"-license=" is license key. Could be temporary trial key or purchased subscription license key.
If license parameter is not supplied on Windows then license from GUI will be used.
For example: "-license=VGVtcG9yYXJ5fDIwMTYxMTIzfDF8UkVDT3wzOTAzMzU2Mj"

"-debug" and "-debugdir" are related. If "-debug" is passed then "-debugdir" has to be passed as well.
For example: "-debug=true -debugdir=C:\temp"

Full example of reco utility command line use:
reco -i=*.tif -project=margate.box -type=xml -o="{input}_{count}.xml" -license=VtcG9yYXJ5fDIwMTYxMTIzfDF8UkVD

RecoWUI Utility

Basic recognition utility with graphical user interface. You can test single file or run multiple files using drag and drop. Accuracy column shows combined average accuracy for all the fields in the image.

recowui

Example of RecoWUI utility in action.

Single Utility

If you receive small document images that only contain single block of text and numbers there is no need to create project with just single bounding box encompassing the small image. We provide extra utility called "single" for running single box recognition on images containing single field of data.

If you want to find parameters accepted by single utility simply run it with "--help" parameter. One of the parameters is called "-boxtype". It is required.
"-boxtype" matches box type you see in Boxes Editor. That is "alpha", "upper", "text", "number", etc. It helps narrow down matching to more specific range of symbols.

Exit Codes

All command line utilities produce exit code. Zero is no-error exit code. Non-zero indicates error.

When creating batch or bash files for our command line utilities check exit codes. Non-zero exit codes are always critical. We call them "fatal errors" because they stop processing and in most cases no other output files get produced until problem is fixed.

One of the typical fatal errors is expired license. Processing will print expiration error and will not continue.

Multiple Reco Instances

You can run multiple instances of Reco utility. If you have dedicated server for the processing it is best to run no more instances than there are CPU units on the machine. When running multiple instances make sure parameters use different input and output paths to avoid possible file processing collisions.

Next