你正在查看的加固dMiner Legacy documentation for version 9.9 -Check here for latest version
RapidMiner Server Settings and Services
You can change commonly accessed RapidMiner Server system settings using the web interface. Additionally, you can change the RapidMiner Server configuration files to make changes to your Java and JBoss settings.
Customize the configurations to fit your organization's needs:
Modify additional commonly accessed settings你的RapidMiner服务器
Modify the secret token你的RapidMiner服务器used by external processes such as the RapidMiner Job Agents
Change standalone.xmlfor hostname, port, HTTP header size and email changes
Change standalone.conffor Java version
Change max-memory.conffor JVM memory settings
Set up RapidMiner Server toto run as a service on startup, if not done on installation
Modifying system settings
See also thetable of system settings。
RapidMiner Server displays the system settings you have set or modified in theAdministration > System Settingswindow of the web interface. From this window you can modify the displayed settings or change default system settings.
The REST API to manage the settings are explained alongside the instructions. In order to use the REST API, all requests require administrator privileges. Possible authorization mechanisms are basic auth or Json Web Tokens (JWT). For help on how to use RapidMiner Server's REST API in general, please consult theREST API documentation page。
Follow these steps to view and change system settings.
Note: System settings can only be edited by anadministrator。If the setting edit (add, change, or remove) seems to have no effect, restart RapidMiner Server.
Property overview
OpenAdministration > System Settings。TheSystem Settingstab lists all settings that have been set or modified for this instance of RapidMiner Server (either manually or during the installation process).
Use[GET] $RMServerHost/api/rest/system-settings
as endpoint URL andapplication/json
as content type.
An example response might look like the following and return status code200
:
[ { "name": "com.rapidanalytics.version.configured", "value": "9.5.000" }, { "name": "exampleProperty", "value": "exampleValue" } ]
Add property
If the property you wish to set is not present in theSystem Settingslist, click onAdd property。prope RapidMiner服务器添加一行rties table. Enter the property name in thePropertyfield of the new row and the value in theValuefield. Refer to thetable of system settingsfor assistance. ClickSubmitto save and apply the new setting(s).
Use[POST] $RMServerHost/api/rest/system-settings
as endpoint URL andapplication/json
as content type. If the request has been handled successfully, a204
will be returned.
The request payload should look like the following:
{ "name": "exampleProperty", "value": "exampleValue" }
Change property
To change the value of a listed property, simply edit theValuefield. ClickSubmitto save and apply the new setting(s).
To change a property via REST endpoint, invoke the same endpoint like for adding a property. If the property with already exists, its value will be overwritten.
删除property
To delete a property, click on the删除icon. ClickSubmitto save the configuration without the removed setting(s). Restart RapidMiner Server to apply that configuration.
Use[DELETE] $RMServerHost/api/rest/system-settings/$nameOfProperty
as endpoint URL. If the request has been handled successfully, a204
will be returned.
Changes are also reflected on theAdministration > System Informationpage,System Settingstab.
Modify the secret token
The secret token is a shared secret to enable an external process such as the RapidMiner Job Agent to communicate with the RapidMiner Server respectively the RapidMiner Job Service REST API.
To invalidate the current secret token and set a new one simply click on theGenerate new Tokenbutton.
Note:Generating a new token might break all waiting and running processes!
The following steps must be done to apply the new token:
TheRapidMiner Servermust be re-started
The token must be exchanged in theRapidMiner Job Agentconfiguration
TheRapidMiner Job Agentmust bere-started
Changing standalone.xml settings
The filestandalone.xml
contains JBoss Application Server 7 configuration settings, such as hostname, ports, mail, database,enabling HTTPS, etc. The file is found inconfiguration/
of yourRapidMiner Server home directory。The next sections describe how to make the following changes in the filestandalone.xml
。
To change the hostname settings, follow these steps:
Edit the file
configuration/standalone.xml
in yourRapidMiner Server home directory。Locate the tags configuring the interface:
Edit the bind address (the IP address after the colon, 127.0.0.1 in the above example) as required. You can enter a hostname instead of an IP address if desired.
Save the file and restart RapidMiner Server.
To change the port settings, follow these steps:
Edit the file
configuration/standalone.xml
in yourRapidMiner Server home directory。Locate the tags configuring the socket bindings (these define the HTTP and HTTPS ports):
Edit the port numbers as required.
Save the file and restart RapidMiner Server.
Note: On Linux, you must be running as root to change port numbers below 1024 (this includes the standard HTTP(S) ports 80 and 443).
If you use single sign on in RapidMiner Server, you must change the HTTP header size. This is because the Kerberos token string is usually quite long, exceeding the default header size.
To change the header size:
Edit the file
configuration/standalone.xml
in yourRapidMiner Server home directory。Locate the extensions tag definitions (they are most likely at the beginning of the file):
. . . Immediatelyafterthe extensions tag (do not modify the extensions tag),addthe following system-properties tag, where
value
defines the maximum URL length:Save the file and restart RapidMiner Server.
If you did not configure the SMTP server during installation or need to change the outgoing email address, you can do it by editing thestandalone.xml
configuration file.
Edit the file
configuration/standalone.xml
in yourRapidMiner Server home directory。Locate the mail subsystem element, for example:
Modify the
from
,username
, andpassword
fields as required. Be certain that thefrom
field is not blank (otherwise sending emails will not work). Thefrom
andusername
fields should not be the same, unless required to be by your email provider. Thefrom
value cannot be an arbitrary address, it must be a registered alias thatusername
can send as.Locate the outbound socket element for example:
< outbound-socket-binding name = " mail-smtp " > <远程-destination host="localhost" port="25"/>
Modify the host and port fields as required.
Save the file and restart RapidMiner Server.
To verify the settings:
Log in to RapidMiner Server as administrator.
Go toAdministration > System Settings。Click on theEmail Configurationtab.
Enter an email address and click theSend test mailbutton. If the email address you entered does not soon receive an email (and you checked any junk and trash folders), consult thelog files。
Note: In theEmail Configurationtab you may see the message “The property com.rapidanalytics.mail.jndi_name is undefined. Assuming JNDI name ‘java:/Mail’. No mail session is configured under this JDNI name.”
JNDI is the Java Naming and Directory Interface, used, for example, if RapidMiner Server runs on a JBoss shared with other applications. Typically this message can be ignored. If you changed the JNDI name in the
standalone.xml
configuration file, you canconfigure the system settings你的RapidMiner服务器and set thecom.rapidanalytics.mail.jndi_name
property to the new JNDI name.
This information is only applicable if you are upgrading from versions 2.4 or earlier to version 2.5 or later using an EAR file. This step isnotnecessary if you perform a full upgrade.
RapidMiner Server version 2.5 improves repository performance when storing large example sets. To include this improvement when performing an EAR upgrade:
Edit the file
configuration/standalone.xml
in yourRapidMiner Server home directory。Locate the datasource subsystem element, for example:
jdbc:mysql://localhost:3306/rapidminer_server mysql-connector-java-5.1.31.jar . . .Add the following line to the
element:true Save the file and restart RapidMiner Server.
Changing standalone.conf(.bat) settings
The filesstandalone.conf
(Linux) orstandalone.conf.bat
(Windows) contain arguments passed to Java when RapidMiner Server starts, for example Xmx, garbage collection, etc. The file is found inbin
folder of the RapidMiner Server installation directory. The next sections describe how to change:
- Java version
Updating the Java version
Once RapidMiner Server is installed, any changes to the Java version require a change to the JAVA_HOME path. Remember that RapidMiner Server requires Java 8. To change JAVA_HOME:
In the RapidMiner Server installation directory, open
bin/standalone.conf.bat
。Change the JAVA_HOME location by changing the following line, whereJRE7is the updated Java folder:
set "JAVA_HOME=C:\Program Files\Java\
Save the file and restart RapidMiner Server.
In the RapidMiner Server installation directory, open
bin/standalone.conf
。Change the JAVA_HOME location by changing the following line, whereJRE7is the updated Java folder:
JAVA_HOME="/opt/java/
" Save the file and restart RapidMiner Server.
Changing memory usage
You can view the maximum memory setting for RapidMiner Server in theAdministration > System Informationwindow of the web interface. Total memory (amount currently assigned to RapidMiner Server by the operating system), maximum memory (maximum memory amount defined during installation), and free memory (allowed memory not currently in use) are displayed under theSystem Loadtab.
The memory usage of the RapidMinerJob AgentsandJob Containersare not included by this view. How to monitor or change the memory usage is described at theJob Agent’sandJob Container’sadministration page.
Starting from yourRapidMiner Server home directory, navigate and open the file
configuration/max-memory.conf
。The file should contain a number followed by the letter
M
。This sequence signifies the maximum amount of memory in MB that Rapidminer Server may use. For example the value8192M
means that RapidMiner Server may allocate up to 8,192 MB of RAM.To modify this setting simply replace the number with the desired amount of memory in MB, that RapidMiner Server may use.
Save the file and restart RapidMiner Server.
Please note that the maximum amount of memory is bound by the RapidMiner Server license you are using.
Please make sure that the value you specify is greater than1303M
which is the minimum Rapidminer Server memory requirement.