1. Documentation
2. 2024.1 (Latest) 2024.0 10.3 10.2 10.1 10.0 9.10 9.9 9.8 9.7 9.6 9.5 9.4 9.3 9.2 9.1 9.0 8.2 8.1 8.0 7.6
3. Server
4. Administration
5. Maintenance
6. Upgrading

Upgrading and Rolling Back RapidMiner Server

This section describes updating RapidMiner Server, both using the full upgrade and the recommended, faster EAR method. It also describes the process for rolling back releases. Refer to the Java update section for instructions on changing the Java version.

To upgrade RapidMiner Server, login and download the latest version. You can download either:

• the Java Enterprise Archive (EAR) file, which installs the newest version without the application server. Use this method to quickly update the software without changing the application server. This is the recommended method for upgrading RapidMiner Server.

• the full server package, which installs the newest version with the application server. Use this method if it is necessary to completely replace the application server and the software. We recommend this method only if there are updates in the application server itself. (Be certain not to overwrite the existing server directory.)

Upgrading with an EAR file

If there are no changes to the application server, it is simpler and faster to update your software using a Java Enterprise Archive (EAR) file as follows:

1. Stop RapidMiner Server. If running Windows, verify that all RapidMiner-related services have stopped.

2. Backup your RapidMiner Server operations database.

3. Backup your RapidMiner extensions. If you are unsure of the directory location, check the setting on the Administration > System Settings page. The location is the value defined for the property com.rapidanalytics.plugindir.

4. Backup and remove the contents of your application data directory in Rapidminer Server installation directory under standalone/data folder.

5. Select EAR File to download the latest version of RapidMiner Server.

6. Rename old RapidMiner Server EAR file (for example, rapidminer-server-7.0.1.ear to rapidminer-server-7.0.1.ear.save).

7. Delete old RapidMiner Server deployment marker file (for example, rapidminer-server-7.0.1.ear.deployed).

8. Place new Rapidminer Server EAR file into the standalone/deployments folder of your installation directory.

9. Start Rapidminer Server.

10. Log on to RapidMiner Server as admin to verify there are no additional update steps needed.

Rolling back an EAR upgrade

To roll back an update, for example because changes had unexpected consequences, follow these steps:

1. Stop RapidMiner Server. If running Windows, verify that all RapidMiner-related services have stopped.

2. Restore your RapidMiner Server database from backup. If unsure how to do so, try searching Google for the appropriate commands for your database type.

3. Rename new RapidMiner Server EAR file (for example, append .save extension to it).

4. Restore old RapidMiner Server EAR file.

5. Replace the contents of your application data directory in Rapidminer Server installation directory under standalone/data folder from the backup.

6. Replace the extension JAR files that you backed up during the upgrade procedure.

7. Restart RapidMiner Server.

Performing a full upgrade

A full upgrade means installing RapidMiner Server into an empty directory while pointing the database to the existing one. If you created an XML installation script when you initially installed RapidMiner Server, you can use it with this method. The script file contains the saved settings (including the installation directory) and connections you configured with the installation wizard. If you did not, consider saving your settings with a script this time through. To perform a full upgrade:

1. Stop RapidMiner Server. If running Windows, verify that all RapidMiner-related services have stopped.

2. If you intend to reuse an installation script that was used before or simply want to install the new version to a directory where a previous version exists, then backup your installation directory by renaming it.

1. Backup your RapidMiner Server operations database.

2. Backup your RapidMiner extensions. If you are unsure of the directory location, check the setting on the Administration > System Settings page. The location is the value defined for the property com.rapidanalytics.plugindir.

3. Download the latest version of the full server package.

4. If applicable, move the script file, located in the old RapidMiner Server installer directory, into the new installer directory.

5. Change to the bin directory, within the installation directory, to locate (and then run) the start script (or batch file) for installing the new version of RapidMiner Server software. If you created an installer script during a previous installation, you may use that script to specify installation settings:

   • For Windows, use rapidminer-server-installer.bat [<install-script-name.xml>]
   • For Linux, Unix, or Mac OS, use rapidminer-server-installer [<install-script-name.xml>]

6. Copy the contents of the backed up plugins dir into the new RapidMiner Server extensions directory.

   Note: Do not overwrite any extensions that are in the new plugins directory as a result of the installation.

7. From the new installation folder, start RapidMiner Server.

8. Do not forget to reapply the configuration changes you made to the previous version of Rapidminer Server. For example if you modified standalone.xml then manually reapply the pieces you changed to the new version too. Do not copy the whole standalone.xml as it may change from JBoss version to version.

9. Log on to RapidMiner Server as admin to verify there are no additional update steps needed.

Rolling back a full upgrade

To roll back an upgrade:

1. Stop RapidMiner Server. If running Windows, verify that all RapidMiner-related services have stopped.

2. Restore your RapidMiner Server database from backup. If unsure how to do so, try searching Google for the appropriate commands for your database type.

3. If you backed up your previous installation directory (because you installed the new version to a directory where an old version existed) then replace the installation directory from backup.

4. From the previous (old) installation folder, start RapidMiner Server.