The Scoring Agent is shipped with RapidMiner Server. To obtain the distribution ZIP you will need to install RapidMiner Server first. After the installation has been completed, navigate to the installation directory and unzip scoring-agent/ to a desired location -- let's call the new location $SA_HOME. Before you start the Scoring Agent, you will need to install a valid license.

Install a license

To install a Scoring Agent license visit and copy the license key to your clipboard. Afterwards navigate to $SA_HOME/home/resources/licenses/rapidminer-scoring-agent and create a new license file with the name rapidminer-scoring.lic. Paste the content of your clipboard into the file.

Configure Scoring Agent

To configure the behavior of the Scoring Agent open the $SA_HOME/home/config/ file and change its contents.

The default port of the Scoring Agent is 8090. If you want to change the port modify the server.port property in the $SA_HOME/home/config/ file and restart the Agent.

Install extensions

To install RapidMiner extensions go to $SA_HOME/home/resources/extensions/ and place the desired extension JARs into the folder.

Configure extensions

To configure extension properties open the $SA_HOME/home/config/rapidminer/ file and change its contents. The Python Scripting extension, for example, can be configured by uncommenting the line rapidminer.python_scripting.path and pointing it to the binary of the Python installation:

 # Set the properties of RapidMiner and available RapidMiner extensions.
 # Below are two examples on how to configure the Python and R scripting extension.

 # Set the path of the python binary for the Python Scripting extension.

 # Set the path of the R binary for the R Scripting extension.

Start the Scoring Agent

To start the Scoring Agent navigate to the $SA_HOME/bin directory and execute rapidminer-scoring-agent in case of a unix system or rapidminer-scoring-agent.bat in case of a windows machine. Once the Scoring Agent has successfully started, you will see the following log lines:

INFO 6221 --- [main] s.b.c.e.t.TomcatEmbeddedServletContainer : Tomcat started on port(s): 8080 (http)
INFO 6221 --- [main] c.r.execution.scoring.Application     : Started Application in 20.226 seconds (JVM running for 22.243)

Read more: Run the the Real-Time Scoring agent as a service

What's next?

Next you can create a new deployment from RapidMiner Server or install an already existing deployment.