Nuance Extraction plugin


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

This plugin uses a “Zone file” to extract data for the specific document level field. This zone file must be created by the user using Nuance OmniPage Ultimate application.


Configurable Properties

Following are the configurable properties available for the Nuance Extraction plugin:

Configurable property Type of value Value options Description
Nuance Auto Rotate/Deskew Switch List of values
  • ON
  • OFF
This property is used to auto rotate and deskew the input images. By default, this property will be set as OFF.
Nuance Extraction Switch List of values
  • ON
  • OFF
This switch is used to turn this plugin ON/OFF. By default, this property will be set as ON.

Dependency on Shared Folders

For each batch class, a folder named fixed-form-extraction” will be created in the batch class’s folder present inside SharedFolders. This folder will contain the following:

  • Settings.STS file – Setting file for Nuance Extraction Plugin.
  • Zone files – User defined Zone files that will be mapped to document type and will be used while extraction.

Steps of Execution

1. This plug-in works in the extraction processing phase of the application after all the document classification on the batch has been done properly.

2. This plugin uses the Zone files present in the Ephesoft_Installation_DirectorySharedFolders{Batch Class}fixed-form-extraction*.zon for extraction.

3. The Processing Project File drop-downs present in the BatchClassList>>BatchClass>>DocumentTypes on the Batch Class Management screen will contain the list of zone files present in the concerned Batch Class. Extraction will be done using the selected zone file.

4. The document type will contain index fields for which the extraction will be performed by Nuance Extraction Plugin whose entry will be present in the zone file.

5. An XML file will be created with respect to each page inside the batch instance folder present in the Ephesoft_Installation_DirectorySharedFoldersephesoft-system-folderBI*. This XML file will be used for extraction.

6. Currently, extraction for text images and form images are supported.

Steps to create Zone File

  1. Open the Nuance Omnipage Ultimate application. Click on File menu and create a new Omnipage document.


2. Click on Load Image option and choose the image file on which zones are to be drawn.


3. Select the zone type. Zones are like overlays. They define the area from which the data will be extracted. Currently, Ephesoft support Text Zones and Form Zones.


4. Draw zones on the image.


5. Click on Tools menu and select the zone template to save the zone file.


6. A pop-up will appear to save the zones drawn on the image. Select “zones on page” and save the zone file. The zone file will have .zon extension.


7. A zone file with the specified name will get created. This zone file will contain information regarding the zones that were drawn by the user.

cid:image030.jpg@01CF9D58.740D11108. User has to manually edit this zone file and add “name” attribute within each “Props” tag of all the zones. The value of the “name” tag will be same as index field names (DLF name) that are present in the Document type.

For example: In the above zone file, if we edit and add the “name” attribute in the “Props” tag, then the zone file will look as follows:


This specifies that the value of an index field (DLF) will be extracted from that zone in which the name of the index field has been given. Thus, there is no sequential extraction in Nuance. Instead the user is free to choose the zone from which the value of DLF will be extracted.

9. After editing and saving the zone file, copy the zone file inside the ”fixed-form-extraction” folder in the Batch Class’s folder present inside SharedFolders.


S no. Error message Possible root cause
1. Values do not get extracted for the document level fields.
  • Check whether zone file is present inside the fixed-form-extraction folder or not.
  • Check whether zone file is mapped with the concerned document type or not.
  • Check whether zone file contains the entry for the particular document level field or not.
2. Problem while extracting form data. Check if the zone file being used is specific to the form type data or not.



<Back| Release Documentation