Skip to main content
Version: Release 24.1

Install or Remove Plugins

This topics provides information about how to install and remove plugins in Release.

important

To install or remove a plugin, you must stop the Release server; plugins that are installed or removed while the server is running will not take effect until it is restarted.

note

For more information on how to start Release and server options, see Start Release. For more information on how to shutdown Release, see Shut down Release

Install a plugin​

  1. In the top navigation bar, click Plugins

  2. Click Browse and browse the list of official plugins, or use the search bar.

  3. Click Install to install a plugin.

  4. When the installation of the plugin is completed, restart your Release instance: Open a command prompt or terminal, point to the XL_RELEASE_SERVER_HOME/bin directory, and execute the appropriate command:

    Operating systemCommand
    Microsoft Windowsrun.cmd
    Unix-based systemsrun.sh

Upload a plugin​

  1. In the top navigation bar, click Plugins
  2. Click Installed.
note

A Release plugin has a .jar extension.

  1. Click Upload new plugin file.

  2. When the upload is completed, restart your Release instance: Open a command prompt or terminal, point to the XL_RELEASE_SERVER_HOME/bin directory, and execute the appropriate command:

    Operating systemCommand
    Microsoft Windowsrun.cmd
    Unix-based systemsrun.sh

Remove a plugin​

important

Plugins may add new types to Release. Removing a plugin may prevent Release from reading your existing data due to missing types.

important

Do not delete the xlr-official folder. The Digital.ai Supported plugins are downloaded to this folder from the plugin manager.

  1. Shut down the Release server.

    Operating systemShortcut
    Microsoft WindowsCtrl + c
    Unix-based systemsCtrl + c

  2. If the plugin was installed manually: Delete the plugin JAR file from the XL_RELEASE_SERVER_HOME/plugins/__local__/ directory. If it is an official plugin: Delete the plugin JAR file from the XL_RELEASE_SERVER_HOME/plugins/xlr-official/ directory.

  3. Start the Release server: Open a command prompt or terminal, point to the XL_RELEASE_SERVER_HOME/bin directory, and execute the appropriate command:

    Operating systemCommand
    Microsoft Windowsrun.cmd
    Unix-based systemsrun.sh

  4. Refresh the Release GUI in your browser.

Test that plugins are installed correctly​

In Release there are two types of plugins: a plugin that is visible through the UI, and a plugin that is a background process with no UI. The following procedures describe how to test if a plugin is installed correctly.

If you find that a plugin is not installed correctly, remove and reinstall the plugin. If, after reinstalling, the plugin is not installed correctly, contact Digital.ai Support.

Verify that a plugin with a UI is installed correctly​

  1. In the top navigation bar, click Plugins and Installed.
  2. Verify that the plugin is installed by browsing the list of installed plugins.
  3. In the left navigation bar, click Dashboards.
  4. Verify that the plugin has a tile and a default description.
  5. In the top navigation bar, click Settings, and Task access.
  6. Verify that plugin related types are listed.

Verify that a plugin with no UI is installed correctly​

  1. From the navigation pane, click Connections under the Configuration group.
  2. Find the plugin that you want to test and click New shared Configuration button.
  3. Fill out the required fields.
  4. Click Test.