You are viewing the RapidMiner Server documentation for version 9.4 - Check here for latest version
Table of system settings for RapidMiner Server
Notice that you can link directly to any of the properties in the table using the whole property name as an ID, for example #com.rapidanalytics.web.anonymous_resources
| Property | Description | Accepted values | Default |
|---|---|---|---|
| Database | |||
| com.rapidanalytics.db.max_rowlength | Sets the maximum number of bytes per row when storing an ExampleSet. If an ExampleSet contains more Attribute data than can be stored in max_rowlength, RapidMiner Server splits it into multiple tables. Reduce this number if you receive a database error that RapidMiner Server created tables with too many columns. | Integer | 20000 |
| com.rapidanalytics.db.stream_chunk_size | Sets the buffer size when reading data from the database. | Integer | 500 rows |
| com.rapidanalytics.db.table_prefix | Sets the prefix for tables storing example sets in the RapidMiner Server database. | Any string allowed as an identifier in your database | es_ |
| com.rapidanalytics.db.exampleset.jndi | Sets the JNDI name of the data source connections where RapidMiner Server stores example sets; defined in standalone.xml. | JNDI identifier | java:/jdbc/RapidAnalyticsDS |
| com.rapidanalytics.db.sql_dialect | Sets the SQL dialect used by the operations database. | MYSQL, ORACLE, MICROSOFT, POSTGRES. But no need to ever edit. | Set on installation by the DB System argument, in the Database Configuration window (so no need to edit). |
| Anonymous access—Requires an "anonymous" user account | |||
| com.rapidanalytics.web.anonymous_resources | Sets whether resources can be accessed without authentication under /api/rest/public/resources. Use this when implementing the anonymous user functionality. | True to allow access or false to deny access | False |
| com.rapidanalytics.web.anonymous_services | Sets whether web service processes can be accessed without authentication under /api/rest/public/processes. Use this when implementing the anonymous user functionality. | True to allow access or false to deny access | False |
| com.rapidanalytics.web.anonymous_reports | Sets whether web apps can be accessed without authentication. Web apps do not have a fixed URL; the access URL is shown while editing the app. Use this when implementing the anonymous user functionality. | True to allow access or false to deny access | False |
| Process log | |||
| com.rapidanalytics.process.log.enable | Sets whether to log process output. Logs are visible in the web interface under Processes > Scheduler and linked from RapidMiner Studio. | True to log process output or false to discard. | True |
| com.rapidanalytics.process.log.update_delay | Sets the interval, in milliseconds, between updates to the database with the latest log records. That is, instead of writing immediately to the log, messages can be delayed for this interval and written at one time. | Integer | 1000 milliseconds |
| com.rapidanalytics.process.log.continuous | Specifies whether to write to the logs as a process executes or whether to write all log data at process completion. | True to write continuously or false to write at completion | True |
| com.rapidanalytics.process.log.limit_access_to_owner | Sets accessibility of the process log. If true, log is only available to the user that started the process. If false, log is available to any user with Read access to the folder. | True or false | False |
| Process execution | |||
| com.rapidanalytics.webservices.concurrency | Sets the concurrency level (i.e. how many CPU cores are used) for each web service that runs. Defaults to 1 which means each web service runs in a single thread and thus responds faster. If you offer web services that take longer to run(several minutes to hours), you can increase this setting to make use of multiple CPU cores (limited by your license) for each web service process. This has the same effect as the Number of threads setting in RapidMiner Studio. Note that if you have many web service calls (hundreds at the same time) for processes that can use multiple cores (e.g. via Loop operators), this can cause new web service calls to fail! This is due to a global limit in the number of threads depending on various system parameters. | Integer | 1 |
| Directories | |||
| com.rapidanalytics.plugindir | Defines the directory where RapidMiner Server stores user-added extensions that are loaded at start up. | You can create the plugin directory anywhere that is accessible to your machine, but be sure that you have write permission to the location. Bundled extensions (no installation necessary) are stored in a separate directory that is independent of the path specified here. | Specified at installation |
| com.rapidanalytics.uploaddir | Defines the directory where RapidMiner Server stores temporary binary files uploaded by the user and needed for processes. | You can create the uploads directory anywhere that is accessible to your machine, but be sure that you have write permission to the location. If the RapidMiner Server host has a small hard disk, make sure you create the directory in a place that can handle the potentially large temporary files. | Specified at installation |
| Logging | |||
| com.rapidanalytics.accesslog.db.mode | Determines when access to resources are logged to the database. | ALWAYS, NEVER, or ONLY_ERROR. | ALWAYS |
| com.rapidanalytics.accesslog.file.mode | Determines when access to resources are logged to a file. | ALWAYS, NEVER, or ONLY_ERROR. | NEVER |
| com.rapidanalytics.accesslog.file.destination | Specifies the destination to write the access log file to. Only applicable if com.rapidanalytics.accesslog.file.mode is ALWAYS or ONLY_ERROR. | Filename | None |
| com.rapidanalytics.mail.jndi_name | Sets the JNDI name of the email session. See changing outgoing email. | JNDI identifier | None |
| Triggers | |||
| com.rapidanalytics.triggers.delay | Sets the delay between active triggers that check conditions (for example, file modifications). | Integer | 10000 ms |
| Web | |||
| com.rapidanalytics.web.hostname | Sets the RapidMiner Server hostname to display to users (to use, for example, for web service URLs). Auto-detected based on configuration. | Any | None |
| com.rapidanalytics.web.myport | Sets the RapidMiner Server port to display to users (to use, for example, for web service URLs and other generated direct links). Auto-detected based on configuration. | Any valid port number | 80 |
| com.rapidanalytics.web.session.timeout | Sets the timeout for web sessions. | Integer | 1800s |
| com.rapidanalytics.web.session.limit.enabled | Set to true if the web interface should disallow multiple sessions per user. The server needs to be restarted once this feature is switched on. It's not supported in high availability mode. | Boolean | false |
| com.rapidanalytics.web.session.limit.amount | Sets the maximum amount of allowed sessions per user in the web interface. | Integer | 1 |
| com.rapidanalytics.web.rooturl | Sets the RapidMiner Server root URL to display to users. Auto-detected based on configuration. | Valid URL | None |
| com.rapidanalytics.web.reverse_dns_lookup | Specifies whether RapidMiner Server does a reverse DNS (IP address to hostname) when writing to the access log. | True to write the reverse DNS lookup results or false to write the IP address to the log | False |
| Scripting extensions | |||
| rapidminer.r_scripting.path | Specifies the path to the RScript executable in your R installation. | Anywhere that is accessible to your machine, but be sure that you have write permission to the location | None |
| rapidminer.python_scripting.package_manager | Specifies the type of default Python distribution, used by the Python Scripting extension. | Possible values:
|
conda (anaconda) |
| rapidminer.python_scripting.conda_environment | Specifies the name of the default conda environment. Used only, if rapidminer.python_scripting.package_manager is set to conda (anaconda). |
Name of an existing conda virtual environment | base |
| rapidminer.python_scripting.venvw_environment | Specifies the name of the default virtualenvwrapper environment. Used only, if rapidminer.python_scripting.package_manager is set to virtualenvwrapper. |
Name of an existing virtualenvwrapper virtual environment | |
| rapidminer.python_scripting.python_binary | Absolute path to the default Python binary file. E.g. C:\Program Files\Python27\python.exe. Used only, if rapidminer.python_scripting.package_manager is set to specific python binaries. |
Absolute path to any installed Python interpreter (executable file) | |
| rapidminer.python_scripting.search_paths | Search path used to search for conda installation/other Python installation besides commonly used paths. Note, that the Python Scripting extension may search inside these directories for Python environments/executables. If you provide folders with lot of entries, this can cause the execution to slow down a bit. | Comma separated list of directories to search for conda installation/other Python installation. E.g. C:\your\unique\path\to\anaconda\bin |
|
| License | |||
| com.rapidanalytics.license.reload_interval | Sets an interval in which a trigger periodically reloads the licenses in milliseconds. | Long | 1800000ms (30 minutes) |
| Miscellaneous | |||
| rapidminer.general.nd4j_backend | Sets the backend used by the Deep Learning extension for computation. Either the system CPU or GPU if available. When selection GPU, make sure the other requirements are met (CUDA 9.0 installed, ...) | CPU, GPU | CPU |
| com.rapidanalytics.enable_timestamp_locking | Sets whether RapidMiner Studio warns if two users are simultaneously modifying the same process (whether a warning message is delivered on saving). | True to warn or false to allow overwrite | True |
| LDAP username and group filters | |||
| com.rapidanalytics.access.userfilter | Sets the filter to restrict access of LDAP authenticated users based on their username. If the username matches the filter then access is granted. Blank or undefined value does not restrict access. | Regular expression | |
| com.rapidanalytics.access.groupfilter | Sets the filter to restrict access of LDAP authenticated users based on their LDAP group membership. If any of the LDAP groups name that the user belongs to matches the filter then access is granted. Blank or undefined value does not restrict access. | Regular expression | |
| Security | |||
| com.rapidanalytics.security.x_frame_options | Set the X-FRAME-OPTIONS header for web site responses to prevent embedding of pages into other websites (e.g. as an iframe). This prevents clickjacking attacks. Please note that setting this header to DENY might also affect the RapidMiner Server UI. | DENY, SAMEORIGIN, or ALLOW-FROM https://example.com/ | Header not set |
| com.rapidanalytics.security.access_control_allow_origin | Used to specify the content of the Access-Control-Allow-Origin header for CORS requests. | *, or https://example.com/ | Header not set (CORS disabled) |
| com.rapidanalytics.security.access_control_allow_credentials | Used to specify the content of the Access-Control-Allow-Credentials header for CORS requests. | true or false | true |
| com.rapidanalytics.security.access_control_allow_headers | Used to specify the content of the Access-Control-Allow-Headers header for CORS requests. | Any comma-separated combination of headers: origin, content-type, accept, authorization | origin, content-type, accept, authorization |
| com.rapidanalytics.security.access_control_allow_methods | Used to specify the content of the Access-Control-Allow-Methods header for CORS requests. | Any comma-separated combination of valid HTTP methods, e.g. GET, POST, PUT, DELETE | GET, POST, PUT, DELETE |
| com.rapidanalytics.security.upload.whitelist | A whitelist for file extensions that may be uploaded via the Web UI and from Studio. If a whitelist is defined, the blacklist will be ignored. | Any comma-separated combination of file extensions, including "none" as a filter for files without any extensions. In case of an empty whitelist all uploads will be blocked. For example, the whitelist 'pdf,csv,none' permits the upload of files with pdf and csv extensions and the upload of files with no file extension. | |
| com.rapidanalytics.security.upload.blacklist | A blacklist for file extensions that should NOT be uploaded via the Web UI and from Studio. If a whitelist is defined, this blacklist will be ignored. | Any comma-separated combination of file extensions, including "none" as a filter for files without any extensions. For example, the blacklist 'exe,sh,none' blocks files with the file extensions exe and sh and also blocks files with no file extension. | |
| com.rapidanalytics.security.upload.content_type.allowed_types | Defines allowed content-types of uploads via the Web UI and from Studio. The content-type check will happen after a file has been uploaded. It uses magic bytes to extract the real content-type of a file regardless of the file extension. | Any comma-separated combination of allowd content-types. In case of an empty list all uploads will be blocked. For example, the content-types 'application/pdf,application/zip' permit the upload of PDF and Zip files. | |
| com.rapidanalytics.security.upload.max_size | Defines the maximum allowed file size in bytes of uploads via the Web UI and from Studio. | Integer | |
| com.rapidanalytics.encryption.key | Used to specify the key used for property encryption. Currently only relevant for the LDAP Property Encryption | Any | |