Batch Class Import/Export


This feature allows a user to export/import an existing batch class to other ephesoft instance. Using this feature, user has a benefit of transferring the exact information of a batch class to another ephesoft application running on a remote system which will save a lot of time needed to reconfigure the batch class to having exact processing ability on a remote system.

Export Batch Class

By exporting a batch class, one can transfer the exact environment/configuration of a batch class present on a system to other. This helps a lot when a system fault occurs since there is no immediate way to migrate the environment to run batches. This also helps a lot in testing and debugging of issues faced in a configuration dependent environment.

Steps for exporting a Batch Class:

  • On ‘Batch Class Management’ UI, select a batch class to be exported (BC1 in screenshot) from the grid by either selecting the row and click ‘Export’ menu button.
  • An application pop up will be generated as displayed below:



As shown, there will be two options available for export of batch class. Either the batch class can be exported with all the learning files present in “lucene-search-classification-sample” and “image-classification-sample” folders or without them. These folders are required to replicate the environment and classification results for the batches to be processed. By default for exporting batch class, the configuration is set to export all learning files also.

  • After that, one just needs to click ‘Ok button and corresponding Batch Class will get exported to the desired location in ‘zip’ format.

Clicking ‘Cancel’ will not perform any operation and pop up will be closed.

This zipped batch class file can now be transferred to any other system and can be imported over there. Below shown is the folder structure which will be exported along with batch class.



Data Exported with Batch Class:

When we export the batch class the following data is exported with batch class:

  • Batch Class specific folder including Script files, properties file etc.
  • Document types, page types, RegEx Expressions (complete batch class hierarchy) defined in database.
  • Some optional data can be selected by the Export Batch Class pop up UI.

Import Batch Class

By importing a batch class, one can create the exact environment/configuration for a batch class present on any other remote system from which a batch class has been exported. This includes import of batch class configurations, document types and related html, xml and tiff files, learnt indexes etc.

Steps for importing a batch class

Prerequisites: Exported zipped batch class file.

  • On ‘Batch Class Management’ UI, click “select files” or drag and drop the zip file for exported batch class in the bottom panel as shown below:



  • After completing the upload of batch class exported zip file below specified pop-up will be displayed. Pop will expand as displayed below:



Here we have the following options:

  • UNC folder textbox/dropdown and Use Existing Checkbox.

Here user has an option to either override an existing batch class or create a completely new batch class from the attached zipped batch class file.

Create a new Batch class:

To create a new batch class from the exported zip file, one needs to uncheck ‘Use Existing’ checkbox. As soon as the checkbox is unchecked, UNC Folder dropdown will turn into an empty checkbox and user has to write the exact path (like D:\Shared Folders\new-public-unc-folder) where he needs to create a new UNC folder for the newly created batch class.

Please note that the UNC folder should be non-existing and unique, else application will prompt user to enter the folder path again.

  • Override an existing Batch Class:

To override an existing batch class from the exported zip file, one needs to check ‘Use Existing’ checkbox. As soon as the checkbox is checked, UNC Folder textbox will turn into a dropdown containing a list of all existing unc folders as option values. Here user just needs to select one of the unc folders belonging to a batch class which he wants to override. The priority of the existing batch class will be retained while overriding the batch class.

  • Name, Description, Priority textboxes:

Name textbox contains Batch Class type or workflow name (RecostarMailRoom, TesseractMailRoom etc.) of exported Batch Class. It should always be unique and must not contain any special characters which are configured in properties file.

In Description textbox user can enter the description of the batch class.

Note: Priority textbox is integer bound and should contain values from 1-100 with-

1-25 = Urgent priority

26-50 = High priority

51-75 = Medium priority

75-100 = Low priority.

  • Roles, Email Accounts and Batch Class Definition checkboxes.

Roles: If checked, Roles will be picked from the zipped batch class file. Else, Roles will be blank or same as that of existing batch class (in case of override).

Email Accounts: If checked, Email accounts will be picked from the zipped batch class file. Else, Email Accounts will be blank or same as that of existing batch class (in case of override).

Import Connections: If checked, then the DB Export and Fuzzy DB connections if configured any in the batch class while exporting, will be imported and set in new batch class.

  • Learned Data.

The batch class can be imported with the learned data from the exported batch class or without that. By default learned data will be imported in the batch class. The learned data contains the folder structure of document types and the files which are learned in those document types.

  • CMIS Mapping.

By default the export plugin properties and the import configurations will be copied in the new imported batch class. The CMIS export mappings are configurable which if selected will be used to copy the exported mappings into the new imported batch class.

  • Encryption.

If the use existing check box is checked then, the new imported batch class will also contain the same encryption as applied in the batch class while exporting. For example if while exporting the encryption is set with encryption algorithm set as AES_128 then in new batch class also it will be the same. Whereas if use existing checkbox is unchecked then operator can input the batch class key and encryption algorithm according to its requirement and the data inside exported batch class will be encrypted with the new algorithm.

  • After that, clicking ‘OK button will create a new Batch Class with a new Batch Class Identifier.




  • Batches are not visible on Batch Instance management and RV screen which run in imported batch class.

Answer: This may happen when roles are not assigned or ‘Roles’ checkbox is left unchecked while importing the batch class. Issue will be solved by assigning roles to the corresponding batch class.

Steps: Go to Batch Class Management screen – Edit the corresponding batch class – Assign roles to the batch class.

  • Batches going to error in Page Processing module which runs in imported batch class.

Answer: There are 2 possible reasons for this:

  • Exported zipped batch class file doesn’t contain Lucene and Image classification samples in it.
  • After its import, sample images are put into these folders but their learning is not done.

Issue will be solved either by exporting the batch class again with ‘image-classification-sample’ and ‘lucene-search-classification-sample’ checkboxes checked or by putting sample images in ‘image-classification-sample’ and ‘lucene-search-classification-sample’ folders present in ‘ephesoft-data’ and clicking ‘Learn Files’ then for the corresponding batch class.