Last Updated on



This document aims at explaining the Ephesoft Encryption framework. This framework enables Ephesoft to encrypt/decrypt the data persisted in XML files and index files while batch processing.  In order to achieve encryption/decryption capabilities Ephesoft maintain encryption/decryption keys at following levels:


  1. Application Level Key
  2. Batch Class Level Key
  3. Batch Instance Level Key
  4. Fuzzy Index
  5. Lucene Index Key
  6. Test KV Key
  7. Test Classification Key
  8. Test-Advance KV Key
  9. Test-Table Key

Ephesoft Encryption Framework


Ephesoft Encryption framework enables Ephesoft to secure data from any unauthorized access.


Key Features

  1. Every Application is identified by a unique Key.
  2. All the data persisted in HOCR.xml, Batch.xml and index files etc. is stored on disk in encrypted form to avoid any unauthorized access of critical data while processing.
  3. All the learned samples and learned index files are re-generated whenever there is a change in encryption algorithm.
  4. Any change in Batch Class Key without changing the encryption algorithm does not affect the learned files and thus they are not regenerated in such case.
  5. Batch Class can be imported using the existing Keys as well as by generating the new key from UI.
  6. Only authorized user will be able to decrypt the encrypted Batch.xml file using web service API. An authorized user is one who belongs to the groups/roles assigned to the batch class on which batches are processed.
  7. No Batch can be decrypted on an application other than the application on which it was processed.
  8. Only a super admin can change the encryption key of a batch class.



  1. Application Key should be generated before applying the encryption algorithm on a batch class.
  2. The user needs to make a change in the Scripting plugin for the plugin execution.


More Info

Hashing Algorithm
Encryption Algorithm
Application Level Key- The Crux of Encryption
Levels of Secret Keys
How to Configure
Error Messages
Backup and Recovery


< Back | Documentation Home Page

Was this article helpful to you?

Walter Lee