{"id":2672,"date":"2015-01-14T19:17:15","date_gmt":"2015-01-14T19:17:15","guid":{"rendered":"https:\/\/ephesoft.com\/docs\/?p=2672"},"modified":"2022-03-16T07:57:49","modified_gmt":"2022-03-16T14:57:49","slug":"how-to-configure-batch-class-encryption","status":"publish","type":"docs","link":"https:\/\/ephesoft.com\/docs\/products\/transact\/configurations\/security-configuration\/how-to-configure-batch-class-encryption\/","title":{"rendered":"Configure Batch Class Encryption"},"content":{"rendered":"

Transact versions:<\/strong> 3.1.1.0 onward<\/p>\n

Summary<\/h4>\n

This framework enables Ephesoft Transact to encrypt or decrypt the data persisted in XML files and index files while batch processing.<\/p>\n

Configuration<\/h2>\n

1. Setup your encryption keys for your application and Batch Class. Application Key can be generated from the System Config<\/strong> tab by the System Administrator.<\/p>\n

\"1b\"<\/a><\/p>\n

 <\/p>\n

\"1\"<\/a><\/p>\n

2. Batch Class Key can be generated by the Super Admin of the Application from the Batch Class Management Screen.<\/p>\n

\"2a\"<\/a><\/p>\n

 <\/p>\n

\"2\"<\/a><\/p>\n

2. Encryption can be enabled\/disabled during Batch Class Import.\u00a0An imported Batch Class can also use an existing key present inside the exported batch class.<\/p>\n

\"3\"<\/a><\/p>\n

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

\"4\"<\/a><\/p>\n

The use of 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\u2019s identity of the batch class being imported is the same as the application to which batch class is being imported. This validation is done so that no unauthorized application can import a batch class that does not belong to the same organization.<\/p>\n

Use Case<\/h3>\n

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 the application key is used by an organization\/application is unique and each application key denotes an organization\/application uniquely.<\/p>\n

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

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

\"Screenshot<\/a><\/p>\n","protected":false},"featured_media":0,"parent":22092,"menu_order":3,"comment_status":"closed","ping_status":"open","template":"","doc_tag":[],"yoast_head":"\nConfigure Batch Class Encryption | Ephesoft Docs<\/title>\n<meta name=\"robots\" content=\"noindex, follow\" \/>\n<meta property=\"og:locale\" content=\"en_US\" \/>\n<meta property=\"og:type\" content=\"article\" \/>\n<meta property=\"og:title\" content=\"Configure Batch Class Encryption\" \/>\n<meta property=\"og:description\" content=\"Transact versions: 3.1.1.0 onward Summary This framework enables Ephesoft Transact to encrypt or decrypt the data persisted in XML files […]\" \/>\n<meta property=\"og:url\" content=\"https:\/\/ephesoft.com\/docs\/products\/transact\/configurations\/security-configuration\/how-to-configure-batch-class-encryption\/\" \/>\n<meta property=\"og:site_name\" content=\"Ephesoft Docs\" \/>\n<meta property=\"article:modified_time\" content=\"2022-03-16T14:57:49+00:00\" \/>\n<meta property=\"og:image\" content=\"https:\/\/ephesoft.com\/docs\/wp-content\/uploads\/2015\/01\/1b.png\" \/>\n<meta name=\"twitter:card\" content=\"summary_large_image\" \/>\n<meta name=\"twitter:label1\" content=\"Est. reading time\" \/>\n\t<meta name=\"twitter:data1\" content=\"4 minutes\" \/>\n<script type=\"application\/ld+json\" class=\"yoast-schema-graph\">{\"@context\":\"https:\/\/schema.org\",\"@graph\":[{\"@type\":\"WebPage\",\"@id\":\"https:\/\/ephesoft.com\/docs\/products\/transact\/configurations\/security-configuration\/how-to-configure-batch-class-encryption\/\",\"url\":\"https:\/\/ephesoft.com\/docs\/products\/transact\/configurations\/security-configuration\/how-to-configure-batch-class-encryption\/\",\"name\":\"Configure Batch Class Encryption | Ephesoft Docs\",\"isPartOf\":{\"@id\":\"https:\/\/ephesoft.com\/docs\/#website\"},\"datePublished\":\"2015-01-14T19:17:15+00:00\",\"dateModified\":\"2022-03-16T14:57:49+00:00\",\"breadcrumb\":{\"@id\":\"https:\/\/ephesoft.com\/docs\/products\/transact\/configurations\/security-configuration\/how-to-configure-batch-class-encryption\/#breadcrumb\"},\"inLanguage\":\"en-US\",\"potentialAction\":[{\"@type\":\"ReadAction\",\"target\":[\"https:\/\/ephesoft.com\/docs\/products\/transact\/configurations\/security-configuration\/how-to-configure-batch-class-encryption\/\"]}]},{\"@type\":\"BreadcrumbList\",\"@id\":\"https:\/\/ephesoft.com\/docs\/products\/transact\/configurations\/security-configuration\/how-to-configure-batch-class-encryption\/#breadcrumb\",\"itemListElement\":[{\"@type\":\"ListItem\",\"position\":1,\"name\":\"Home\",\"item\":\"https:\/\/ephesoft.com\/docs\/\"},{\"@type\":\"ListItem\",\"position\":2,\"name\":\"Transact\",\"item\":\"https:\/\/ephesoft.com\/docs\/products\/transact\/\"},{\"@type\":\"ListItem\",\"position\":3,\"name\":\"System Configuration\",\"item\":\"https:\/\/ephesoft.com\/docs\/products\/transact\/configurations\/\"},{\"@type\":\"ListItem\",\"position\":4,\"name\":\"Security Configuration\",\"item\":\"https:\/\/ephesoft.com\/docs\/products\/transact\/configurations\/security-configuration\/\"},{\"@type\":\"ListItem\",\"position\":5,\"name\":\"Configure Batch Class Encryption\"}]},{\"@type\":\"WebSite\",\"@id\":\"https:\/\/ephesoft.com\/docs\/#website\",\"url\":\"https:\/\/ephesoft.com\/docs\/\",\"name\":\"Ephesoft Docs\",\"description\":\"Intelligent Document Processing Made Easy\",\"potentialAction\":[{\"@type\":\"SearchAction\",\"target\":{\"@type\":\"EntryPoint\",\"urlTemplate\":\"https:\/\/ephesoft.com\/docs\/?s={search_term_string}\"},\"query-input\":\"required name=search_term_string\"}],\"inLanguage\":\"en-US\"}]}<\/script>\n<!-- \/ Yoast SEO Premium plugin. -->","yoast_head_json":{"title":"Configure Batch Class Encryption | Ephesoft Docs","robots":{"index":"noindex","follow":"follow"},"og_locale":"en_US","og_type":"article","og_title":"Configure Batch Class Encryption","og_description":"Transact versions: 3.1.1.0 onward Summary This framework enables Ephesoft Transact to encrypt or decrypt the data persisted in XML files […]","og_url":"https:\/\/ephesoft.com\/docs\/products\/transact\/configurations\/security-configuration\/how-to-configure-batch-class-encryption\/","og_site_name":"Ephesoft Docs","article_modified_time":"2022-03-16T14:57:49+00:00","og_image":[{"url":"https:\/\/ephesoft.com\/docs\/wp-content\/uploads\/2015\/01\/1b.png"}],"twitter_card":"summary_large_image","twitter_misc":{"Est. reading time":"4 minutes"},"schema":{"@context":"https:\/\/schema.org","@graph":[{"@type":"WebPage","@id":"https:\/\/ephesoft.com\/docs\/products\/transact\/configurations\/security-configuration\/how-to-configure-batch-class-encryption\/","url":"https:\/\/ephesoft.com\/docs\/products\/transact\/configurations\/security-configuration\/how-to-configure-batch-class-encryption\/","name":"Configure Batch Class Encryption | Ephesoft Docs","isPartOf":{"@id":"https:\/\/ephesoft.com\/docs\/#website"},"datePublished":"2015-01-14T19:17:15+00:00","dateModified":"2022-03-16T14:57:49+00:00","breadcrumb":{"@id":"https:\/\/ephesoft.com\/docs\/products\/transact\/configurations\/security-configuration\/how-to-configure-batch-class-encryption\/#breadcrumb"},"inLanguage":"en-US","potentialAction":[{"@type":"ReadAction","target":["https:\/\/ephesoft.com\/docs\/products\/transact\/configurations\/security-configuration\/how-to-configure-batch-class-encryption\/"]}]},{"@type":"BreadcrumbList","@id":"https:\/\/ephesoft.com\/docs\/products\/transact\/configurations\/security-configuration\/how-to-configure-batch-class-encryption\/#breadcrumb","itemListElement":[{"@type":"ListItem","position":1,"name":"Home","item":"https:\/\/ephesoft.com\/docs\/"},{"@type":"ListItem","position":2,"name":"Transact","item":"https:\/\/ephesoft.com\/docs\/products\/transact\/"},{"@type":"ListItem","position":3,"name":"System Configuration","item":"https:\/\/ephesoft.com\/docs\/products\/transact\/configurations\/"},{"@type":"ListItem","position":4,"name":"Security Configuration","item":"https:\/\/ephesoft.com\/docs\/products\/transact\/configurations\/security-configuration\/"},{"@type":"ListItem","position":5,"name":"Configure Batch Class Encryption"}]},{"@type":"WebSite","@id":"https:\/\/ephesoft.com\/docs\/#website","url":"https:\/\/ephesoft.com\/docs\/","name":"Ephesoft Docs","description":"Intelligent Document Processing Made Easy","potentialAction":[{"@type":"SearchAction","target":{"@type":"EntryPoint","urlTemplate":"https:\/\/ephesoft.com\/docs\/?s={search_term_string}"},"query-input":"required name=search_term_string"}],"inLanguage":"en-US"}]}},"comment_count":0,"_links":{"self":[{"href":"https:\/\/ephesoft.com\/docs\/wp-json\/wp\/v2\/docs\/2672"}],"collection":[{"href":"https:\/\/ephesoft.com\/docs\/wp-json\/wp\/v2\/docs"}],"about":[{"href":"https:\/\/ephesoft.com\/docs\/wp-json\/wp\/v2\/types\/docs"}],"replies":[{"embeddable":true,"href":"https:\/\/ephesoft.com\/docs\/wp-json\/wp\/v2\/comments?post=2672"}],"version-history":[{"count":2,"href":"https:\/\/ephesoft.com\/docs\/wp-json\/wp\/v2\/docs\/2672\/revisions"}],"predecessor-version":[{"id":50597,"href":"https:\/\/ephesoft.com\/docs\/wp-json\/wp\/v2\/docs\/2672\/revisions\/50597"}],"up":[{"embeddable":true,"href":"https:\/\/ephesoft.com\/docs\/wp-json\/wp\/v2\/docs\/22092"}],"next":[{"title":"Support for batches executed of Encrypted Batch Classes.","link":"https:\/\/ephesoft.com\/docs\/products\/transact\/configurations\/security-configuration\/support-for-batches-executed-of-encrypted-batch-classes\/","href":"https:\/\/ephesoft.com\/docs\/wp-json\/wp\/v2\/docs\/6536"}],"prev":[{"title":"Security: Restricting access to certain Ephesoft Web Pages","link":"https:\/\/ephesoft.com\/docs\/products\/transact\/configurations\/security-configuration\/security-restricting-access-to-certain-ephesoft-web-pages\/","href":"https:\/\/ephesoft.com\/docs\/wp-json\/wp\/v2\/docs\/2622"}],"wp:attachment":[{"href":"https:\/\/ephesoft.com\/docs\/wp-json\/wp\/v2\/media?parent=2672"}],"wp:term":[{"taxonomy":"doc_tag","embeddable":true,"href":"https:\/\/ephesoft.com\/docs\/wp-json\/wp\/v2\/doc_tag?post=2672"}],"curies":[{"name":"wp","href":"https:\/\/api.w.org\/{rel}","templated":true}]}}