{"id":31817,"date":"2017-04-25T09:33:45","date_gmt":"2017-04-25T17:33:45","guid":{"rendered":"https:\/\/ephesoft.com\/docs\/2019-1-2\/moduleplugin-configuration\/extraction-module\/regular-regex-extraction-plugin-3\/"},"modified":"2020-11-24T09:46:54","modified_gmt":"2020-11-24T16:46:54","slug":"regular-regex-extraction-plugin-3","status":"publish","type":"docs","link":"https:\/\/ephesoft.com\/docs\/products\/transact\/features-and-functions\/administrator\/moduleplugin-configuration\/extraction-module\/regular-regex-extraction-plugin-3\/","title":{"rendered":"Regular Regex Extraction Plugin"},"content":{"rendered":"

Available<\/b>: on-premises, cloud<\/p>\n

Overview<\/span><\/h1>\n

This plugin extracts index field values based on the pattern defined for that field.\u00a0 A semicolon-separated collection of one or more words followed by a regular expression can be defined for the pattern.\u00a0 The system will search each page for the regular expression.\u00a0 If a match is found, the system will look to the left of the match and see if all of the preceding words in the pattern can be found.\u00a0 If all of the words are found (in order), the value will be extracted.\u00a0 If only a subset of the words are found, or if none of the words are found, the value will not be extracted.<\/p>\n

Examples<\/span><\/span><\/h3>\n

Consider the following text defined for the pattern field of the InvoiceDate index field:\u00a0 Invoice;Date;d{1,2}[\/]d{1,2}[\/]d{2,4}<\/p>\n

Example 1<\/strong><\/p>\n

Text string in document:\u00a0 Invoice Date 21\/03\/2012<\/p>\n

Result: “21\/03\/2012” will be extracted for the InvoiceDate index field.\u00a0 This happens because “21\/03\/2012” matches the regular expression pattern, with “Date” found to its left, and “Invoice” found to its left.<\/p>\n

Example 2<\/strong><\/p>\n

Text string in document:\u00a0 Date 21\/03\/2012<\/p>\n

Result:\u00a0 Nothing will be extracted for this index field.\u00a0 Even though “21\/03\/2012” matches the regular expression, and “Date” is found to its left, the word “Invoice” is not found to the left of “Date.”<\/p>\n

Plugin Configuration<\/span><\/span><\/h3>\n

The REGULAR_REGEX_EXTRACTION plugin can be configured in the following UI:<\/p>\n

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

Properties Description<\/b><\/p>\n\n\n\n\n\n
Configurable property<\/strong><\/td>\nType of value<\/strong><\/td>\nValue options<\/strong><\/td>\nDescription<\/strong><\/td>\n<\/tr>\n
Regular Regex <\/strong>Extraction Switch<\/strong><\/td>\nList of Values<\/td>\n\n
    \n
  • ON<\/li>\n
  • OFF<\/li>\n<\/ul>\n

     <\/td>\n

This property determines if the plugin will run or not.<\/p>\n

Default value is ON.<\/td>\n<\/tr>\n

Regular Regex Confidence Score<\/strong><\/td>\nInteger<\/td>\n0 – 100<\/td>\nActs as a multiplier for the confidence score calculated by matching regex.<\/td>\n<\/tr>\n<\/tbody>\n<\/table>\n

 <\/p>\n

The semicolon-separated set of words and regular expression can be entered in the\u00a0Pattern<\/strong> column for each index field:<\/p>\n

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

Troubleshooting<\/span><\/span><\/h3>\n

The following table lists possible error messages that could appear, and an explanation of what each error message means.<\/p>\n\n\n\n\n\n\n
Error message<\/strong><\/td>\nPossible root cause<\/strong><\/td>\n<\/tr>\n<\/thead>\n
Invalid input pattern sequence.<\/td>\nThe pattern entered is not a valid regular expression, or doesn’t match the proper format.<\/td>\n<\/tr>\n
No FieldType data found from data base for document type<\/td>\nThe FieldType column doesn’t contain a valid value.<\/td>\n<\/tr>\n<\/tbody>\n<\/table>\n","protected":false},"featured_media":0,"parent":31802,"menu_order":8,"comment_status":"closed","ping_status":"open","template":"","doc_tag":[],"yoast_head":"\nRegular Regex Extraction Plugin | 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=\"Regular Regex Extraction Plugin\" \/>\n<meta property=\"og:description\" content=\"Available: on-premises, cloud Overview This plugin extracts index field values based on the pattern defined for that field.\u00a0 A semicolon-separated […]\" \/>\n<meta property=\"og:url\" content=\"https:\/\/ephesoft.com\/docs\/products\/transact\/features-and-functions\/administrator\/moduleplugin-configuration\/extraction-module\/regular-regex-extraction-plugin-3\/\" \/>\n<meta property=\"og:site_name\" content=\"Ephesoft Docs\" \/>\n<meta property=\"article:modified_time\" content=\"2020-11-24T16:46:54+00:00\" \/>\n<meta property=\"og:image\" content=\"https:\/\/ephesoft.com\/docs\/wp-content\/uploads\/2017\/04\/1-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=\"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\/moduleplugin-configuration\/extraction-module\/regular-regex-extraction-plugin-3\/\",\"url\":\"https:\/\/ephesoft.com\/docs\/products\/transact\/features-and-functions\/administrator\/moduleplugin-configuration\/extraction-module\/regular-regex-extraction-plugin-3\/\",\"name\":\"Regular Regex Extraction Plugin | Ephesoft Docs\",\"isPartOf\":{\"@id\":\"https:\/\/ephesoft.com\/docs\/#website\"},\"datePublished\":\"2017-04-25T17:33:45+00:00\",\"dateModified\":\"2020-11-24T16:46:54+00:00\",\"breadcrumb\":{\"@id\":\"https:\/\/ephesoft.com\/docs\/products\/transact\/features-and-functions\/administrator\/moduleplugin-configuration\/extraction-module\/regular-regex-extraction-plugin-3\/#breadcrumb\"},\"inLanguage\":\"en-US\",\"potentialAction\":[{\"@type\":\"ReadAction\",\"target\":[\"https:\/\/ephesoft.com\/docs\/products\/transact\/features-and-functions\/administrator\/moduleplugin-configuration\/extraction-module\/regular-regex-extraction-plugin-3\/\"]}]},{\"@type\":\"BreadcrumbList\",\"@id\":\"https:\/\/ephesoft.com\/docs\/products\/transact\/features-and-functions\/administrator\/moduleplugin-configuration\/extraction-module\/regular-regex-extraction-plugin-3\/#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\":\"Modules and Plugins\",\"item\":\"https:\/\/ephesoft.com\/docs\/products\/transact\/features-and-functions\/administrator\/moduleplugin-configuration\/\"},{\"@type\":\"ListItem\",\"position\":6,\"name\":\"Extraction Module\",\"item\":\"https:\/\/ephesoft.com\/docs\/products\/transact\/features-and-functions\/administrator\/moduleplugin-configuration\/extraction-module\/\"},{\"@type\":\"ListItem\",\"position\":7,\"name\":\"Regular Regex Extraction Plugin\"}]},{\"@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":"Regular Regex Extraction Plugin | Ephesoft Docs","robots":{"index":"noindex","follow":"follow"},"og_locale":"en_US","og_type":"article","og_title":"Regular Regex Extraction Plugin","og_description":"Available: on-premises, cloud Overview This plugin extracts index field values based on the pattern defined for that field.\u00a0 A semicolon-separated […]","og_url":"https:\/\/ephesoft.com\/docs\/products\/transact\/features-and-functions\/administrator\/moduleplugin-configuration\/extraction-module\/regular-regex-extraction-plugin-3\/","og_site_name":"Ephesoft Docs","article_modified_time":"2020-11-24T16:46:54+00:00","og_image":[{"url":"https:\/\/ephesoft.com\/docs\/wp-content\/uploads\/2017\/04\/1-1.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\/moduleplugin-configuration\/extraction-module\/regular-regex-extraction-plugin-3\/","url":"https:\/\/ephesoft.com\/docs\/products\/transact\/features-and-functions\/administrator\/moduleplugin-configuration\/extraction-module\/regular-regex-extraction-plugin-3\/","name":"Regular Regex Extraction Plugin | Ephesoft Docs","isPartOf":{"@id":"https:\/\/ephesoft.com\/docs\/#website"},"datePublished":"2017-04-25T17:33:45+00:00","dateModified":"2020-11-24T16:46:54+00:00","breadcrumb":{"@id":"https:\/\/ephesoft.com\/docs\/products\/transact\/features-and-functions\/administrator\/moduleplugin-configuration\/extraction-module\/regular-regex-extraction-plugin-3\/#breadcrumb"},"inLanguage":"en-US","potentialAction":[{"@type":"ReadAction","target":["https:\/\/ephesoft.com\/docs\/products\/transact\/features-and-functions\/administrator\/moduleplugin-configuration\/extraction-module\/regular-regex-extraction-plugin-3\/"]}]},{"@type":"BreadcrumbList","@id":"https:\/\/ephesoft.com\/docs\/products\/transact\/features-and-functions\/administrator\/moduleplugin-configuration\/extraction-module\/regular-regex-extraction-plugin-3\/#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":"Modules and Plugins","item":"https:\/\/ephesoft.com\/docs\/products\/transact\/features-and-functions\/administrator\/moduleplugin-configuration\/"},{"@type":"ListItem","position":6,"name":"Extraction Module","item":"https:\/\/ephesoft.com\/docs\/products\/transact\/features-and-functions\/administrator\/moduleplugin-configuration\/extraction-module\/"},{"@type":"ListItem","position":7,"name":"Regular Regex Extraction Plugin"}]},{"@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\/31817"}],"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=31817"}],"version-history":[{"count":0,"href":"https:\/\/ephesoft.com\/docs\/wp-json\/wp\/v2\/docs\/31817\/revisions"}],"up":[{"embeddable":true,"href":"https:\/\/ephesoft.com\/docs\/wp-json\/wp\/v2\/docs\/31802"}],"next":[{"title":"REST API Lookup Plugin","link":"https:\/\/ephesoft.com\/docs\/products\/transact\/features-and-functions\/administrator\/moduleplugin-configuration\/extraction-module\/custom-rest-api-lookup\/","href":"https:\/\/ephesoft.com\/docs\/wp-json\/wp\/v2\/docs\/31815"}],"prev":[{"title":"RecoStar Extraction Plugin","link":"https:\/\/ephesoft.com\/docs\/products\/transact\/features-and-functions\/administrator\/moduleplugin-configuration\/extraction-module\/recostar-extraction-plugin\/","href":"https:\/\/ephesoft.com\/docs\/wp-json\/wp\/v2\/docs\/31842"}],"wp:attachment":[{"href":"https:\/\/ephesoft.com\/docs\/wp-json\/wp\/v2\/media?parent=31817"}],"wp:term":[{"taxonomy":"doc_tag","embeddable":true,"href":"https:\/\/ephesoft.com\/docs\/wp-json\/wp\/v2\/doc_tag?post=31817"}],"curies":[{"name":"wp","href":"https:\/\/api.w.org\/{rel}","templated":true}]}}