Installing plug-ins

Plug-ins can be installed at any time. You do not need to restart the server after you install a plug-in by using the graphical user interface.

Before you begin

The plug-in framework is supported on the versions of Linux and Microsoft Windows that IBM® UrbanCode Release supports. The plug-in framework uses Groovy 2.1.9, which is installed when you install IBM UrbanCode Release. The groovy.home.path variable in the file is set to the Groovy directory when you install IBM UrbanCode Release. If you are running in a clustered environment, check that the plugins.folder.path variable points to a shared directory that can be accessed by all nodes in the cluster.

About this task

You can upgrade a plug-in by installing the new version over the old version.


  1. Download the installation files for one or more plug-ins from the following site:

    Documentation for plug-ins and the steps in the plug-ins is available on that site.

  2. Click Integrations > Plugins, and then click Upload Plugin. A plug-in must include at least one step that defines a user interface. If a plug-in does not include a step that defines a user interface, the installation process fails.
  3. Click Browse, navigate to the compressed plug-in file, and then click Save.


The plug-in is listed on the Plugins page. If the plug-in is the connector type, it is also available on the Integrations page. After the plug-in is installed, it is available immediately. The plug-in is imported to the installation_directory/UCRelease/urelease/plugins/repo directory.