HCL OneDB Explore Server Configuration

A properties file is required to run the HCL OneDB™ Explore server. When starting the HCL OneDB Explore server, you can pass the properties file name as part of the start command. Otherwise, HCL OneDB Explore will look for a properties file named OneDB Explore-server.properties in the classpath.

An example configuration file documenting all supported HCL OneDB Explore server configuration properties can be found in OneDB Explore-server-example.properties.

initialAdminPassword

When starting the HCL OneDB Explore server for the first time, an admin user will be created with the password specified in the initialAdminPassword property. This user will have system administrative privileges on the HCL OneDB Explore server which includes the ability to create other users, grant privileges, and make configuration changes to the server.

This property is only required the very first time you start the HCL OneDB Explore server. For security reasons, it is recommended that you remove this property from your OneDB Explore server configuration file after the HCL OneDB Explore server has been initialized for the first time.

alert.startNumberAlertSendThreads

Configures the number of threads in the thread pool that processes and dispatches alert notifications (by email, Twilio, Pager Duty, etc.) when an alerting incident occurs. The default number of threads is 4.

alert.numberConditionCheckThreads

Configures the number of threads in the thread pool that checks whether alerting conditions have been violated whenever new monitoring data comes in. The default number of threads is 4.

dataSource.IFX_ISOLATION_LEVEL

Specifies the isolation level to set on JDBC connections to the various OneDB database servers. The default value is 1.

hostname

The host name of the HCL OneDB Explore server. The host name determines the network adapter or interface that the HCL OneDB Explore server binds the server socket to.

The default value is an empty string. When set to an empty string, the HCL OneDB Explore server will bind to all available network interfaces on the host machine.

httpPort

The HTTP port to run the HCL OneDB Explore server on. This port will serve both the OneDB Explore web UI and the HCL OneDB Explore REST API. Set this value to -1 to disable the HTTP protocol for HCL OneDB Explore. If httpPort is set to -1, make sure that httpsPort is set to something other than -1.The default value is 8080.

httpsPort

The HTTPS port to run the HCL OneDB Explore server on. This port will serve both the HCL OneDB Explore web UI and the HCL OneDB Explore REST API.

Set this value to -1 to disable the HTTPS protocol for HCL OneDB Explore. If httpsPort is set to -1, make sure that httpPort is set to something other than -1.

If httpsPort is something other than -1, you must set the ssl.keystore.file and ssl.keystore.password properties, and potentially also the ssl.key.password property if your key password is different from the keystore password.

The default value is -1 indicating that HTTPS is disabled by default.

h2.encrypt.algorithm

Sets the algorithm for H2 database file encryption. The encryption algorithms supported by H2 are AES, XTEA, and FOG. The default value is AES.

h2.encrypt.enable

Controls whether the H2 database file which holds HCL OneDB Explore server's internal metdata is encrypted. If you set this property to true, you must also set the h2.encrypt.password property. The default value is false.

h2.encrypt.password

Sets the password to use for H2 database file encryption. If h2.encrpyt.enable is set to true, you must set the password for encryption.

pool.connectionTimeout

Specifies the number of milliseconds to wait for a JDBC connection to an OneDB database server to be established before it times out. The default value is 5000 (5 seconds).

pool.idleTimeout

Specifies the number of milliseconds that a JDBC connection can be idle in the connection pool before it is closed. The default value is 60000 (1 minute).

pool.maximumPoolSize

The maximum number of JDBC connections in each connection pool. The HCL OneDB Explore server will maintain a connection pool for each OneDB database that it needs to connect to. The pool.maximumPoolSize puts a cap on the total number of open JDBC connections that can be established to each database.

The default value is 5.

pool.minimumIdle

The minimum number of idle JDBC connections in each connection pool. The HCL OneDB Explore server will maintain a connection pool for each OneDB database server that it needs to connect to. Setting pool.minimumIdle to zero indicates that all JDBC connections in the connection pool should be closed when they have been sitting idle for longer than the pool.idleTimeout threshold. Setting pool.minimumIdle to a positive integer indicates the number of connections that should be kept open in the connection pool even when they exceed the pool.idleTimeout. The default and recommended value is 0.

redirectHTTPtoHTTPS

If set to true, HTTP traffic to HCL OneDB Explore will automatically be redirected to HTTPS. This will include web socket communication between the HCL OneDB Explore server and agent. If this value is set to true, you will be required to configure SSL in your agent configuration properties.

The default value is false.

rest.session.timeout

Specifies the number of milliseconds that a REST session can be idle before it is closed. The default value is 3600000 (60 minutes).

ssl.keystore.file

The path to the keystore file that contains the certificate to use for network encryption. This property must be set if httpsPort is set to something other than -1.

ssl.keystore.password

The password to unlock the keystore file for network encryption. If this property is not set and the HTTPS is configured, you will be prompted on the command line to enter the keystore password when starting the OneDBHCL OneDB Explore server.

ssl.key.password

The password to unlock the entry into the keystore. The default value is no password, which means to use the keystore password. If the entry into the keystore requires a password that is different from the keystore password, set this property to the entry password.

user.password.maxAge

Controls the maximum age (in days) of a user password. User passwords that are older than the max age will be considered as expired. Setting this property to zero, which is the default value, specifies that user passwords never expire. Setting this property to a value greater than zero specifies the maximum age (in days) of a user password before it expires. A user will start receiving notifications in the HCL OneDB Explore UI when the difference between the current date and the password expiration date is less than or equal to 15 days.

user.password.minLength

Controls the minimum length for a user password. The default value is 8.

user.password.requireLowerCase

Controls whether user passwords are required to include at least one lowercase character. The default value is true.

user.password.requireNumber

Controls whether user passwords are required to include at least one number. The default value is true.

user.password.requireSpecialCharacterFromSet

Controls whether user passwords are required to include at least one special character. An empty string indicates that no special characters are required. Setting this value to “!@#$%^&*()? would require user passwords to include at least one of those characters. The default value is an empty string.

user.password.requireUpperCase

Controls whether user passwords are required to include at least one uppercase character. The default value is true.