{"id":31703,"date":"2015-11-25T20:03:12","date_gmt":"2015-11-26T04:03:12","guid":{"rendered":"https:\/\/ephesoft.com\/docs\/2019-1-2\/developers\/custom-plugins\/how-to-create-a-custom-plugin\/"},"modified":"2021-02-18T11:24:10","modified_gmt":"2021-02-18T18:24:10","slug":"how-to-create-a-custom-plugin","status":"publish","type":"docs","link":"https:\/\/ephesoft.com\/docs\/products\/transact\/developers\/custom-plugins\/how-to-create-a-custom-plugin\/","title":{"rendered":"Creating Custom Plugins"},"content":{"rendered":"<h2><a id=\"post-31703-_wqp01nzfxfq4\"><\/a>Prerequisites<\/h2>\n<p><strong>Important: <\/strong>Before proceeding, read and agree to the <a href=\"https:\/\/ephesoft.com\/docs\/products\/transact\/developers\/#disclaimer\">Developer Disclaimer<\/a>.<\/p>\n<p>To create a custom plugin for Ephesoft Transact, you will need the following installed on your system:<\/p>\n<ul>\n<li><a href=\"https:\/\/www.oracle.com\/java\/technologies\/javase-downloads.html\">Java JDK<\/a><\/li>\n<li><a href=\"https:\/\/maven.apache.org\/download.cgi\">Apache Maven<\/a><\/li>\n<li><a href=\"http:\/\/www.ninite.com\">Eclipse<\/a><\/li>\n<li>Maven<\/li>\n<\/ul>\n<p>To install Maven, perform the following steps:<\/p>\n<ol>\n<li>Open Eclipse.<\/li>\n<li>Go to <strong>Help <\/strong>&gt; <strong>Eclipse Marketplace<\/strong>.<\/li>\n<li>Search \u201cMaven\u201d.<\/li>\n<li>Click <strong>Install <\/strong>on \u201cMaven Integration for Eclipse\u201d.<\/li>\n<li>Follow the installation steps as prompted.<\/li>\n<li>After the installation is complete, go to <strong>Window<\/strong> &gt; <strong>Preferences<\/strong>. You should see Maven listed in the left panel.<\/li>\n<\/ol>\n<h2><a id=\"post-31703-_60529d7aazjp\"><\/a>Create a Custom Plugin<\/h2>\n<h3><a id=\"post-31703-_10jisf7abvhr\"><\/a>Create a New Project<\/h3>\n<ol>\n<li>Open Eclipse.<\/li>\n<li>Click <strong>File<\/strong> &gt; <strong>New.<\/strong><\/li>\n<li>Select <strong>Maven Project<\/strong>.<\/li>\n<\/ol>\n<p><img decoding=\"async\" width=\"975\" height=\"527\" class=\"wp-image-47083\" src=\"https:\/\/ephesoft.com\/docs\/wp-content\/uploads\/2015\/11\/selectmavenproject2.png\" alt=\"SelectMavenProject2\" srcset=\"https:\/\/ephesoft.com\/docs\/wp-content\/uploads\/2015\/11\/selectmavenproject2.png 975w, https:\/\/ephesoft.com\/docs\/wp-content\/uploads\/2015\/11\/selectmavenproject2-300x162.png 300w, https:\/\/ephesoft.com\/docs\/wp-content\/uploads\/2015\/11\/selectmavenproject2-768x415.png 768w\" sizes=\"(max-width: 975px) 100vw, 975px\" \/><\/p>\n<p><em>Figure 1. Create a Maven Project<\/em><\/p>\n<ol start=\"4\">\n<li>Select <strong>Use default Workspace location<\/strong>.<\/li>\n<\/ol>\n<p><img decoding=\"async\" width=\"975\" height=\"527\" class=\"wp-image-47084\" src=\"https:\/\/ephesoft.com\/docs\/wp-content\/uploads\/2015\/11\/defautworkspace-1.png\" alt=\"DefautWorkSpace\" srcset=\"https:\/\/ephesoft.com\/docs\/wp-content\/uploads\/2015\/11\/defautworkspace-1.png 975w, https:\/\/ephesoft.com\/docs\/wp-content\/uploads\/2015\/11\/defautworkspace-1-300x162.png 300w, https:\/\/ephesoft.com\/docs\/wp-content\/uploads\/2015\/11\/defautworkspace-1-768x415.png 768w\" sizes=\"(max-width: 975px) 100vw, 975px\" \/><\/p>\n<p><em>Figure 2. Use Default Workspace Location<\/em><\/p>\n<ol start=\"5\">\n<li>Select the quickstart Maven archetype. The Artifact ID is<strong> maven-archetype-quickstart<\/strong>.<\/li>\n<\/ol>\n<p><img decoding=\"async\" width=\"975\" height=\"527\" class=\"wp-image-47085\" src=\"https:\/\/ephesoft.com\/docs\/wp-content\/uploads\/2015\/11\/quickstartmaven-1.png\" alt=\"QuickStartMaven\" srcset=\"https:\/\/ephesoft.com\/docs\/wp-content\/uploads\/2015\/11\/quickstartmaven-1.png 975w, https:\/\/ephesoft.com\/docs\/wp-content\/uploads\/2015\/11\/quickstartmaven-1-300x162.png 300w, https:\/\/ephesoft.com\/docs\/wp-content\/uploads\/2015\/11\/quickstartmaven-1-768x415.png 768w\" sizes=\"(max-width: 975px) 100vw, 975px\" \/><\/p>\n<p><em>Figure 3. Select Quickstart Maven Archetype<\/em><\/p>\n<ol start=\"6\">\n<li>Enter the Group ID and Artifact ID. The Group ID is the package structure for your project. The Artifact ID will be the name of your project, and the final source folder of your package. More information about the Java specification for package names can be found in this<a href=\"http:\/\/docs.oracle.com\/javase\/specs\/.\"> Oracle article<\/a>.\n<ol type=\"a\">\n<li>Group ID: com.ephesoft.customplugin<\/li>\n<li>Artifact ID: ephesoft-custom-plugin<\/li>\n<\/ol>\n<\/li>\n<\/ol>\n<p><img decoding=\"async\" width=\"975\" height=\"527\" class=\"wp-image-47086\" src=\"https:\/\/ephesoft.com\/docs\/wp-content\/uploads\/2015\/11\/groupidarticatid-1.png\" alt=\"GroupIdArticatId\" srcset=\"https:\/\/ephesoft.com\/docs\/wp-content\/uploads\/2015\/11\/groupidarticatid-1.png 975w, https:\/\/ephesoft.com\/docs\/wp-content\/uploads\/2015\/11\/groupidarticatid-1-300x162.png 300w, https:\/\/ephesoft.com\/docs\/wp-content\/uploads\/2015\/11\/groupidarticatid-1-768x415.png 768w\" sizes=\"(max-width: 975px) 100vw, 975px\" \/><\/p>\n<p><em>Figure 4. Enter Group ID and Artifact ID<\/em><\/p>\n<ol start=\"7\">\n<li>Your Eclipse project workspace should now look like this:<\/li>\n<\/ol>\n<p><img decoding=\"async\" width=\"975\" height=\"527\" class=\"wp-image-47087\" src=\"https:\/\/ephesoft.com\/docs\/wp-content\/uploads\/2015\/11\/mavenprojectworkspace-1.png\" alt=\"MavenProjectWorkspace\" srcset=\"https:\/\/ephesoft.com\/docs\/wp-content\/uploads\/2015\/11\/mavenprojectworkspace-1.png 975w, https:\/\/ephesoft.com\/docs\/wp-content\/uploads\/2015\/11\/mavenprojectworkspace-1-300x162.png 300w, https:\/\/ephesoft.com\/docs\/wp-content\/uploads\/2015\/11\/mavenprojectworkspace-1-768x415.png 768w\" sizes=\"(max-width: 975px) 100vw, 975px\" \/><\/p>\n<p><em>Figure 5. Sample Eclipse Project<\/em><\/p>\n<h3><a id=\"post-31703-_rz161tx5hve4\"><\/a>Add Ephesoft Libraries<\/h3>\n<p>Perform the following steps to add the Ephesoft Libraries to your Eclipse project.<\/p>\n<p><strong>Note:<\/strong> Custom script class files should not be added to any custom JAR files. Adding a custom script class file into any JAR file will cause issues, as the default location for the custom script class file is <em>[Ephesoft_Directory]<\/em>\\JavaAppServer\\temp\\DynamicCodeCompiler.<\/p>\n<ol start=\"8\">\n<li>Open your project folder. Right-click on <strong>ephesoft-custom-plugin<\/strong>.<\/li>\n<li>Select <strong>Build Path <\/strong>&gt; <strong>Configure Build Path<\/strong>.<\/li>\n<li>Select the <strong>Libraries <\/strong>tab.<\/li>\n<li>Click <strong>Add External Jars<\/strong>.<\/li>\n<li>Navigate to <em>[Ephesoft_Directory]<\/em>\\Application\\WEB-INF\\lib.<\/li>\n<li>Select all JAR files.<\/li>\n<li>Click <strong>Open<\/strong>.<\/li>\n<li>Click <strong>OK<\/strong>.<\/li>\n<\/ol>\n<h3><a id=\"post-31703-_ebpu9ox7lw50\"><\/a>Create a New Interface<\/h3>\n<p>Perform the following steps to create a new Java interface for your custom plugin.<\/p>\n<ol start=\"16\">\n<li>Open your package. Right-click on <strong>com.ephesoft.customplugin.ephesoft.custom_plugin<\/strong>.<\/li>\n<li>Select <strong>New <\/strong>&gt; <strong>Interface<\/strong>.<\/li>\n<li>Set the <strong>Name <\/strong>to \u201cCustomPlugin\u201d.<\/li>\n<\/ol>\n<p><img decoding=\"async\" class=\"wp-image-47088\" src=\"https:\/\/ephesoft.com\/docs\/wp-content\/uploads\/2015\/11\/mavennewinterface-1.png\" alt=\"MavenNewInterface\" width=\"493\" height=\"465\" srcset=\"https:\/\/ephesoft.com\/docs\/wp-content\/uploads\/2015\/11\/mavennewinterface-1.png 863w, https:\/\/ephesoft.com\/docs\/wp-content\/uploads\/2015\/11\/mavennewinterface-1-300x283.png 300w, https:\/\/ephesoft.com\/docs\/wp-content\/uploads\/2015\/11\/mavennewinterface-1-768x725.png 768w\" sizes=\"(max-width: 493px) 100vw, 493px\" \/><\/p>\n<p><em>Figure 6. New Java Interface<\/em><\/p>\n<ol start=\"9\">\n<li>Click <strong>Finish<\/strong>.<\/li>\n<li>Replace the file contents with the following code:<\/li>\n<\/ol>\n<pre>package com.ephesoft.customplugin.ephesoft_custom_plugin;\r\nimport com.ephesoft.dcma.core.DCMAException;\r\nimport com.ephesoft.dcma.da.id.BatchInstanceID;\r\npublic interface CustomPlugin \r\n{\r\n    void helloWorld(final BatchInstanceID batchInstanceID, final String pluginWorkflow) throws DCMAException;\r\n}<\/pre>\n<p><img decoding=\"async\" width=\"975\" height=\"527\" class=\"wp-image-47089\" src=\"https:\/\/ephesoft.com\/docs\/wp-content\/uploads\/2015\/11\/mavencustomplugin-1.png\" alt=\"MavenCustomPlugin\" srcset=\"https:\/\/ephesoft.com\/docs\/wp-content\/uploads\/2015\/11\/mavencustomplugin-1.png 975w, https:\/\/ephesoft.com\/docs\/wp-content\/uploads\/2015\/11\/mavencustomplugin-1-300x162.png 300w, https:\/\/ephesoft.com\/docs\/wp-content\/uploads\/2015\/11\/mavencustomplugin-1-768x415.png 768w\" sizes=\"(max-width: 975px) 100vw, 975px\" \/><\/p>\n<p><em>Figure 7. Replace File Contents<\/em><\/p>\n<h3><a id=\"post-31703-_lzp3mwt2hnil\"><\/a>Create a Java Class<\/h3>\n<p>Perform the following steps to create a Java class to implement the CustomPlugin interface.<\/p>\n<ol start=\"21\">\n<li>Open your package. Right-click on <strong>com.ephesoft.customplugin.ephesoft.custom_plugin<\/strong>.<\/li>\n<li>Click <strong>New <\/strong>&gt; <strong>Class<\/strong>.<\/li>\n<li>Set the <strong>Name <\/strong>to \u201cCustomePluginImpl\u201d.<\/li>\n<\/ol>\n<p><img decoding=\"async\" class=\"wp-image-47090\" src=\"https:\/\/ephesoft.com\/docs\/wp-content\/uploads\/2015\/11\/mavencustompluginimpl-1.png\" alt=\"MavenCustomPluginImpl\" width=\"512\" height=\"602\" srcset=\"https:\/\/ephesoft.com\/docs\/wp-content\/uploads\/2015\/11\/mavencustompluginimpl-1.png 852w, https:\/\/ephesoft.com\/docs\/wp-content\/uploads\/2015\/11\/mavencustompluginimpl-1-255x300.png 255w, https:\/\/ephesoft.com\/docs\/wp-content\/uploads\/2015\/11\/mavencustompluginimpl-1-768x903.png 768w\" sizes=\"(max-width: 512px) 100vw, 512px\" \/><\/p>\n<p><em>Figure 8. New Java Class<\/em><\/p>\n<ol start=\"24\">\n<li>Click <strong>Finish<\/strong>.<\/li>\n<li>Replace the file contents with the following code:<\/li>\n<\/ol>\n<pre>package com.ephesoft.customplugin.ephesoft_custom_plugin;\r\nimport org.springframework.util.Assert;\r\nimport com.ephesoft.dcma.core.DCMAException;\r\nimport com.ephesoft.dcma.core.annotation.PostProcess;\r\nimport com.ephesoft.dcma.core.annotation.PreProcess;\r\nimport com.ephesoft.dcma.core.component.ICommonConstants;\r\nimport com.ephesoft.dcma.da.id.BatchInstanceID;\r\nimport com.ephesoft.dcma.da.service.BatchClassPluginConfigService;\r\nimport com.ephesoft.dcma.util.BackUpFileService;\r\npublic class CustomPluginImpl implements CustomPlugin, ICommonConstants {\r\n    private BatchClassPluginConfigService batchClassPluginConfigService;\r\n    @PreProcess\r\n    public void preProcess(final BatchInstanceID batchInstanceID, String pluginWorkflow) {\r\n        Assert.notNull(batchInstanceID);\r\n        BackUpFileService.backUpBatch(batchInstanceID.getID());\r\n    }\r\n    @PostProcess\r\n    public void postProcess(final BatchInstanceID batchInstanceID, String pluginWorkflow) {\r\n        Assert.notNull(batchInstanceID);\r\n    }\r\n    public void helloWorld(BatchInstanceID batchInstanceID, String pluginWorkflow) throws DCMAException {\r\n        \/\/TODO Auto-generated method stub\r\n        String name = \"\";\r\n        String propertyName = \"app.name\";\r\n        name = batchClassPluginConfigService.getPluginPropertiesForBatch(batchInstanceID.getID(), \"EPHESOFT_CUSTOM_PLUGIN\").get(propertyName);\r\n        System.out.println(\"**** Ephesoft Custom Plugin: Hello \" + name + \" \" + batchInstanceID.getID() + \" *****\");\r\n    }\r\n    public BatchClassPluginConfigService getBatchClassPluginService() {\r\n        return batchClassPluginConfigService;\r\n    }\r\n    public void setBatchClassPluginConfigService(BatchClassPluginConfigService batchClassPluginConfigService) {\r\n        this.batchClassPluginConfigService = batchClassPluginConfigService;\r\n    }<\/pre>\n<p><img decoding=\"async\" width=\"983\" height=\"469\" class=\"wp-image-47091\" src=\"https:\/\/ephesoft.com\/docs\/wp-content\/uploads\/2015\/11\/mavencustompluginimplcode-1.png\" alt=\"MavenCustomPluginImplCode\" srcset=\"https:\/\/ephesoft.com\/docs\/wp-content\/uploads\/2015\/11\/mavencustompluginimplcode-1.png 983w, https:\/\/ephesoft.com\/docs\/wp-content\/uploads\/2015\/11\/mavencustompluginimplcode-1-300x143.png 300w, https:\/\/ephesoft.com\/docs\/wp-content\/uploads\/2015\/11\/mavencustompluginimplcode-1-768x366.png 768w\" sizes=\"(max-width: 983px) 100vw, 983px\" \/><\/p>\n<p><em>Figure 9. Replace File Contents<\/em><\/p>\n<h3><a id=\"post-31703-_y7o97zp6yhky\"><\/a>Create Folder Structure for XML Resources<\/h3>\n<p>Perform the following steps to create a folder structure for your XML resources.<\/p>\n<ol start=\"26\">\n<li>Right-click on your project in the <strong>Project Explorer<\/strong>.<\/li>\n<li>Click <strong>New <\/strong>&gt; <strong>Source Folder<\/strong>.<\/li>\n<li>Set the <strong>Folder Name <\/strong>to \u201csrc\/main\/resources\u201d.<\/li>\n<\/ol>\n<p><img decoding=\"async\" width=\"975\" height=\"528\" class=\"wp-image-47092\" src=\"https:\/\/ephesoft.com\/docs\/wp-content\/uploads\/2015\/11\/mavensrcxml-1.png\" alt=\"MavenSRCXML\" srcset=\"https:\/\/ephesoft.com\/docs\/wp-content\/uploads\/2015\/11\/mavensrcxml-1.png 975w, https:\/\/ephesoft.com\/docs\/wp-content\/uploads\/2015\/11\/mavensrcxml-1-300x162.png 300w, https:\/\/ephesoft.com\/docs\/wp-content\/uploads\/2015\/11\/mavensrcxml-1-768x416.png 768w\" sizes=\"(max-width: 975px) 100vw, 975px\" \/><\/p>\n<p><em>Figure 10. New Source Folder<\/em><\/p>\n<ol start=\"29\">\n<li>Click <strong>Finish<\/strong>.<\/li>\n<li>Create a META-INF folder:\n<ol type=\"a\">\n<li>In the project folder you just created, right-click <strong>src\/main\/resources<\/strong>.<\/li>\n<li>Click <strong>New <\/strong>&gt; <strong>Folder<\/strong>.<\/li>\n<li>Set the <strong>Folder Name <\/strong>to \u201cMETA-INF\u201d.<\/li>\n<li>Click <strong>Finish<\/strong>.<\/li>\n<\/ol>\n<\/li>\n<li>Create a subfolder under META-INF.\n<ol type=\"a\">\n<li>Right-click the <strong>META-INF <\/strong>folder.<\/li>\n<li>Select <strong>New <\/strong>&gt; <strong>Folder<\/strong>.<\/li>\n<li>Set the <strong>Folder Name <\/strong>to \u201cephesoft-custom-plugin\u201d (or the name of your project, if different).<\/li>\n<li>Click <strong>Finish<\/strong>.<\/li>\n<\/ol>\n<\/li>\n<\/ol>\n<h3><a id=\"post-31703-_rhxry8yeljor\"><\/a>Create XML Files<\/h3>\n<p>Perform the following steps to create the XML resources.<\/p>\n<h4><a id=\"post-31703-_8pnhrucb30d4\"><\/a>ephesoft-custom-plugin.xml<\/h4>\n<ol start=\"32\">\n<li>Right-click on <strong>src\/main\/resources<\/strong>.<\/li>\n<li>Select <strong>New <\/strong>&gt; <strong>XML File<\/strong>.<\/li>\n<\/ol>\n<p><strong>Note: <\/strong>If \u201cXML File\u201d is not available, click <strong>Other <\/strong>and search for \u201cXML File\u201d.<\/p>\n<ol start=\"34\">\n<li>Set the <strong>Name <\/strong>to \u201cephesoft-custom-plugin.xml\u201d (or the name of your project, if different).<\/li>\n<li>Click <strong>Finish<\/strong>. You can now add elements, attributes, entities, and notations to the XML file.<\/li>\n<li>Add the following content to the XML file:<\/li>\n<\/ol>\n<pre class=\" language-markup\"><code class=\" language-markup\"><span class=\"token prolog\">&lt;?xml version=\"1.0\" encoding=\"UTF-8\"?&gt;<\/span>\r\n<span class=\"token tag\"><span class=\"token punctuation\">&lt;<\/span>plugin<span class=\"token punctuation\">&gt;<\/span><\/span>\r\n  <span class=\"token tag\"><span class=\"token punctuation\">&lt;<\/span>jar-name<span class=\"token punctuation\">&gt;<\/span><\/span>ephesoft-custom-plugin.jar<span class=\"token tag\"><span class=\"token punctuation\">&lt;\/<\/span>jar-name<span class=\"token punctuation\">&gt;<\/span><\/span>\r\n  <span class=\"token tag\"><span class=\"token punctuation\">&lt;<\/span>plugin-name<span class=\"token punctuation\">&gt;<\/span><\/span>EPHESOFT_CUSTOM_PLUGIN<span class=\"token tag\"><span class=\"token punctuation\">&lt;\/<\/span>plugin-name<span class=\"token punctuation\">&gt;<\/span><\/span>\r\n  <span class=\"token tag\"><span class=\"token punctuation\">&lt;<\/span>plugin-desc<span class=\"token punctuation\">&gt;<\/span><\/span>Ephesoft Custom Plugin<span class=\"token tag\"><span class=\"token punctuation\">&lt;\/<\/span>plugin-desc<span class=\"token punctuation\">&gt;<\/span><\/span>\r\n  <span class=\"token tag\"><span class=\"token punctuation\">&lt;<\/span>plugin-workflow-name<span class=\"token punctuation\">&gt;<\/span><\/span>CUSTOM_PLUGIN<span class=\"token tag\"><span class=\"token punctuation\">&lt;\/<\/span>plugin-workflow-name<span class=\"token punctuation\">&gt;<\/span><\/span>\r\n  <span class=\"token tag\"><span class=\"token punctuation\">&lt;<\/span>plugin-service-instance<span class=\"token punctuation\">&gt;<\/span><\/span>CustomPlugin<span class=\"token tag\"><span class=\"token punctuation\">&lt;\/<\/span>plugin-service-instance<span class=\"token punctuation\">&gt;<\/span><\/span>\r\n  <span class=\"token tag\"><span class=\"token punctuation\">&lt;<\/span>method-name<span class=\"token punctuation\">&gt;<\/span><\/span>helloWorld<span class=\"token tag\"><span class=\"token punctuation\">&lt;\/<\/span>method-name<span class=\"token punctuation\">&gt;<\/span><\/span>\r\n  <span class=\"token tag\"><span class=\"token punctuation\">&lt;<\/span>is-scripting<span class=\"token punctuation\">&gt;<\/span><\/span>FALSE<span class=\"token tag\"><span class=\"token punctuation\">&lt;\/<\/span>is-scripting<span class=\"token punctuation\">&gt;<\/span><\/span>\r\n  <span class=\"token tag\"><span class=\"token punctuation\">&lt;<\/span>back-up-file-name<span class=\"token punctuation\">&gt;<\/span><\/span>EphesoftCustomPlugin<span class=\"token tag\"><span class=\"token punctuation\">&lt;\/<\/span>back-up-file-name<span class=\"token punctuation\">&gt;<\/span><\/span>\r\n  <span class=\"token tag\"><span class=\"token punctuation\">&lt;<\/span>script-name<span class=\"token punctuation\">&gt;<\/span><\/span>N\/A<span class=\"token tag\"><span class=\"token punctuation\">&lt;\/<\/span>script-name<span class=\"token punctuation\">&gt;<\/span><\/span>\r\n  <span class=\"token tag\"><span class=\"token punctuation\">&lt;<\/span>application-context-path<span class=\"token punctuation\">&gt;<\/span><\/span>applicationContext-ephesoft-custom-plugin.xml<span class=\"token tag\"><span class=\"token punctuation\">&lt;\/<\/span>application-context-path<span class=\"token punctuation\">&gt;<\/span><\/span>\r\n  <span class=\"token tag\"><span class=\"token punctuation\">&lt;<\/span>plugin-properties<span class=\"token punctuation\">&gt;<\/span><\/span>\r\n    <span class=\"token tag\"><span class=\"token punctuation\">&lt;<\/span>plugin-property<span class=\"token punctuation\">&gt;<\/span><\/span>\r\n      <span class=\"token tag\"><span class=\"token punctuation\">&lt;<\/span>name<span class=\"token punctuation\">&gt;<\/span><\/span>app.name<span class=\"token tag\"><span class=\"token punctuation\">&lt;\/<\/span>name<span class=\"token punctuation\">&gt;<\/span><\/span>\r\n      <span class=\"token tag\"><span class=\"token punctuation\">&lt;<\/span>type<span class=\"token punctuation\">&gt;<\/span><\/span>STRING<span class=\"token tag\"><span class=\"token punctuation\">&lt;\/<\/span>type<span class=\"token punctuation\">&gt;<\/span><\/span>\r\n      <span class=\"token tag\"><span class=\"token punctuation\">&lt;<\/span>description<span class=\"token punctuation\">&gt;<\/span><\/span>Name<span class=\"token tag\"><span class=\"token punctuation\">&lt;\/<\/span>description<span class=\"token punctuation\">&gt;<\/span><\/span>\r\n      <span class=\"token tag\"><span class=\"token punctuation\">&lt;<\/span>is-mandatory<span class=\"token punctuation\">&gt;<\/span><\/span>FALSE<span class=\"token tag\"><span class=\"token punctuation\">&lt;\/<\/span>is-mandatory<span class=\"token punctuation\">&gt;<\/span><\/span>\r\n      <span class=\"token tag\"><span class=\"token punctuation\">&lt;<\/span>is-multivalue<span class=\"token punctuation\">&gt;<\/span><\/span>FALSE<span class=\"token tag\"><span class=\"token punctuation\">&lt;\/<\/span>is-multivalue<span class=\"token punctuation\">&gt;<\/span><\/span>\r\n    <span class=\"token tag\"><span class=\"token punctuation\">&lt;\/<\/span>plugin-property<span class=\"token punctuation\">&gt;<\/span><\/span>\r\n  <span class=\"token tag\"><span class=\"token punctuation\">&lt;\/<\/span>plugin-properties<span class=\"token punctuation\">&gt;<\/span><\/span>\r\n  <span class=\"token tag\"><span class=\"token punctuation\">&lt;<\/span>dependencies<span class=\"token punctuation\">&gt;<\/span><\/span>\r\n<span class=\"token tag\"><span class=\"token punctuation\">&lt;\/<\/span>dependencies<span class=\"token punctuation\">&gt;<\/span><\/span>\r\n<span class=\"token tag\"><span class=\"token punctuation\">&lt;\/<\/span>plugin<span class=\"token punctuation\">&gt;<\/span><\/span><\/code><\/pre>\n<ol start=\"37\">\n<li>Configure the XML file. Refer to the following table for more information on configurable elements.:<\/li>\n<\/ol>\n<table>\n<tbody>\n<tr>\n<td><strong>Element<\/strong><\/td>\n<td><strong>Description<\/strong><\/td>\n<\/tr>\n<tr>\n<td>jar-name<\/td>\n<td>Name of the JAR file containing your plugin code. This should be <strong><em>&lt;name of the project&gt;<\/em><\/strong>.jar<\/td>\n<\/tr>\n<tr>\n<td>plugin-name<\/td>\n<td>Name of the plugin that will show in the workflow. In the CustomPluginImpl.java class, we used the name \u201cEPHESOFT_CUSTOM_PLUGIN\u201d.<\/td>\n<\/tr>\n<tr>\n<td>plugin-service-instance<\/td>\n<td>Name of the bean identifier we will reference in the <strong>applicationContext.xml<\/strong>.<\/td>\n<\/tr>\n<tr>\n<td>method-name<\/td>\n<td>Name of the method that will be first called when the plugin executes in the workflow.<\/td>\n<\/tr>\n<tr>\n<td>plugin-properties<\/td>\n<td>Defines the properties of the plugin that will be configured in the UI. In the CustomPlugin.java class, we called on one property\u2014\u201dapp.name\u201d.<\/td>\n<\/tr>\n<\/tbody>\n<\/table>\n<p><img decoding=\"async\" width=\"975\" height=\"528\" class=\"wp-image-47093\" src=\"https:\/\/ephesoft.com\/docs\/wp-content\/uploads\/2015\/11\/mavenprojectname-1.png\" alt=\"MavenprojectName\" srcset=\"https:\/\/ephesoft.com\/docs\/wp-content\/uploads\/2015\/11\/mavenprojectname-1.png 975w, https:\/\/ephesoft.com\/docs\/wp-content\/uploads\/2015\/11\/mavenprojectname-1-300x162.png 300w, https:\/\/ephesoft.com\/docs\/wp-content\/uploads\/2015\/11\/mavenprojectname-1-768x416.png 768w\" sizes=\"(max-width: 975px) 100vw, 975px\" \/><\/p>\n<p><em>Figure 11. Edit XML File<\/em><\/p>\n<h4><a id=\"post-31703-_6vosqwi79xhq\"><\/a>applicationContext-ephesoft-custom-plugin.xml<\/h4>\n<ol start=\"38\">\n<li>Right-click on the <strong>META-INF<\/strong> folder you created.<\/li>\n<li>Select <strong>New <\/strong>&gt; <strong>XML File<\/strong>.<\/li>\n<li>Set the <strong>Name <\/strong>to \u201capplicationContext-<strong><em>&lt;name of your project&gt;<\/em><\/strong>.xml\u201d. For example \u201capplicationContext-ephesoft-custom-plugin.xml\u201d.<\/li>\n<li>Click <strong>Finish<\/strong>.<\/li>\n<li>Add the following content to the XML file:<\/li>\n<\/ol>\n<pre class=\" language-markup\"><code class=\" language-markup\"><span class=\"token prolog\">&lt;?xml version=\"1.0\" encoding=\"UTF-8\"?&gt;<\/span>\r\n<span class=\"token tag\"><span class=\"token punctuation\">&lt;<\/span>beans <span class=\"token attr-name\">xmlns<\/span><span class=\"token attr-value\"><span class=\"token punctuation\">=<\/span><span class=\"token punctuation\">\"<\/span>http:\/\/www.springframework.org\/schema\/beans<span class=\"token punctuation\">\"<\/span><\/span> <span class=\"token attr-name\"><span class=\"token namespace\">xmlns:<\/span>tx<\/span><span class=\"token attr-value\"><span class=\"token punctuation\">=<\/span><span class=\"token punctuation\">\"<\/span>http:\/\/www.springframework.org\/schema\/tx<span class=\"token punctuation\">\"<\/span><\/span> <span class=\"token attr-name\"><span class=\"token namespace\">xmlns:<\/span>p<\/span><span class=\"token attr-value\"><span class=\"token punctuation\">=<\/span><span class=\"token punctuation\">\"<\/span>http:\/\/www.springframework.org\/schema\/p<span class=\"token punctuation\">\"<\/span><\/span> <span class=\"token attr-name\"><span class=\"token namespace\">xmlns:<\/span>util<\/span><span class=\"token attr-value\"><span class=\"token punctuation\">=<\/span><span class=\"token punctuation\">\"<\/span>http:\/\/www.springframework.org\/schema\/util<span class=\"token punctuation\">\"<\/span><\/span> <span class=\"token attr-name\"><span class=\"token namespace\">xmlns:<\/span>xsi<\/span><span class=\"token attr-value\"><span class=\"token punctuation\">=<\/span><span class=\"token punctuation\">\"<\/span>http:\/\/www.w3.org\/2001\/XMLSchema-instance<span class=\"token punctuation\">\"<\/span><\/span> <span class=\"token attr-name\"><span class=\"token namespace\">xmlns:<\/span>aop<\/span><span class=\"token attr-value\"><span class=\"token punctuation\">=<\/span><span class=\"token punctuation\">\"<\/span>http:\/\/www.springframework.org\/schema\/aop<span class=\"token punctuation\">\"<\/span><\/span> <span class=\"token attr-name\"><span class=\"token namespace\">xmlns:<\/span>context<\/span><span class=\"token attr-value\"><span class=\"token punctuation\">=<\/span><span class=\"token punctuation\">\"<\/span>http:\/\/www.springframework.org\/schema\/context<span class=\"token punctuation\">\"<\/span><\/span> <span class=\"token attr-name\">xsi:schemaLocation<\/span><span class=\"token attr-value\"><span class=\"token punctuation\">=<\/span><span class=\"token punctuation\">\"<\/span>http:\/\/www.springframework.org\/schema\/beans http:\/\/www.springframework.org\/schema\/beans\/spring-beans-3.0.xsd http:\/\/www.springframework.org\/schema\/util http:\/\/www.springframework.org\/schema\/util\/spring-util-3.0.xsd http:\/\/www.springframework.org\/schema\/context http:\/\/www.springframework.org\/schema\/context\/spring-context-3.0.xsd http:\/\/www.springframework.org\/schema\/aop http:\/\/www.springframework.org\/schema\/aop\/spring-aop-3.0.xsd http:\/\/www.springframework.org\/schema\/tx http:\/\/www.springframework.org\/schema\/tx\/spring-tx-3.0.xsd<span class=\"token punctuation\">\"<\/span><\/span> <span class=\"token attr-name\">default-autowire<\/span><span class=\"token attr-value\"><span class=\"token punctuation\">=<\/span><span class=\"token punctuation\">\"<\/span>byName<span class=\"token punctuation\">\"<\/span><\/span><span class=\"token punctuation\">&gt;<\/span><\/span>\r\n  <span class=\"token tag\"><span class=\"token punctuation\">&lt;<\/span>import <span class=\"token attr-name\">resource<\/span><span class=\"token attr-value\"><span class=\"token punctuation\">=<\/span><span class=\"token punctuation\">\"<\/span>classpath:\/META-INF\/ephesoft-custom-plugin\/applicationContext.xml<span class=\"token punctuation\">\"<\/span><\/span><span class=\"token punctuation\">\/&gt;<\/span><\/span>\r\n<span class=\"token tag\"><span class=\"token punctuation\">&lt;\/<\/span>beans<span class=\"token punctuation\">&gt;<\/span><\/span><\/code><\/pre>\n<p><img decoding=\"async\" width=\"975\" height=\"528\" class=\"wp-image-47094\" src=\"https:\/\/ephesoft.com\/docs\/wp-content\/uploads\/2015\/11\/mavenapplicationcontextprojectname-1.png\" alt=\"MavenApplicationContextProjectName\" srcset=\"https:\/\/ephesoft.com\/docs\/wp-content\/uploads\/2015\/11\/mavenapplicationcontextprojectname-1.png 975w, https:\/\/ephesoft.com\/docs\/wp-content\/uploads\/2015\/11\/mavenapplicationcontextprojectname-1-300x162.png 300w, https:\/\/ephesoft.com\/docs\/wp-content\/uploads\/2015\/11\/mavenapplicationcontextprojectname-1-768x416.png 768w\" sizes=\"(max-width: 975px) 100vw, 975px\" \/><\/p>\n<p><em>Figure 12. applicationContext.xml File<\/em><\/p>\n<h4><a id=\"post-31703-_qev8k33z2uv7\"><\/a>applicationContext.xml<\/h4>\n<ol start=\"43\">\n<li>Right-click on the META-INF subfolder <strong>ephesoft-custom-plugin<\/strong> (or the name of your project, if different).<\/li>\n<li>Select <strong>New <\/strong>&gt; <strong>XML File<\/strong>.<\/li>\n<li>Name the file \u201capplicationContext.xml\u201d.<\/li>\n<li>Click <strong>Finish<\/strong>.<\/li>\n<li>Add the following content to the XML file:<\/li>\n<\/ol>\n<pre class=\" language-markup\"><code class=\" language-markup\"><span class=\"token prolog\">&lt;?xml version=\"1.0\" encoding=\"UTF-8\"?&gt;<\/span>\r\n<span class=\"token tag\"><span class=\"token punctuation\">&lt;<\/span>beans <span class=\"token attr-name\"><span class=\"token namespace\">xsi:<\/span>schemaLocation<\/span><span class=\"token attr-value\"><span class=\"token punctuation\">=<\/span><span class=\"token punctuation\">\"<\/span>http:\/\/www.springframework.org\/schema\/beans http:\/\/www.springframework.org\/schema\/beans\/spring-beans-3.0.xsd http:\/\/www.springframework.org\/schema\/util http:\/\/www.springframework.org\/schema\/util\/spring-util-3.0.xsd http:\/\/www.springframework.org\/schema\/context http:\/\/www.springframework.org\/schema\/context\/spring-context-3.0.xsd http:\/\/www.springframework.org\/schema\/aop http:\/\/www.springframework.org\/schema\/aop\/spring-aop-3.0.xsd http:\/\/www.springframework.org\/schema\/tx http:\/\/www.springframework.org\/schema\/tx\/spring-tx-3.0.xsd<span class=\"token punctuation\">\"<\/span><\/span> <span class=\"token attr-name\">default-autowire<\/span><span class=\"token attr-value\"><span class=\"token punctuation\">=<\/span><span class=\"token punctuation\">\"<\/span>byName<span class=\"token punctuation\">\"<\/span><\/span><span class=\"token punctuation\">&gt;<\/span><\/span>\r\n  <span class=\"token tag\"><span class=\"token punctuation\">&lt;<\/span>import <span class=\"token attr-name\">resource<\/span><span class=\"token attr-value\"><span class=\"token punctuation\">=<\/span><span class=\"token punctuation\">\"<\/span>classpath:\/META-INF\/applicationContext-data-access.xml<span class=\"token punctuation\">\"<\/span><\/span><span class=\"token punctuation\">\/&gt;<\/span><\/span>\r\n  <span class=\"token tag\"><span class=\"token punctuation\">&lt;<\/span>import <span class=\"token attr-name\">resource<\/span><span class=\"token attr-value\"><span class=\"token punctuation\">=<\/span><span class=\"token punctuation\">\"<\/span>classpath:\/META-INF\/applicationContext-batch.xml<span class=\"token punctuation\">\"<\/span><\/span><span class=\"token punctuation\">\/&gt;<\/span><\/span>\r\n  <span class=\"token tag\"><span class=\"token punctuation\">&lt;<\/span>import <span class=\"token attr-name\">resource<\/span><span class=\"token attr-value\"><span class=\"token punctuation\">=<\/span><span class=\"token punctuation\">\"<\/span>classpath:\/META-INF\/applicationContext-core.xml<span class=\"token punctuation\">\"<\/span><\/span><span class=\"token punctuation\">\/&gt;<\/span><\/span>\r\n  <span class=\"token tag\"><span class=\"token punctuation\">&lt;<\/span>bean <span class=\"token attr-name\">id<\/span><span class=\"token attr-value\"><span class=\"token punctuation\">=<\/span><span class=\"token punctuation\">\"<\/span>CustomPlugin<span class=\"token punctuation\">\"<\/span><\/span> <span class=\"token attr-name\">class<\/span><span class=\"token attr-value\"><span class=\"token punctuation\">=<\/span><span class=\"token punctuation\">\"<\/span>com.ephesoft.customplugin.ephesoft_custom_plugin.CustomPluginImpl<span class=\"token punctuation\">\"<\/span><\/span><span class=\"token punctuation\">&gt;<\/span><\/span>\r\n    <span class=\"token tag\"><span class=\"token punctuation\">&lt;<\/span>property <span class=\"token attr-name\">name<\/span><span class=\"token attr-value\"><span class=\"token punctuation\">=<\/span><span class=\"token punctuation\">\"<\/span>batchClassPluginConfigService<span class=\"token punctuation\">\"<\/span><\/span> <span class=\"token attr-name\">ref<\/span><span class=\"token attr-value\"><span class=\"token punctuation\">=<\/span><span class=\"token punctuation\">\"<\/span>batchClassPluginConfigService<span class=\"token punctuation\">\"<\/span><\/span><span class=\"token punctuation\">\/&gt;<\/span><\/span>\r\n  <span class=\"token tag\"><span class=\"token punctuation\">&lt;\/<\/span>bean<span class=\"token punctuation\">&gt;<\/span><\/span>\r\n  <span class=\"token tag\"><span class=\"token punctuation\">&lt;<\/span><span class=\"token namespace\">context:<\/span>component-scan <span class=\"token attr-name\">base-package<\/span><span class=\"token attr-value\"><span class=\"token punctuation\">=<\/span><span class=\"token punctuation\">\"<\/span>com.ephesoft.customplugin.ephesoft_custom_plugin<span class=\"token punctuation\">\"<\/span><\/span><span class=\"token punctuation\">\/&gt;<\/span><\/span>\r\n<span class=\"token tag\"><span class=\"token punctuation\">&lt;\/<\/span>beans<span class=\"token punctuation\">&gt;<\/span><\/span><\/code><\/pre>\n<p>You should have a folder structure that looks like the following:<\/p>\n<p><img decoding=\"async\" width=\"300\" height=\"99\" class=\"wp-image-47095\" src=\"https:\/\/ephesoft.com\/docs\/wp-content\/uploads\/2015\/11\/mavenfolderstructure2-1.png\" alt=\"MavenFolderStructure2\" \/><\/p>\n<p><em>Figure 13. Folder Structure<\/em><\/p>\n<h4><a id=\"post-31703-_tlllfu8xs9dz\"><\/a>pom.xml<\/h4>\n<ol start=\"48\">\n<li>Locate the <strong>pom.xml <\/strong>under your project. It should already exist.<\/li>\n<li>Replace the contents of the <strong>pom.xml<\/strong> with the following:<\/li>\n<\/ol>\n<pre class=\" language-markup\"><code class=\" language-markup\"><span class=\"token prolog\">&lt;?xml version=\"1.0\"?&gt;<\/span>\r\n<span class=\"token tag\"><span class=\"token punctuation\">&lt;<\/span>project <span class=\"token attr-name\"><span class=\"token namespace\">xsi:<\/span>schemaLocation<\/span><span class=\"token attr-value\"><span class=\"token punctuation\">=<\/span><span class=\"token punctuation\">\"<\/span>http:\/\/maven.apache.org\/POM\/4.0.0 http:\/\/maven.apache.org\/xsd\/maven-4.0.0.xsd<span class=\"token punctuation\">\"<\/span><\/span><span class=\"token punctuation\">&gt;<\/span><\/span>\r\n  <span class=\"token tag\"><span class=\"token punctuation\">&lt;<\/span>modelVersion<span class=\"token punctuation\">&gt;<\/span><\/span>4.0.0<span class=\"token tag\"><span class=\"token punctuation\">&lt;\/<\/span>modelVersion<span class=\"token punctuation\">&gt;<\/span><\/span>\r\n  <span class=\"token tag\"><span class=\"token punctuation\">&lt;<\/span>groupId<span class=\"token punctuation\">&gt;<\/span><\/span>com.ephesoft.customplugin<span class=\"token tag\"><span class=\"token punctuation\">&lt;\/<\/span>groupId<span class=\"token punctuation\">&gt;<\/span><\/span>\r\n  <span class=\"token tag\"><span class=\"token punctuation\">&lt;<\/span>artifactId<span class=\"token punctuation\">&gt;<\/span><\/span>ephesoft-custom-plugin<span class=\"token tag\"><span class=\"token punctuation\">&lt;\/<\/span>artifactId<span class=\"token punctuation\">&gt;<\/span><\/span>\r\n  <span class=\"token tag\"><span class=\"token punctuation\">&lt;<\/span>version<span class=\"token punctuation\">&gt;<\/span><\/span>0.0.1-SNAPSHOT<span class=\"token tag\"><span class=\"token punctuation\">&lt;\/<\/span>version<span class=\"token punctuation\">&gt;<\/span><\/span>\r\n  <span class=\"token tag\"><span class=\"token punctuation\">&lt;<\/span>packaging<span class=\"token punctuation\">&gt;<\/span><\/span>jar<span class=\"token tag\"><span class=\"token punctuation\">&lt;\/<\/span>packaging<span class=\"token punctuation\">&gt;<\/span><\/span>\r\n  <span class=\"token tag\"><span class=\"token punctuation\">&lt;<\/span>name<span class=\"token punctuation\">&gt;<\/span><\/span>ephesoft-custom-plugin<span class=\"token tag\"><span class=\"token punctuation\">&lt;\/<\/span>name<span class=\"token punctuation\">&gt;<\/span><\/span>\r\n  <span class=\"token tag\"><span class=\"token punctuation\">&lt;<\/span>url<span class=\"token punctuation\">&gt;<\/span><\/span>http:\/\/maven.apache.org<span class=\"token tag\"><span class=\"token punctuation\">&lt;\/<\/span>url<span class=\"token punctuation\">&gt;<\/span><\/span>\r\n  <span class=\"token tag\"><span class=\"token punctuation\">&lt;<\/span>properties<span class=\"token punctuation\">&gt;<\/span><\/span>\r\n    &lt;project.build.sourceEncoding&gt;UTF-8&lt;\/project.build.sourceEncoding&gt;\r\n  <span class=\"token tag\"><span class=\"token punctuation\">&lt;\/<\/span>properties<span class=\"token punctuation\">&gt;<\/span><\/span>\r\n  <span class=\"token tag\"><span class=\"token punctuation\">&lt;<\/span>dependencies<span class=\"token punctuation\">&gt;<\/span><\/span>\r\n    <span class=\"token tag\"><span class=\"token punctuation\">&lt;<\/span>dependency<span class=\"token punctuation\">&gt;<\/span><\/span>\r\n      <span class=\"token tag\"><span class=\"token punctuation\">&lt;<\/span>groupId<span class=\"token punctuation\">&gt;<\/span><\/span>com.ephesoft.dcma<span class=\"token tag\"><span class=\"token punctuation\">&lt;\/<\/span>groupId<span class=\"token punctuation\">&gt;<\/span><\/span>\r\n      <span class=\"token tag\"><span class=\"token punctuation\">&lt;<\/span>artifactId<span class=\"token punctuation\">&gt;<\/span><\/span>dcma-core<span class=\"token tag\"><span class=\"token punctuation\">&lt;\/<\/span>artifactId<span class=\"token punctuation\">&gt;<\/span><\/span>\r\n      <span class=\"token tag\"><span class=\"token punctuation\">&lt;<\/span>version<span class=\"token punctuation\">&gt;<\/span><\/span>0.0.1<span class=\"token tag\"><span class=\"token punctuation\">&lt;\/<\/span>version<span class=\"token punctuation\">&gt;<\/span><\/span>\r\n      <span class=\"token tag\"><span class=\"token punctuation\">&lt;<\/span>scope<span class=\"token punctuation\">&gt;<\/span><\/span>system<span class=\"token tag\"><span class=\"token punctuation\">&lt;\/<\/span>scope<span class=\"token punctuation\">&gt;<\/span><\/span>\r\n      <span class=\"token tag\"><span class=\"token punctuation\">&lt;<\/span>systemPath<span class=\"token punctuation\">&gt;<\/span><\/span>${project.basedir}\/src\/main\/resources\/ephesoft.jar<span class=\"token tag\"><span class=\"token punctuation\">&lt;\/<\/span>systemPath<span class=\"token punctuation\">&gt;<\/span><\/span>\r\n    <span class=\"token tag\"><span class=\"token punctuation\">&lt;\/<\/span>dependency<span class=\"token punctuation\">&gt;<\/span><\/span>\r\n    <span class=\"token tag\"><span class=\"token punctuation\">&lt;<\/span>dependency<span class=\"token punctuation\">&gt;<\/span><\/span>\r\n      <span class=\"token tag\"><span class=\"token punctuation\">&lt;<\/span>groupId<span class=\"token punctuation\">&gt;<\/span><\/span>org.springframework<span class=\"token tag\"><span class=\"token punctuation\">&lt;\/<\/span>groupId<span class=\"token punctuation\">&gt;<\/span><\/span>\r\n      <span class=\"token tag\"><span class=\"token punctuation\">&lt;<\/span>artifactId<span class=\"token punctuation\">&gt;<\/span><\/span>spring-core<span class=\"token tag\"><span class=\"token punctuation\">&lt;\/<\/span>artifactId<span class=\"token punctuation\">&gt;<\/span><\/span>\r\n      <span class=\"token tag\"><span class=\"token punctuation\">&lt;<\/span>version<span class=\"token punctuation\">&gt;<\/span><\/span>3.0.5.RELEASE<span class=\"token tag\"><span class=\"token punctuation\">&lt;\/<\/span>version<span class=\"token punctuation\">&gt;<\/span><\/span>\r\n    <span class=\"token tag\"><span class=\"token punctuation\">&lt;\/<\/span>dependency<span class=\"token punctuation\">&gt;<\/span><\/span>\r\n    <span class=\"token tag\"><span class=\"token punctuation\">&lt;<\/span>dependency<span class=\"token punctuation\">&gt;<\/span><\/span>\r\n      <span class=\"token tag\"><span class=\"token punctuation\">&lt;<\/span>groupId<span class=\"token punctuation\">&gt;<\/span><\/span>junit<span class=\"token tag\"><span class=\"token punctuation\">&lt;\/<\/span>groupId<span class=\"token punctuation\">&gt;<\/span><\/span>\r\n      <span class=\"token tag\"><span class=\"token punctuation\">&lt;<\/span>artifactId<span class=\"token punctuation\">&gt;<\/span><\/span>junit<span class=\"token tag\"><span class=\"token punctuation\">&lt;\/<\/span>artifactId<span class=\"token punctuation\">&gt;<\/span><\/span>\r\n      <span class=\"token tag\"><span class=\"token punctuation\">&lt;<\/span>version<span class=\"token punctuation\">&gt;<\/span><\/span>4.8.1<span class=\"token tag\"><span class=\"token punctuation\">&lt;\/<\/span>version<span class=\"token punctuation\">&gt;<\/span><\/span>\r\n      <span class=\"token tag\"><span class=\"token punctuation\">&lt;<\/span>scope<span class=\"token punctuation\">&gt;<\/span><\/span>test<span class=\"token tag\"><span class=\"token punctuation\">&lt;\/<\/span>scope<span class=\"token punctuation\">&gt;<\/span><\/span>\r\n    <span class=\"token tag\"><span class=\"token punctuation\">&lt;\/<\/span>dependency<span class=\"token punctuation\">&gt;<\/span><\/span>\r\n    <span class=\"token tag\"><span class=\"token punctuation\">&lt;<\/span>dependency<span class=\"token punctuation\">&gt;<\/span><\/span>\r\n      <span class=\"token tag\"><span class=\"token punctuation\">&lt;<\/span>groupId<span class=\"token punctuation\">&gt;<\/span><\/span>org.springframework<span class=\"token tag\"><span class=\"token punctuation\">&lt;\/<\/span>groupId<span class=\"token punctuation\">&gt;<\/span><\/span>\r\n      <span class=\"token tag\"><span class=\"token punctuation\">&lt;<\/span>artifactId<span class=\"token punctuation\">&gt;<\/span><\/span>spring-beans<span class=\"token tag\"><span class=\"token punctuation\">&lt;\/<\/span>artifactId<span class=\"token punctuation\">&gt;<\/span><\/span>\r\n      <span class=\"token tag\"><span class=\"token punctuation\">&lt;<\/span>version<span class=\"token punctuation\">&gt;<\/span><\/span>3.0.5.RELEASE<span class=\"token tag\"><span class=\"token punctuation\">&lt;\/<\/span>version<span class=\"token punctuation\">&gt;<\/span><\/span>\r\n    <span class=\"token tag\"><span class=\"token punctuation\">&lt;\/<\/span>dependency<span class=\"token punctuation\">&gt;<\/span><\/span>\r\n  <span class=\"token tag\"><span class=\"token punctuation\">&lt;\/<\/span>dependencies<span class=\"token punctuation\">&gt;<\/span><\/span>\r\n<span class=\"token tag\"><span class=\"token punctuation\">&lt;\/<\/span>project<span class=\"token punctuation\">&gt;<\/span><\/span><\/code><\/pre>\n<p><img decoding=\"async\" width=\"975\" height=\"718\" class=\"wp-image-47096\" src=\"https:\/\/ephesoft.com\/docs\/wp-content\/uploads\/2015\/11\/mavenpomxml-1.png\" alt=\"MavenpomXML\" srcset=\"https:\/\/ephesoft.com\/docs\/wp-content\/uploads\/2015\/11\/mavenpomxml-1.png 975w, https:\/\/ephesoft.com\/docs\/wp-content\/uploads\/2015\/11\/mavenpomxml-1-300x221.png 300w, https:\/\/ephesoft.com\/docs\/wp-content\/uploads\/2015\/11\/mavenpomxml-1-768x566.png 768w\" sizes=\"(max-width: 975px) 100vw, 975px\" \/><\/p>\n<p><em>Figure 14. pom.xml<\/em><\/p>\n<h3><a id=\"post-31703-_exhx6r3eqhlh\"><\/a>Compile the Project<\/h3>\n<ol start=\"50\">\n<li>Copy and paste the <strong>ephesoft.jar<\/strong> file from <em>[Ephesoft_Directory]<\/em>\\Application\\WEB-INF\\lib to your project <strong>src\/main\/resources<\/strong> Folder.<\/li>\n<li>Right-click on the project folder.<\/li>\n<li>Select <strong>Run As <\/strong>&gt;<strong> Maven build<\/strong>.<\/li>\n<li>Set <strong>Goals <\/strong>as \u201cclean install\u201d.<\/li>\n<li>Click <strong>Apply<\/strong>.<\/li>\n<li>Click <strong>OK<\/strong>.<\/li>\n<\/ol>\n<p><strong>Note: <\/strong>After compiling you may need to refresh your project to update the folder structure.<\/p>\n<h3><a id=\"post-31703-_im5r95ei83ac\"><\/a>Import the Plugin into Transact<\/h3>\n<ol start=\"56\">\n<li>After compiling your project in Eclipse, locate the <strong>ephesoft-custom-plugin.0.0.1-SNAPSHOT.jar<\/strong> file under the target folder.<\/li>\n<li>Temporarily copy the file to your Desktop.<\/li>\n<li>Rename the JAR from \u201cephesoft-custom-plugin.0.0.1-SNAPSHOT.jar\u201d to \u201cephesoft-custom-plugin.jar\u201d.<\/li>\n<li>Locate <strong>ephesoft-custom-plugin.xml <\/strong>under your project.<\/li>\n<li>Temporarily copy the file to your Desktop.<\/li>\n<li>Zip the <strong>ephesoft-custom-plugin.jar <\/strong>and <strong>ephesoft-custom-plugin.xml <\/strong>files together.<\/li>\n<\/ol>\n<p><strong>Note: <\/strong>The ZIP name must be the same as the JAR file. For example, \u201cephesoft-custom-plugin.zip\u201d.<\/p>\n<p><img decoding=\"async\" width=\"974\" height=\"524\" class=\"wp-image-47097\" src=\"https:\/\/ephesoft.com\/docs\/wp-content\/uploads\/2015\/11\/mavencompresedzip-1.png\" alt=\"MavenCompresedZip\" srcset=\"https:\/\/ephesoft.com\/docs\/wp-content\/uploads\/2015\/11\/mavencompresedzip-1.png 974w, https:\/\/ephesoft.com\/docs\/wp-content\/uploads\/2015\/11\/mavencompresedzip-1-300x161.png 300w, https:\/\/ephesoft.com\/docs\/wp-content\/uploads\/2015\/11\/mavencompresedzip-1-768x413.png 768w\" sizes=\"(max-width: 974px) 100vw, 974px\" \/><\/p>\n<p><em>Figure 15. Create a Zipped Folder<\/em><\/p>\n<ol start=\"62\">\n<li>In Ephesoft Transact, go to <strong>System Configuration <\/strong>&gt; <strong>Workflow Management<\/strong>.<\/li>\n<li>Drag and drop your created ZIP file into the<strong> Import Plugin<\/strong> section.<\/li>\n<li>Restart Transact.<\/li>\n<\/ol>\n","protected":false},"featured_media":0,"parent":31701,"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>Creating 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=\"Creating Custom Plugins\" \/>\n<meta property=\"og:description\" content=\"Prerequisites Important: Before proceeding, read and agree to the Developer Disclaimer. To create a custom plugin for Ephesoft Transact, you [&hellip;]\" \/>\n<meta property=\"og:url\" content=\"https:\/\/ephesoft.com\/docs\/products\/transact\/developers\/custom-plugins\/how-to-create-a-custom-plugin\/\" \/>\n<meta property=\"og:site_name\" content=\"Ephesoft Docs\" \/>\n<meta property=\"article:modified_time\" content=\"2021-02-18T18:24:10+00:00\" \/>\n<meta property=\"og:image\" content=\"https:\/\/ephesoft.com\/docs\/wp-content\/uploads\/2015\/11\/selectmavenproject2.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=\"9 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\/developers\/custom-plugins\/how-to-create-a-custom-plugin\/\",\"url\":\"https:\/\/ephesoft.com\/docs\/products\/transact\/developers\/custom-plugins\/how-to-create-a-custom-plugin\/\",\"name\":\"Creating Custom Plugins | Ephesoft Docs\",\"isPartOf\":{\"@id\":\"https:\/\/ephesoft.com\/docs\/#website\"},\"datePublished\":\"2015-11-26T04:03:12+00:00\",\"dateModified\":\"2021-02-18T18:24:10+00:00\",\"breadcrumb\":{\"@id\":\"https:\/\/ephesoft.com\/docs\/products\/transact\/developers\/custom-plugins\/how-to-create-a-custom-plugin\/#breadcrumb\"},\"inLanguage\":\"en-US\",\"potentialAction\":[{\"@type\":\"ReadAction\",\"target\":[\"https:\/\/ephesoft.com\/docs\/products\/transact\/developers\/custom-plugins\/how-to-create-a-custom-plugin\/\"]}]},{\"@type\":\"BreadcrumbList\",\"@id\":\"https:\/\/ephesoft.com\/docs\/products\/transact\/developers\/custom-plugins\/how-to-create-a-custom-plugin\/#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\":\"Creating 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":"Creating Custom Plugins | Ephesoft Docs","robots":{"index":"noindex","follow":"follow"},"og_locale":"en_US","og_type":"article","og_title":"Creating Custom Plugins","og_description":"Prerequisites Important: Before proceeding, read and agree to the Developer Disclaimer. To create a custom plugin for Ephesoft Transact, you [&hellip;]","og_url":"https:\/\/ephesoft.com\/docs\/products\/transact\/developers\/custom-plugins\/how-to-create-a-custom-plugin\/","og_site_name":"Ephesoft Docs","article_modified_time":"2021-02-18T18:24:10+00:00","og_image":[{"url":"https:\/\/ephesoft.com\/docs\/wp-content\/uploads\/2015\/11\/selectmavenproject2.png"}],"twitter_card":"summary_large_image","twitter_misc":{"Est. reading time":"9 minutes"},"schema":{"@context":"https:\/\/schema.org","@graph":[{"@type":"WebPage","@id":"https:\/\/ephesoft.com\/docs\/products\/transact\/developers\/custom-plugins\/how-to-create-a-custom-plugin\/","url":"https:\/\/ephesoft.com\/docs\/products\/transact\/developers\/custom-plugins\/how-to-create-a-custom-plugin\/","name":"Creating Custom Plugins | Ephesoft Docs","isPartOf":{"@id":"https:\/\/ephesoft.com\/docs\/#website"},"datePublished":"2015-11-26T04:03:12+00:00","dateModified":"2021-02-18T18:24:10+00:00","breadcrumb":{"@id":"https:\/\/ephesoft.com\/docs\/products\/transact\/developers\/custom-plugins\/how-to-create-a-custom-plugin\/#breadcrumb"},"inLanguage":"en-US","potentialAction":[{"@type":"ReadAction","target":["https:\/\/ephesoft.com\/docs\/products\/transact\/developers\/custom-plugins\/how-to-create-a-custom-plugin\/"]}]},{"@type":"BreadcrumbList","@id":"https:\/\/ephesoft.com\/docs\/products\/transact\/developers\/custom-plugins\/how-to-create-a-custom-plugin\/#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":"Creating 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\/31703"}],"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=31703"}],"version-history":[{"count":0,"href":"https:\/\/ephesoft.com\/docs\/wp-json\/wp\/v2\/docs\/31703\/revisions"}],"up":[{"embeddable":true,"href":"https:\/\/ephesoft.com\/docs\/wp-json\/wp\/v2\/docs\/31701"}],"next":[{"title":"Importing Custom Plugins","link":"https:\/\/ephesoft.com\/docs\/products\/transact\/developers\/custom-plugins\/improved-custom-plugin-import-mechanism\/","href":"https:\/\/ephesoft.com\/docs\/wp-json\/wp\/v2\/docs\/31702"}],"wp:attachment":[{"href":"https:\/\/ephesoft.com\/docs\/wp-json\/wp\/v2\/media?parent=31703"}],"wp:term":[{"taxonomy":"doc_tag","embeddable":true,"href":"https:\/\/ephesoft.com\/docs\/wp-json\/wp\/v2\/doc_tag?post=31703"}],"curies":[{"name":"wp","href":"https:\/\/api.w.org\/{rel}","templated":true}]}}