{"id":31702,"date":"2018-03-22T16:07:19","date_gmt":"2018-03-23T00:07:19","guid":{"rendered":"https:\/\/ephesoft.com\/docs\/2019-1-2\/developers\/custom-plugins\/improved-custom-plugin-import-mechanism\/"},"modified":"2020-11-20T09:34:51","modified_gmt":"2020-11-20T16:34:51","slug":"improved-custom-plugin-import-mechanism","status":"publish","type":"docs","link":"https:\/\/ephesoft.com\/docs\/products\/transact\/developers\/custom-plugins\/improved-custom-plugin-import-mechanism\/","title":{"rendered":"Importing Custom Plugins"},"content":{"rendered":"

Applies to: <\/strong>Ephesoft Transact 4.5.0.0 and above<\/p>\n

This page describes how to import custom plugins into a batch class. These instructions are intended for Transact Administrators working in an on-premises environment. For Transact Cloud environments, free custom plugins are available in your instance by default.<\/span><\/p>\n

To purchase a premium custom plugin, please contact <\/span>sales@ephesoft.com<\/span><\/a>.\u00a0<\/span><\/p>\n

<\/a>Overview<\/h2>\n

Custom plugins are imported as a ZIP file, which contains a plugin JAR file and an XML file with information about the plugin. Once a custom plugin is uploaded into Transact, the system creates an entry in the database where all default plugins are listed.<\/p>\n

The plugin JAR is copied to the customPluginJars <\/strong>folder in SharedFolders, along with the associated XML file.<\/p>\n

<\/a>Import the Plugin<\/h2>\n

To import a custom plugin, perform the following steps:<\/p>\n

    \n
  1. In Ephesoft Transact, go to System Configuration<\/strong>.<\/li>\n
  2. Select Workflow Management<\/strong>.<\/li>\n
  3. In the Import Plugin <\/strong>panel, click Select Files<\/strong>.<\/li>\n<\/ol>\n

    <\/p>\n

    Figure 1. Import Custom Plugin<\/em><\/p>\n

      \n
    1. From the pop-up, select your ZIP file and click Open<\/strong>.<\/li>\n
    2. Restart Ephesoft Transact.<\/li>\n<\/ol>\n

      The custom plugin is now available for use.<\/p>\n

      Note: <\/strong>To use the plugin, navigate to the associated module, and add the plugin to the Selected Plugins<\/strong> column. Refer to Configuring Plugins<\/a> for steps.<\/p>\n

      For help removing a custom plugin, refer to Removing Custom Plugins<\/a>.<\/p>\n","protected":false},"featured_media":0,"parent":31701,"menu_order":1,"comment_status":"closed","ping_status":"open","template":"","doc_tag":[],"yoast_head":"\nImporting Custom Plugins | 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 Custom Plugins\" \/>\n<meta property=\"og:description\" content=\"Applies to: Ephesoft Transact 4.5.0.0 and above This page describes how to import custom plugins into a batch class. These […]\" \/>\n<meta property=\"og:url\" content=\"https:\/\/ephesoft.com\/docs\/products\/transact\/developers\/custom-plugins\/improved-custom-plugin-import-mechanism\/\" \/>\n<meta property=\"og:site_name\" content=\"Ephesoft Docs\" \/>\n<meta property=\"article:modified_time\" content=\"2020-11-20T16:34:51+00:00\" \/>\n<meta property=\"og:image\" content=\"https:\/\/ephesoft.com\/docs\/wp-content\/uploads\/2018\/03\/word-image-7.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\/custom-plugins\/improved-custom-plugin-import-mechanism\/\",\"url\":\"https:\/\/ephesoft.com\/docs\/products\/transact\/developers\/custom-plugins\/improved-custom-plugin-import-mechanism\/\",\"name\":\"Importing Custom Plugins | Ephesoft Docs\",\"isPartOf\":{\"@id\":\"https:\/\/ephesoft.com\/docs\/#website\"},\"datePublished\":\"2018-03-23T00:07:19+00:00\",\"dateModified\":\"2020-11-20T16:34:51+00:00\",\"breadcrumb\":{\"@id\":\"https:\/\/ephesoft.com\/docs\/products\/transact\/developers\/custom-plugins\/improved-custom-plugin-import-mechanism\/#breadcrumb\"},\"inLanguage\":\"en-US\",\"potentialAction\":[{\"@type\":\"ReadAction\",\"target\":[\"https:\/\/ephesoft.com\/docs\/products\/transact\/developers\/custom-plugins\/improved-custom-plugin-import-mechanism\/\"]}]},{\"@type\":\"BreadcrumbList\",\"@id\":\"https:\/\/ephesoft.com\/docs\/products\/transact\/developers\/custom-plugins\/improved-custom-plugin-import-mechanism\/#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\":\"Custom Plugins\",\"item\":\"https:\/\/ephesoft.com\/docs\/products\/transact\/developers\/custom-plugins\/\"},{\"@type\":\"ListItem\",\"position\":5,\"name\":\"Importing Custom Plugins\"}]},{\"@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 Custom Plugins | Ephesoft Docs","robots":{"index":"noindex","follow":"follow"},"og_locale":"en_US","og_type":"article","og_title":"Importing Custom Plugins","og_description":"Applies to: Ephesoft Transact 4.5.0.0 and above This page describes how to import custom plugins into a batch class. These […]","og_url":"https:\/\/ephesoft.com\/docs\/products\/transact\/developers\/custom-plugins\/improved-custom-plugin-import-mechanism\/","og_site_name":"Ephesoft Docs","article_modified_time":"2020-11-20T16:34:51+00:00","og_image":[{"url":"https:\/\/ephesoft.com\/docs\/wp-content\/uploads\/2018\/03\/word-image-7.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\/custom-plugins\/improved-custom-plugin-import-mechanism\/","url":"https:\/\/ephesoft.com\/docs\/products\/transact\/developers\/custom-plugins\/improved-custom-plugin-import-mechanism\/","name":"Importing Custom Plugins | Ephesoft Docs","isPartOf":{"@id":"https:\/\/ephesoft.com\/docs\/#website"},"datePublished":"2018-03-23T00:07:19+00:00","dateModified":"2020-11-20T16:34:51+00:00","breadcrumb":{"@id":"https:\/\/ephesoft.com\/docs\/products\/transact\/developers\/custom-plugins\/improved-custom-plugin-import-mechanism\/#breadcrumb"},"inLanguage":"en-US","potentialAction":[{"@type":"ReadAction","target":["https:\/\/ephesoft.com\/docs\/products\/transact\/developers\/custom-plugins\/improved-custom-plugin-import-mechanism\/"]}]},{"@type":"BreadcrumbList","@id":"https:\/\/ephesoft.com\/docs\/products\/transact\/developers\/custom-plugins\/improved-custom-plugin-import-mechanism\/#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":"Custom Plugins","item":"https:\/\/ephesoft.com\/docs\/products\/transact\/developers\/custom-plugins\/"},{"@type":"ListItem","position":5,"name":"Importing Custom Plugins"}]},{"@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\/31702"}],"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=31702"}],"version-history":[{"count":0,"href":"https:\/\/ephesoft.com\/docs\/wp-json\/wp\/v2\/docs\/31702\/revisions"}],"up":[{"embeddable":true,"href":"https:\/\/ephesoft.com\/docs\/wp-json\/wp\/v2\/docs\/31701"}],"next":[{"title":"Removing Custom Plugins","link":"https:\/\/ephesoft.com\/docs\/products\/transact\/developers\/custom-plugins\/remove-a-custom-plugin\/","href":"https:\/\/ephesoft.com\/docs\/wp-json\/wp\/v2\/docs\/5983"}],"prev":[{"title":"Creating Custom Plugins","link":"https:\/\/ephesoft.com\/docs\/products\/transact\/developers\/custom-plugins\/how-to-create-a-custom-plugin\/","href":"https:\/\/ephesoft.com\/docs\/wp-json\/wp\/v2\/docs\/31703"}],"wp:attachment":[{"href":"https:\/\/ephesoft.com\/docs\/wp-json\/wp\/v2\/media?parent=31702"}],"wp:term":[{"taxonomy":"doc_tag","embeddable":true,"href":"https:\/\/ephesoft.com\/docs\/wp-json\/wp\/v2\/doc_tag?post=31702"}],"curies":[{"name":"wp","href":"https:\/\/api.w.org\/{rel}","templated":true}]}}