{"id":31908,"date":"2015-03-10T11:02:48","date_gmt":"2015-03-10T19:02:48","guid":{"rendered":"https:\/\/ephesoft.com\/docs\/2019-1-2\/batch-class-management\/add-new-index-field\/"},"modified":"2020-10-05T16:43:40","modified_gmt":"2020-10-05T23:43:40","slug":"add-new-index-field","status":"publish","type":"docs","link":"https:\/\/ephesoft.com\/docs\/products\/transact\/features-and-functions\/administrator\/batch-class-management\/index-fields-4050\/add-new-index-field\/","title":{"rendered":"Add New Index Field"},"content":{"rendered":"<p>In this page, you will learn what an index field is, and how to create a new index field in Ephesoft Transact.<\/p>\n<ul>\n<li><a href=\"#post-31908-_jqmr6r2k7l20\">What is an Index Field?<\/a><\/li>\n<li><a href=\"#post-31908-_285cw3l664zl\">Prerequisites<\/a><\/li>\n<li><a href=\"#post-31908-_2ejnizf723ln\">Add New Index Field<\/a><\/li>\n<li><a href=\"#post-31908-_d1n6fur7fby3\">Import Index Field<\/a><\/li>\n<li><a href=\"#post-31908-_rlo8xbeb1eni\">Next Steps<\/a><\/li>\n<\/ul>\n<h2><a id=\"post-31908-_jqmr6r2k7l20\"><\/a>What is an Index Field?<\/h2>\n<p>An index field is used to store metadata for fields in a particular document. These fields can then be used to classify documents or extract data from the documents. Here are some potential index fields for a sample document type, US Driver\u2019s License:<\/p>\n<ul>\n<li>Address<\/li>\n<li>Expiry Date<\/li>\n<li>First Name<\/li>\n<li>Last Name<\/li>\n<li>License Number<\/li>\n<\/ul>\n<p>Index fields are Document Level Fields (DLF), which means they are unique to their document type. Index fields contain extraction and validation rules that determine what data should be extracted from your uploaded documents.<\/p>\n<p>Continue reading to learn how to add or import new index fields.<\/p>\n<h2><a id=\"post-31908-_285cw3l664zl\"><\/a>Prerequisites<\/h2>\n<p>You will need an existing batch class and document type.<\/p>\n<h2><a id=\"post-31908-_2ejnizf723ln\"><\/a>Add New Index Field<\/h2>\n<p>To add a new index field:<\/p>\n<ol>\n<li>Go to <strong>Batch Class Management<\/strong>.<\/li>\n<li>Select your batch class and click <strong>Open<\/strong>.<\/li>\n<\/ol>\n<p><strong>Note<\/strong>: When you open a batch class, the <strong>Document Types<\/strong> page displays by default.<\/p>\n<p><img decoding=\"async\" class=\"wp-image-45800\" src=\"https:\/\/ephesoft.com\/docs\/wp-content\/uploads\/2015\/03\/word-image-26.png\" width=\"1064\" height=\"537\" srcset=\"https:\/\/ephesoft.com\/docs\/wp-content\/uploads\/2015\/03\/word-image-26.png 1920w, https:\/\/ephesoft.com\/docs\/wp-content\/uploads\/2015\/03\/word-image-26-300x151.png 300w, https:\/\/ephesoft.com\/docs\/wp-content\/uploads\/2015\/03\/word-image-26-1024x517.png 1024w, https:\/\/ephesoft.com\/docs\/wp-content\/uploads\/2015\/03\/word-image-26-768x388.png 768w, https:\/\/ephesoft.com\/docs\/wp-content\/uploads\/2015\/03\/word-image-26-1536x775.png 1536w\" sizes=\"(max-width: 1064px) 100vw, 1064px\" \/><\/p>\n<p><em>Figure 1. Document Type Page<\/em><\/p>\n<ol start=\"3\">\n<li>Select your document type from the <strong>Document Types <\/strong>folder. This will open the <strong>Index Fields <\/strong>page.<\/li>\n<li>Click <strong>Add <\/strong>to create a new index field.<\/li>\n<\/ol>\n<p><img decoding=\"async\" class=\"wp-image-45801\" src=\"https:\/\/ephesoft.com\/docs\/wp-content\/uploads\/2015\/03\/word-image-27.png\" width=\"399\" height=\"193\" srcset=\"https:\/\/ephesoft.com\/docs\/wp-content\/uploads\/2015\/03\/word-image-27.png 449w, https:\/\/ephesoft.com\/docs\/wp-content\/uploads\/2015\/03\/word-image-27-300x145.png 300w\" sizes=\"(max-width: 399px) 100vw, 399px\" \/><\/p>\n<p><em>Figure 2. Add New Index Field<\/em><\/p>\n<ol start=\"5\">\n<li>Create a <strong>Name <\/strong>and <strong>Description <\/strong>for the index field. Click the red text box and begin typing.<\/li>\n<\/ol>\n<p><strong>Important<\/strong>: The index field name cannot be changed once the workflow has been deployed.<\/p>\n<ol start=\"6\">\n<li>Perform any additional configurations as desired and click <strong>Apply<\/strong>.<\/li>\n<\/ol>\n<h2><a id=\"post-31908-_d1n6fur7fby3\"><\/a>Import Index Field<\/h2>\n<p>You can also import index fields between batch classes or servers. This can be helpful if you have multiple batch classes with the same index field, or if you need to move to a new Ephesoft Transact environment.<\/p>\n<ol>\n<li>Go to the <strong>Batch Class Management <\/strong>page and open your bach class.<\/li>\n<li>Select <strong>Document Types <\/strong>&gt;<strong> [<em>your document type<\/em>] <\/strong>&gt; <strong>Index Fields<\/strong>.<\/li>\n<li>Select one or more index fields you want to export.<\/li>\n<li>Click <strong>Export.<\/strong><\/li>\n<\/ol>\n<p><strong><img decoding=\"async\" class=\"wp-image-45802\" src=\"https:\/\/ephesoft.com\/docs\/wp-content\/uploads\/2015\/03\/word-image-28.png\" width=\"1029\" height=\"502\" srcset=\"https:\/\/ephesoft.com\/docs\/wp-content\/uploads\/2015\/03\/word-image-28.png 1920w, https:\/\/ephesoft.com\/docs\/wp-content\/uploads\/2015\/03\/word-image-28-300x146.png 300w, https:\/\/ephesoft.com\/docs\/wp-content\/uploads\/2015\/03\/word-image-28-1024x500.png 1024w, https:\/\/ephesoft.com\/docs\/wp-content\/uploads\/2015\/03\/word-image-28-768x375.png 768w, https:\/\/ephesoft.com\/docs\/wp-content\/uploads\/2015\/03\/word-image-28-1536x750.png 1536w\" sizes=\"(max-width: 1029px) 100vw, 1029px\" \/><\/strong><\/p>\n<p><em>Figure 3. Export Index Fields<\/em><\/p>\n<p>This creates a .zip file that you can then import to a different batch class or Ephesoft Transact environment.<\/p>\n<ol start=\"5\">\n<li>To import the zipped index field, click <strong>Select Files <\/strong>in the bottom panel, or drag and drop the .zip file into the dotted area.<\/li>\n<\/ol>\n<h2><a id=\"post-31908-_rlo8xbeb1eni\"><\/a>Next steps<\/h2>\n<ul>\n<li>More on <a href=\"https:\/\/ephesoft.com\/docs\/products\/transact\/features-and-functions\/administrator\/batch-class-management\/index-fields-4050\/\">Index Fields<\/a><\/li>\n<li><a href=\"https:\/\/ephesoft.com\/docs\/products\/transact\/features-and-functions\/administrator\/moduleplugin-configuration\/extraction-module\/\">Extraction Module<\/a><\/li>\n<li><a href=\"https:\/\/ephesoft.com\/docs\/products\/transact\/features-and-functions\/administrator\/moduleplugin-configuration\/validate-document\/\">Validate Document Module<\/a><\/li>\n<\/ul>\n","protected":false},"featured_media":0,"parent":31894,"menu_order":0,"comment_status":"closed","ping_status":"open","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>Add New Index Field | 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=\"Add New Index Field\" \/>\n<meta property=\"og:description\" content=\"In this page, you will learn what an index field is, and how to create a new index field in [&hellip;]\" \/>\n<meta property=\"og:url\" content=\"https:\/\/ephesoft.com\/docs\/products\/transact\/features-and-functions\/administrator\/batch-class-management\/index-fields-4050\/add-new-index-field\/\" \/>\n<meta property=\"og:site_name\" content=\"Ephesoft Docs\" \/>\n<meta property=\"article:modified_time\" content=\"2020-10-05T23:43:40+00:00\" \/>\n<meta property=\"og:image\" content=\"https:\/\/ephesoft.com\/docs\/wp-content\/uploads\/2015\/03\/word-image-26.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=\"2 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\/index-fields-4050\/add-new-index-field\/\",\"url\":\"https:\/\/ephesoft.com\/docs\/products\/transact\/features-and-functions\/administrator\/batch-class-management\/index-fields-4050\/add-new-index-field\/\",\"name\":\"Add New Index Field | Ephesoft Docs\",\"isPartOf\":{\"@id\":\"https:\/\/ephesoft.com\/docs\/#website\"},\"datePublished\":\"2015-03-10T19:02:48+00:00\",\"dateModified\":\"2020-10-05T23:43:40+00:00\",\"breadcrumb\":{\"@id\":\"https:\/\/ephesoft.com\/docs\/products\/transact\/features-and-functions\/administrator\/batch-class-management\/index-fields-4050\/add-new-index-field\/#breadcrumb\"},\"inLanguage\":\"en-US\",\"potentialAction\":[{\"@type\":\"ReadAction\",\"target\":[\"https:\/\/ephesoft.com\/docs\/products\/transact\/features-and-functions\/administrator\/batch-class-management\/index-fields-4050\/add-new-index-field\/\"]}]},{\"@type\":\"BreadcrumbList\",\"@id\":\"https:\/\/ephesoft.com\/docs\/products\/transact\/features-and-functions\/administrator\/batch-class-management\/index-fields-4050\/add-new-index-field\/#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\":\"Index Fields\",\"item\":\"https:\/\/ephesoft.com\/docs\/products\/transact\/features-and-functions\/administrator\/batch-class-management\/index-fields-4050\/\"},{\"@type\":\"ListItem\",\"position\":7,\"name\":\"Add New Index Field\"}]},{\"@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":"Add New Index Field | Ephesoft Docs","robots":{"index":"noindex","follow":"follow"},"og_locale":"en_US","og_type":"article","og_title":"Add New Index Field","og_description":"In this page, you will learn what an index field is, and how to create a new index field in [&hellip;]","og_url":"https:\/\/ephesoft.com\/docs\/products\/transact\/features-and-functions\/administrator\/batch-class-management\/index-fields-4050\/add-new-index-field\/","og_site_name":"Ephesoft Docs","article_modified_time":"2020-10-05T23:43:40+00:00","og_image":[{"url":"https:\/\/ephesoft.com\/docs\/wp-content\/uploads\/2015\/03\/word-image-26.png"}],"twitter_card":"summary_large_image","twitter_misc":{"Est. reading time":"2 minutes"},"schema":{"@context":"https:\/\/schema.org","@graph":[{"@type":"WebPage","@id":"https:\/\/ephesoft.com\/docs\/products\/transact\/features-and-functions\/administrator\/batch-class-management\/index-fields-4050\/add-new-index-field\/","url":"https:\/\/ephesoft.com\/docs\/products\/transact\/features-and-functions\/administrator\/batch-class-management\/index-fields-4050\/add-new-index-field\/","name":"Add New Index Field | Ephesoft Docs","isPartOf":{"@id":"https:\/\/ephesoft.com\/docs\/#website"},"datePublished":"2015-03-10T19:02:48+00:00","dateModified":"2020-10-05T23:43:40+00:00","breadcrumb":{"@id":"https:\/\/ephesoft.com\/docs\/products\/transact\/features-and-functions\/administrator\/batch-class-management\/index-fields-4050\/add-new-index-field\/#breadcrumb"},"inLanguage":"en-US","potentialAction":[{"@type":"ReadAction","target":["https:\/\/ephesoft.com\/docs\/products\/transact\/features-and-functions\/administrator\/batch-class-management\/index-fields-4050\/add-new-index-field\/"]}]},{"@type":"BreadcrumbList","@id":"https:\/\/ephesoft.com\/docs\/products\/transact\/features-and-functions\/administrator\/batch-class-management\/index-fields-4050\/add-new-index-field\/#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":"Index Fields","item":"https:\/\/ephesoft.com\/docs\/products\/transact\/features-and-functions\/administrator\/batch-class-management\/index-fields-4050\/"},{"@type":"ListItem","position":7,"name":"Add New Index Field"}]},{"@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\/31908"}],"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=31908"}],"version-history":[{"count":0,"href":"https:\/\/ephesoft.com\/docs\/wp-json\/wp\/v2\/docs\/31908\/revisions"}],"up":[{"embeddable":true,"href":"https:\/\/ephesoft.com\/docs\/wp-json\/wp\/v2\/docs\/31894"}],"next":[{"title":"Copying Index Fields","link":"https:\/\/ephesoft.com\/docs\/products\/transact\/features-and-functions\/administrator\/batch-class-management\/index-fields-4050\/copy-index-field\/","href":"https:\/\/ephesoft.com\/docs\/wp-json\/wp\/v2\/docs\/31899"}],"wp:attachment":[{"href":"https:\/\/ephesoft.com\/docs\/wp-json\/wp\/v2\/media?parent=31908"}],"wp:term":[{"taxonomy":"doc_tag","embeddable":true,"href":"https:\/\/ephesoft.com\/docs\/wp-json\/wp\/v2\/doc_tag?post=31908"}],"curies":[{"name":"wp","href":"https:\/\/api.w.org\/{rel}","templated":true}]}}