KB Article #: KB0010159

Topic/Category: Mail

Applies to: All versions.

Issue: When installing Ephesoft on multiple servers, mail is sending two batch instances which are duplicating e-mails.

Root Cause: Mail server is run on Ephesoft server.

Solution: To resolve this issue, you will need to disable the mail service on the other Ephesoft server. Allow only one server running the mail service. To do so, please follow the steps below:

1. Locate the filename applicationContext.xml in the folder <Ephesoft install directory>\Ephesoft\Application\. This file is used to run Ephesoft services.

2. You will need to comment-out the Mail Module service, look for this line below.

<!-- Un-comment it to start Mail Module on this machine. -->
<!-- -->
<import resource="classpath:/META-INF/applicationContext-dcma-mail-import.xml" />

3. You will need to move the closing comment to the line below the Mail Module service, see below.

<!-- Un-comment it to start Mail Module on this machine. -->
<!--
<import resource="classpath:/META-INF/applicationContext-dcma-mail-import.xml" />
-->

4. Restart the Ephesoft service.

|  Documentation Main Page  | How To Articles | Downloads and Updates |

KB Articles

KB Article # 10178

Topic/Category: Recostar, tif

Issue: Large Document (PDF, TIF): Not All Recostar BD HOCR Files Created

Analysis:

Solution:

Increase timeout period for Recostar-wait

< Back|KB Main Page | Next KB Article >

The Latest Version of Ephesoft can be Downloaded here

4040_ReleaseNotes

concurrent.scanner.operators in dcma-twain-settings

KB Article #10224

Topic/Category:WebScanner

Applies to: 4031 +

Summary:

|
Documentation Main Page
|
How To Articles
|
Downloads and Updates
|

A Masterclass showing you an overview of the Admin Interface in the 4.0.x versions.

A Masterclass showing you an overview of the Operator Interface in the 4.0.x versions.

KB Article #: KB0010266

Topic/Category: GhostScript

Applies to: All versions.

Issue: During Folder Import process, IMPORT_MULTIPAGE_FILES module error out due to GhostScript directory is missing.

Root Cause: GhostScript directory is blank.

Solution:

Steps to resolve:

1. Stop Ephesoft service.
2. Go to <Ephesoft installed directory>\Dependencies and remove the gs directory.
   For 32-bit server: Rename gs32bit folder to gs folder.
   For 64-bit server: Rename gs64bit folder to gs folder.
3. Start Ephesoft service.

|  Documentation Main Page  | How To Articles | Downloads and Updates |

KB Article #: KB0010268

Applies to: All versions.

Issue: Ephesoft Service will not start.

Root Cause: You must have the JDK application started for Ephesoft to work.

Solution:

Steps to resolve:

1. Stop Ephesoft service.
2. Go to <Ephesoft installed directory>\Dependencies.
   For 32-bit server: Rename jdk1.7.0_71_32bit folder to jdk1.7.0_71 folder.
   For 64-bit server: Rename jdk1.7.0_71_64bit folder to jdk1.7.0_71 folder.
3. Start Ephesoft service.

|  Documentation Main Page  | How To Articles | Downloads and Updates |

KB Articles

KB Article # 10301

Topic/Category: Installation

Ephesoft Version: 3x,4x

Issue: 508 Compliance: Voluntary Product Accessibility Template – VPAT

Solution:
VPAT documents for 3x and 4x are available at the following links.

VPAT 508 form v3 6-26-13

VPAT 508 form v4 03-16-2015

< Back|KB Main Page | Next KB Article >

KB Articles

KB Article # 10274

Topic/Category: Validation

Ephesoft Version: 3x, 4x

Issue: How Do You Make An Index Field Optional During Validation?

Analysis:

Say you want to create a regular expression to validate with specific reges rules AND blank values. How would you do so?

Solution:
Combine your regular expression with the regular expression for blank(empty/null) space.
This REGEX will validate BLANK:

 ^\s*$

Say you want to accept yes, no or empty space as a validation rule. The following would apply:

 yes|no|^\s*$

< Back|KB Main Page | Next KB Article >

Java applet interaction with Ephesoft

KB Article #10249

Topic / Category: Webscanner

Applies to: Ephesoft 4.0+

Details:

The Java applet interfaces with Ephesoft server by sending request to Servlets.

The following communication is done by the applet:

1. Convey different form of Scanning Status.
2. Send client logs to server.
3. Upload scanned Images to server.

Following are servlet configuration define inside the web.xml:-

1. Servlet for handling Status request.

<servlet>

                        <servlet-name>ScannerStatusConveyerServlet</servlet-name>

                        <servlet-class>com.ephesoft.dcma.twain.ScannerStatusConveyerServlet</servlet-class>

                        <load-on-startup>1</load-on-startup>

        </servlet>

2. Servlet for logging client logs in server.

<servlet>

                <servlet-name>loggingServlet</servlet-name>

                <servlet-class>com.ephesoft.dcma.twain.LoggingServlet</servlet-class>

                <load-on-startup>1</load-on-startup>

</servlet>

3. Servlet for uploading images.

<servlet>

                <servlet-name>uploadServlet</servlet-name>

                <servlet-class>com.ephesoft.dcma.twain.UploadServlet</servlet-class>

                <load-on-startup>1</load-on-startup>

</servlet>

|
Documentation Main Page
|
How To Articles
|
Downloads and Updates
|

KB Articles

KB Article # 10063

Topic/Category: Workflow, MSSQL, mysql, mariadb

Ephesoft Version: 4x

Issue: “Variable @black is undefined” displayed in web browser

Analysis:

Manually removing Activiti tables will impact accuracy of reporting data, thus we would not recommend cleaning up Activiti tables manually. However in case of Activiti corruption and getting a system back online this may be the only alternative.

Solution:

Description
A significant amount of data related to workflow get accumulated over a period of time. This piling up of data may hamper the overall application performance in the long run. By manually cleaning up the Activiti related tables this situation can be avoided.
Activiti Table Cleanup for MSSQL
Take the backup of the database before proceeding. Stop Ephesoft server if it is running.
A) Prerequisites: All batches must be in the following states to initiate the clean-up.
1. DELETED
2. ERROR
3. FINISHED

B) Drop the following tables from <ephesoft_DB> by executing the queries in the query editor. While executing the query replace <ephesoft_DB> with the name of the Ephesoft database

MSSQL

drop table <ephesoft_DB>.dbo.ACT_EVT_LOG;
drop table <ephesoft_DB>.dbo.ACT_GE_PROPERTY;
drop table <ephesoft_DB>.dbo.ACT_HI_ACTINST;
drop table <ephesoft_DB>.dbo.ACT_HI_ATTACHMENT;
drop table <ephesoft_DB>.dbo.ACT_HI_COMMENT;
drop table <ephesoft_DB>.dbo.ACT_HI_DETAIL;
drop table <ephesoft_DB>.dbo.ACT_HI_IDENTITYLINK;
drop table <ephesoft_DB>.dbo.ACT_HI_PROCINST;
drop table <ephesoft_DB>.dbo.ACT_HI_TASKINST;
drop table <ephesoft_DB>.dbo.ACT_HI_VARINST;
drop table <ephesoft_DB>.dbo.ACT_ID_INFO;
drop table <ephesoft_DB>.dbo.ACT_ID_MEMBERSHIP;
drop table <ephesoft_DB>.dbo.ACT_ID_USER;
drop table <ephesoft_DB>.dbo.ACT_RE_MODEL;
drop table <ephesoft_DB>.dbo.ACT_RU_EVENT_SUBSCR;
drop table <ephesoft_DB>.dbo.ACT_RU_IDENTITYLINK;
drop table <ephesoft_DB>.dbo.ACT_RU_JOB;
drop table <ephesoft_DB>.dbo.ACT_RU_TASK;
drop table <ephesoft_DB>.dbo.ACT_RU_VARIABLE;
drop table <ephesoft_DB>.dbo.ACT_GE_BYTEARRAY;
drop table <ephesoft_DB>.dbo.ACT_ID_GROUP;
drop table <ephesoft_DB>.dbo.ACT_RE_DEPLOYMENT;
drop table <ephesoft_DB>.dbo.ACT_RU_EXECUTION;
drop table <ephesoft_DB>.dbo.ACT_RE_PROCDEF;

MySQL or MariaDB

drop table <ephesoft_DB>.act_evt_log;
drop table <ephesoft_DB>.act_ge_property;
drop table <ephesoft_DB>.act_hi_actinst;
drop table <ephesoft_DB>.act_hi_attachment;
drop table <ephesoft_DB>.act_hi_comment;
drop table <ephesoft_DB>.act_hi_detail;
drop table <ephesoft_DB>.act_hi_identitylink;
drop table <ephesoft_DB>.act_hi_procinst;
drop table <ephesoft_DB>.act_hi_taskinst;
drop table <ephesoft_DB>.act_hi_varinst;
drop table <ephesoft_DB>.act_id_info;
drop table <ephesoft_DB>.act_id_membership;
drop table <ephesoft_DB>.act_id_user;
drop table <ephesoft_DB>.act_re_model;
drop table <ephesoft_DB>.act_ru_event_subscr;
drop table <ephesoft_DB>.act_ru_identitylink;
drop table <ephesoft_DB>.act_ru_job;
drop table <ephesoft_DB>.act_ru_task;
drop table <ephesoft_DB>.act_ru_variable;
drop table <ephesoft_DB>.act_ge_bytearray;
drop table <ephesoft_DB>.act_id_group;
drop table <ephesoft_DB>.act_re_deployment;
drop table <ephesoft_DB>.act_ru_execution;
drop table <ephesoft_DB>.act_re_procdef;

After the operation ensure that all the activity related tables (ACT_*) are removed from the database.
C) In the <reporting_DB> execute the given query after updating the <reporting_DB> with the database name used in reporting

MSSQL

 update <reporting_DB>.dbo.last_execution set last_execution_at = GETDATE() where job in ('BATCH_INSTANCE_LAST_UPDATE' ,'DASHBOARD' ,'STANDARD', 'ADVANCED');

MySQL or MariaDB

 update <report_DB>.last_execution set last_execution_at = NOW() where job in ('BATCH_INSTANCE_LAST_UPDATE' ,'DASHBOARD' ,'STANDARD', 'ADVANCED');

D) Set workflow.deploy parameter to true in file {Ephesoft Installation Directory}\WEB-INF\classes\META-INF\dcma-workflows\dcma-workflows.properties and restart the server.
E) Restart the Ephesoft server.

NOTE: It is important to note that no batches must be in a state other than DELETED, ERROR or FINISHED. Cleaning up data otherwise may lead to database corruption.
By executing the following procedure previous reporting data will be lost. Ephesoft reporting is directly linked to the Activiti tables and deleting them would impact the reporting data.

< Back|KB Main Page | Next KB Article >

New Feature : Retain sorting information in cookies for Batch Instance Management and Batch List Screen.
New Feature : Validation tab to get opened by default if there are no batches in Review, Review tab to get opened by default if there are no batches in Validation or if there are batches in both Review and Validation.
New Feature : Review Validate tab title should display either Review or Validate.
New Feature : Web Service API to submit a batch instance and get back the Batch Instance Id.
New Feature : Display Page Id’s in the Review, Validation and Web Scanner screen thumbnail view.
New Feature : Collapse the Web Scanner leftmost panel on the basis of configuration in the property file. The panel should be collapsed by default.
New Feature : Files in Shared Folders should not be allowed to be downloaded directly.
New Feature : Turn the Deploy button red in case user is required to deploy the workflow changes.
New Feature : On the Validation Table view, highlight all the extracted columns of a row in case the checkbox is checked.
New Feature : Move the Setting.sts file for Nuance at the Batch Class level.
New Feature : Job to delete the finished and deleted batches from the database if reporting has been executed on them.
New Feature : Webscanner: Add a “forward” and “back page” shortcut to go through the Preview of Scanned Pages.
New Feature : Use Adv. Key Value screen vs. simple kv extraction in KV page Process plugin
New Feature : Incorporate GraphicsMagick with as a separate option (along with imagemagick) for file conversion.
New Feature : Ability to disable KV Extraction Rules.
New Feature : Ability to delete a document or multiple documents in Validation.
New Feature : Sticky field feature at Index Fields level.
New Feature : Ability to create new batch class that should copy BC1 by default.
New Feature : Support variables similar to COPY_BATCH_XML in CMIS export.
New Feature : In case of a server not active for x amount of duration, the entry should be DELETED from the Server_Registry table in database.
New Feature : Given the same aspect ratio of images but different resolutions, the ephesoft system should have built in mathematics to automatically deal with differing resolutions of the same image and be able to successfully handle KV extraction.
New Feature : Batch Instance ID to be passed through on the workflow error email template.
New Feature : Shortcut to close a batch on RV screen and confirm all navigation changes from the batch with the help of confirmation popup.
New Feature : Switch to generate plugin level batch xmls
New Feature : Always on feature for ETL, Logi Info and Batch class management PPM charts
New Feature : Retain filters in batch instance management/batch list/etc
New Feature : Being able Delete New Status batches
New Feature : Internationalization of embedded logiinfo report contents
New Feature : Performance enhancements in ETL
New Feature : Feature to show limited number of alternate values for fields to prevent large size xmls causing slowness on Validation screen
New Feature : Addition of workflow start time in batch instance table
New Feature : “Allow Fuzzy DB and DB Export to configure for Database Schema other than “dbo” for MSSQL.

”
New Feature : No two users with same username should be allowed to login into Web Scanner.
New Feature : As an administrator, I want to view the Ephesoft script logging when executing scripts so that I am aware of the operations taking place while script execution.
Improvement : As an administrator, I do not want to see the F1 key in the Shortcut key column in the Function Key Mapping screen so that F1 does function key does not conflict with the browser shortcuts and cause conflicts.
Improvement : As an administrator/operator, I want to view the column width of the Batch Name column set to optimum number of characters on Batch Instance Management and Batch List screen so that I can view most of the batch names fully without re sizing the column.
Improvement : As an administrator, I want to install Ephesoft without any restriction on the database Password so that there are no conflicts with the external DB server policies.
Improvement : As an administrator, when I install the Ephesoft application, open-office.properties should set the references to localhost instead of the computer name so that the file can be copied over to another server without changes.
Improvement : As an administrator, I should be able to configure the text to be displayed for document in Document type drop down present in the middle panel in Review/Validation screen so that it is consistent in left panel and drop down.
Improvement : Tomcat changes to support more concurrent users in Web Scanner.
Improvement : Change default values of user connectivity props file and add comments for easier AD configuration for new installation.
Improvement : Deadlock issues due to heartbeat configurations in multi server environments.
Improvement : Reporting Schema Enhancements.
Improvement : Bring back MySQL Support in Ephesoft Installer.
Improvement : Ordering of the priority should be kept in the Batch List screen graph.
Improvement : Batch Instance Error cause should get displayed in the BIM bottom panel at all times.
Improvement : Ability to delete *.bd files after use from Learning to save hard drive space.
Improvement : Field value option list enhancement.
Improvement : Code enhancement for faster import of PDFs and their breakup into tiffs.
Improvement : Add Additional Settings column in the Index Field Listing screen.
Improvement : Application will show KV extraction plugin selected by default in Test Extraction UI.
Improvement : Usability enhancement on the button positioning on KV Extraction Screen and all other screens in the application.
Improvement : Feature to display a combo-box listing all the categories used for index fields in the document type.
Improvement : Restrict on UI special characters in DocType Name.
Improvement : Ask user whether to override or make a copy while importing document type/index field with same name.
Improvement : Pagination dropdown on Pagination Bar
Improvement : Fuzzy DB popup on RV screen should not show any extra space in case of lesser number of columns
Improvement : Adding X-offset and Y-offset on KV Extraction Rule defination and KVPP rule defination screen.
Improvement : Feature to eliminate the unused alternatives for computed table combinations
Fix : Blank screen and Document Mode behavior in IE9 browser; “page fit” does not work
Fix : Active Directory configuration in server.xml is lost.
Fix : As an administrator, I should be able to successfully upgrade through installer and preserve the configured port settings and database permissions so that I can have a hassle free upgrade and don’t have to reconfigure the port/database settings.
Fix : With administrative installation, file permissions are not automatically set correctly for active directory so that ephesoft doesn’t start properly.
Fix : Ephesoft should not pick up emails from mail server if the email configuration has been disabled.
Fix : Support for Windows Server 2012 R2.
Fix : Retain the priority of the existing batch class while overriding the batch class.

Documentation | Go To Full Release Notes Page >

Overview & Purpose

E-mail Configuration Screen is responsible for configuring the user mail accounts and E-mail Import plugin is responsible for importing the documents present in a defined form from the user’s mail account. User is allowed to configure any mail account as well as the type of documents which the plug-in will support. This configuration is done per batch class. Multiple email accounts can be setup for each batch class.

Configuration

Mail configuration

Following are the configurable mail account properties:

If any field of Email configuration is not valid the field will be shown in red color.

Configurable Properties file

• <Ephesoft installation directory>\ Application\WEB-INF\classes\META-INF\dcma-mail-import\mail-import. properties:

• <Ephesoft installation directory>\ Application\WEB-INF\classes\META-INF\dcma-mail-import\open-office.properties:

Email Enable

This feature is responsible for enabling/disabling an email for importing the documents present in a defined form from the user’s mail account. A batch class can have multiple user mail accounts and multiple enable/disable user mail accounts.

Test Email

This feature is responsible to verify whether a configured user mail account is valid. User can check the connection for user’s mail account after configuration of mail account.

Characteristics

• The functionality/service allows the user to set up any number of mail accounts for gathering data.
• The user is allowed to configure the account via UI.
• The functionality/service can support multiple document formats.
• The functionality/service makes use of the open-office to convert the received data files into application usable formats.
• The functionality/service is capable of downloading and saving the attachments of a mail.

Steps of execution/working

• When the plug-in properties have been set up properly, Ephesoft moves ahead with mail downloading by accessing the mail account.
• Email import service reads the user’s mail configuration from the database, and tries to access the user’s mail account using the configured settings.
• If the service is able to connect to the user account, it reads all the mails contained in the configured folder.
• After the service has read the mails, it starts processing multiple mails at a time.
• Each read mail goes through a three step procedure of processing, downloading, converting and creating a batch for the mail.
• If any error occurs processing of a mail, the service sends notification mail to mail accounts configured for notification.

Troubleshooting

Following are few common error messages received due to mal-functioning of the plugin:

Email Import with Folder other than Inbox

Earlier in Email Import Configuration folder name was not editable. It was fixed to Inbox folder only. Now, Folder name is editable for IMAP Server but is fixed to Inbox for POP3 Server.

Overview

This functionality aims at providing the application user (mainly review operators) the flexibility of customizing the shortcuts for specific operations on the RV screen. The user can run some code script as per the need which will be fired just by pressing a key.

1. Parameters involved:
   • • 1. Method name: defines the name of the method in the script which should be executed upon usage.
       2. Key: the shortcut key associated with the method.
       3. Description: contains the user’s description for the method.

Below snapshot displays the parameters involved in function key mapping.

1. Steps For adding a function key:
2. Click on Add button.

1. Enter the corresponding values in method name.

1. Click on Apply button.

1. A message will be displayed that “Batch Class updated successfully”.

1. Sample values:

Characteristics

• The functionality allows one to customize the RV screen to use shortcut keys performing user defined functions.
• The user can associate a function key to a particular method specified in the script ‘ScriptFieldValueChange.java‘ present at the location ‘{Ephesoft-Home}\SharedFolders\{Batch class ID}\scripts’
• User can run the script either by clicking the button displayed on UI or the function key button available on the Review Validate UI.
• User can only associate one method to a particular key but same method can be assigned to multiple keys.
• User can choose all the values from F2 to F11 except F5. Support for F1 and F5 has not been provided so that they do not conflict with the browser shortcuts.
• The functionality allows user to add description of the script associated to a key.
• Function keys are document type specific and will only be displayed on RV screen if selected document type has function keys defined for a batch class.

Working

• • • When a batch reached Review/Validation stage, user can either press the function key to run a particular method or can press the function key button displayed in the 2^nd panel.

• • • A dialog box saying ‘Executing function keyscript’ will appear. By the time it goes off, user’s script has been executed.

Overview

GraphicsMagick has been added as an option for image conversion process in the following Batch Class plugins along with ImageMagick:

• Import multipage file plugin
• Create Display Image plugin
• Create Thumbnails plugin
• Create OCR Input plugin
• Create MultiPage Files plugin

Batch Class Plugin Changes

• Import multipage file plugin

Following new properties has been added:

• Create Display Image plugin, Create Thumbnails plugin & Create OCR Input plugin

A property named “image_conversion_using_graphicsMagick” has been added in “imagemagick.properties” file located in Ephesoft_Installation_Directory\Application\WEB-INF\classes\META-INF\dcma-imagemagick folder governing whether GraphicsMagick will be used as Image conversion process or not. The property can take value either ‘ON’ or ‘OFF’.

By default, the value of property will be set as “ON” stating that GraphicsMagick will be used as image conversion process. In case the value is set as “OFF”, ImageMagick will be used as image conversion process.

• Create MultiPage Files plugin

In the “Create MultiPage Files plugin”, GraphicsMagick has been added as an option in the “Multipage File Export Process” dropdown.

Performance

Below are the comparative performance numbers obtained while running batches using ImageMagick & using GraphicMagick:

Refer http://www.graphicsmagick.org/ for more details.

Supported Parameters

Following parameters are supported by GraphicMagick:

Refer http://www.graphicsmagick.org/GraphicsMagick.html for see the list of supported parameters

Overview

Import Multipage Files plugin is required when running a batch on multipage images. This plugin will break the multipage pdf’s and tiffs into multiple single page tiffs. Multipage pdf’s will be converted to single page tiffs using Ghostscript/Recostar whereas multipage tiffs will be converted to page single page tiffs using ImageMagick/GraphicMagick .

Configuration

UI Configuration

IMPORT_MULTIPAGE_FILES properties can be edited at following admin UI:

Property File Configuration

Property File location: <Ephesoft-Installation-Path>\ Application\WEB-INF\classes\META-INF\dcma-import-folder\dcma-import-folder.properties\*

Optimization parameters and results

“-sDEVICE” parameter

• -sDEVICE=tiff12nc
  • Produces 12-bit RGB output
•  -sDEVICE=tiff24nc
  • Produces 24-bit RGB output
•  -sDEVICE=tiff48nc
  • Produces 48-bit RGB output
•  -sDEVICE=tiff32nc
  • Produces 32-bit CMYK output
• -sDEVICE=tiff64nc
  • Produces 64-bit CMYK output
• -sDEVICE=tiffscaled24 -sCompression=lzw
  • Produces a 24 bit RGB image and allows the use of a special compression tag along with it which allows us to compress the size of the image.
• -sDEVICE=tifflzw
  • Produces black-and-white output and can be combined with various compression options.
• Following are the results of images produced by splitting a PDF with the given specifications under different GhostScript parameters:

Results

• PDF Size: 514Kb
• Number of pages in PDF: 26

Note: PDF contained mixture of colored and B/W images

Troubleshooting

Following are few common error messages received due to mal-functioning of the plugin:

Overview

Given the same aspect ratio of images but different resolutions, the Ephesoft system have built in mathematics to automatically deal with differing resolutions of the same image and be able to successfully handle KV extraction.

Usability

This feature takes in account the case when a KV extraction rule is configured for a sample of specific resolution, whereas the batch execution input image is of different resolution other than the configured one. Application will internally adjust overlays for the image of Batch Execution by normalizing them.

Instead of storing key-Value coordinates as distance from origin of the image, we would be storing it in normalized form. This way, the coordinates stored would be independent of image size.

For Example, we have following

Key Coordinates: (x, y)

Value Coordinates: (x’, y’)

Image Coordinates: (X, Y)

Normalized Values to be stored would be:

Normalized Key Coordinates: (x/X, y/Y)

Normalized Value Coordinates: (x’/X, y’/Y)

Similarly other values related to KV would be calculated and stored.

During extraction the normalized values would be de-normalized with respect to the input image given for extraction.

Assuming Image Coordinates are: (P, Q)

De-Normalized Key Coordinates: ((x/X)*P, (y/Y)*Q)

De-Normalized Value Coordinates: ((x’/X)*P, (y’/Y)*Q)

These de-normalized Coordinates would be normalized with respect to new image dimensions. Key Value extraction would be performed based on these normalized coordinates.

Overview

This feature allows a user to specify a ‘Key-Value pair’ which can be used for extracting document level index field values based on relative location of ‘value’ against a specified key.

Usability

User is provided with ‘Add’ and ‘Edit’ buttons to define and modify the KV patterns. These buttons are available on KV Extraction Rule node present under each index field:

Figure: Key Value Extraction Grid under Batch Class Management

Option has been provided to enable/disable particular KV extraction rule. This setting would allow users to select what extraction rules should be used for Batch processing. Enable/disable particular extraction rule will be marked with green/red indicator respectively.

As soon as user will click on any of the above specified buttons, following UI will be displayed.

Copy KV Extraction Rule

.

At a time, you can copy only one KV Extraction Rule.

Key Value Extraction View

Each key value field consists of following attributes in KV extraction:

• Key Pattern (regex or other pre-defined field)
• Value Pattern (regex)
• Fuzzy Percent (None, 10%, 20% or 30%)
• Fetch Value (First, Last or All)
• Page Value (First, Last or All)
• Zone Value(All, Top, Left, Right, Middle or Bottom)
• Weight (0 to 1)

Key: Regular expression pattern for the key.

Value: Regular expression pattern for the value.

Fuzzy Percent: Fuzzy percent option returns extracted results that match a pattern approximately.

Allowed user values are none, 10%, 20% and 30%.

Fetch Value: User can specify following fetch value while defining advanced key value pair:

• First  to extract only first data from the value zone matching the value pattern specified.
• Last  to extract only last data from the value zone matching the value pattern specified.
• All  to extract only all data from the value zone matching the value pattern specified.

Page Value: User can specify following page value while defining advanced key value pair:

• ALL KV Extraction will be performed on all pages of the document.
• FIRST KV Extraction will be performed on first page of the document.
• LAST KV Extraction will be performed on last page of the document.

Weight: multiplied with confidence score value to calculate new confidence score.

Anchor to be used for multiple fields:

It aims to use the result of previously extracted document level fields for extraction of other document level fields.

User can use previously defined field as a key while defining key value field for some other document level field.

• There is a “Use Existing Field For Key” checkbox present on KV extraction UI.

• On checking this, a list will be populated with the names of document level fields that can be used as a key.

User can select any of those fields as key.

• • Note: Only those document level fields will be shown in drop down whose field order number is less than the field order number of the field for which key value pair is being defined.

• If “Use Existing Field For Key” check box is selected, value of the field selected as key should be captured.

Example: Suppose there are two document level fields State and City, and image contains following data:

State: CALIFORNIA

City: LA

While defining the advanced key value field for City,

• Use existing field for key should be checked.
• State should be selected from the drop down for key pattern.
• CALIFORNIA should be captured as key.
• LA should be captured as a value.

Uploading File:

Multiple file uploading support is provided on KV extraction screen from 4.0 version. File format supported for uploading are:

• PDF
• TIFF/TIF

Figure: Key Value Extraction File Upload View

Dropdowns and arrow keys are available on menu bar for traversing between files and pages respectively.

Editing Overlays in KV Extraction:

Functionality to edit key and value overlays on the KV Extraction Screen has been made much smoother and easier on the latest 4.0 version.

Default Overlays for key and value appears on the uploaded image. Overlays are resizable and draggable inside the image, which makes working on them much easier.

View OCR Data:

Feature to view OCR’ed contents of image is introduced in version 4.0. ‘View OCR Data’ toggle button is available on menu bar. This button generates the OCR content of the current loaded image and displays it on UI.

Figure: Key Value Extraction View OCR Data View

Test KV:

Feature to view the extracted results from Key-Value pair is enhanced to show the matched values on image. Values extracted from the image based on key and value pattern are drawn on the image and respective details of extraction are shown on bottom panel grid. User can scroll into view by clicking on respective row.

Figure: Key Value Extraction Test KV View

Clear:

Feature to clear the extracted results from the image and redraws Key-Value overlays.

Toolbar:

Navigation Icons to traverse to next, previous, first and last images in Image toolbar.

Apply Button is renamed to ‘Apply KV’ on Advanced KV Screen. Please find below illustrative screenshot:

Overview

The new API performs extraction on the input document PDF or a ZIP file (enclosed single page or multipage tiff/tif or pdf). Extraction plugins are fetched from the batch class corresponding to the input batch class identifier. The extraction will be performed based on the extraction plugins configurations and rules configured for the particular batch class.

If the document type is given as an input parameter then document classification is not performed and extraction is performed as per specified document type, otherwise classification and extraction is performed on the input to generate the results.

Input Parameters

Input parameters to the Web Service API would be

INPUT PARAMETERS

1. PDF File (single or multipage)/ ZIP File (zip file may contain single page or multipage tif/tiff or pdf)

2. batchClassIdentifier: String parameter for batch class identifier

3. docType (optional parameter) if user enters a docType then no document classification is performed otherwise classification of the document will be performed.

Output Parameters

Batch XML will be output for the web service.

Web Service URL

http://<HOSTNAME>:8080/dcma/rest/ocrClassifyExtract

Example-

localhost:8080/dcma/rest/batchClass/ocrClassifyExtract

Checklist:

1. Extraction would be done only if Extraction module is configured for the particular batch class
2. Extraction would be performed only for the plugins which have extraction switch ON in batch class configuration.

Sample client code using apache commons http client:-

private static void ocrClassifyExtract() {

HttpClient client = new HttpClient();

String url = “http://localhost:8080/dcma/rest/ocrClassifyExtract”;

PostMethod mPost = new PostMethod(url);

// Adding HTML file for processing

File file1 = new File(“C:\\sample\\US-Invoice.tiff”);

Part[] parts = new Part[2];

try {

parts[0] = new FilePart(file1.getName(), file1);

// Adding parameter for batchClassIdentifier

parts[1] = new StringPart(“batchClassIdentifier”, “BC1”);

MultipartRequestEntity entity = new MultipartRequestEntity(parts, mPost.getParams());

mPost.setRequestEntity(entity);

int statusCode = client.executeMethod(mPost);

if (statusCode == 200) {

System.out.println(“Web service executed successfully..”);

String responseBody = mPost.getResponseBodyAsString();

System.out.println(statusCode + ” *** ” + responseBody);

} else if (statusCode == 403) {

System.out.println(“Invalid username/password..”);

} else {

System.out.println(mPost.getResponseBodyAsString());

}

} catch (FileNotFoundException e) {

System.err.println(“File not found for processing..”);

} catch (HttpException e) {

e.printStackTrace();

} catch (IOException e) {

e.printStackTrace();

} finally {

if (mPost != null) {

mPost.releaseConnection();

}

}

}