OmniPage Extraction plugin

The OmniPage extraction plugin is part of the extraction module. This plugin extracts the data for the document level fields (DLF) for the particular document classified by the document assembler plugin. This plugin uses a .tlz file to extract data for the specific document level field. You need to create the .tlz file using the OmniPage Form Template Editor.

Configuration

See the following table for configurable properties available for the OmniPage Extraction plugin.

Configurable property Type of value Value options Description

OmniPage 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 is set to OFF.

OmniPage Extraction Switch

List of values

  • ON
  • OFF

This switch is used to turn this plugin ON/OFF. By default, this property is set to ON.

Dependency on SharedFolders

For each batch class, a folder fixed-form-extraction is created in the batch class folder inside SharedFolders. This folder contains the following files:

  • SETTING.STS: Setting file for OmniPage Extraction plugin.
  • .tlz files: User-defined files that are mapped to a document type and are used for extraction.

Steps of execution

This plugin works in the extraction processing phase after classification.

This plugin uses the .tlz files located in [Ephesoft Transact_Directory]\SharedFolders\[your batch class]\fixed-form-extraction*.tlz for extraction.

The Processing Project File drop-down lists located on the Document Types page for a batch class, contain the list of .tlz files for that batch class. The selected .tlz file is used for extraction.

An XML file is created with respect to each page inside the batch instance folder located in the [Ephesoft Transact_Directory]\SharedFolders\ephesoft-system-folder\BI*. This XML file is used for extraction.

Extraction for text images and form images are supported.

After editing and saving the .tlz file, you must copy the file to the fixed-form-extraction folder, located in SharedFolders > [your batch class].

Troubleshooting

Error message Possible root cause

Values do not get extracted for the document level fields.

  • Check whether the .tlz file is present in the fixed-form-extraction folder or not.
  • Check whether the .tlz file is mapped with the concerned document type or not.
  • Check whether the .tlz file contains the entry for the particular document level field or not.

Problem while extracting form data.

Check if the .tlz file being used is specific to the form type data or not.