Installationsanleitung für unsere RapidMiner Extensions

Die Installation unserer Extensions unterscheidet sich für RapidMiner Studio und RapidMiner Server. Während die Installation in RapidMiner Studio durch die grafische Benutzeroberfläche unterstützt wird , muss die Installation auf dem RapidMiner Server über das Administratorwebinterface manuell durchgeführt werden. Aber keine Sorge, wir führen Sie in den folgenden Abschnitten Schritt für Schritt sicher durch die Installation.

Installation in RapidMiner Studio

Unsere Extensions können in RapidMiner Studio sowohl manuell als auch über den RapidMiner Marketplace installiert werden. Insbesondere in produktiven Szenarien und wenn Sie planen, das Ganze groß auszurollen, empfehlen wir die Installation über den RapidMiner Marketplace, da mit der manuellen Installation mehrere Nachteile verbunden sind. So können beispielsweise keine automatischen Updates durchgeführt werden und Sie müssten die Extension regelmäßig manuell updaten.

Installation über den RapidMiner Marketplace

  • Der Marketplace ist über den Menüpunkt Extensions von RapidMiner Studio zu erreichen.
  • Geben Sie den Namen der gewünschten Extension in das Suchfeld ein und drücken Sie auf den Button Search.
  • Wählen Sie die Extension aus und setzen einen Haken bei Select for Installation.
  • Nachdem Sie alle Extensions ausgewählt haben, die Sie installieren möchten, beginnen Sie die Installation mit Install x packages.
  • Die Installation wird nun ausgeführt und anschließend muss RapidMiner Studio neu gestartet werden.

 

 

 

 

 

 

Manuelle Installation
  • Laden Sie die Extension von der RapidMiner Marketplace Website.
  • Öffnen Sie den Dateimanager und navigieren Sie zu Ihrem Benutzerverzeichnis. In Windows ist das normalerweise C:\Benutzer\< Ihr Benutername >, aber Sie können den Ordner auch öffnen indem Sie %userprofile% in die Adresszeile Ihres Dateimanagers eingeben .
  • In Ihrem Benutzerverzeichnis legt RapidMiner bei der ersten Ausführung einen Ordner mit dem Namen .RapidMiner an. Öffnen Sie diesen, navigieren Sie zu dem Unterordner extensions und legen dort die heruntergeladene JAR-Datei ab.
   
  • Löschen Sie ältere Versionen der Extension, falls vorhanden, da ansonsten möglicherweise weiterhin eine ältere Version geladen wird. Beenden Sie vorher RapidMiner Studio, da sich die Dateien ansonsten nicht löschen lassen. Unsere Extensions werden nach folgendem Schema benannt, wobei die x für die aktuelle Versionsnummern stehen:
    • RapidMiner-Extension-< Name >_< Version Codewort >-x.x.xxx-all.jar oder
    • < Extension-Identifikator >-ANY-x.x.xxx.jar
 
Extension Identifikator

Statistics Extension

rmx_stat

Jackhammer Extension

rmx_toolkit

Advanced Reporting Extension

rmx_adv_reporting

  • Nach einem Neustart von RapidMiner Studio stehen die neuen Operatoren für Sie bereit.
 

Für einige Funktionen der Extensions muss der interne Sicherheitsmechanismus von RapidMiner ausgeschaltet werden, der verhindert, dass die Extension das Dateisystem erreichen kann oder in sonst einer Weise tiefer mit Ihrem System interagiert. Unglücklicherweise ist das für einige unserer Funktionen aber notwendig, um überhaupt zu funktionieren.

  • Öffnen Sie Preferences in Menüpunkt Settings von RapidMiner Studio.
  • Wechseln Sie zu dem Tab Start-up und setzen Sie einen Haken bei Grant additional permissions to unsigned extensions.
  • Anschließend muss RapidMiner neu gestartet werden.

Extensions zusätzliche Rechte zu geben, kann die Sicherheit Ihrer Daten und Ihres Systems gefährden. Installieren Sie nur Extensions aus sicheren Quellen!

Lizenzaktivierung

Falls Sie eine Lizenz erworben haben, müssen Sie Folgendes tun, um diese zu aktivieren:

  • Platzieren Sie einen beliebigen Operator aus der Extension in einen Prozess. In den Parametereinstellungen des Operators befindet sich ein Button mit der Aufschrift Demo Version ‑ Enter Licence Key here.
  • Klicken Sie auf diesen Button und ein Dialogfeld öffnet sich, in das Sie die Lizenzdaten eingeben können.
  • Geben Sie Ihre E-Mail-Adresse ein. Für Unternehmenslizenzen kann das jede E-Mail-Adresse mit der Domaine des Unternehmens sein, ansonsten ist es die E-Mail-Adresse der Person, für die die Lizenz ausgestellt wurde.
  • Kopieren Sie den Lizenzschlüssel, den Sie von uns per E-Mail erhalten haben, in das zweite Eingabefeld.
  • Wenn angezeigt wird, dass die Lizenzdaten korrekt sind, bestätigen Sie mit OK. Andernfalls stellen Sie sicher, dass Sie den kompletten Schlüssel kopiert haben und sich kein Tippfehler in der E-Mail-Adresse befindet.
  • Um die Lizenz zu aktivieren, ist kein Neustart erforderlich, es reicht aus, in einen anderen Prozess zu wechseln. Nach der Aktivierung ist der Aktivierungsbutton in den Parametereinstellungen nicht mehr vorhanden.

Installation auf dem RapidMiner Server

Um eine Extension auf dem RapidMiner Server zu installieren, muss der Server neu gestartet werden. Stellen Sie sicher, dass dadurch keine wichtigen Prozesse unterbrochen werden. Außerdem müssen Sie sich als Administrator auf dem RapidMiner Server Webinterface anmelden und benötigen Schreibrechte für das Plugin-Verzeichnis.

  • Laden Sie die Extension von der RapidMiner Marketplace Website.
  • Melden Sie Sich als Administrator auf dem Webinterface von RapidMiner Server an, öffnen den Menüpunkt Administration auf der linken Seite und wählen den Unterpunkt System Settings.
  • Der Wert, der der Eigenschaft com.rapidanalytics.plugindir zugeordnet ist, entspricht dem Verzeichnis, in das die heruntergeladene JAR-Datei kopiert werden muss. Wenn der Wert noch nicht definiert ist, muss ein Verzeichnis für die Extensions erstellt und der Pfad zu diesem als Wert angegeben werden. Stellen Sie dabei sicher, dass RapidMiner Server Leserechte für dieses Verzeichnis besitzt!
  • Die Länge der Werte ist aufgrund der Speicherung in einer Datenbank auf 250 Zeichen beschränkt. Da der Lizenzschlüssel länger als diese 250 Zeichen ist, muss er auf mehrere Einträge aufgesplittet werden, wobei die einzelnen Werte nicht aus exakt 250 Zeichen bestehen müssen, sondern auch kleiner sein dürfen. Die Eigenschaften müssen folgendermaßen benannt werden, wobei n jede Zahl sein kann, solange aufeinanderfolgende Zahlen genutzt werden:
    • rapidminer.< Extension-Identifikator >.license_key_1
    • rapidminer.< Extension-Identifikator >.license_key_2
    • ...
    • rapidminer.< Extension-Identifikator >.license_key_n
Extension Identifikator

Statistics Extension

rmx_statistics

Jackhammer Extension

rmx_toolkit

Advanced Reporting Extension

rmx_adv_reporting

Web Automation Extension

rmx_webautomation

  • Außerdem muss die Eigenschaft rapidminer.< Extension-Identifikator >.email zu den Systemeigenschaften hinzugefügt werden. Als Wert wird die E-Mail-Adresse des lizenzierten Benutzers der Extension eingetragen.
  • Kopieren Sie nun die JAR-Datei aus dem Marketplace in das Plugin-Verzeichnis des RapidMiner Servers und löschen alle darin enthaltenen alten Versionen der Extension. Unsere Extensions werden nach folgendem Schema benannt, wobei die x für die aktuelle Versionsnummern stehen:
    • RapidMiner-Extension-< Name >_< Version Codewort >-x.x.xxx-all.jar oder
    • < Extension-Identifikator >-ANY-x.x.xxx.jar

Ab der RapidMiner Server Version 8.0.0 ist es darüber hinaus notwendig, eine Extension auch für jeden Job Agent (inklusive dem Default Job Agent) separat zu installieren. Die dazu notwendigen Schritte unterscheiden sich je nach RapidMiner Server Version.

RapidMiner Server Version 9.2
  • Legen Sie die JAR-Datei in das Verzeichnis \rapidminer-server-home\resources\extensions. Die JAR-Dateien werden allen Job Agents von hier aus automatisch zur Verfügung gestellt. Der standalone server nutzt standardmäßig ebenfalls dieses Verzeichnis als Extension-Verzeichnis. Somit muss bei Updates der Extensions nur ein Verzeichnis aktualisiert werden.
  • Falls Sie für die Extensions nicht den Standard-Ordner verwenden, muss die Konfigurationsdatei \rapidminer-server-home/configuration/execution.properties angepasst werden, damit auch die Job Agents und nicht nur der Server auf die Extensions zugreifen können. Fügen sie der Datei folgende Zeile hinzu:
    • sync.extensionDir=< pathToTheCustomFolder >
  • Um die Extension für den jeweiligen Job Agent zu aktivieren, muss die Datei rapidminer.properties modifiziert werden. Die Datei befindet sich je nach Typ des Job Agent an einem der folgenden Orte:
    • rapidminer-server-home\job-agent-home\config\rapidminer\rapidminer.properties (für den in der RapidMiner Server Installation enthaltenen Job Agent)
    • job-agent\home\config\rapidminer\rapidminer.properties (für manuell installierte Job Agents)
  •   Fügen sie der Date rapidminer.properties folgende Zeilen hinzu:
    • < Extension-Identifier >.email=< your-email@your-company >
    • < Extension-Identifier >.license_key= <your-license-key
RapidMiner Server Version 9.0/9.1
  • Die Job Agents dieser RapidMiner Server Versionen haben standardmäßig kein vordefiniertes Extension-Verzeichnis. Wenn der Job Agent auf dem gleichen Rechner läuft wie der Server, legen Sie die Extension JAR-Datei in den Ordner \rapidminer-server-home\resources\extensions. Wenn der Job Agent auf einem anderen Rechner läuft, erstellen Sie ein  /extensions Unterverzeichnis in dem Installationsverzeichnis des Job Agents und legen die JAR-Dateien in dieses Verzeichnis.
  • Konfigurieren Sie den Job Agent indem Sie der Datei  job-agent\home\config\agent.properties die Zeile  jobagent.container.extensionsDir = extension path> hinzufügen. Hierbei entspricht dem absoluten Pfad des Verzeichnises, in dem sich die Exnteion JAR-Dateien befinden. Achten Sie bei Verzeichnisangaben immer darauf ein / und kein \ zu nutzen .
  • Aktivieren Sie die Lizenzen für unsere Extenions indem Sie der Datei  job-agent\home\config\rapidminer\rapidminer.properties folgende Zeilen hinzufügen
    • < Extension-Identifier >.email=< your-email@your-company >
    • < Extension-Identifier >.license_key= <your-license-key
RapidMiner Server Version 8.0.0
  • Platzieren Sie dafür die JAR-Datei in das Verzeichnis /extensions des jeweiligen Job-Agent-Verzeichnisses. Die Lizenzen für unsere Extensions aktivieren Sie für den jeweiligen Job Agent indem Sie die Datei container.properties in dem Job-Agent-Verzeichnis ...\config\container  editieren. Fügen Sie folgende Zeilen ein:
    • < Extension-Identifikator >.email=< your-email@your-company >
    • < Extension-Identifikator >.license_key= <your-license-key >
  • Um die Installation abzuschließen, muss der RapidMiner Server neu gestartet werden. Stellen Sie vorher sicher, dass keine wichtigen Prozesse auf dem Server laufen, die nicht unterbrochen werden dürfen. Falls es sich um einem Produktivserver handelt, sollten Sie das System redundant aufgesetzt haben, so dass der zweite Server weiter zur Verfügung steht.
  • Nach erfolgreicher Installation ist die Extension unter Administration > Operators & Extensions > Extensions aufgelistet.

Falls es zu Problemen bei der Installation kommen sollte, zögern Sie nicht, sich an unser Supportteam zu wenden. Kontaktdaten finden Sie in Ihrer Bestellbestätigung.