Release and deploy your plugin

This page provides step-by-steps instructions to release and deploy a plugin developed for Semarchy xDM.

The plugin is released as a Jar file that will be deployed in a Semarchy xDM instance. Once deployed, the plugin becomes available for design and run-time.

Generate the plugin binary

When the plugin is tested, or when a new version is available, you can generate the plugin binary.

To generate the plugin binary:

  1. Select the plugin project, right-click and select Export.

  2. Select Plugin Development > Deployable plugins and fragments.

  3. In the Destination tab, use the Browse button to select a target directory for your plugin. For example: c:\temp.

  4. Select the plugin to deploy. For example: com.acme.phoneStandardizer.

  5. Click Finish.

The jar for the plugin is created in a plugins folder under the selected destination directory. The generated jar file is named after the plugin ID and version number.

When selecting the plugins and fragments to deploy, make sure to select only the plugin, and not the JUnit test case fragments as they are not needed for running the plugin.

Increment the plugin version

If the plugin was modified or fixed, before generating the new version of the plugin binary, increment the plugin version

To increment the plugin version:

  1. In the plugin project, double-click the plugin.xml file to edit it.

  2. In the overview tab, increment the Version number. For example, if the original plugin version is 1.0.0, then the first patch for this plugin would be 1.0.1.

  3. Press Control+S (or Command+S on macOS) to save the editor.

You can re-generate the plugin binary.

As the generated jar file is named after the plugin ID and its version number, you can preserve in this directory the successive versions of the plugin.

Deploy the plugin

To deploy a plugin in a Semarchy xDM instance, you must connect with a user that has the Platform Administration Read/Write privileges, or with an administrator user (semarchyAdmin role).

To deploy the plugin binary:

  1. Connect to the Semarchy Configuration.

  2. Double-click the Plugins link.

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

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

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

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