Install or remove plugins

Important: To install or remove a plugin, you must stop the XL 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 XL Release and server options, see Start XL Release. For more information on how to shutdown XL Release, see Shut down XL 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 XL Release instance: Open a command prompt or terminal, point to the XL_RELEASE_SERVER_HOME/bin directory, and execute the appropriate command:

    Operating system Command
    Microsoft Windows run.cmd
    Unix-based systems run.sh

Upload a plugin

  1. In the top navigation bar, click Plugins

  2. Click Installed. Note: An XL Release plugin has a .jar extension.

  3. Click Upload new plugin file.

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

    Operating system Command
    Microsoft Windows run.cmd
    Unix-based systems run.sh

Remove a plugin

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

Important: Do not delete the xlr-official folder. The XebiaLabs supported plugins are downloaded to this folder from the plugin manager.

  1. Shut down the XL Release server.

    Operating system Shortcut
    Microsoft Windows Ctrl + c
    Unix-based systems Ctrl + 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 XL Release server: Open a command prompt or terminal, point to the XL_RELEASE_SERVER_HOME/bin directory, and execute the appropriate command:

    Operating system Command
    Microsoft Windows run.cmd
    Unix-based systems run.sh
  4. Refresh the XL Release GUI in your browser.

Test that plugins are installed correctly

In XL 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 XebiaLabs 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 top 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. In the top navigation bar, click Settings and Shared configuration.
  2. Find the plugin that you want to test and click New shared Configuration button.
  3. Fill out the required fields.
  4. Click Test.