OneDB Explore Agent Configuration

A properties file is required to run the OneDB Explore agent.

When starting the agent, you can pass the properties file name as part of the start command. Otherwise, the agent will look for a properties file named agent.properties in the classpath.

An example configuration file documenting the supported OneDB Explore agent configuration properties can be found at $INFORMIXDIR/hq/OneDB Explore-agent-example.properties.

informixServer.id

The id of the Informix database server in OneDB Explore. You find the server’s id on the server’s Setup page in the OneDB Explore UI.

server.host

The host name on which the OneDB Explore server is running.

server.port

The port on which the OneDB Explore server is running.

dataSource.IFX_ISOLATION_LEVEL

Specifies the isolation level to set on JDBC connections to the target and repository Informix database servers.

The default value is 1 (DIRTY READ).

pool.connectionTimeout

Specifies the number of milliseconds to wait for a JDBC connection to the target or repository Informix 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 OneDB Explore agent will maintain a connection pool for the target database server and another a connection pool for the repository database server. 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 3.

pool.minimumIdle

The minimum number of idle JDBC connections in each connection pool. The OneDB Explore agent will maintain a connection pool for the target database server and another a connection pool for the repository database server. Setting pool.minimumIdle to zero indicates that all JDBC connections in the connection pool should be closed when they exceed the pool.idleTimeout. 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.

ssl.enable

Whether SSL should be enabled to secure web socket communication between the agent and the OneDB Explore server. Set this value to true if theOneDB Explore server port specified in server.port is an HTTPS port.
Note: if redirectHTTPtoHTTPS is set to true in the OneDB Explore server configuration file, you must set this value to true in the agent configuration file.

If ssl.enable is set to true, you must also configure the ssl.keystore.file and ssl.keystore.password configuration properties.

The default value is false.

ssl.keystore.file

The path to the keystore file that contains the certificate to use for encrypting web socket communication between the agent and the OneDB Explore server. This property must be set if ssl.enable is set to true.

ssl.keystore.password

The password to unlock the keystore file for used for encrypting web socket communication between the agent and the OneDB Explore server.

This property must be set if ssl.enable is set to true.

target.informixdir

Optionally, specify the directory on the local machine where Informix is installed. If left empty, the agent will query the server for the INFORMIXDIR property. This property is used by sensors that gather data from onstat or other Informix utilities

target.onlinelog

Optionally specify the path to the online.log file for the target Informix database server.

If this is left empty and the Online Log monitoring sensor is enabled for this server, the agent will lookup the online.log file path by querying the database server.

There is no default value.

target.ping.frequency

Specifies the interval, in seconds, between pings to the target database server to see if it is still online. When the agent is running, it will regularly monitor whether the target database server is online or offline. This property controls the duration between these checks.

The default value is 1, indicating to check the server status every second.

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.requireUpperCase

Controls whether user passwords are required to include at least one uppercase 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.