RoboServer 設定 - ヘッドレス モード

Kofax RPA には RoboServer をコマンド ラインで設定するためのユーティリティがいくつか同梱されています。ユーティリティの場所は、Kofax RPA インストール フォルダの bin サブフォルダの中です。設定ファイルはユーザー依存で、ユーザー フォルダに保存されます。詳細については、『Kofax RPA Installation Guide』(Kofax RPA インストール ガイド) の「Important Folders」(重要なフォルダ) を参照してください。

  • ConfigureRS: JMX パスワードと Management Console パスワードを RoboServer 設定ファイル (roboserver.settings) に設定します。
  • ConfigureMC: Management Console 管理者と、証明書パスワードを mc.settings ファイルに設定します。
  • ConfigureRSUser: ユーザーの追加や除去を行い、rsusers.xml ファイル内のユーザー クレデンシャルをアップデートします。このファイル内の情報を使用して、API 要求を認証します。

使用上のヘルプについては、 -h オプションでユーティリティを実行します。

Management Console (RoboServer の登録先) に接続を設定するには、次のコマンドをタイプします。

ConfigureRS -mcUrl http://admin:password@localhost:8080/ManagementConsole

すべての権限と Password1 というパスワードを持つ user1 というユーザーを作成するには、次のコマンドをタイプします。

ConfigureRSUser user1 Password1 -a

API 要求の認証を有効にするには、rsusers.xml を開いて、有効になっている属性を true にする必要があります。以下に例を示します。

Sample rsusers.xml configuration file

<?xml version="1.0" encoding="UTF-8"?>

 <userConfiguration enabled="true">
   <users>
     <user username="user1" password_hash="20c7628c31534b8718a1da00435505e4262e3f4dc305">
       <startRobot/>
       <stopRobot/>
       <shutdownRoboServer/>
     </user>
   </users>
 </userConfiguration>

Sample roboserver.settings configuration file

# Settings file for RoboServer. Some configurations contains encrypted passwords and should not be edited by hand, 
           these should be modified using dedicated commandline tools.

# The directory of use on RoboServer when the API used the DefaultRoboLibrary. On windows \ must be escaped like this 
c:\\\\users\\AppData\\Local\\Kapow\\...
defaultProject = /home/mikael.nilsson/Kapow/trunk

# Should RoboServer be allowed to access the fileSystem, or call commands/scripts. Values: true/false
sec_allow_file_system_access = false

# Will RoboServer accept JDBC drivers sent from the Management Console. Values: true/false
sec_accept_jdbc_drivers = true

# Should RoboServer log all loaded URLs to the log4j audit log. Values true/false
sec_log_http_traffic = false

# If enabled RoboServer will check credentials for API requests. Values: true/false
sec_authenticate_api_requests = false

# If enabled RoboServer generate an error when accessing a https site without a valid certificate. Values: true/false
cert_verify_https_certificates = false

# If enabled, RoboServer will only allow SSL connections from trusted client. Values true/false
cert_verify_api_certificates = false

# Configures if the the JMX service should be enabled
enable_jmx = false

# The port number for the JMX service to listen on.
jmx_port_Number = 50100

# If enabled, input for robots is exposed through JMX. Values: true/false 
jmx_show_inputs = true

# Heartbeat notification interval, in seconds
jmx_heartbeat_interval = 0

# Configure if JMX should use RMI
enable_jmx_rmi = false

# Optional RMI host and port for the JMX service. Use if you need to connect through a firewall. Example: example.com:51001
jmx_rmi_url = 

# Enables authentication for JMX requests. Values: true/false
jmx_enable_authentication = true

# The user-name used for JMX authentication
jmx_username = 

# The password used for JMX authentication. This should be created using the ConfigureRS command line tool.
jmx_password = 

# Configures if the socket service should be enabled
enable_socket_service = false

# Configures which port the RoboServer should be listening on
port = 50000

# Configures if the ssl socket service should be enabled
enable_ssl_socket_service = false

# Configures which ssl port the RoboServer should be listening on
ssl_port = 50001

# Configures if the JMS service should be enabled
enable_jms_service = false

# Configures which id the RoboServer should have when running JMS
jms_id = 1

# Configures the URL of the message broker when running JMS
broker_url = 

# Configures if the RoboServer should register to a Management Console
enable_mc_registration = false

# Specify which Management Console to register to formatted as: http[s]://<hostname>:<port number>
mc_URL = 

# The user name to use for authentication to the Management Console
mc_username = 

# The password to use for authentication to the Management Console
mc_password = 

# Specifies which cluster the RoboServer should be registered to
cluster = 

# Causes RoboServer to output status and runtime events
verbose = false

Sample mc.settings configuration file

# Settings file for Management Console. Passwords should not be edited by hand, but using the 'ConfigureMC' command line utility.


 # Should the MC web-server start a HTTP listener. Values true/false
 mc_http = true

 # Configures the port of the http listener.
 mc_http_port = 50080

 # Should the MC web-server start a HTTPs listener. Values true/false
 mc_https = false

 # Configures the port of the HTTPS listener.
 mc_https_port = 50443

 # Password for the certificate used by the HTTPs listener. This should be created using the ConfigureMC command line tool.
 mc_https_cert_password = 3W2MTrL/b2k=

 # Enables MC internal user management, to support multi user scenarios. Values: true/false
 mc_enable_usermanagement = true

 # The user-name of the MC super user.
 mc_admin_user =admin

 # The passwordHash of the MC super user. This is a salted SHA-256 hash.
 mc_admin_password =7800451255702ef8ae5f5fa0337833059d80b81d5af5872bdeafed230bab479896b6df4f63b25a24

 # Configures which hosts are allowed to upload JDBC jar files to MC. Values: NONE, LOCALHOST, ANY_HOST
 mc_allow_jdbc_upload = LOCALHOST