{"id":51780,"date":"2022-11-28T14:22:14","date_gmt":"2022-11-28T21:22:14","guid":{"rendered":"https:\/\/ephesoft.com\/docs\/?post_type=docs&#038;p=51780"},"modified":"2022-11-28T14:25:39","modified_gmt":"2022-11-28T21:25:39","slug":"importing-and-exporting-extraction-and-classification-rules","status":"publish","type":"docs","link":"https:\/\/ephesoft.com\/docs\/products\/transact\/features-and-functions\/administrator\/batch-class-management\/batch-class\/importing-and-exporting-extraction-and-classification-rules\/","title":{"rendered":"Importing and Exporting Extraction and Classification Rules"},"content":{"rendered":"<p><strong>Applies to: <\/strong>on-premises, cloud<\/p>\n<h1><a id=\"post-51780-_8xal5g8hetms\"><\/a>Introduction<\/h1>\n<p><strong>Applies to:<\/strong> Transact version 2022.1.01 or newer. (Windows\/Linux)<\/p>\n<p>This article describes how to export and import extraction and classification rules. These steps are intended for Transact administrators.<\/p>\n<h1><a id=\"post-51780-_pnxqulcgprnu\"><\/a>Overview<\/h1>\n<p>Ephesoft Transact enables you to export or import the following rules to aid in reuse and quicker batch class design:<\/p>\n<ul>\n<li>Key-value extraction rules from index fields<\/li>\n<li>Key-value page level field extraction rules<\/li>\n<li>Key-value page process classification rules<\/li>\n<\/ul>\n<p>These rules are compressed into a .zip file that can be imported into an index field or batch class of your choosing.<\/p>\n<h1><a id=\"post-51780-_1fob9te\"><\/a>Prerequisites<\/h1>\n<p>To import and export extraction and classification rules, the following configurations must be in place:<\/p>\n<ul>\n<li>You will need a batch class with a document type configured. For detailed steps, refer to <a href=\"https:\/\/ephesoft.com\/docs\/features-and-functions\/administrator\/batch-class-management\/add-new-document\/\">Add New Document Type<\/a>.<\/li>\n<li>Your document type should have at least one index field. For detailed steps, refer to <a href=\"https:\/\/ephesoft.com\/docs\/products\/transact\/features-and-functions\/administrator\/batch-class-management\/index-fields-4050\/add-new-index-field\/\">Add New Index Field<\/a>.<\/li>\n<\/ul>\n<h1><a id=\"post-51780-_3znysh7\"><\/a>Exporting Extraction and Classification Rules<\/h1>\n<p>To begin the export, start with these steps:<\/p>\n<ol>\n<li>From the <strong>Batch Class Management <\/strong>page, select and open your batch class.<\/li>\n<li>To export KV Extraction rules:\n<ol type=\"a\">\n<li>From the <strong>Document Types<\/strong> page, select and open your document type.<\/li>\n<li>Go to <strong>Index Fields &gt; (Field Name) &gt; KV Extraction Rule<\/strong>.<\/li>\n<\/ol>\n<\/li>\n<li>To export KV Page Process related rules:\n<ol type=\"a\">\n<li>For page process key-value page level field extraction rules, go to <strong>Modules &gt; Page Process &gt; KV_PAGE_PROCESS &gt; Page Level Fields<\/strong>.<\/li>\n<li>For page process classification rules, go to <strong>Modules &gt; Page Process &gt; KV_PAGE_PROCESS &gt; Classification Rules<\/strong>.<\/li>\n<\/ol>\n<\/li>\n<\/ol>\n<p>The page for your selected item appears, as in this example for KV Extraction Rules.<\/p>\n<p><img decoding=\"async\" width=\"1152\" height=\"542\" class=\"wp-image-51781\" src=\"https:\/\/ephesoft.com\/docs\/wp-content\/uploads\/2022\/11\/word-image-51780-1.png\" srcset=\"https:\/\/ephesoft.com\/docs\/wp-content\/uploads\/2022\/11\/word-image-51780-1.png 1152w, https:\/\/ephesoft.com\/docs\/wp-content\/uploads\/2022\/11\/word-image-51780-1-300x141.png 300w, https:\/\/ephesoft.com\/docs\/wp-content\/uploads\/2022\/11\/word-image-51780-1-1024x482.png 1024w, https:\/\/ephesoft.com\/docs\/wp-content\/uploads\/2022\/11\/word-image-51780-1-768x361.png 768w\" sizes=\"(max-width: 1152px) 100vw, 1152px\" \/><\/p>\n<p><em>Figure 1. KV Extraction Rules (Example)<\/em><\/p>\n<ol start=\"4\">\n<li>Select the items you want to export. To select all of them, select the checkbox in the column heading.<strong>Note:<\/strong> At least one item must be selected to export.<\/li>\n<\/ol>\n<ol start=\"5\">\n<li>Click <strong>Export<\/strong>. The .zip file is generated and saved on your computer.<\/li>\n<\/ol>\n<h1><a id=\"post-51780-_tvho8j399i8f\"><\/a>Importing Extraction and Classification Rules<\/h1>\n<p>Use the .zip file to import your items. Do the following:<\/p>\n<ol>\n<li>From the <strong>Batch Class Management <\/strong>page, select and open your batch class.<\/li>\n<li>Go to the appropriate rule panel:\n<ul>\n<li>For index field key-value extraction rules, go to <strong>(Document Type)<\/strong> <strong>&gt; Index Fields &gt; (Field Name) &gt; KV Extraction Rule<\/strong>.<\/li>\n<li>For page process key-value page level field extraction rules, go to <strong>Modules &gt; Page Process &gt; KV_PAGE_PROCESS &gt; Page Level Fields<\/strong>.<\/li>\n<li>For page process classification rules, go to <strong>Modules &gt; Page Process &gt; KV_PAGE_PROCESS &gt; Classification Rules<\/strong>.<\/li>\n<\/ul>\n<\/li>\n<li>Drag the .zip file into the <strong>Import<\/strong> panel at the bottom of the window. You can also click Select Files and navigate to the .zip file you want to import.<\/li>\n<\/ol>\n<p>As an example, this is what the <strong>Import <\/strong>panel looks like for KV Extraction Rules.<\/p>\n<p><img decoding=\"async\" width=\"1152\" height=\"235\" class=\"wp-image-51782\" src=\"https:\/\/ephesoft.com\/docs\/wp-content\/uploads\/2022\/11\/word-image-51780-2.png\" srcset=\"https:\/\/ephesoft.com\/docs\/wp-content\/uploads\/2022\/11\/word-image-51780-2.png 1152w, https:\/\/ephesoft.com\/docs\/wp-content\/uploads\/2022\/11\/word-image-51780-2-300x61.png 300w, https:\/\/ephesoft.com\/docs\/wp-content\/uploads\/2022\/11\/word-image-51780-2-1024x209.png 1024w, https:\/\/ephesoft.com\/docs\/wp-content\/uploads\/2022\/11\/word-image-51780-2-768x157.png 768w\" sizes=\"(max-width: 1152px) 100vw, 1152px\" \/><\/p>\n<p><em>Figure 2. Import KV Extraction Rule(s) Panel<\/em><\/p>\n<ol start=\"4\">\n<li>When the import is completed, the number of rules added are indicated along with any duplicate rules that were ignored. Click <strong>OK<\/strong> to continue.<\/li>\n<\/ol>\n<p><img decoding=\"async\" width=\"662\" height=\"298\" class=\"wp-image-51783\" src=\"https:\/\/ephesoft.com\/docs\/wp-content\/uploads\/2022\/11\/word-image-51780-3.png\" srcset=\"https:\/\/ephesoft.com\/docs\/wp-content\/uploads\/2022\/11\/word-image-51780-3.png 662w, https:\/\/ephesoft.com\/docs\/wp-content\/uploads\/2022\/11\/word-image-51780-3-300x135.png 300w\" sizes=\"(max-width: 662px) 100vw, 662px\" \/><\/p>\n<p><em>Figure 3. Import Confirmation<\/em><\/p>\n<ol start=\"5\">\n<li>When you are satisfied, click <strong>Apply<\/strong>.<\/li>\n<li>Click <strong>Deploy. <\/strong><\/li>\n<\/ol>\n<h1><a id=\"post-51780-_5m4qlbptsxe\"><\/a>Troubleshooting<\/h1>\n<p>Refer to the table below for common workarounds.<\/p>\n<table>\n<thead>\n<tr style=\"color: #ffffff;background-color: #1f3864\" valign=\"top\">\n<th style=\"text-align: left\"><strong>Issue<\/strong><\/th>\n<th style=\"text-align: left\"><strong>Workaround<\/strong><\/th>\n<\/tr>\n<tr valign=\"top\" bgcolor=\"#d9e2f3\">\n<th style=\"text-align: left\">Unable to export or import extraction rules in Ephesoft Transact versions prior to 2022.1.01.<\/th>\n<th style=\"text-align: left\">Perform an in-place upgrade of Ephesoft Transact to 2022.1.01 before attempting to export or import extraction rules.<\/th>\n<\/tr>\n<tr valign=\"top\">\n<th style=\"text-align: left\">Batches are not visible on the Batch Instance Management, Review, and Validation screens.<\/th>\n<th style=\"text-align: left\">This may happen when roles are not assigned or if the Roles checkbox is unchecked when importing the batch class. Perform the following steps to resolve this:<\/p>\n<ol>\n<li style=\"text-align: left\">Navigate to the Batch Instance Management screen.<\/li>\n<li style=\"text-align: left\">Edit the corresponding batch class.<\/li>\n<li style=\"text-align: left\">Assign roles to the batch class.<\/li>\n<\/ol>\n<\/th>\n<\/tr>\n<\/thead>\n<\/table>\n","protected":false},"featured_media":0,"parent":47108,"menu_order":6,"comment_status":"closed","ping_status":"closed","template":"","doc_tag":[],"yoast_head":"<!-- This site is optimized with the Yoast SEO Premium plugin v19.0 (Yoast SEO v22.1) - https:\/\/yoast.com\/wordpress\/plugins\/seo\/ -->\n<title>Importing and Exporting Extraction and Classification Rules | 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=\"Importing and Exporting Extraction and Classification Rules\" \/>\n<meta property=\"og:description\" content=\"Applies to: on-premises, cloud Introduction Applies to: Transact version 2022.1.01 or newer. (Windows\/Linux) This article describes how to export and [&hellip;]\" \/>\n<meta property=\"og:url\" content=\"https:\/\/ephesoft.com\/docs\/products\/transact\/features-and-functions\/administrator\/batch-class-management\/batch-class\/importing-and-exporting-extraction-and-classification-rules\/\" \/>\n<meta property=\"og:site_name\" content=\"Ephesoft Docs\" \/>\n<meta property=\"article:modified_time\" content=\"2022-11-28T21:25:39+00:00\" \/>\n<meta property=\"og:image\" content=\"https:\/\/ephesoft.com\/docs\/wp-content\/uploads\/2022\/11\/word-image-51780-1.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\/features-and-functions\/administrator\/batch-class-management\/batch-class\/importing-and-exporting-extraction-and-classification-rules\/\",\"url\":\"https:\/\/ephesoft.com\/docs\/products\/transact\/features-and-functions\/administrator\/batch-class-management\/batch-class\/importing-and-exporting-extraction-and-classification-rules\/\",\"name\":\"Importing and Exporting Extraction and Classification Rules | Ephesoft Docs\",\"isPartOf\":{\"@id\":\"https:\/\/ephesoft.com\/docs\/#website\"},\"datePublished\":\"2022-11-28T21:22:14+00:00\",\"dateModified\":\"2022-11-28T21:25:39+00:00\",\"breadcrumb\":{\"@id\":\"https:\/\/ephesoft.com\/docs\/products\/transact\/features-and-functions\/administrator\/batch-class-management\/batch-class\/importing-and-exporting-extraction-and-classification-rules\/#breadcrumb\"},\"inLanguage\":\"en-US\",\"potentialAction\":[{\"@type\":\"ReadAction\",\"target\":[\"https:\/\/ephesoft.com\/docs\/products\/transact\/features-and-functions\/administrator\/batch-class-management\/batch-class\/importing-and-exporting-extraction-and-classification-rules\/\"]}]},{\"@type\":\"BreadcrumbList\",\"@id\":\"https:\/\/ephesoft.com\/docs\/products\/transact\/features-and-functions\/administrator\/batch-class-management\/batch-class\/importing-and-exporting-extraction-and-classification-rules\/#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\":\"Features and Functions\",\"item\":\"https:\/\/ephesoft.com\/docs\/products\/transact\/features-and-functions\/\"},{\"@type\":\"ListItem\",\"position\":4,\"name\":\"Administrator Role and Features\",\"item\":\"https:\/\/ephesoft.com\/docs\/products\/transact\/features-and-functions\/administrator\/\"},{\"@type\":\"ListItem\",\"position\":5,\"name\":\"Batch Class Management\",\"item\":\"https:\/\/ephesoft.com\/docs\/products\/transact\/features-and-functions\/administrator\/batch-class-management\/\"},{\"@type\":\"ListItem\",\"position\":6,\"name\":\"Batch Class\",\"item\":\"https:\/\/ephesoft.com\/docs\/products\/transact\/features-and-functions\/administrator\/batch-class-management\/batch-class\/\"},{\"@type\":\"ListItem\",\"position\":7,\"name\":\"Importing and Exporting Extraction and Classification Rules\"}]},{\"@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":"Importing and Exporting Extraction and Classification Rules | Ephesoft Docs","robots":{"index":"noindex","follow":"follow"},"og_locale":"en_US","og_type":"article","og_title":"Importing and Exporting Extraction and Classification Rules","og_description":"Applies to: on-premises, cloud Introduction Applies to: Transact version 2022.1.01 or newer. (Windows\/Linux) This article describes how to export and [&hellip;]","og_url":"https:\/\/ephesoft.com\/docs\/products\/transact\/features-and-functions\/administrator\/batch-class-management\/batch-class\/importing-and-exporting-extraction-and-classification-rules\/","og_site_name":"Ephesoft Docs","article_modified_time":"2022-11-28T21:25:39+00:00","og_image":[{"url":"https:\/\/ephesoft.com\/docs\/wp-content\/uploads\/2022\/11\/word-image-51780-1.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\/features-and-functions\/administrator\/batch-class-management\/batch-class\/importing-and-exporting-extraction-and-classification-rules\/","url":"https:\/\/ephesoft.com\/docs\/products\/transact\/features-and-functions\/administrator\/batch-class-management\/batch-class\/importing-and-exporting-extraction-and-classification-rules\/","name":"Importing and Exporting Extraction and Classification Rules | Ephesoft Docs","isPartOf":{"@id":"https:\/\/ephesoft.com\/docs\/#website"},"datePublished":"2022-11-28T21:22:14+00:00","dateModified":"2022-11-28T21:25:39+00:00","breadcrumb":{"@id":"https:\/\/ephesoft.com\/docs\/products\/transact\/features-and-functions\/administrator\/batch-class-management\/batch-class\/importing-and-exporting-extraction-and-classification-rules\/#breadcrumb"},"inLanguage":"en-US","potentialAction":[{"@type":"ReadAction","target":["https:\/\/ephesoft.com\/docs\/products\/transact\/features-and-functions\/administrator\/batch-class-management\/batch-class\/importing-and-exporting-extraction-and-classification-rules\/"]}]},{"@type":"BreadcrumbList","@id":"https:\/\/ephesoft.com\/docs\/products\/transact\/features-and-functions\/administrator\/batch-class-management\/batch-class\/importing-and-exporting-extraction-and-classification-rules\/#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":"Features and Functions","item":"https:\/\/ephesoft.com\/docs\/products\/transact\/features-and-functions\/"},{"@type":"ListItem","position":4,"name":"Administrator Role and Features","item":"https:\/\/ephesoft.com\/docs\/products\/transact\/features-and-functions\/administrator\/"},{"@type":"ListItem","position":5,"name":"Batch Class Management","item":"https:\/\/ephesoft.com\/docs\/products\/transact\/features-and-functions\/administrator\/batch-class-management\/"},{"@type":"ListItem","position":6,"name":"Batch Class","item":"https:\/\/ephesoft.com\/docs\/products\/transact\/features-and-functions\/administrator\/batch-class-management\/batch-class\/"},{"@type":"ListItem","position":7,"name":"Importing and Exporting Extraction and Classification Rules"}]},{"@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\/51780"}],"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=51780"}],"version-history":[{"count":4,"href":"https:\/\/ephesoft.com\/docs\/wp-json\/wp\/v2\/docs\/51780\/revisions"}],"predecessor-version":[{"id":51787,"href":"https:\/\/ephesoft.com\/docs\/wp-json\/wp\/v2\/docs\/51780\/revisions\/51787"}],"up":[{"embeddable":true,"href":"https:\/\/ephesoft.com\/docs\/wp-json\/wp\/v2\/docs\/47108"}],"prev":[{"title":"Function Keys","link":"https:\/\/ephesoft.com\/docs\/products\/transact\/features-and-functions\/administrator\/batch-class-management\/batch-class\/function-keys\/","href":"https:\/\/ephesoft.com\/docs\/wp-json\/wp\/v2\/docs\/31896"}],"wp:attachment":[{"href":"https:\/\/ephesoft.com\/docs\/wp-json\/wp\/v2\/media?parent=51780"}],"wp:term":[{"taxonomy":"doc_tag","embeddable":true,"href":"https:\/\/ephesoft.com\/docs\/wp-json\/wp\/v2\/doc_tag?post=51780"}],"curies":[{"name":"wp","href":"https:\/\/api.w.org\/{rel}","templated":true}]}}