The following table describes the ZooKeeper properties for the Foundation microservice:
| S.NO | PROPERTY | DESCRIPTION |
|---|---|---|
| 1 | server.ssl.enabled-protocols | This property controls the SSL configuration for the Spring Boot application. |
| 2 | server.tomcat.accesslog.directory | This property holds the directory in which log files are created. It can be absolute or relative to the Tomcat's base directory. |
| 3 | server.tomcat.accesslog.enabled | This property controls the Tomcat logs for the Boot application. |
| 4 | server.tomcat.accesslog.max-days | The maximum number of days rotated access logs will be retained for before being deleted. If not specified, the default value is set to 10. |
| 5 | server.tomcat.accesslog.pattern | This property holds the pattern of the access logs to be printed. This will follow the Apache Tomcat parameters. |
| 6 | skava.auditlog.db.driverClassName | This property holds the driver class name of the MySQL server. |
| 7 | skava.auditlog.db.enabled | This property specifies whether to store the audit logs in the MySQL DB or not. The value can be:
|
| 8 | skava.auditlog.db.password | This property sets the password of the MySQL server for audit logs. |
| 9 | skava.auditlog.db.url | This property holds the DB URL of the MySQL server. |
| 10 | skava.auditlog.db.userName | This property sets the username of the MySQL server for audit logs. |
| 11 | skava.auditlog.enabled | This property enables or disables the audit log component. |
| 12 | skava.auditlog.file-location | This property sets the file location of the audit log component. |
| 13 | skava.auditlog.layout-type | This property sets the layout type of the audit log component. |
| 14 | skava.cache.cascadeCacheNames | This property enables the Cascade cache by its name. |
| 15 | skava.cache.enableCascade | This property enables or disables the Cascade cache. |
| 16 | skava.cache.enabled | This property enables or disables the cache. |
| 17 | skava.cache.localCache.config.storeCache.cacheSize | This property sets the local cache entry size. |
| 18 | skava.cache.localCache.config.storeCache.maxIdleInSeconds | This property sets the local cache maximum idle time (in seconds). |
| 19 | skava.cache.localCache.config.storeCache.timeToLiveInSeconds | This property sets the local cache expiry time (in seconds). |
| 20 | skava.cache.localCache.type | This property sets the local cache type for L1 cache used in the cascade cache (uses both in-memory cache and server-side cache using Redis). |
| 21 | skava.cache.maxCacheSize | This property holds the cache size in bytes. If the value is greater than 0, then the cache is restricted based on the value. Otherwise, no limitation for cache. |
| 22 | skava.cache.redis.cacheNames | This property holds the Redis cache names used by the application. |
| 23 | skava.cache.redis.clearCacheEventName | This property is used to set the event name for cache clear operation. |
| 24 | skava.cache.redis.client | This property indicates the type of client for Redis connection. |
| 25 | skava.cache.redis.cluster.maxRedirects | This property contains the maximum number of redirects to follow when executing commands across the clusters of the Redis server. |
| 26 | skava.cache.redis.cluster.nodes | This property contains a list of comma-separated host:port pairs to bootstrap from. This represents an initial list of cluster nodes. It is required to have at least one entry. |
| 27 | skava.cache.redis.clusterEnabled | This property enables or disables the cluster of the Redis server. |
| 28 | skava.cache.redis.database | This property holds the Redis database index used by the connection factory. |
| 29 | skava.cache.redis.enabled | This property indicates whether the Redis component needs to be enabled or disabled for this application. It is recommended that it should be enabled (true) for the production and production-grade environments (like performance). |
| 30 | skava.cache.redis.expTimeTolive | This property holds the expiration time of Redis entries. That is the maximum time the objects are requested to be held in the Redis server. Using this property you are requesting Redis to hold the objects for the specified time but it is the LRU/LCU which will determine how long an entry survives in the cache. |
| 31 | skava.cache.redis.host | This property holds the Redis server's hostname/IP for caching objects. |
| 32 | skava.cache.redis.maxTimeTolive | This property holds the expiration time of Redis entries, that is, the maximum time the objects are requested to be held in the Redis server. Using this property, you can request Redis server to hold the objects for a specified time, but it is the LRU/LCU, which determines how long an entry survives in the cache. |
| 33 | skava.cache.redis.password | This property holds the password for connecting to the Redis server. This is required if the authentication is enabled for the Redis server. It is recommended that it should be enabled for the production environment. |
| 34 | skava.cache.redis.pool.maxActive | This property holds the maximum number of connections that can be allocated by the pool at a given time. Use a negative value for no limit. |
| 35 | skava.cache.redis.pool.maxIdle | This property holds the maximum number of idle connections in the pool. Use a negative value to indicate an unlimited number of idle connections. |
| 36 | skava.cache.redis.pool.minIdle | This property holds the minimum number of idle connections to maintain in the pool. This setting only has an effect if it is positive. |
| 37 | skava.cache.redis.port | This property holds the Redis server's port for the application to connect for both read and write cache operations. |
| 38 | skava.cache.redis.sentinel.master | This property contains the name of the Redis server. |
| 39 | skava.cache.redis.sentinel.nodes | This property contains a list of comma-separated host:port pairs of the Redis server. |
| 40 | skava.cache.redis.ssl | This property enables or disables the SSL in the Redis server:
|
| 41 | skava.cache.redis.timeout | This property holds the connection timeout value of all Redis connections for both read and write. |
| 42 | skava.cache.redis.url | This property specifies the URL of the Redis server. |
| 43 | skava.cache.useOnlyL2Cache | This property enables or disables the L2 cache (that is, in-memory cache). |
| 44 | skava.core.releasedefinition.enabled | This property enables the release definition endpoint. |
| 45 | skava.cors.allowedHeaders | This property contains the allowed headers value. |
| 46 | skava.cors.allowedMethods | This property contains allowed methods for the Spring Boot controller. |
| 47 | skava.cors.allowedOrigins | This property sets allowedOrigins for a CORS request. |
| 48 | skava.cors.enabled | This property controls the SSL configuration for the Spring Boot application. |
| 49 | skava.cors.exposedHeaders | This property sets exposedHeaders for a CORS request. |
| 50 | skava.cors.maxAge | This property sets maxAge for a CORS request. The value is mentioned in seconds. |
| 51 | skava.cors.pathPattern | This property holds the pattern for a CORS request. |
| 52 | skava.event.className | This property is used to set the fully qualified name of the custom implementation class. |
| 53 | skava.event.enabled | This property enables or disables the event component. |
| 54 | skava.event.enableExternalEvent | This property is used to enable/disable the external event component. |
| 55 | skava.event.enableFatEvent | This property is used to enable/disable the fat event. |
| 56 | skava.event.eventbridge.eventBusName | This property is used to set the fully qualified name of the custom implementation class. |
| 57 | skava.event.eventbridge.region | This property is used to set the fully qualified name of the custom implementation class. |
| 58 | skava.event.externalClassName | This property is used to set the fully qualified name of the custom implementation class. |
| 59 | skava.event.externalFatEventClass | This property is used to set the fully qualified name of the custom implementation class. |
| 60 | skava.event.rabbitmq.concurrentConsumers | This property holds the value for maximum allowed concurrent consumers. |
| 61 | skava.event.rabbitmq.enabled | This property enables or disables the RabbitMQ server for the event component. |
| 62 | skava.event.rabbitmq.host | This property holds the host name of the RabbitMQ server. |
| 63 | skava.event.rabbitmq.password | This property holds the password of the RabbitMQ server. |
| 64 | skava.event.rabbitmq.port | This property holds the port of the RabbitMQ server. |
| 65 | skava.event.rabbitmq.ssl.addresses | This property sets the addresses for the RabbitMQ server cluster. |
| 66 | skava.event.rabbitmq.ssl.algorithm | This property sets the SSL algorithm, which is used for the RabbitMQ server. |
| 67 | skava.event.rabbitmq.ssl.cluster-enabled | This property enables or disables the cluster for the RabbitMQ server. |
| 68 | skava.event.rabbitmq.ssl.enabled | This property enables or disables the SSL support for RabbitMQ server. |
| 69 | skava.event.rabbitmq.userName | This property holds the username of the RabbitMQ server. |
| 70 | skava.event.rabbitmq.virtualHost | This property sets the virtual host for RabbitMQ server. |
| 71 | skava.foundation.liveEnvironment | This property is used identify the live environment and authoring environment. |
| 72 | skava.hibernate.acquireIncrement | This property determines how many connections at a time c3p0 tries to acquire when the pool is exhausted. The default value is 3. |
| 73 | skava.hibernate.c3p0IdleTestPeriod | This property holds the idle time (in seconds) before a connection is validated automatically. If the given number is greater than 0, the Hybernate connection pool c3p0 tests all idle connections pooled, but validates the connections for every number of seconds. |
| 74 | skava.hibernate.c3p0MaxSize | This property holds the maximum number of JDBC connections to be held in the pool at any given time. You need to take extra care while updating this value since it has a direct impact on the performance of the application, tune only when there is a necessity. |
| 75 | skava.hibernate.c3p0MaxStatements | This property holds the number of prepared statements that be cached. It indicates the c3p0's global PreparedStatement cache. This controls the total number of statements cached, for all connections. |
| 76 | skava.hibernate.c3p0MinSize | This property holds the minimum number of JDBC connections to be held in the pool at any given time. You need to take extra care while updating this value since it has a direct impact on the performance of the application, tune only when there is a necessity. |
| 77 | skava.hibernate.c3p0Timeout | This property holds the pool's idle connection timeout post which the connection is removed from the pool. The value is mentioned in seconds. The value 0 indicates the idle connections never expire. |
| 78 | skava.hibernate.dialect | This property holds the dialect to be used by Hibernate. The dialect specifies the type of database used in Hibernate so that Hibernate can generate appropriate type of SQL statements. |
| 79 | skava.hibernate.driverClassName | This property holds the JDBC driver class name for making the connections to the database. |
| 80 | skava.hibernate.enabled | This property indicates whether the Hibernate component is enabled or disabled for this application. It is recommended that not to update this property from the default value. |
| 81 | skava.hibernate.formatSql | This property indicates whether the SQL statements enabled for printing should be formatted or not. If this property and the property skava.hibernate.showSql is set to true then the queries are SQL formatted making it more readable. |
| 82 | skava.hibernate.hbm2ddlAuto | This property holds the strategy to be used by Hibernate on startup. The possible values are validate, update, create, or create-drop which indicate the appropriate action will be taken on startup. It is recommended that the value is to be set as none in the production and/or production-like environments because where the schema will not be created every time the application starts up. |
| 83 | skava.hibernate.hibernateReader.acquireIncrement | This property determines how many connections at a time c3p0 will try to acquire when the pool is exhausted. The default value is 3. |
| 84 | skava.hibernate.hibernateReader.c3p0IdleTestPeriod | This property holds the idle time in seconds before a connection is automatically validated. If it is greater than 0, c3p0 will test all idle, pooled but unchecked-out connections, at the specified time period (in seconds). |
| 85 | skava.hibernate.hibernateReader.c3p0MaxSize | This property holds the maximum number of JDBC connections to be held in the pool at any given time. You need to take extra care while updating this value since it has a direct impact on the performance of the application, tune only when there is a necessity. The hibernate default value is 100. |
| 86 | skava.hibernate.hibernateReader.c3p0MaxStatements | This property holds the number of prepared statements that be cached, i.e., c3p0s global PreparedStatement cache. This controls the total number of Statements cached, for all Connections. |
| 87 | skava.hibernate.hibernateReader.c3p0MinSize | This propery holds the minimum number of JDBC connections in the pool. The default hibernate value is 1. |
| 88 | skava.hibernate.hibernateReader.c3p0Timeout | This property holds the pool's idle connection timeout post which the connection is removed from the pool. The value mentioned here is in seconds. The value 0 indicates that idle connections never expire. |
| 89 | skava.hibernate.hibernateReader.enabled | This property is used to enable the reader DB. |
| 90 | skava.hibernate.hibernateReader.initialPoolSize | The number of connections a pool tries to acquire upon startup. The default value is 3. |
| 91 | skava.hibernate.hibernateReader.url | This property is used to read the database URL. |
| 92 | skava.hibernate.initialPoolSize | This property contains the number of connections a pool tries to acquire upon startup. The default value is 3. |
| 93 | skava.hibernate.newGeneratorMappings | This property holds the Hibernate setting. It indicates whether the new IdentifierGenerator implementations are used for AUTO, TABLE, and SEQUENCE or not. If it is set to false, the ID generation is left to the DB sequence or the application logic. It is recommended that this property is set as false. |
| 94 | skava.hibernate.packageToScan | This property indicates the Java package having all the database entity objects to be used by Hibernate component. |
| 95 | skava.hibernate.password | This property holds the data store password to be used by Hibernate component to connect to the database. |
| 96 | skava.hibernate.port | This property holds the port number of the database to be used by Hibernate component to connect to the database. |
| 97 | skava.hibernate.url | This property holds the database JDBC URL to enable the database connection. |
| 98 | skava.hibernate.username | This property holds the username to be used by Hibernate component to connect to the database. |
| 99 | skava.secretsmanager.className | This property specifies a class for the secret management. |
| 100 | skava.swaggerglobalparams.enabled | This property indicates the Swagger global params. The default value is false. If this property value is set to true, the Swagger global params from the application .yml will be referred and added in the Swagger UI. |
| 101 | spring.sleuth.trace-id128 | This property indicates whether the sleuth 128 bit traceid in the logs is enabled or not. The default value is true. |
| 102 | skava.hibernate.showSql | This property indicates whether the SQL generated by Hibernate to be printed in the log file or not. If it is set to true, will print all the SQLs generated by Hibernate as part of the dialect. |
| 103 | ZK_REDIS_SSL_ENABLED | This property enables or disables the Redis server SSL. The default value is FALSE. |
| 104 | ZK_REDIS_TIMEOUT | This property holds connection timeout value of Redis in milliseconds. The default value is 10000. |
| 105 | ZK_REDIS_USERNAME | This property holds the login username of the Redis server. The default value is empty. |
| 106 | ZK_PROTOCOLS | This property enables macro support for the TLS protocol version. |
| 107 | ZK_REDIS_PASSWORD | This property holds the Redis password. |
| 108 | skava.cache.redis.username | This property indicates the login username of the Redis server. |
| 109 | endpoints.loggers.enabled | This property is used to enable or disable the logger. |
| 110 | web.exposure.include | This property is used to expose the management endpoints. |
| 111 | server.max-http-header-size | To increase http header size we have externalize this property. |
| 112 | externalEventConfig.fileHost | This property is used to set the hosting events on external website. |
| 113 | externalEventConfig.tempStoragePath | This property is used to set the file path for the external events. |
| 114 | skava.event.rabbitmq.amqpEnabled | This property is used to enable AMQP (Advanced Message Queuing Protocol). When the value is
|
Revision History
2024-07-12 | SD – Updated ZK properties.
2024-06-19 | SD – Updated ZK properties for 8.17.0 to 8.16.0.
2023-10-22 | JP – Updated content for 8.15.4 release.
2023-01-05 | JP – Updated content for 8.13.0 release.
2022-04-10 | JP – Fixed link and http issues.
2021-12-27 | AN – Updated content for 8.11 release.
2020-12-16 | AN – Added the missing properties.
2020-03-09 | AN – Updated content for April 2020 release.
2020-01-14 | AN– Updated content for February 2020 release.
2019-07-09 | AM – Updated ZK properties for July 2019 release.
2019-06-08 | PLK – Minor copyedits.
2019-05-16 | AN – Updated to a new table tool.
2019-01-22 | PLK – Content uploaded.