1. Home
  2. Transact
  3. Developer Documentation
  4. Custom Plugins
  5. Improved Custom Plugin Import Mechanism

Improved Custom Plugin Import Mechanism

Improved Custom Plugin Import Mechanism


In previous versions of Transact, custom plugins were kept locally in the Ephesoft application lib folder (EphesoftApplicationWEB-INFlib). In multi-server environment, the user had to go to all other servers deployed in the same cluster and manually copy plugin jar file to the application lib folder. Apart from copying jar file he had to create an import statement in the application-context.xml file. This created a problem for managing custom plugins in multi-server environment. Every time when the user had to update the plugin jar file, he had to update the jar file on each server. If he forgot to update the jar file on any of the servers, he would observe inconsistency in plugin execution if the server on which the custom plugin is imported goes down (fails).

In Ephesoft Transact v4.5.0.0, the custom plugin import mechanism is enhanced to help you manage custom plugin jar files at one common location in a cluster.

Location Path – (SharedFolders/customPluginJars).

Custom plugin is imported from the UI as a zip file containing a plugin jar file and a xml file with information about the plugin. Once a zip file is uploaded into Ephesoft Transact, the system extracts data from the zip file and reads xml configuration file to make database changes as per the information shared in configuration file. The system creates an entry in the database where all the default plugins are listed. The plugin jar is copied to the folder SharedFolders/customPluginJars along with the modified context.xml.


An existing constraint, which does not allow dependent jars to be uploaded with plugin jar, will still be there. Only plugin jar can be uploaded and stored at a common location using plugin import UI. You can directly place all dependent jars at the common location separately.


To import a custom plugin:

1. Login to the application as an Administrator and navigate to the System Configuration.


2. Click on the Workflow Management section. This will list all the default plugins available in the application.

Click on the Select hyperlink in the right panel to import a new custom plugin.


3. Browse the custom plugin zip file from your local system. This zip file contains the custom plugin jar file.

4. By clicking the OK button, the plugin is imported into the system and listed along with the other plugins in the Workflow Management section.

5. Once the custom plugin zip is imported, the system copies the custom plugin jar file and its context xml file to Ephesoft Shared Folders location.

The imported plugin (in this case, TEST_CUSTOM_PLUGIN) can now be used in the application.

6. To use this plugin, navigate to the Batch Class Management module and open your batch class.

Navigate to the required module (e.g. Modules >> Folder Import). From the plugin list, drag and drop the custom plugin in the Selected Plugin section.

Click on the Apply and Deploy button to save the workflow.

7. The plugin gets listed in the corresponding module list (in this case, Folder Import).

You can now configure the plugin same as other default plugins by defining the properties in the Plugin Configuration panel.


Once imported, the plugin cannot be deleted or overridden in case you want to modify the code (logic). For using the modified code of the same custom plugin, you must import the same custom plugin with a different name.

Once the custom plugin in imported, the application itself creates a new entry in the database where all the default plugins are listed.


Was this article helpful to you? Yes No 1