Categories

Versions

You are viewing the RapidMiner Server documentation for version 9.6 - Check here for latest version

Installing Extensions

Note that any extensions used by RapidMiner Server must also be installed on RapidMiner Job Agent and RapidMiner Studio instances that you are using to create or execute the RapidMiner Server process(es). You must install the same extension version on all platforms.

See the note on synchronization of extensions.

Installing extensions enables you to expand the power of RapidMiner.

To install an extension on RapidMiner Server, follow these steps:

  1. Locate RapidMiner Server's extension folder. By default it is the resources/extensions/ folder in the RapidMiner Server home folder. If you are unsure, check the setting on the Administration > System Information > System settings page. The folder location is the value defined for the property com.rapidanalytics.plugindir:

    If the property is not defined, you can add it and assign any folder on the server that you have write permissions to.

  2. Extensions can be downloaded from the RapidMiner RapidMiner Marketplace. If you already installed the extension on RapidMiner Studio, you can copy it from the RapidMiner Studio extension directory (in .RapidMiner/managed of the user home directory). Download or copy the extension, which is stored as a .jar file.

  3. Copy the extension to the extensions folder that you located in step 1.

  4. Restart RapidMiner Server.

  5. Open the Administration > Operators & Extensions page and change to the Extensions tab to verify the extension is correctly installed:

A note on synchronization

With version 9.2, an automatic synchronization of resources between RapidMiner Server and the connected Job Agents was introduced. Extensions that have been installed on RapidMiner Server will automatically be available on the Job Agent as well, provided that one of the following conditions is satisfied:

  • The extensions are installed in the default location for extensions: the <home>/resources/extensions/ folder in the RapidMiner Server home directory
  • Or, if the extensions are installed elsewhere, you need to include the following property in the configuration file <home>/configuration/execution.properties

      sync.extensionDir=<pathToTheCustomFolder>
    

Examples

Read more: