This document defines the operations that can be done on a batch in validation state. During this stage, a user can perform various operations on the batch like classifying, splitting, copying, deleting the document etc., along with the ability to change the value of the index fields which have been extracted. The document also explains the various plug-in properties that should be set for batches that are in validation state. With the help of these properties Ephesoft facilitates fuzzy search option, suggestion box facility, and development of external modules or applications and integrates them to work together with Ephesoft. Whenever a batch comes for validation, its status is changed to “Ready for Validation” and it needs to be validated by the user manually, if it is not validated automatically.

Below is the screen shot of the BatchList page which contains a tab for the list of all the batches present in “READY_FOR_VALIDATION” state.





Please follow the below steps to set up the validation plug-in properties:

  • Login to the Ephesoft Admin Module (Batch Class Management).
  • Navigate to Batch Class -> Modules -> Validate Document module -> Validate Document plugin.








[table caption=”” width=”800″ colwidth=”20|100|50″ colalign=”left|left|center|left|right”]
Configurable property,Type~~of value,Value~~options,Description
Field Value Change Script Switch,List of~~values,ON~~OFF,”If the switch is enabled, then every time the field values are changed, the field value change script runs.~~Default OFF.”
Fuzzy Search Switch,List of~~values,ON~~OFF,”If the switch is enabled, then fuzzy search facility is enabled.~~Default ON.”
Suggestion box Switch,List of~~values,ON~~OFF,”If the switch is enabled, then suggestions for alternate values for Index fields are available.~~Default OFF.”
External Application Switch,List of~~values,ON~~OFF,”This field is used to develop external applications and integrate them to work together with Ephesoft.~~Default OFF.”
Fuzzy Pop Up X Dimension (in px),Integer,Integer~~value,To specify the x-dimension of the fuzzy search result pop-up in pixels.
Fuzzy Pop Up Y Dimension (in px),Integer,Integer~~value,To specify the y-dimension of the fuzzy search result pop-up in pixels.
Validation Script Switch,List of~~values,ON~~OFF,”If the switch is enabled, then whenever the batch in validation state is saved, the specified script runs.~~Default OFF.”
External Application X Dimension (in px),Integer,Integer~~value,To specify the x-dimension of the external application in pixels.
External Application Y Dimension (in px),Integer,Integer~~value,To specify the y-dimension of the external application in pixels.
“URL1 Title, URL2 Title, URL3 Title and URL4 Title”,String,N-A,These properties hold titles for the external application.
“URL1 (Ctrl+4), URL2 (Ctrl+7), URL3 (Ctrl+8) and URL4 (Ctrl+9)”,String,N-A,”To fire the specified External Application for a batch on the Review Validate UI. URL of the external application is specified here which can be accessed via shortcut keys (Ctrl+4, etc.) as well as by pressing buttons defined. (App1, App4, App2, App 3 as can be seen in the below UI).”
Index Field Value Separator,String,String,”The String entered will act as a separator for multiple words populated in an Index Field. If nothing is entered then, space will act as a separator.”
Insert Table Row Script Switch,List of~~values,ON~~OFF,”If the switch is enabled, then every time a new row is inserted in a table, script new table row insert runs.~~Default OFF.”
Sticky Index fields Field Switch,List of~~values,ON~~OFF,If the switch is enabled data populated in Index fields will be retained on changing the document type.~~Default OFF.
Table Extraction Suggestion Box Switch,List of~~values,ON~~OFF,”If the switch is enabled, suggestions for alternate values for table cells are available.~~Default OFF.”



External application on Review Validate Screen




Features List

There are three panels in this screen.

  • Left-most-panel or 1st panel – contains a document tree for the classified and unclassified Ephesoft documents.
  • Middle-panel or 2nd panel – contains the review panel and facilitates fuzzy search option. Review panel contains the list of document types and the list of documents for merging. Below review panel there is a textbox for fuzzy search index fields(with their extracted value) for the co
  • Right-most-panel or 3rd panel shows the enlarged image of the selected document.





In the document tree, classified as well as unclassified documents are displayed. Classified documents are marked by a green check mark. Unclassified documents are marked by a red question-mark on its right-top.


Index fields with their extracted values are displayed in the middle panel. In the below UI, the index field is Time and its extracted value is 21:29:34.Value of an index field can be populated by selecting overlay from image in the right-most panel.

The middle panel also contains a Table button for navigation to the Table View. This icon shows a red sign if the table contains any invalid data.




Clicking on the table view button opens another panel that contains a table corresponding to the selected document. This option comes only if some table configuration has been defined for the batch class. If no table has been configured then this option doesn’t appear. The table should contain only valid data. If any cell in the table contains any invalid data, then that batch is not validated.

Values in table can also be populated by selecting overlay from Right-most-panel.

Table on Review Validate Screen




  • Insert: Inserts a new row below the selected row in the table.
  • Delete: Deletes the selected rows. A row can be selected for deletion by selecting its check box.
  • Delete All: Deletes all the table rows.
  • Manual Extraction: A user can fill the data manually by selecting zones for row columns in the table.
    • Empty column can be populated by performing manual extraction for the column. For this, user has to select the Column checkbox present on the right of manual extraction button.
    • Invalid data extracted during Manual extraction for rows can be discarded by selecting the header checkboxes of a column. Any row with invalid value for the checked column will not be added on performing manual extraction.
  • Back: Navigates to the validate view.
  • Function keys have also been added on the table view to execute function key script. Add New Table button has now been removed from the table view. Any script can be executed by using the available function keys.
  • Table contains data validated using the table validation rules and column validation patterns defined for it. An invalid column value is highlighted using pink color and invalid row is highlighted using orange color.
  • The table validation rule failed over a row is displayed on the top of table view on selecting the invalid row. The row data is also validated on the fly if the user makes any changes in the row.
  • The columns validated using column validation pattern can be marked as valid by hitting Ctrl + b on the column’s cell.

Fuzzy search option returns table data that match a pattern approximately. Every document is mapped to a table in database. Data from the table in database is returned corresponding to the pattern specified in the fuzzy search textbox. A particular row from that table can be selected for populating data into Index fields.




User can populate the Index fields with data by clicking over the image.




  •  User can populate the Index fields with multiple data by holding the Ctrl key and clicking the mouse’s left button. This will result in a list of words separated by configured Index Field Value Separator.
  • If OCR confidence validation has been enabled, the Index field, whose OCR confidence fails to match the OCR confidence threshold, is displayed in “Red” with an error message on the top.
  • The Index field can be validated by pressing Ctrl + b, which removes the error message on the top. The OCR confidence validation can also be removed by pressing Ctrl + s.

Right-most panel

The right-most panel contains the buttons for splitting, deleting, rotating the document, etc. These buttons can be used to perform some functionality given in the shortcuts tab. We can select any page from any document and use these buttons to perform the functionality shown in the screen shot below:




Clicking on shortcuts will open a table of shortcuts for operations like saving, splitting, merging, deleting the document etc.




Following shortcuts are explained at this location:


Split document feature has been enhanced for retaining Index Field and Table Data. On splitting a document the user is prompted for retaining Index Field values and Table Data.