Chapter 17. List of Configuration Properties

By default, this property is commented out and has a dynamically computed value: path containing CloverETL value for pre 5.0 installations and CloverDX for 5.0 and newer installations.

If defined by the user, value has a higher priority.

The property can be overridden using:

environment variable clover.clover.home

context parameter <Parameter name="clover.home">

or system property -Dclover.clover.home=

This property is primarily intended to be used as a placeholder in the sandbox root path specification. So the sandbox path is specified with the placeholder and it's resolved to the real path just before it's used. The sandbox path may still be specified as an absolute path, but placeholder has some significant advantages:

* sandbox definition may be exported/imported to another environment with a different directory structure

* user creating sandboxes doesn't have to care about physical location on the filesystem

* each node in Cluster environment may have a different "sandboxes.home" value, so the directory structure doesn't have to be identical

For backward compatibility, the default value uses the content of the clover.home configuration property.

true | false If it is set to false, then the path relative to a sandbox root may point out of the sandbox. No file/folder outside of the sandbox is accessible by the relative path otherwise.

If enabled, the Server scans the ${sandboxes.home} directory during the first start with an empty database and imports all subdirectories as shared sandboxes. It skips hidden directories (e.g. .git).

Enables/disables the job queue. See Job Queue for more details about job queue.

Enables/disables processing of Data Services by the job queue. By default Data Services are not processed by the job queue, see Job Queue Impact for more details.

System CPU load that is considered high and job queue will start enqueuing jobs, see Job Queue Load Metrics for more details. The value 0.85 means 85% system CPU load. This property can be used to tweak the CPU load threshold from which jobs will be enqueued.

Usage of JVM heap memory in Server Core that is considered high and job queue will enter emergency mode, see Job Queue Emergency Mode for more details. The value 0.9 means 90% use of heap memory. This property can be used to tweak the Server Core heap memory usage threshold from which job queue will enter emergency mode.

Usage of JVM heap memory in Worker that is considered high and job queue will enter emergency mode, see Job Queue Emergency Mode for more details. The value 0.9 means 90% use of heap memory. This property can be used to tweak the Worker heap memory usage threshold from which job queue will enter emergency mode.

Maximum number of jobs that can be enqueued at one time - i.e. the maximum size of the queue. Each enqueued job consumes a small amount of memory, this property protects the CloverDX Server from running out of memory.

Time interval (in milliseconds) between each evaluation of job queue. This property defines how often the job queue processes enqueued jobs to be started, checks performance metrics etc. See Job Queue Algorithm for more details.

The job queue starts enqueued jobs in batches, and load step defines the size of the batch (i.e. number of jobs started at the same time). The load step is automatically adjusted by the job queue, and the jobqueue.initialLoadStep property defines the initial value of the load step. See Job Queue Algorithm for more details.

The job queue starts enqueued jobs in batches, and load step defines the size of the batch (i.e. number of jobs started at the same time). The load step is automatically adjusted by the job queue, and the jobqueue.minLoadStep property defines the minimum value of the load step. See Job Queue Algorithm for more details.

The job queue starts enqueued jobs in batches, and load step defines the size of the batch (i.e. number of jobs started at the same time). The load step is automatically adjusted by the job queue, and the jobqueue.maxLoadStep property defines the maximum value of the load step. See Job Queue Algorithm for more details.

Specifies the location of the OpenSSH configuration file which allows you to define SSH access outside of CloverDX Server. The path to the file is ~/path/to/.ssh/ssh_config There is no default file; therefore, without proper specification, no configuration file is loaded.

List of features which are accessible using HTTP and which should be protected by Basic HTTP Authentication. The list has form of semicolon separated items; Each feature is specified by its servlet path.

Realm string for HTTP Basic Authentication.

List of features which are accessible using HTTP and which should be protected by HTTP Digest Authentication. The list has form of semi-colon separated items. Each feature is specified by its servlet path.

Please keep in mind that HTTP Digest Authentication is feature added to the version 3.1. If you upgraded your older CloverDX Server distribution, users created before the upgrade cannot use the HTTP Digest Authentication until they reset their passwords. So when they reset their passwords (or the admin does it for them), they can use Digest Authentication as well as new users.

Enable/disable protection of Simple HTTP API and REST API against CSRF attacks, enabled by default. The CSRF protection requires presence of the X-Requested-By header in the requests.

For more details, see the section called “CSRF Protection”.

Format of log that can be seen in Monitoring > Logs > Worker.

Size of log that can be seen in Monitoring > Logs > Worker.

Number of threads which are always active (running or idling). Related to a thread pool for processing server events.

Max size of the queue (FIFO) which contains tasks waiting for an available thread. Related to a thread pool for processing server events. For queueCapacity=0, there are no waiting tasks, each task is immediately executed in an available thread or in a new thread.

Max number of active threads. If no thread from a core pool is available, the pool creates new threads up to "maxPoolSize" threads. If there are more concurrent tasks then maxPoolSize, thread manager refuses to execute it.

Switch for idling threads timeout. If true, the "corePoolSize" is ignored so all idling threads may be time-outed

timeout for idling threads in seconds

Enables or disables simple HTTP API.

If the HTTP API is disabled, there is no link to HTTP API operations in login page, the HTTP API tab in Launch Service that is accessible under Test button is not visible, and the HTTP API, the /clover/httpapi.jsp and HTTP API servlet are not accessible.

Available since 4.8.0M1. See Simple HTTP API.

Maximum depth for webDAV method PROPFIND. When the depth is not specified, the default is supposed to be infinite (according to the rfc2518), however it's necessary to set some limit, otherwise the webDav client might overload the server filesystem.

Also if the depth value specified by webDAV client in the request is higher than the pre-configured max depth, only the pre-configured maximum is used.

Whether REST API returns absolute URLs to resources. By default it returns absolute URLs (e.g. http://example.com:8080/clover/api/rest/v1/dashboards/1/monitors/191) that contain the full hostname. Absolute URLs are easier to use, but in some cases they might not be correct, e.g. in case of connecting through a load balancer. In such case it is possible to set this property to false and the REST API will return relative URLs, e.g. /clover/api/rest/v1/dashboards/1/monitors/191.

The periodicity of Groovy checks for Groovy event listeners (in milliseconds).

Displays/hides the debug window.

The maximum time interval (in hours) for which the data in Performance Tab is recorded.

Note: longer time intervals increase Server memory consumption and may increase latency when using Server GUI.

Sets the background color of the Instance Indicator.

Possible values are: green, blue, yellow and red. If a wrong value is set, the color is inherited from the GUI's header.

For the changes to take effect, you must log out and then back in the Server.

Sets the label of the Instance Indicator. Note that too long label will be cropped in the GUI.

For the changes to take effect, you must log out and then back in the Server.

Value of the property is a version number. If the version of CloverDX Server you are upgrading to is equal or less than the version, database patching will be started automatically. Otherwise a user approval is required. Example autoapply_sys_db_patches=5.7 or autoapply.sys.db.patches=99.9..

How often the Operations Dashboard refreshes its content, in milliseconds.

Timeout for HTTP requests from the Operations Dashboard to the REST API, in milliseconds.

Enable/disable the Worker. To enable Worker, set to 1 (this is the default). To disable Worker and run all jobs in Core Server, set to 0.

Starting more than one Worker is currently (in 4.9.0) not supported.

Port range used for communication between Server Core and Worker and between Workers on different Cluster nodes. Communication between Server Core and Worker is done on localhost. Workers on different Cluster nodes communicate directly with each other over these ports - in Cluster setup, this port range should be open in firewall for other Cluster nodes.

This property can be easily configured in the Worker tab of Setup.

worker.portRange should contain at least 5 ports for 1 node (depending on other options, a node takes at most 5 ports from the range). We recommend to use portRange of at least 10 ports to avoid possible problems with occupied ports after restart of Worker.

If more Cluster nodes run on the same machine, make sure that there are enough free ports for Workers of all Cluster nodes on the machine. The default configuration of worker.portRange is sufficient for that.

Timeout for connection initialization between Worker and Server Core, in both directions. The timeout is in milliseconds.

This setting can be useful when handling communication issues between Server Core and Worker, typically under high load you might want to increase the timeout.

Read timeout for communication requests between Worker and Server Core, in both directions. If a request is not completely served before reaching this limit, the connection is terminated. The timeout is in milliseconds.

This setting can be useful when handling communication issues between Server Core and Worker, typically under high load you might want to increase the timeout.

A directory with additional .jar files to be added to the Worker's classpath. The .jar files would typically be libraries used by graphs (e.g. JDBC drivers for database connections) or JDBC drivers used in JNDI connections defined in Worker (see Worker - JNDI Properties).

The Worker's classpath is separate from Server Core (i.e. application container classpath). Any libraries needed by jobs executed on Worker need to be added on the Worker's classpath.

For backward compatibility, the default value uses the content of the clover.home configuration property.

The property can contain paths to multiple directories. The separator between the directories can be a colon (on Linux and Mac) or semicolon (Linux, Mac and Windows), e.g.:

worker.classpath=/home/clover/worker-lib;/opt/worker-lib-2

Some basic wildcards are supported: directory-* and directory-?.

The maximum Java heap size of Worker in MB, it will be translated to the -Xmx option for the Worker's JVM. Jobs executed in the Worker require heap memory based on their complexity, dataset size, etc.

See our recommendations for heap sizes of Worker and Server Core.

This property can be easily configured in the Worker tab of Setup.

Setting to 0 uses Java default heap size (automatically determined by Java). This setting is not recommended for production usage.

The initial Java heap size of Worker in MB, it will be translated to the -Xms option for the Worker's JVM. We recommend to set this to the same value as worker.maxHeapSize

This property can be easily configured in the Worker tab of Setup.

Setting to 0 uses Java default initial heap size (automatically determined by Java). This setting is not recommended for production usage.

Adds Java command line options for the Worker's JVM. This property is useful to tweak the configuration of the Worker's JVM, e.g. to tune garbage collector settings. These command line options override default options of the JVM.

For example to enable parallel garbage collector: -XX:+UseParallelGC.

See Additional Diagnostic Tools section for useful options for troubleshooting and debugging Worker.

This property can be easily configured in the Worker tab of Setup.

Sets whether system Java properties are inherited from the Server Core process to the Worker process. We automatically inherit some system properties to simplify the Worker configuration.

For the list of system Java properties inherited from the Server Core to Worker, see properties passed from Server Core if worker.inheritSystemProperties is true.

This functionality is enabled by default. Use this property to disable this behavior in case some of the inherited properties would cause issues.

Absolute path to the Java binary for Worker process, e.g. /user/local/java/bin/java.

Use this property if you need to use a specific Java binary for running the Worker.

Note: Make sure that Worker uses the same major Java version as the Server Core (e.g. Java 11). Using different major Java versions is not supported.

Enables or disables an SSL connection for Worker. Note that if the Server runs on HTTPS, SSL is enabled automatically; however, this property has a higher priority.

The alias of the key in keyStore. Optional - the property does not have to be specified if there is only one key in the KeyStore.

Standard SSL related properties.

Values of the properties containing passwords are encrypted.

javax.net.ssl.keyStore is passed only if javax.net.ssl.keyStorePassword is not empty.

See also SSL properties for Worker.

Properties for proxy configuration.

The properties with * are passed for http, https and ftp.

From the worker.enableDebug property; * is a dynamically determined port used by the debugger. The port can be seen in the Worker section of the Monitoring or Setup page.

The absolute path to a file containing encrypted keystore and truststore passwords for Worker. See also SSL properties for Worker.

Worker-specific SSL configuration properties.

Values of the properties containing passwords are encrypted.

If the standard SSL properties are used (see above), the Worker-specific properties don't have to be configured. See also SSL properties for Worker.