1. Home
  2. Transact
  3. Features and Functions
  4. Administrator Role and Features
  5. Batch Class Management
  6. Batch Class
  7. Batch Class Features

Batch Class Features

Batch Class Management Charts

This functionality aims at providing the application user to see the (PPM) page processed per minute of the batch classes graphically. PPM is calculated dynamically from the past history of the page processed in the different batch classes.


  • The functionality allows one to visualize the PPM of different batch classes in form of bar chart.
  • This functionality allows one to visualize the PPM of selected batch class in form of gauge chart.


  • When a BCM screen is loaded, then on the left side of the screen a bar chart showing PPM comparison of batch classes shown in the grid i.e. per page is displayed.

  • A gauge chart is displayed on left side of screen below PPM chart which provides an eye-catching PPM (Page processed per minute) of the selected batch class in batch class grid.


Assign User Roles to Batch Class

This feature allows a super-admin to assign roles to all the batch classes. The users in any of these three assigned roles can view the batch classes. The three roles are:

  • role 1
  • role 2
  • role 3

A super-admin can assign multiple roles to a batch class.


Unlock Batch Class

This feature allows a user to release lock on a batch class on which it is working. This allows other users, who are assigned role to that batch class, to use that batch class.

A user can also unlock multiple batch class(es) in one go.

Please Note:

  1. A super-admin can unlock any batch class, be it is used by any other user.
  2. A non-super admin can unlock only those batch classes on which it has acquired a lock.


In above screenshot, a super-admin is unlocking a batch class on which user1 has acquired lock.

Open Batch Class

A user can open a batch class by three ways :

  1. Double click the grid row in batch class management screen.
  2. Select the grid row and press cntrl+k.
  3. Select the checkbox of grid row and click open.

Please Note:

A batch class on which lock has been acquired by some other user cannot be opened before unlocking it.


Apply Unsaved Changes

A user can save all the changes made to batch class, by just clicking Apply button. On click of Apply button, changes will be saved in the Database.

\lipsye33writableapply 1.png

After this, a success message is displayed to the user, that tells all changes have been successfully saved in the database.

\lipsye33writableapply 2.png

Close Batch Class

If user is inside the batch class to do some operation on that batch class and wants to come back to batch class grid that contains a list of batch classes, then user should click the close button.


If user forgot to save some changes and click the close button, then below pop-up message is displayed to the user.


On click of Save button, unsaved changes will be saved in database and user is redirected to the batch class grid and on click of Discard button, unsaved changes will not be saved in database and user is redirected to the batch class grid.

Encrypt Batch Class

This feature provides the functionality of encrypting the XML and index files generated during the processing. It is basically supported at the Batch Class Level. It will make the data non-readable for a human eye.

Only a super-admin is allowed to encrypt a batch class. A batch class can be encrypted only if application level key is generated.


  • To secure the data from any un-authorized access.


Batch Class Key can be generated from Batch Class Management Screen using “Encrypt” button. On click of this button a dialog box will open. By default, NONE encryption algorithm is selected, and Batch Class Key textbox is disabled. When user select any encryption algorithm, Batch Class Key textbox is enabled where it will enter key. On click of OK button, key will be generated and used encryption algorithm will be shown in “Encryption Algo” column on Batch Class Management screen.

If any of the batches of the batch class are in state other than “DELETED” or “FINISHED” then key cannot be generated.


Key Features

  • Every Application is identified by a unique Key.
  • All the HOCR.xml, Batch.xml, Index files generated have data in encrypted form.
  • All the sample and learned files are re-generated whenever there is a change in encryption algorithm.
  • Change in Batch Class Key without changing the algorithm will not affect the learned files.
  • Batch Class can be imported using the existing Keys as well as by generating the new key from UI.
  • Encrypted Batch.xml can be decrypted using the web.xml, only by an authorized user.
  • An authorized user is the one who belongs to the groups/roles assigned to the batch class for which the batch was processed.
  • No Batch can be decrypted at an application other than the application on which it was processed.
  • Only a super admin has an access to change the encryption key of a batch class.

Encryption Algorithm

The algorithm which is used for encrypting the data in the generated files is AES algorithm. There is a flexibility to choose between AES-128 / AES-256 bit algorithm.

Hashing Algorithm

Keys are generated using Hashing algorithm on the data available for generating Keys.

Key LengthHashing Algorithm

Levels of Secret Keys

LevelLocationMechanismKey Length
Application<Shared-Folders>/ephesoft-key-store-file/ephesoft.keystoreCan be generated only once from UI.128
Batch Class<Batch-Class-folder>/ephesoft-key-store-file/ephesoft.keystoreConfigurable from UI.128/256
Batch Instance<ephesoft-system-folder>/ephesoft-key-store-file/ephesoft.keystoreGenerated dynamically using Application Level Key and Batch Instance Key.Length of Batch Class Key.
Fuzzy-DB Index<Batch-Class-Folder>/<fuzzy-index-folder>/ephesoft-key-store-file/ephesoft.keystoreGenerated dynamically using Application Level Key and Batch Instance Key.Length of Batch Class Key.
Lucene Key<Batch-Class-Folder>/<lucene-search-classification-sample>/ephesoft-key-store-file/ephesoft.keystoreGenerated dynamically using Application Level Key and Batch Instance Key.Length of Batch Class Key.
Test KV<Batch-Class-Folder>/<test-KV-Folder >/ephesoft-key-store-file/ephesoft.keystoreGenerated dynamically using Application Level Key and Batch Instance Key.Length of Batch Class Key.
Test Advance KV<Batch-Class-Folder>/<test-Advance-KV-Folder>/ephesoft-key-store-file/ephesoft.keystoreGenerated dynamically using Application Level Key and Batch Instance Key.Length of Batch Class Key.
Test Classification<Batch-Class-Folder>/<test-Content-Classification-Folder>/ephesoft-key-store-file/ephesoft.keystoreGenerated dynamically using Application Level Key and Batch Instance Key.Length of Batch Class Key.
Test Table<Batch-Class-Folder>/<test-table >/ephesoft-key-store-file/ephesoft.keystoreGenerated dynamically using Application Level Key and Batch Instance Key.Length of Batch Class Key.

Batch Class Priority

This batch class priority is the priority with which batches of this batch class will be executed in comparison with other batch instances of other batch classes. The priority of the batch class is a numerical value from among 1 to 100 and is used to compare with priority of different batches of different batch classes when executing to access resources and to order the execution of plugins.


Each batch instance has a priority which is equal to the priority set for the batch class. In case of multiple batches being executed simultaneously, then one with higher priority is executed earlier. This priority is helpful in picking up of batches also. The batch class priority of can be changed easily from the batch class grid. To edit the batch class priority, click on the batch class priority cell of the batch class whose priority needs to be changed. The grid will change into editable text box and the new priority can be entered there.

Priority cannot be left blank or 0. In case user leave it blank then the old priority will be set and if user enters 0 then text box will be highlighted and error message stating “Priority should be between 1 and 100” will be shown as tool tip .

The updated batch class priority is applicable only after clicking on apply button.


Batch Class Copy

The batch classes can be copied to make different copies of it. The use of this functionality is to reduce the configurations to a minimum. When after selecting the batch class and clicking the copy button in the batch class management menu bar, a dialog appears which require the below specified configurations. Below shown is a screen shot for the same:

  1. Name: A unique name for the batch class is required. The selected batch class name is pre-populated. The name of that batch class has to be unique and cannot contain any characters from among the list of characters configured in properties file.
  2. Description: The description for the batch class. This value cannot be empty.
  3. Priority: The priority of that batch class is set. By default the priority of the batch class whose copy is being made is pre-populated. The priority field is a slider.
  4. UNC Folder: The path of the UNC folder is configured. By default the UNC path of batch class being copied is pre-populated. The UNC folder path should be unique, the folder should be present and should be empty. This path can also be a network path.


There are different validations for the fields, some are shown in the below screenshots.



If all the fields are validated then the batch class is copied on click of “OK” button. In the back-end all the folder structure of the batch class being copied is also copied. The new batch class is displayed in the grid.

Batch Class Delete

Batch classes can be deleted from the batch class management screen by selecting their checkbox and clicking Delete.

Note: Batch classes BC1, BC2, and BC3 cannot be deleted.



Was this article helpful to you? Yes No