Manage plug-ins

Semarchy xDM allows extending its capabilities using Java code. Using the Open Plug-in 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 plug-ins.

See Plug-in development for more information about developing and packaging your own plug-ins.

A Plug-in is delivered as a jar file bundle that must be deployed in each Semarchy xDM server instance running integration jobs that use the plug-in. 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 plug-in with a newer version of this plug-in will automatically make the platform work with the newer plug-in version. The deployment process installs a new plug-in or replaces an existing plug-in version with a new one.

Deploy a plug-in

To deploy a plug-in:

  1. In Semarchy Configuration, select Plug-ins in the navigation drawer.

  2. Click the uploadplugins Install or Update Plug-in button in the upper right corner of the Plug-ins editor. The Install/Update Plug-ins dialog opens.

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

  4. Click OK. A Status window shows the number of plug-ins installed or updated.

  5. Your session is closed to take this new plug-in into account. Restart the session.

  6. In Semarchy Configuration, select the Overview editor, and then click the Plug-ins link.

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

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

Uninstall a plug-in

To uninstall a plug-in:

  1. In Semarchy Configuration, select Plug-ins in the navigation drawer.

  2. Select the plug-in in the list.

  3. Click the delete Uninstall Selected Plug-ins button in the editor’s toolbar.