Table 16.1. General configuration
| key | description | default |
|---|---|---|
| config.file | location of CloverETL Server configuration file | [working_dir]/ cloverServer.properties |
| license.file | location of CloverETL Server licence file (license.dat) | |
| engine.config.file | location of CloverETL engine configuration properties file | properties file packed with CloverETL |
| private.properties | List of server properties which are used only by CloverETL Server code. So these properties are not accessible outside of the ServerFacade. By default there are all properties which may contain password in the list. Basically it means, that their values are not visible for web GUI users. Values are replaced by single star "*". Changes in this list may cause unexpected behavior of some server API. | jdbc.password,executor.password,security.ldap.password,clover.smtp.password |
| engine.plugins.src | This property may contain absolute path to some "source" of additional CloverETL engine plugins. These plugins are not a substitute for plugins packed in WAR. "Source" may be directory or zip file. Both directory and zip must contain subdirectory for each plugin. Changes in the directory or the ZIP file apply only when the server is restarted. For details see section "Extensibility - engine plugins". | empty |
| datasource.type | Set this explicitly to JNDI if you need CloverETL Server to connect to DB using JNDI datasource. In such case, parameters "datasource.jndiName" and "jdbc.dialect" must be set properly. Possible values: JNDI | JDBC | JDBC |
| datasource.jndiName | JNDI location of DB DataSource. It is applied only if "datasource.type" is set to "JNDI". | java:comp/env/jdbc/clover_server |
| jdbc.driverClassName | class name for jdbc driver name | |
| jdbc.url | jdbc url used by CloverETL Server to store data | |
| jdbc.username | jdbc database user name | |
| jdbc.password | jdbc database user name | |
| jdbc.dialect | hibernate dialect to use in ORM | |
| quartz.driverDelegateClass | SQL dialect for quartz. Value is automatically derived from "jdbc.dialect" property value. | |
| security_enabled | true | false If it is set to false, then no authentication is required and anyone has admin privileges. | true |
| security.default_domain | Domain which all new users are included in. Stored in user's record in the database. Shouldn't be changed unless the "clover" must be white-labelled. | clover |
| security.basic_authentication.features_list | Semi-colon separated list of features which are accessible using HTTP and which should be protected by Basic HTTP Authentication. Each feature is specified by its servlet path. | /request_processor;/simpleHttpApi;/launch;/launchIt;/downloadStorage;/downloadFile;/uploadSandboxFile;/downloadLog |
| security.basic_authentication.realm | Realm string for HTTP Basic Authentication. | CloverETL Server |
| security.digest_authentication.features_list | Semi-colon separated list of features which are accessible using HTTP and which should be protected by HTTP Digest Authentication. 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 CloverETL 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. | /webdav |
| security.digest_authentication.realm | Realm string for HTTP Digest Authentication. If it is changed, all users have to reset their passwords, otherwise they won't be able to access to the server features protected by HTTP digest Authentication. | CloverETL Server |
| security.digest_authentication.nonce_validity | Interval of validity for HTTP Digest Authentication specified in seconds. When the interval passes, server requires new authentication from the client. Most of the HTTP clients do it automatically. | 300 |
| clover.event.fileCheckMinInterval | Interval of file checkes (in milliseconds) See Chapter 10, File event listeners for details. | 1000 |
| clover.smtp.host | SMTP server hostname or IP address | |
| clover.smtp.port | SMTP server port | |
| clover.smtp.authentication | true/false If it is false, username and password are ignored | |
| clover.smtp.username | SMTP server username | |
| clover.smtp.password | SMTP server password | |
| logging.project_name | used in log messages where it is neccessary to name the product name | CloverETL |
| logging.default_subdir | name of default subdirectory for all server logs; it is relative to the path specified by system property "java.io.tmpdir". Don't specify absolute path, use properties which are intended for absolute path. | cloverlogs |
| launch.log.dir | Location, where server should store launch requests logs. See Launch Services section for details. | ${java.io.tmpdir}/[logging.default_subdir]/launch where ${java.io.tmpdir} is system property |
| graph.logs_path | Location, where server should store Graph run logs. See Logging section for details. | ${java.io.tmpdir}/[logging.default_subdir]/graph where ${java.io.tmpdir} is system property |
| temp.default_subdir | Name of default subdirectory for server tmp files; it is relative to the path specified by system property "java.io.tmpdir". | clovertmp |
| graph.debug_path | Location, where server should store Graph debug info. | ${java.io.tmpdir}/[temp.default_subdir]/debug where ${java.io.tmpdir} is system property |
| graph.dictionary_path | Location, where server should store graph dictionary temporary files. | ${java.io.tmpdir}/[temp.default_subdir]/dictionary where ${java.io.tmpdir} is system property |
| graph.pass_event_params_to_graph_in_old_style | Since 3.0. It is switch for backwards compatibility of passing parameters to the graph executed by graph event. In version prior to 3.0 all params has been passed to executed graph. Since 3.0 just specified parameters are passed. Please see Task - Execution of Graph for details. | false |
| threadManager.pool.corePoolSize | Number of threads which are always active (running or idling). Related to thread pool for processing server events. | 4 |
| threadManager.pool.queueCapacity | Max size of the queue(FIFO) which contains tasks waiting for thread. Related to thread pool for processing server events. It means, that there won't be more then "queueCapacity" waiting tasks. i.e. queueCapacity=0 - no waiting tasks, each task is immediatelly executed in available thread or in new thread. queueCapacity=1024 - up to 1024 tasks may be waiting in the queue for available thread from "corePoolSize". | 12 |
| threadManager.pool.maxPoolSize | Max number of active threads. If no thread from core pool is available and queue capacity is exceeded, pool creates new threads up to "maxPoolSize" threads. If there are more concurrent tasks then maxPoolSize, thread manager refuses to execute it. Thus keep queueCapacity or maxPoolSize big enough. | 1024 |
| task.archivator.batch_size | Max number of records deleted in one batch. It is used for deleting of archived run records. | 50 |
| launch.http_header_prefix | Prefix of HTTP headers added by launch services to the HTTP response. | X-cloveretl |
| task.archivator.archive_file_prefix | Prefix of archive files created by archivator. | cloverArchive_ |
| license.context_names | Comma separated list of web-app contexts which may contain license. Each of them has to start with slash! Works only on Apache Tomcat. | /clover-license,/clover_license |
| license.display_header | Switch which specifies whether display license header in server web GUI or not. | false |
Table 16.2. Defaults for graph execution configuration - see section Graph config properties for details
| key | description | default |
|---|---|---|
| executor.tracking_interval | Interval in milliseconds for scanning current status of running graph. The shorter interval, the bigger log file. | 2000 |
| executor.log_level | Log level of graph runs. TRACE | DEBUG | INFO | WARN | ERROR | INFO |
| executor.max_running_concurrently | Amount of graph instances which may exist(or run) concurrently. 0 means no limits | 0 |
| executor.max_graph_instance_age | Interval in milliseconds. Specifies how long graph instance can be idling before it is released from memory. 0 means no limits. This property has been renamed since 2.8. Original name was executor.maxGraphInstanceAge | 0 |
| executor.classpath | Classpath for transformation/processor classes used in the graph. Directory [sandbox_root]/trans does not have to be listed here, since it is automatically added to graph run classpath. | |
| executor.skip_check_config | Disables check of graph configuration. Increases performance of graph execution, however may be useful during graph development. | true |
| executor.password | Password for decoding of encoded DB connection passwords. | |
| executor.verbose_mode | If true, more descriptive logs of graph runs are generated. | true |
| executor.use_jmx | If true, graph executor registers jmx mBean of running graph. | true |
| executor.debug_mode | If true, edges with enabled debug store data into files in debug directory. See property "graph.debug_path" | false |
See "Clustering" section for more properties.