Manage plugins

Semarchy xDM allows extending its capabilities using Java code. Using the Open Plugin Architecture, existing services or information systems can contribute to the master data processing and enrichment. You can extend the Enrichment and Validation capabilities in Semarchy xDM through user-defined plugins.

See Plugin development for more information about developing and packaging your own plugins.

A plugin is delivered as a jar file bundle that must be deployed in each Semarchy xDM server instance running integration jobs that use the plugin. You do not need to restart the server to take new or updated bundles into account.

These bundles are tagged with a version number. As a consequence, updating an existing plugin with a newer version of this plugin will automatically make the platform work with the newer plugin version. The deployment process installs a new plugin or replaces an existing plugin version with a new one.

Deploy a plugin

To deploy a plugin:

  1. In Semarchy Configuration, select Plugins in the navigation drawer.

  2. Click the uploadplugins Install or Update Plugin button in the upper right corner of the Plugins editor. The Install/Update Plugins dialog opens.

  3. Click the Add button and select the plugin binary file. For example: com.acme.phoneStandardizer_1.0.0.jar.

  4. Click OK. A Status window shows the number of plugins installed or updated.

  5. Your session is closed to take this new plugin into account. Restart the session.

  6. In Semarchy Configuration, select the Overview editor, and then click the Plugins link.

The plugin now appears in the list, and can be used in the models and integration jobs.

Make sure to install the plugins required by the jobs of a model before deploying the model. If a job starts before its required plugins are installed, then it will fail. The plugin can be installed and the job resumed after the installation.

Uninstall a plugin

To uninstall a plugin:

  1. In Semarchy Configuration, select Plugins in the navigation drawer.

  2. Select the plugin in the list.

  3. Click the delete Uninstall Selected Plugins button in the editor’s toolbar.