› Modules and plugins › Extraction module › OmniPage Extraction plugin › Form Data Extraction using OmniPage

Form Data Extraction using OmniPage

This topic describes how to install, activate, and configure Fixed Form Extraction using OmniPage. To integrate with OmniPage, you need to use the OmniPage Extraction plugin. These instructions are intended for Transact administrators.

OMNIPAGE_EXTRACTION_PLUGIN is a part of the Extraction module. You can use OMNIPAGE_EXTRACTION_PLUGIN to extract:

  • Text data

  • Check box data

  • OCR form data

  • Hand-written data

  • Barcode data

Also, use OMNIPAGE_EXTRACTION_PLUGIN to extract data in multiple languages. Data extraction through OmniPage happens with the help of template files (TLZ). These template files are created using the OmniPage Form Template Editor application installed on Windows systems.

Only non-cursive handwritten extraction is supported.

Install OmniPage Form Template Editor

Download the OmniPage Form Template Editor installer for Windows from the download portal. When installed on a Windows system, OmniPage Form Template Editor can be used to create templates for the OMNIPAGE_EXTRACTION_PLUGIN plugin on both Windows and Linux environments.

First, install OmniPage Form Template Editor on a Windows system. Later, you will add the template created through this editor to OMNIPAGE_EXTRACTION_PLUGIN in a Linux environment.

Activate OmniPage Form Template Editor

After you install OmniPage Form Template Editor, activate the license.

You can activate OmniPage Form Template Editor using OmniPage Licensing Tool both online and offline.

If you receive the error "The server couldn't activate license", see OmniPage Form Template Editor License Activation Error 48 for troubleshooting.

Online activation

Perform the following steps to activate OmniPage Form Template Editor.

  1. From the Start menu, launch OmniPage Licensing Tool.

    If OmniPage Licensing Tool is able to successfully communicate with OmniPage Licensing Server, the licenses found in the license store display. It also displays the Hardware Fingerprint (HWFP) of your development system.

  2. Click File > Download to select and download the license file.

    If you have already downloaded the license file to this system through OmniPage Licensing Tool, select the downloaded license file.

  3. Click Functions > Activate.

    Upon successful activation, the relevant Activation Date displays. Expiration Date is displayed only if you have a temporary license.

Offline activation

If your system does not have the Internet access, you can download and activate the license manually. To do this, use a separate system with the Internet access and proceed as follows:

  1. Open a web browser and go to the OmniPage Capture SDK license download page.
  2. Enter the serial numbers in the area provided and click Download licenses.
  3. Using a portable media, transfer the downloaded license files to the target developer system where the OmniPage Capture Software Development Kit (CSDK) is installed.
  4. From the Start menu, launch OmniPage Licensing Tool.
  5. Click File > Load and load each license file separately.
  6. Click File > Prepare Licenses for Manual Activation to zip and save your license files.
  7. Click Functions > Remove to remove each loaded license separately.
  8. Using a portable media, transfer your zipped license files back to the other computer with the Internet access.
  9. Open a web browser and go to the OmniPage Capture SDK license activation page.

    Follow the instructions on that page.

  10. Download and save the received zipped license files to a portable media, and transfer them to the target system.
  11. Launch OmniPage Licensing Tool on the target system again.
  12. Click File > Import to import the zipped license files.
Your licenses display in the Licenses area of OmniPage Licensing Tool with the relevant activation dates.

Configure Fixed Form Extraction using OmniPage template file

This section describes how to add OmniPage template files to Transact.

  1. Create a template file (TLZ) using the OmniPage Form Template Editor.
  2. Copy the new template file to the following folder:

    [Ephesoft Transact_Directory]\SharedFolders\<BC ID>\fixed-form-extraction\<your document type>

  3. From the Batch Class Management screen, select and open your batch class.
  4. Go to Document Types > <your document type> > Fixed Form Extraction.
  5. Map the template file with the relevant pages and click Apply.
OMNIPAGE_EXTRACTION_PLUGIN is now configured to use the mapped template file to extract data. You can verify the extraction on the Validation screen.