1. Home
  2. Transact
  3. Features and Functions
  4. Administrator Role and Features
  5. Module/Plugin Configuration
  6. Extraction Module
  7. Nuance Extraction plugin

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. You will need to create the zone file using the Nuance Form Template Editor.


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

Configurable propertyType of valueValue options Description
Nuance Auto Rotate/Deskew SwitchList 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 SwitchList of values
  • ON
  • OFF
This switch is used to turn this plugin ON/OFF. By default, this property will be set as ON.
Figure 1. Nuance Extraction Plugin

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.
Figure 2. SharedFolders

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.

Figure 3. Document Types

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.

7. 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 messagePossible 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.



Was this article helpful to you? Yes No