{"id":31838,"date":"2015-03-09T12:51:19","date_gmt":"2015-03-09T20:51:19","guid":{"rendered":"https:\/\/ephesoft.com\/docs\/2019-1-2\/moduleplugin-configuration\/extraction-module\/scripting-plugin-2\/"},"modified":"2020-11-24T09:52:51","modified_gmt":"2020-11-24T16:52:51","slug":"scripting-plugin-2","status":"publish","type":"docs","link":"https:\/\/ephesoft.com\/docs\/products\/transact\/features-and-functions\/administrator\/moduleplugin-configuration\/extraction-module\/scripting-plugin-2\/","title":{"rendered":"Scripting Plugin"},"content":{"rendered":"

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

Overview<\/h1>\n

This plug-in reads the batch\u2019s batch.xml file and works upon the given document as per the scripts given in the scripts folder. All the scripts are placed inside \u201c{SharedFolder}batch class folder (ex:-BC1)scripts<\/strong>\u201d.<\/p>\n

For any script there are two ways to write it, either it could be written in \u201cIScript\u201d or \u201cJDOM\u201d. For running any type of script user needs to place the script inside the \u201cscripts\u201d folder inside batch class folder for the respective batch class on which the script needs to be run.<\/p>\n

Configuration<\/h2>\n

Configurable properties<\/h3>\n

Following are the configurable properties available for the Fuzzy Db plug-in in the dcma-scripting-plugin properties file in META_INFdcma-scripting-plugin:<\/p>\n\n\n\n\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
Script Parser Type<\/strong><\/td>\nString<\/td>\n\n
    \n
  • jdom<\/li>\n<\/ul>\n
      \n
    • iscript<\/li>\n<\/ul>\n<\/td>\n
This value defines the type of scripts that will run. There could be two types of scripts that could be run i.e. JDOM and ISCRIPT. For script to run in JDOM user has to give the parser type as \u201cjdom\u201d. For script to run in ISCRIPT user has to give the value as \u201ciscript\u201d.Default jdom.<\/td>\n<\/tr>\n
Script Switch<\/strong><\/td>\nString<\/td>\n\n
    \n
  • ON<\/li>\n<\/ul>\n
      \n
    • OFF<\/li>\n<\/ul>\n<\/td>\n
This switch is used to set the execution of scripts on or off. If this switch is off then no script will run otherwise scripts will run.Default ON.<\/td>\n<\/tr>\n
Script<\/strong> Class<\/strong> Name<\/strong><\/td>\nString<\/td>\nNA<\/td>\nThis tells the user as to what is the name of application level script file.<\/td>\n<\/tr>\n
Script<\/strong> Folder<\/strong> Name<\/strong><\/td>\nString<\/td>\nNA<\/td>\nThis tells the user about the name of folder where application level script is lying.<\/td>\n<\/tr>\n
A<\/strong>pplication<\/strong> Level<\/strong> Script <\/strong>cron<\/strong> Expression<\/strong><\/td>\nString<\/td>\nNA<\/td>\nThis tells the user about the cron job expression.<\/td>\n<\/tr>\n
Script<\/strong> Optimizer<\/strong> Switch<\/strong><\/td>\nString<\/td>\n\n
    \n
  • ON<\/li>\n<\/ul>\n
      \n
    • OFF<\/li>\n<\/ul>\n<\/td>\n
This property is used to implement the optimization of scripts.<\/td>\n<\/tr>\n<\/tbody>\n<\/table>\n

This is shown in the screen shot given below:<\/p>\n

\"\"<\/p>\n

Steps for configuring the plugin<\/h3>\n
    \n
  • User can set the script switch to on\/off for running the scripts and for skipping the execution of scripts respectively.<\/li>\n
  • If the script switch is on then the parser type mentioned in the \u201cScript Parser Type<\/strong>\u201d property defines the type of scripts given.<\/li>\n
  • If the parser type is jdom then the JDOM scripts will run and if any script is present that runs for ISCRIPT then it will give errors and vice versa.<\/li>\n<\/ul>\n

    Steps of execution<\/h2>\n
      \n
    • Configure the plugin switch in the below configuration file i.e.<\/li>\n<\/ul>\n

      META-INF\/dcma-scripting-plugin\/dcma-scripting-plugin.properties file. Also give the parser type for the script to run.<\/p>\n

        \n
      • Enter the desired script in the scripts folder of the batch class in which user wants to run the script in. There are predefined scripts present in the scripts folder for each batch class. These are the dummy scripts.<\/li>\n
      • There is a set format for the naming of the scripts which will be picked as their names are configured. Therefore the names of the scripts need to be the same as in the scripts folder. For running any custom script, user needs to make changes to the present script or make its own custom script with same name as predefined scripts and replace the existing script.<\/li>\n<\/ul>\n

        Dependency<\/h2>\n

        There is only one dependency of this plug-in. The \u201cimport-batch-folder\u201d plug-in needs to be executed before \u201cscripting-plugin\u201d to generate the files required for processing of \u201cscripting-plugin\u201d. If the batch goes into \u201cError\u201d state then proper logs will be generated in log file kept at {Application}dcma-all.log.<\/p>\n

        NOTE:<\/strong> There are some scripts placed in the \u201cscripts\u201d folder which are required for the system.<\/p>\n

        Troubleshooting<\/h2>\n

        Following are few common error messages seen due to mal-functioning of the plugin:<\/p>\n\n\n\n\n\n
        S no.<\/strong><\/td>\nError message<\/strong><\/td>\nPossible root cause<\/strong><\/td>\n<\/tr>\n
        1<\/td>\nScript having invalid parser type or invalid arguments. Throwing workflow in error<\/td>\nThis occurs when the entered parser type and the present script types does not match for ex. If parser given is dom and user puts in an iscript script then this error occurs.<\/td>\n<\/tr>\n
        2<\/td>\nScript error out. Throwing workflow in error.<\/td>\nThis happens when the custom script that has been put error out and needs to be corrected.<\/td>\n<\/tr>\n<\/tbody>\n<\/table>\n

         <\/p>\n","protected":false},"featured_media":0,"parent":31802,"menu_order":10,"comment_status":"closed","ping_status":"open","template":"","doc_tag":[],"yoast_head":"\nScripting 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=\"Scripting Plugin\" \/>\n<meta property=\"og:description\" content=\"Available: on-premises, cloud Overview This plug-in reads the batch\u2019s batch.xml file and works upon the given document as per the […]\" \/>\n<meta property=\"og:url\" content=\"https:\/\/ephesoft.com\/docs\/products\/transact\/features-and-functions\/administrator\/moduleplugin-configuration\/extraction-module\/scripting-plugin-2\/\" \/>\n<meta property=\"og:site_name\" content=\"Ephesoft Docs\" \/>\n<meta property=\"article:modified_time\" content=\"2020-11-24T16:52:51+00:00\" \/>\n<meta property=\"og:image\" content=\"https:\/\/ephesoft.com\/docs\/wp-content\/uploads\/2015\/03\/word-image303.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=\"3 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\/scripting-plugin-2\/\",\"url\":\"https:\/\/ephesoft.com\/docs\/products\/transact\/features-and-functions\/administrator\/moduleplugin-configuration\/extraction-module\/scripting-plugin-2\/\",\"name\":\"Scripting Plugin | Ephesoft Docs\",\"isPartOf\":{\"@id\":\"https:\/\/ephesoft.com\/docs\/#website\"},\"datePublished\":\"2015-03-09T20:51:19+00:00\",\"dateModified\":\"2020-11-24T16:52:51+00:00\",\"breadcrumb\":{\"@id\":\"https:\/\/ephesoft.com\/docs\/products\/transact\/features-and-functions\/administrator\/moduleplugin-configuration\/extraction-module\/scripting-plugin-2\/#breadcrumb\"},\"inLanguage\":\"en-US\",\"potentialAction\":[{\"@type\":\"ReadAction\",\"target\":[\"https:\/\/ephesoft.com\/docs\/products\/transact\/features-and-functions\/administrator\/moduleplugin-configuration\/extraction-module\/scripting-plugin-2\/\"]}]},{\"@type\":\"BreadcrumbList\",\"@id\":\"https:\/\/ephesoft.com\/docs\/products\/transact\/features-and-functions\/administrator\/moduleplugin-configuration\/extraction-module\/scripting-plugin-2\/#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\":\"Scripting 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":"Scripting Plugin | Ephesoft Docs","robots":{"index":"noindex","follow":"follow"},"og_locale":"en_US","og_type":"article","og_title":"Scripting Plugin","og_description":"Available: on-premises, cloud Overview This plug-in reads the batch\u2019s batch.xml file and works upon the given document as per the […]","og_url":"https:\/\/ephesoft.com\/docs\/products\/transact\/features-and-functions\/administrator\/moduleplugin-configuration\/extraction-module\/scripting-plugin-2\/","og_site_name":"Ephesoft Docs","article_modified_time":"2020-11-24T16:52:51+00:00","og_image":[{"url":"https:\/\/ephesoft.com\/docs\/wp-content\/uploads\/2015\/03\/word-image303.png"}],"twitter_card":"summary_large_image","twitter_misc":{"Est. reading time":"3 minutes"},"schema":{"@context":"https:\/\/schema.org","@graph":[{"@type":"WebPage","@id":"https:\/\/ephesoft.com\/docs\/products\/transact\/features-and-functions\/administrator\/moduleplugin-configuration\/extraction-module\/scripting-plugin-2\/","url":"https:\/\/ephesoft.com\/docs\/products\/transact\/features-and-functions\/administrator\/moduleplugin-configuration\/extraction-module\/scripting-plugin-2\/","name":"Scripting Plugin | Ephesoft Docs","isPartOf":{"@id":"https:\/\/ephesoft.com\/docs\/#website"},"datePublished":"2015-03-09T20:51:19+00:00","dateModified":"2020-11-24T16:52:51+00:00","breadcrumb":{"@id":"https:\/\/ephesoft.com\/docs\/products\/transact\/features-and-functions\/administrator\/moduleplugin-configuration\/extraction-module\/scripting-plugin-2\/#breadcrumb"},"inLanguage":"en-US","potentialAction":[{"@type":"ReadAction","target":["https:\/\/ephesoft.com\/docs\/products\/transact\/features-and-functions\/administrator\/moduleplugin-configuration\/extraction-module\/scripting-plugin-2\/"]}]},{"@type":"BreadcrumbList","@id":"https:\/\/ephesoft.com\/docs\/products\/transact\/features-and-functions\/administrator\/moduleplugin-configuration\/extraction-module\/scripting-plugin-2\/#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":"Scripting 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\/31838"}],"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=31838"}],"version-history":[{"count":0,"href":"https:\/\/ephesoft.com\/docs\/wp-json\/wp\/v2\/docs\/31838\/revisions"}],"up":[{"embeddable":true,"href":"https:\/\/ephesoft.com\/docs\/wp-json\/wp\/v2\/docs\/31802"}],"next":[{"title":"Table Extraction Plugin","link":"https:\/\/ephesoft.com\/docs\/products\/transact\/features-and-functions\/administrator\/moduleplugin-configuration\/extraction-module\/table-extraction-plugin-3\/","href":"https:\/\/ephesoft.com\/docs\/wp-json\/wp\/v2\/docs\/31827"}],"prev":[{"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"}],"wp:attachment":[{"href":"https:\/\/ephesoft.com\/docs\/wp-json\/wp\/v2\/media?parent=31838"}],"wp:term":[{"taxonomy":"doc_tag","embeddable":true,"href":"https:\/\/ephesoft.com\/docs\/wp-json\/wp\/v2\/doc_tag?post=31838"}],"curies":[{"name":"wp","href":"https:\/\/api.w.org\/{rel}","templated":true}]}}