Install or remove plugins
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
- In the top navigation bar, click Plugins
- Click Browse and browse the list of official plugins, or use the search bar.
- Click Install to install a plugin.
-
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 system Command Microsoft Windows run.cmd
Unix-based systems run.sh
Upload a plugin
- In the top navigation bar, click Plugins
- Click Installed.
Note: A Release plugin has a
.jar
extension. - Click Upload new plugin file.
-
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 system Command Microsoft Windows run.cmd
Unix-based systems run.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.
-
Shut down the Release server.
Operating system Shortcut Microsoft Windows Ctrl + c Unix-based systems Ctrl + c - 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 theXL_RELEASE_SERVER_HOME/plugins/xlr-official/
directory. -
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 system Command Microsoft Windows run.cmd
Unix-based systems run.sh
- 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
- In the top navigation bar, click Plugins and Installed.
- Verify that the plugin is installed by browsing the list of installed plugins.
- In the top navigation bar, click Dashboards.
- Verify that the plugin has a tile and a default description.
- In the top navigation bar, click Settings, and Task access.
- Verify that plugin related types are listed.
Verify that a plugin with no UI is installed correctly
- In the top navigation bar, click Settings and Shared configuration.
- Find the plugin that you want to test and click
.
- Fill out the required fields.
- Click Test.