The Recostar extraction plugin by default is a part of the extraction module. This plugin extracts the data for the document level fields for the particular document classified in the document assembler plugin.

Using these plugin document level fields is populating via reading XML file generated by the RSP project file with Recostar tool.

RSP file is having in the following format:

  • User should map the document level fields in the RSP file where the above screen shot having oval mark.
  • User can find further details for creating the RSP file for extraction in “Recostar Design Studio and Fixed Form documentation”.

Steps of execution

    • This plug-in works in the extraction processing phase of the application when all the document classification on the batch has been done properly.
    • This plugin extracts the document level field’s data 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}\native\RecostarPlugin\bin\*.rsp file will be used.


Configurable Properties

Following are the configurable properties available for the Fuzzy Db plugin:

Configurable property Type of value Value options Description
Recostar color switch List of values
  • ON
  • OFF
If color switch is ON then PNG file will be used for OCRing.
Recostar Auto Rotate switch List of values
  • ON
  • OFF
This property is used to auto rotation of the input images on the basis of orientation provided by the recostar.
Recostar Extraction Switch List of values
  • ON
  • OFF
This switch is used to turn this plugin ON/OFF.


Apart from the above mentioned properties, there is a major configuration associated with this plugin. Recostar extracts values depending on the project file being used. Hence the project file is the important file for this plugin.

Since the project file maps document level fields with appropriate values (or patterns or barcodes), for extraction, it is purely document type specific. Hence instead of specifying the project file name at the plugin level, one needs to specify the project file name for each document type.

This mapping of each document type with the project file is provided in the BatchClassList>>BatchClass>>DocumentTypes on the Batch Class Management screen. Any “.rsp” file inside the “fixed-form-extraction” folder inside the batch class folder in shared folders appears in the dropdown and one can select the appropriate project file (.rsp file) in the following property: ‘Form Processing Project File’(See below):

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 one would require one of the plugins from: ‘Create OCR Input Plugin’/ ‘Create Display Image Plugin’ to run before it.

However, it is important that the document tag has been created in the batch.xml and also the document type has been selected appropriately for the batch. Hence, one should ideally place this plugin after page processing and document classification plugins are done with their processing and the manual Review stage has been crossed.

Dependency on shared folders

The batch class folder inside the main shared folder contains a folder by the name: ‘fixed-form-extraction’

This folder contains the project files from which a user can map the document type (for Recostar extraction).


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 not installed or invalid.
  • Tomcat server is not started.
2. Problem in verifying License Unable to connect with Ephesoft license server or some error occurred at Ephesoft license server side.
3. Unable to load Fpr.rsp file RSP file used for processing is invalid.
4. Exception while reading from XML Unable to process batch xml file or batch xml is invalid.
5. Image Processing or XML updation failed Unable to update batch xml.
6. File has invalid extension File processed by recostar has invalid extension.
7. Document Type could not be found for Page Invalid document being used for processing.
8. Unable to parse Orientation tag in Recostar xml file. Recostar xml file has invalid value for Orientation tag.
9. Unable to rotate the file:according to the values specified in its xml Recostar xml file has invalid value for rotation.


It should also be noted that if you are using the Recostar HOCR plugin and the Recostar Extraction plugin in your batch class, the configuration in the UI for these two plugins must match in regards to using color documents. If the color switch is turned on in the Recostar HOCR plugin, the same switch must be turned on in the Recostar Extraction plugin.


<Back| Release Documentation

Was this article helpful to you?