Installation Guide for our RapidMiner Extensions

The installation of our extension differs for RapidMiner Studio and RapidMiner Server. While the installation in Studio is supported because of its graphical user interface, on the server side the installation needs to be done over the administration interface of RapidMiner Server manually. But don't worry, we will guide you through the procedure step by step.

Installation in RapidMiner Studio

Our extensions could be installed in RapidMiner Studio eighter using the RapidMiner Marketplace or manually. Especially in a productive scenario and if you plan to role it out in a larger scale, we recommend the installation using the RapidMiner Marketplace because the manual installation has several draw backs. For example you will not automatically receive updates and will need to update the extension manually consistently.

Installation using the RapidMiner Marketplace

  • Simply go to the Extensions menu and select Marketplace (Updates and Extensions).
  • Enter the name of the desired extension in the search field and press the Search button.
  • Select the desired extension by clicking on it and set the checkbox Select for Installation.
  • After you selected all extensions, press Install x packages.
  • The installation will be done and you need to restart RapidMiner.

 

 

 

 

 

 

 

 

Manual Installation
  • Download the extension file from the RapidMiner Marketplace Website.
  • Open a File Explorer and go to your user directory. On Windows this is usually C:\Users\, but you can also reach it by entering %userprofile% in the address line of your explorer.
  • Inside your user directory RapidMiner creates a directory called .RapidMiner when it is first started. Open it, navigate to the subdirectory extensions and save the downloaded JAR-File there.

 

 

  •  Make sure no previous version of the respective extension remains in the plugins directory. Otherwise the older version might still be used. If you cannot delete the file, exit RapidMiner Studio before trying again. The extension files are named after following pattern, with the x being actual version numbers:
    • RapidMiner-Extension-< Name >_< Version Codeword >-x.x.xxx-all.jar or
    • < Extension-Identifier >-ANY-x.x.xxx.jar

 

ExtensionIdentifier

Statistics Extension

rmx_stat

Jackhammer Extension

rmx_toolkit

Advanced Reporting Extension

rmx_adv_reporting

  • After restarting RapidMiner Studio the new operators are available.

 

For some extension features you will need to disable RapidMiner's internal security mechanism as it prevents accessing the file system or otherwise interact deeper with your system. Unfortunately this is a requirement for some of our operators to work at all.

  • Open Preferences in the Settings menu of RapidMiner Studio.
  • Switch to the Start-up tab and set the checkbox Grant additional permissions to unsigned extensions.
  • Then restart RapidMiner to apply changes.

Granting extensions additional rights may endanger the securtity of your data and system. Only install extensions from safe sources!

License activation

  If you have bought a license key, please follow theses instructions to activate it:
  • Just add any operator of the extension to an empty process. It will show a button marked with Demo Version ‑ Enter Licence Key here in the parameter panel.
 
  • Click on that button to open a dialog to activate the license.
  • Enter your email address. For company licenses that can be any email address within the company's domain, otherwise it needs to be the email of the named user registered for the license.
  • Copy the license key you received from us per email into the second input field of the dialog.
  • If you got the confirmation that the license is valid, click OK. Otherwise make sure you copied the complete key and you don't have a typo in your email.
  • To activate the license, you only need to open another process, no restart required. Afterwards the operators will not show a Demo Version Button anymore.

Installation on RapidMiner Server

For the installation on the Server you need to restart the server, so make sure no important processes will be interrupted! You also need to login to the admin account of the RapidMiner web interface and have file access on the directory that was selected as plugin directory.

  • Download the extension file from the RapidMiner Marketplace Website.
  • Login to the RapidMiner Server web interface and open the Administration menu on the left. Select System Settings.
  • The value of the property com.rapidanalytics.plugindir is the directory the downloaded JAR file has to be stored. If it is not defined, you need to add it and point it on a directory on the server. Make sure RapidMiner Server has read access on that directory!
  • RapidMiner Server has a limitation for the property length of 250 characters due to the underlying database. Hence we need to split the license key into multiple properties, as it is longer than 250 characters. You don't need to split the key in exactly 250 characteres, you can simply grab a part that is roughly smaller than 250 and cut and paste it into a property. The properties have to be named as follows with n being any number as long as you use consecutive numbers :

    • rapidminer.< Extension-Identifier >.license_key_1
    • rapidminer.< Extension-Identifier >.license_key_2
    • ...
    • rapidminer.< Extension-Identifier >.license_key_n
Extension Identifikator

Statistics Extension

rmx_stat

Jackhammer Extension

rmx_toolkit

Advanced Reporting Extension

rmx_adv_reporting

Web Automation Extension

rmx_webautomation

Then add the property rapidminer.< Extension-Identifikator >.email to system settings and put the email of the licensed user into the email property.

  • Copy the downloaded JAR file into the plugins directory of RapidMiner Server and delete all previous versions of the extension. The extension files are named after following pattern, with the x being actual version numbers:
    • RapidMiner-Extension-< Name >_< Version Codeword >-x.x.xxx-all.jar or
    • < Extension-Identifier >-ANY-x.x.xxx.jar

From RapidMiner Server Version 8.0.0 it is necessary to install an extension also for every Job Agent (including the default Job Agent) separatly. How to do this exactly depends on the version of RapidMinerServer you are using.

RapidMiner Server Version 9.2
  • Place the extensions into \rapidminer-server-home\resources\extensions. The extension jar-files are automatically delivered to all job-agents from here. The standalone server by default also uses this directory as extension directory.
  • To activate the licenses for our extensions for the specific Job Agent, you have to edit the file rapidminer.properties. The location of this file is:
    • rapidminer-server-home\job-agent-home\config\rapidminer\rapidminer.properties (for the bundled job-agent coming with the RapidMiner Server installation)
    • job-agent\home\config\rapidminer\rapidminer.properties (for manually installed job-agents)
  •   Add following rows to the rapidminer.properties file:
    • < Extension-Identifier >.email=< your-email@your-company >
    • < Extension-Identifier >.license_key= <your-license-key
RapidMiner Server Version 9.0/9.1
  • These versions do not have a default extension folder for the job-agents. If the job-agent runs on the same machine as the server, place the extension jar files into the folder \rapidminer-server-home\resources\extensions, which is also used as extension folder by the standalone server. Configure the job-agent by adding the line jobagent.container.extensionsDir = \rapidminer-server-home\resources\extensions to the file job-agent\home\config\agent.properties. Make sure to always use slash ( / ) as folder separator, even on windows machines. If the job-agent runs an a different machine, create an /extensions folder in your job-agent folder, place your extension jar-files into this folder and configure add the line jobagent.container.extensionsDir = \job-agent\extensions to the file \job-agent\home\config\agent.properties
  • To activate the licenses for our extensions for the specific Job Agent, you have to edit the file job-agent\home\config\rapidminer\rapidminer.properties
  • Add following rows to the rapidminer.properties file:
    • < Extension-Identifier >.email=< your-email@your-company >
    • < Extension-Identifier >.license_key= <your-license-key
RapidMiner Server Version 8.0.0

Put the Jar file into the /extensions directory of the respective Job Agent. To activate the licenses for our extensions for the specific Job Agent, you have to edit the file container.properties in the Job Agent folder ...\config\container. Add the following rows:

  • < Extension-Identifier >.email=< your-email@your-company >
  • < Extension-Identifier >.license_key= <your-license-key
  • Now you need to restart the server. Make sure no important processes are running on the server that you would interrupt. If it's a productive, client facing server, you should have set it up in a redundant way, so that one server will still be working.
  • If everything worked fine, you should see the extension after the restart in the Administration > Operators & Extensions view.

If you have any further problems with the installation, please don't hesitate to contact our support team. You will find contact details in the delivery email.