Applicable Ephesoft versions:

Ephesoft v3.1.1.0 or Higher



This featured framework enables Ephesoft to encrypt/decrypt the data persisted in XML files and index files while batch processing.
See More Info section…



1. Setup Your Encryption Keys for your Application and Batch Class

a. Application Key can be generated from the System Config tab by the Super Admin











b. Batch Class Key can be generated by the Super Admin of the Application from the Batch Class Management Screen.










2. Encryption can be enabled/disabled during Batch Class Import.

In addition to this imported Batch Class can also use an existing key present inside the exported batch class.





3. If user wants to enable encryption during batch class import or wants to change key of existing encrypted batch class then while importing re-learning all the files, key/key-store generation will take place which may take some time.







The use existing encryption keys can be used when a user wants to use already generated keys/key-stores in batch class because user does not want to generate new keys such that no re-learning, key/key-stores generation is done. But this feature works only if the application level key i.e. application’s identity of batch class being imported is same as application to which batch class is being imported. This validation is done so that no un-authorized application can import a batch class which does not belong to same organization.


A batch class BCx belongs to organization A and another organization B is trying to import the batch class BCx using existing keys into their application. Since organization A is different from organization B thus organization B must not be able to use the Batch class which has already been encrypted by another organization. This is validated using Applications identity i.e. application key since application key being used by an organization/application is unique and each application key denotes an organization/application uniquely.

In case if one wants to import/export an encrypted batch class between different environments like Production or Development for same organization then application identity on both Production and Development environment must be same. This will validate that Batch Class belongs to same organization.

To achieve this one will have to use same Application key on all the environments in organization as this key is an identity key and identifies if application belongs to same organization.

Screenshot from 2017-05-23 11-03-51




More Info:

Documentation – Ephesoft Encryption Framework

Disabling Encryption Application Key



< Back | How To Main Page | Documentation – Ephesoft Encryption Framework >

Was this article helpful to you?


Comments are closed.