› Modules and plugins › Extraction module › RecoStar Extraction plugin

RecoStar Extraction plugin

The RECOSTAR_EXTRACTION plugin is a part of the Extraction module, by default. This plugin extracts data from the fields that are contained in a document. The RECOSTAR_EXTRACTION plugin extracts data values from document-level fields in the Extraction module. This plugin is typically used for extracting data from fixed forms.

The RecoStar extraction plugin supports extraction on Windows installations of Transact. The RecoStar extraction plugin is available on Linux as a beta feature.

For Linux installations, fixed-form extraction is performed by the OmniPage extraction plugin and is still recommended.

For additional information about creating the RSP file, see Create fixed-form projects with RecoStar Design Studio.

Configure the RECOSTAR_EXTRACTION plugin

The Administrator user account is required for this procedure.

  1. Launch the Transact application and go to Administrator > Batch Class Management.
  2. When prompted to log in, provide your credentials.

    The Batch Class Management screen appears, displaying all the batch classes currently contained in Transact.

  3. Open the batch class to be configured, select the batch and click Open.
  4. In the navigation pane on the left side, expand the Modules section, and click Extraction to display the plugins currently configured for the Extraction module.
  5. Click (highlight) the RECOSTAR_EXTRACTION plugin.

    The Plugin Configuration screen appears on the right.

    Define the following settings for the RECOSTAR_EXTRACTION plugin.

    Configurable property Options Description

    RecoStar Extraction color switch (for Windows only)

    • ON
    • OFF

    • 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

    • ON
    • OFF

    Use this property to apply auto-rotation of the input images during OCR, based on the orientation provided by the RecoStar OCR engine.

    RecoStar Extraction switch

    • ON
    • OFF

    Use this switch to enable or disable this plugin.

    Retain Intermediate File

    • ON
    • OFF

    If enabled (ON), this setting deletes the XML file once batch execution and extraction are complete. If disabled (OFF), Transact retains this intermediate XML file even after batch processing is complete.

  6. (For Windows) In the Plugin Configuration window, set the following options.

    • Recostar Extraction color switch: OFF

    • Recostar Auto Rotate switch: OFF

    • Recostar Extraction Switch: OFF

    • Retain Intermediate File: OFF

  7. (For Linux) In the Plugin Configuration window, set the following options.

    • Recostar Auto Rotate switch: ON

    • Recostar Extraction Switch: ON

    • Retain Intermediate File: OFF

  8. Click Apply to save the changes.
  9. Click Deploy to activate the changes, making them immediately applicable to batch class processing.
  10. Click Close to exit the Plugin Configuration screen.

Additional settings

Evaluate certain additional settings in regard to this plugin. Make additional changes in the batch class, if required.

This plugin only requires an image as an input, which is a PNG file if the color switch is ON, or a TIFF file if the color switch is OFF.

The RECOSTAR_EXTRACTION plugin for Linux does not support PNG files.

Therefore, the administrator requires one of the following additional plugins. Either the CREATE_OCR_INPUT plugin or the CREATE_DISPLAY_IMAGE plugin is required. One of these plugins must execute before this RecoStar Extraction plugin. These plugins are typically located in the Page Process module, which comes before the Extraction module.

Ideally, one should place the RecoStar Extraction plugin after the page process and document classification plugins, and that the RecoStar Extraction plugin not execute until after the Review stage has been completed.

The RecoStar Extraction plugin requires a valid document type to be classified for the batch.

RecoStar Extraction dependency on the RECOSTAR_HOCR Plugin (Windows Only)

If you are using the RECOSTAR_HOCR plugin in your batch class, which is typically in the Page Process module, in combination with the RecoStar Extraction plugin, which is typically in the Extraction module, the configuration in the UI for these two plugins must match with regard 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. This dependency is not needed for the Linux version.

Troubleshooting RecoStar Extraction

Error message Possible root cause

Invalid License. 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.

Problem in verifying License

Unable to connect with Ephesoft license server or some error occurred at Ephesoft license server side.

Unable to load Fpr.rsp file

The RSP file used for processing is invalid.

Exception while reading from XML

Unable to process the batch.xml file or the batch.xml file is invalid.

Image processing or XML updating failed

Unable to update the batch.xml fiule.

File has invalid extension

File processed by the RecoStar OCR engine has an invalid extension.

Document type could not be found for page

Invalid document is being used for processing.

Unable to parse the orientation tag in RecoStar xml file.

The RecoStar xml file has an invalid value for the orientation tag.

Unable to rotate the file: according to the values specified in its xml

The RecoStar xml file has an invalid value for rotation