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

Job Agents


The RapidMiner Server preconfigures the agent with some of the properties it can infer before you download the distribution. You can edit these properties after downloading and unpacking the agent.

Agent Properties

You can alter the configuration of the Job Agent by changing {homeDir}/config/ Each property has a comment before which explains what effect the configuration has on the agent.

Container Properties

The content inside {homeDir}/config/rapidminer/ is going to be copied into each job directory before container start:

  • {homeDir}/config/rapidminer/.RapidMiner: Defines the execution context. Place your own configuration files into this directory if you need it for your extensions.
  • {homeDir}/config/rapidminer/ the properties in this file are going to be set as system properties for the Job Container. The agent will also add RapidMiner Server's address properties to this file automatically before the container starts. Use this file to provide your custom properties (e.g. extension properties) for the container.

You can also use the Central resource management to synchronize the execution context from the RapidMiner Server home folder.


To enable correct execution of RapidMiner processes the Job Agent uses various external resources like JDBC drivers, RapidMiner extensions, custom Java libraries, and RapidMiner Server licenses. These resources are stored within the {homeDir}/resources/ folder of the Job Agent.

Central resource management

The Job Agent's external resources are centrally managed and automatically synchronized from the RapidMiner Server instance the Job Agent is connected to. Also the Execution context will be synchronized by default to all Job Agents.

Resource management

Centrally managed Job Agent resources are stored in the resource/ folder of the RapidMiner Server home folder. Both RapidMiner Server and all connected Job Agents use the same set of resources.

To install a new or manage an existing centrally managed resources do the following:

  1. Select the resource type you want to update (JDBC, Extensions, Custom libraries)
  2. From the table below locate the path of the resource type you want to update
  3. Update the resource type by adding or removing content from the selected folder
  4. Restart RapidMiner Server. All connected Job Agents will automatically synchronize the new resource configuration from RapidMiner Server.
Type Source Path
JDBC <rapidminer-server-home>/resources/jdbc/
Extensions <rapidminer-server-home>/resources/extensions/
Custom libraries <rapidminer-server-home>/resources/libs/
Licenses Licenses are automatically synced to connected Job Agents on license installation via the RapidMiner Server UI
Execution context <rapidminer-server-home>/.RapidMiner/

Certain files or folders for each resource type can also be ignored. Those files will be excluded during the automatic resource synchronization. The following table contains the required property name which has to be set for the specific type within the <rapidminer-server-home>/configuration/ file and the type's default excluded files if there are any. Filenames have to be defined as a list and are relative to the resource type's source folder.

Type Path Default Exclusions
JDBC sync.jdbcExclusions
Extensions sync.extensionExclusions
Custom libraries sync.libsExclusions
Licenses sync.licenseExclusions
Execution context sync.executionContextExclusions extensions/workspace

For example, if you like to exclude myExtension1.jar and myExtension2.jar in the <rapidminer-server-home>/resources/extensions/ folder, set sync.extensionExclusions = myExtension1.jar, myExtension2.jar.

Automatic synchronization

By default, all resources and the execution context are automatically synchronized from the RapidMiner Server instance after the Job Agent has been started. Also, the resources are synchronized after a restart of the RapidMiner Server instance.

The Job Agent downloads the resources to the type specific resource folder and overwrites all potential existing files. These type specific resource folders are:

Type Path
JDBC <jobagent-home>/resources/jdbc/
Extensions <jobagent-home>/resources/extensions/
Custom libraries <jobagent-home>/resources/libs/
Licenses <jobagent-home>/resources/licenses/
Execution context <jobagent-home>/config/rapidminer/.RapidMiner

Individual resource management

To setup a Job Agent with an individual resources that differ from the centrally managed resource set the automatic synchronization can be disabled by setting jobagent.sync.enabled = false in the config/ file. After a restart of the Job Agent it will only use the resources that are already available in the respective resource folders.

To install a new or manage an existing local resources do the following:

  1. Shutdown the Job Agent
  2. Locate the path of the resource type you want to update
  3. Update the resource type by adding or removing content from the selected folder
  4. Restart the Job Agent

Resource types


JDBC connections can be defined in the {homeDir}/resources/jdbc/jdbc_properties.xml file.


Extensions are provided from {homeDir}/resources/extensions/ directory.

Custom libraries

Custom libraries are Java libraries which you can be used in a RapidMiner process, for example within the Execute Script operator. You can add these libraries to the {homeDir}/resources/libs/ folder and then they are automatically available for execution.

Don't confuse custom libraries with JDBC drivers or extensions.


The Job Agent licenses are installed in the {homeDir}/resources/licenses/ directory.

You can define the number of spawned Job Containers (jobagent.container.count) for each Job Agent and the memory per Job Container (jobagent.container.memoryLimit) in the {homeDir}/config/ file. Keep in mind that these settings need to comply with your current server license.

Execution context

The Execution context for each job are placed in {homeDir}/config/rapidminer/.RapidMiner.