{"id":31693,"date":"2016-03-14T12:09:47","date_gmt":"2016-03-14T20:09:47","guid":{"rendered":"https:\/\/ephesoft.com\/docs\/2019-1-2\/developers\/scripting-guide\/client-side-scripting\/"},"modified":"2020-05-19T12:24:43","modified_gmt":"2020-05-19T19:24:43","slug":"client-side-scripting","status":"publish","type":"docs","link":"https:\/\/ephesoft.com\/docs\/products\/transact\/developers\/scripting-guide\/client-side-scripting\/","title":{"rendered":"Client Side Scripting"},"content":{"rendered":"<h3>Overview<\/h3>\n<p><a id=\"post-8896-_Toc349147032\"><\/a> There are 3 different JS methods to handle different events on Web Scanner and Upload Batch Screen.<\/p>\n<ul>\n<li><strong>Selecting a Batch Class when UI renders.<\/strong>\n<ul>\n<li>A method is called when the UI renders. A String <strong><em>Identifier<\/em><\/strong> is expected as a return out of it. If the method returns null , then default view would be shown, else the Batch Class with <strong><em>Identifier<\/em><\/strong> will be selected by default.<\/li>\n<\/ul>\n<\/li>\n<\/ul>\n<p>Purpose: This method provides additional functionality to auto select batch class on Upload batch and web scanner screen, when screen is opened.<\/p>\n<ul>\n<li><strong>Prepopulating Field Values<\/strong>\n<ul>\n<li>Method is called before displaying the pop up for the Batch Class Fields. Returned Values is e prepopulated values for the fields.<\/li>\n<\/ul>\n<\/li>\n<\/ul>\n<p>Purpose: This method provides functionality to pre populating batch class fields depending on batch class identifier.<\/p>\n<ul>\n<li><strong>Calling JS methods when field value changes<\/strong><\/li>\n<li>Handled the event of Batch Class Fields Value change and provided an \u00a0interface to call a function to expect a JSON as a return, which sets the returned values to all the other fields<\/li>\n<\/ul>\n<p>Purpose: To set other batch class fields based on value of a batch class field.<\/p>\n<p>Below screenshot highlights the area where these scripts work on Upload Batch screen.<\/p>\n<p><img decoding=\"async\" src=\"https:\/\/ephesoft.com\/docs\/wp-content\/uploads\/2016\/03\/word-image160.png\" alt=\"\" \/><\/p>\n<p>Following are the\u00a0new methods have been added to the utility.js file present at Ephesoft\/Application path for the required functionality.\u00a0Please refer to the attached screenshot for configuration details.<\/p>\n<p><img decoding=\"async\" src=\"https:\/\/ephesoft.com\/docs\/wp-content\/uploads\/2016\/03\/word-image161.png\" alt=\"\" \/><\/p>\n<h2><a id=\"post-8896-_Toc445722826\"><\/a>JS Methods description in utility.js<\/h2>\n<p><img decoding=\"async\" src=\"https:\/\/ephesoft.com\/docs\/wp-content\/uploads\/2016\/03\/word-image162.png\" alt=\"\" \/><\/p>\n<p><img decoding=\"async\" src=\"https:\/\/ephesoft.com\/docs\/wp-content\/uploads\/2016\/03\/word-image163.png\" alt=\"\" \/><\/p>\n","protected":false},"featured_media":0,"parent":31688,"menu_order":5,"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>Client Side Scripting | 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=\"Client Side Scripting\" \/>\n<meta property=\"og:description\" content=\"Overview There are 3 different JS methods to handle different events on Web Scanner and Upload Batch Screen. Selecting a [&hellip;]\" \/>\n<meta property=\"og:url\" content=\"https:\/\/ephesoft.com\/docs\/products\/transact\/developers\/scripting-guide\/client-side-scripting\/\" \/>\n<meta property=\"og:site_name\" content=\"Ephesoft Docs\" \/>\n<meta property=\"article:modified_time\" content=\"2020-05-19T19:24:43+00:00\" \/>\n<meta property=\"og:image\" content=\"https:\/\/ephesoft.com\/docs\/wp-content\/uploads\/2016\/03\/word-image160.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=\"1 minute\" \/>\n<script type=\"application\/ld+json\" class=\"yoast-schema-graph\">{\"@context\":\"https:\/\/schema.org\",\"@graph\":[{\"@type\":\"WebPage\",\"@id\":\"https:\/\/ephesoft.com\/docs\/products\/transact\/developers\/scripting-guide\/client-side-scripting\/\",\"url\":\"https:\/\/ephesoft.com\/docs\/products\/transact\/developers\/scripting-guide\/client-side-scripting\/\",\"name\":\"Client Side Scripting | Ephesoft Docs\",\"isPartOf\":{\"@id\":\"https:\/\/ephesoft.com\/docs\/#website\"},\"datePublished\":\"2016-03-14T20:09:47+00:00\",\"dateModified\":\"2020-05-19T19:24:43+00:00\",\"breadcrumb\":{\"@id\":\"https:\/\/ephesoft.com\/docs\/products\/transact\/developers\/scripting-guide\/client-side-scripting\/#breadcrumb\"},\"inLanguage\":\"en-US\",\"potentialAction\":[{\"@type\":\"ReadAction\",\"target\":[\"https:\/\/ephesoft.com\/docs\/products\/transact\/developers\/scripting-guide\/client-side-scripting\/\"]}]},{\"@type\":\"BreadcrumbList\",\"@id\":\"https:\/\/ephesoft.com\/docs\/products\/transact\/developers\/scripting-guide\/client-side-scripting\/#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\":\"Developer Documentation\",\"item\":\"https:\/\/ephesoft.com\/docs\/products\/transact\/developers\/\"},{\"@type\":\"ListItem\",\"position\":4,\"name\":\"Scripting Resources\",\"item\":\"https:\/\/ephesoft.com\/docs\/products\/transact\/developers\/scripting-guide\/\"},{\"@type\":\"ListItem\",\"position\":5,\"name\":\"Client Side Scripting\"}]},{\"@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":"Client Side Scripting | Ephesoft Docs","robots":{"index":"noindex","follow":"follow"},"og_locale":"en_US","og_type":"article","og_title":"Client Side Scripting","og_description":"Overview There are 3 different JS methods to handle different events on Web Scanner and Upload Batch Screen. Selecting a [&hellip;]","og_url":"https:\/\/ephesoft.com\/docs\/products\/transact\/developers\/scripting-guide\/client-side-scripting\/","og_site_name":"Ephesoft Docs","article_modified_time":"2020-05-19T19:24:43+00:00","og_image":[{"url":"https:\/\/ephesoft.com\/docs\/wp-content\/uploads\/2016\/03\/word-image160.png"}],"twitter_card":"summary_large_image","twitter_misc":{"Est. reading time":"1 minute"},"schema":{"@context":"https:\/\/schema.org","@graph":[{"@type":"WebPage","@id":"https:\/\/ephesoft.com\/docs\/products\/transact\/developers\/scripting-guide\/client-side-scripting\/","url":"https:\/\/ephesoft.com\/docs\/products\/transact\/developers\/scripting-guide\/client-side-scripting\/","name":"Client Side Scripting | Ephesoft Docs","isPartOf":{"@id":"https:\/\/ephesoft.com\/docs\/#website"},"datePublished":"2016-03-14T20:09:47+00:00","dateModified":"2020-05-19T19:24:43+00:00","breadcrumb":{"@id":"https:\/\/ephesoft.com\/docs\/products\/transact\/developers\/scripting-guide\/client-side-scripting\/#breadcrumb"},"inLanguage":"en-US","potentialAction":[{"@type":"ReadAction","target":["https:\/\/ephesoft.com\/docs\/products\/transact\/developers\/scripting-guide\/client-side-scripting\/"]}]},{"@type":"BreadcrumbList","@id":"https:\/\/ephesoft.com\/docs\/products\/transact\/developers\/scripting-guide\/client-side-scripting\/#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":"Developer Documentation","item":"https:\/\/ephesoft.com\/docs\/products\/transact\/developers\/"},{"@type":"ListItem","position":4,"name":"Scripting Resources","item":"https:\/\/ephesoft.com\/docs\/products\/transact\/developers\/scripting-guide\/"},{"@type":"ListItem","position":5,"name":"Client Side Scripting"}]},{"@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\/31693"}],"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=31693"}],"version-history":[{"count":0,"href":"https:\/\/ephesoft.com\/docs\/wp-json\/wp\/v2\/docs\/31693\/revisions"}],"up":[{"embeddable":true,"href":"https:\/\/ephesoft.com\/docs\/wp-json\/wp\/v2\/docs\/31688"}],"next":[{"title":"Display Error Cause for Default Scripts","link":"https:\/\/ephesoft.com\/docs\/products\/transact\/developers\/scripting-guide\/display-error-cause-default-scripts\/","href":"https:\/\/ephesoft.com\/docs\/wp-json\/wp\/v2\/docs\/31690"}],"prev":[{"title":"Batch.xml and XSD Schema for Developers","link":"https:\/\/ephesoft.com\/docs\/products\/transact\/developers\/scripting-guide\/batch-xml-schema\/","href":"https:\/\/ephesoft.com\/docs\/wp-json\/wp\/v2\/docs\/31694"}],"wp:attachment":[{"href":"https:\/\/ephesoft.com\/docs\/wp-json\/wp\/v2\/media?parent=31693"}],"wp:term":[{"taxonomy":"doc_tag","embeddable":true,"href":"https:\/\/ephesoft.com\/docs\/wp-json\/wp\/v2\/doc_tag?post=31693"}],"curies":[{"name":"wp","href":"https:\/\/api.w.org\/{rel}","templated":true}]}}