Last Updated on


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 this plugin document level fields are populated via reading XML file generated by Recostar tool using RSP project file configured for document’s pages.

RSP file has following format:




  1.  User should map the document level fields in the RSP file as shown in oval mark in screen shot.
  2. User can find further details for creating the RSP file for extraction in “Recostar Design Studio and Fixed Form documentation”.

Steps of execution

  1. This plug-in works in the extraction processing phase of the application when all the document classification on the batch has been done properly.
  2. This plugin extracts the document level field’s data from the image using Recostar tool.
  3. This plugin uses the RSP file present in the {SharedFolderPath}\{Batch Class}\recostar-extraction folder. In case if RSP file is not present in the mentioned folder then the RSP file present in {Application}\native\RecostarPlugin\bin folder will be used for extraction.


Configurable Properties

Following are the configurable properties available for the Recostar extraction plugin:


Configurable property Type of value Value options Description
Recostar color switch List of values ON

If color switch is ON then PNG file will be used for OCRing.
Recostar Auto Rotate switch List of values ON

This property is used to auto rotate the input images on the basis of orientation computed by the Recostar.
Recostar Extraction Switch List of values ON

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 important 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 can be specified in BatchClassList>>BatchClass>>DocumentTypes on the Batch Class Management screen. All “.rsp” files present inside the “recostar-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 properties:

  1. ‘Page 1 Processing Project File’
  2. ‘Page 2 Processing Project File’
  3. ‘Page 3 Processing Project File’
  4. ‘Last Page (Page > 3) 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 execute before this plugin. One should ideally place this plugin after page processing and document classification plugins as this plugin requires a valid document type to be classified for the batch.

Dependency on shared folders

The batch class folder present inside the shared folder contains a folder by the name: ‘recostar-extraction’

This folder contains the .rsp project files which a user can use to 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 updating failed Unable to update batch xml.
6. File has invalid extension File being 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.




Was this article helpful to you?