Batch Class Management
This topic includes the information about batch class features on the Batch Class Management screen.
Assign user roles
With this feature, a super admin can assign roles to all the batch classes. Users assigned to any of the following roles can view the batch classes:
- role1
- role2
- role3
A super admin can assign multiple roles to a batch class.
Unlock batch class
With this feature, a user can release a lock on a batch class on which it is working. This allows other users who are assigned to that batch class to use that batch class.
A user can also unlock multiple batch classes.
Note the following:
- A super admin can unlock any batch class, even used by any other user.
- A non-super admin can unlock only those batch classes on which they acquired a lock.
Open batch class
A user can open a batch class by doing any of the following actions:
- Double-click the grid row in the Batch Class Management screen.
- Select the grid row and press Ctrl + K.
- Select the check box of the grid row and click Open.
A batch class locked by another user cannot be opened until it is unlocked.
Apply unsaved changes
Click Apply to save all changes made to a batch class. These changes are saved in the database. A success message appears to confirm that all changes have been saved in the database.
Close batch class
To return to the batch class grid that contains a list of batch classes, click Close. If the user does not save the changes and clicks Close, you are prompted to save the changes.
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 the application level key is generated. The purpose of this feature is to secure the data from any unauthorized access.
Working
Batch Class Key can be generated from the Batch Class Management screen using the Encrypt button. Click Encrypt to open a dialog box. By default, the NONE encryption algorithm is selected, and the Batch Class Key text box is disabled. When a user selects any encryption algorithm, the Batch Class Key text box is enabled where it will enter key. Click OK. The key will be generated and used. The encryption algorithm displays in the Encryption Algo column on the Batch Class Management screen.
If any of the batches of the batch class is in a state other than DELETED or FINISHED, then the 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 the 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 does not affect the learned files.
- Batch class can be imported using the existing keys as well as by generating the new key from the 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 AES algorithm is used for encrypting the data in the generated files. There is a flexibility to select the AES-128 or AES-256 bit algorithm.
Hashing algorithm
Keys are generated using one of the hashing algorithms listed below.
|
Key length |
Hashing algorithm |
|---|---|
|
128 |
MD5 |
|
256 |
SHA-256 |
Levels of secret keys
| Level | Location | Mechanism | Key length |
|---|---|---|---|
| Application | <Shared-Folders>/ephesoft-key-store-file/ephesoft.keystore | Can be generated only once from the UI. | 128 |
| Batch Class | <Batch-Class-folder>/ephesoft-key-store-file/ephesoft.keystore | Configurable from the UI. | 128/256 |
| Batch Instance | <ephesoft-system-folder>/ephesoft-key-store-file/ephesoft.keystore | Generated 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.keystore | Generated 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.keystore | Generated 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.keystore | Generated 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.keystore | Generated 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.keystore | Generated 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.keystore | Generated dynamically using Application Level Key and Batch Instance Key. | Length of Batch Class Key. |
Batch class priority
The batch class priority is the execution order of batches of a batch class in comparison with other batch instances of other batch classes. The priority of the batch class is a numerical value from 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.
Usability
Each batch instance has a priority which is equal to the priority set for the batch class. When multiple batches are executed simultaneously, the one with higher priority is executed earlier. Also, this priority is helpful in picking up batches. The batch class priority can be easily changed in the batch class grid.
To edit the batch class priority, click the batch class priority cell of the batch class that you plan to change. The grid becomes the editable text box so you can update the priority value.
The Priority field cannot be left blank or 0. If the Priority field is blank, then the previous Priority value is set. If the Priority field is 0, then the text box is highlighted, and the following error message appears as a tool tip: Priority should be between 1 and 100.
The updated batch class priority is applicable only after you click the Apply button.
Close batch class
To return to the batch class grid that contains a list of batch classes, click Close. If you do not save the changes and click Close, you are prompted to save the changes.
Copy batch class
Batch classes can be copied and used as the basis of new configurations. When after selecting the batch class and clicking the copy button in the batch class management menu bar, a dialog box appears requiring the following specified configurations. Each dialog box has different field validations.
- 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.
- Description: The description for the batch class. This value cannot be empty.
- 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.
- 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.
If all the fields are validated then the batch class is copied when you click OK. In the backend, the entire folder structure of the batch class is also copied. The new batch class is displayed in the grid.
Delete batch class
You can delete batch classes by selecting the required check boxes and clicking Delete. A dialog box appears to confirm the deletion of all the selected batch classes.