RecoStar HOCR Plugin

Note: For an updated version of this article, with additional information through Ephesoft Transact Release 4.5.0.x, please refer to the following Wiki article instead:


The RecoStar HOCR plugin by default is the part of page processing module of Ephesoft application. This plugin uses RecoStar for generating HOCR files. This plugin reads the image files listed in the batch xml of a batch instance and generates HOCR file for each one of them.

Barcode values can be decoded with this plugin using the barcode enabled project file.

Steps of execution

    • This plug-in works in the page processing phase of the application when all the import processing on the batch has been done.
    • This plugin extracts the contents of the image using RecoStar tool.
    • This plugin uses the RSP file present on the SharedFolder{Batch Class}fixed-form-extraction*.rsp otherwise file present in the bin folder of the {Application}nativeRecostarPluginbin*.rsp file will be used.
    • If barcode swtich is ON, then the RSP file should be barcode enabled.


Configurable Properties

Following are the list of configurable properties for the plugin:

The following table summarizes the settings for plugin configuration.

Configurable property Type of value       Value options                 Description
Recostar Project File Name List of values • Fpr.rsp
• Fpr_Multi
• FPR_Barcode.rsp
This option is used to specify the project file name used to perform OCR.
Recostar color switch List of values • ON
• Set the color switch to ON to use a PNG input file for OCR (optical character recognition).
• Set the color switch to OFF to use a TIFF input file for OCR.
Recostar Auto Rotate switch List of values • ON
This property is used to auto rotation of the input images on the basis of orientation provided by the RecoStar OCR engine.
Recostar Switch List of values • ON
This switch is used to enable or disable this plugin.
Barcode Switch List of values • ON
This property is used to read the barcode from the input images using the barcode-enabled RecoStar project file —  example: FPR_Barcode.rsp
Recostar Valid Extensions List of values • tiff
• gif
• png
RecoStar can support these three formats when performing OCR. The user can configure the allowable image format for performing OCR in that plugin.
Recostar Deskew Switch List of values • ON
This property is used to adjust tilted images as straight.


This plugin only requires an image as an input (which is a PNG if color switch is ON and a TIFF if color switch is OFF). Hence, the user would require one of the plugins from: ‘Create OCR Input Plugin’/ ‘Create Display Image Plugin’ to run before it in this module.

Dependency on shared folders

The batch class folder inside the main shared folder contains a folder by the name: recostar-extraction. This file contains the “Recostar Project file” as specified by the first property. If the file selected does not exist, the default file by the selected name present inside RecoStar will be used for Recostar OCRing.


Following are few common error messages received due to malfunctioning of the OCR process:

S no. Error Message Possible Root Cause
1. Invalid License. So could not be verified. Network connection failure.
Recostar command is not valid.
License is either not installed or invalid.
The Tomcat server is not started.
2. Problem in verifying License Unable to connect with Ephesoft license server or some error occurred at the Ephesoft license server side.
3. Unable to load Fpr.rsp file RSP file being used for processing is invalid.
4. Exception while reading from XML Unable to process the batch.xml file or the batch.xml file is invalid.
5. No valid extensions are specified in resources  No valid extension is selected.
6. Image Processing or XML updation failed Unable to update the batch.xml file.
7. File has invalid extension File processed by the Recostar OCR engine has an invalid extension.
8. Unable to parse Orientation tag in Recostar xml file. The Recostar xml file has invalid value for the orientation tag.
9. Unable to rotate the file:according to the values specified in its xml  The Recostar xml file has an invalid value for rotation.