The following table describes the ZooKeeper properties for the Search microservice:
| S.NO | PROPERTY | DESCRIPTION |
|---|---|---|
| 1 | hystrix.command.user-key.circuitBreaker.requestVolumeThreshold | This property sets the minimum number of requests in a rolling window that will trip the circuit. |
| 2 | hystrix.command.user-key.circuitBreaker.sleepWindowInMilliseconds | This property sets the amount of time, after tripping the circuit, to reject requests before allowing attempts again to determine if the circuit should again be closed. |
| 3 | hystrix.command.user-key.execution.isolation.thread.timeoutInMilliseconds | This property sets instance-specific values dynamically which overrides the preceding three levels of defaults. |
| 4 | server.servlet.contextPath | This property holds the Spring Boot application's context path. |
| 5 | server.ssl.enabled | This property controls the SSL configuration for the Boot application. |
| 6 | server.ssl.key-alias | This property holds the keystore alias name set during the import using keytool utility. |
| 7 | server.ssl.key-store | This property holds the keystore PrivateKeyEntry which will be used as the SSL certificate for the microservice. |
| 8 | server.ssl.key-store-password | This property holds the keystore password for opening the keystore mentioned in key-store property. |
| 9 | server.ssl.key-store-type | This property holds the keystore type. |
| 10 | 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. |
| 11 | server.tomcat.accesslog.enabled | This property controls the Tomcat logs for the Boot application. |
| 12 | server.tomcat.accesslog.pattern | This property is used to set the pattern for writing logs in Tomcat. |
| 13 | skava.auditlog.enabled | This property enables or disables the audit log component. |
| 14 | skava.auditlog.file-location | TThis property holds the path to store the audit logs. |
| 15 | skava.auditlog.layout-type | This property is used to denote the layout type. |
| 16 | skava.authorization.authExpiryTimeMins | This property is used to set the expiry time of auth token in milliseconds. |
| 17 | skava.authorization.authHeader | This property is used to set the header parameter name in which the auth token is passed. |
| 18 | skava.authorization.businessAdminRoleName | This property used to mention business admin user role name for the auth token generation. |
| 19 | skava.authorization.enabled | This property indicates whether the authorization component is enabled or disabled for the corresponding microservice. If the value is set as false, then all APIs are open to access without any authorization check and this is not recommended for the production or public APIs. For the production, production-like, or public environments, this property should be enabled (true). |
| 20 | skava.authorization.guestUserRoleName | This property used to mention guest user role name for the auth token generation. |
| 21 | skava.authorization.regUserRoleName | This property used to mention registered user role name for the auth token generation. |
| 22 | skava.authorization.superAdminRoleName | The property is used to set the super admin role name used in the application. |
| 23 | skava.authorization.tokenSecret | The property is used to set the secret value used for encryption and decryption of secret. |
| 24 | skava.cors.allowedHeaders | This property is used to set allowed headers for the cors request. |
| 25 | skava.cors.allowedMethods | This property is used to set allowed methods for the cors request. |
| 26 | skava.cors.allowedOrigins | This property is used to set allowed origins for the cors request. |
| 27 | skava.cors.enabled | This property is used to enable the cors component. |
| 28 | skava.cors.maxAge | This property is used to set maxAge for the cors request in seconds. |
| 29 | skava.cors.pathPattern | This property is used to set pathPattern for the cors request. |
| 30 | skava.hibernate.c3p0IdleTestPeriod | 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. |
| 31 | skava.hibernate.c3p0MaxSize | This property indicates the maximum number of JDBC connections in the pool. Hibernate default - 100. |
| 32 | skava.hibernate.c3p0MaxStatements | This property indicates the number of prepared statements will be cached. It increases the performance. Hibernate default is 0 and the caching is disabled. |
| 33 | skava.hibernate.c3p0MinSize | This property indicates the minimum number of JDBC connections in the pool. Hibernate default is 1. |
| 34 | skava.hibernate.c3p0Timeout | This property indicates when an idle connection is removed from the pool (in second). Hibernate default is 0 and never expire. |
| 35 | skava.hibernate.dialect | This property represents a dialect of SQL implemented by a particular RDBMS. |
| 36 | skava.hibernate.driverClassName | This property represents the class name of JDBC driver class. |
| 37 | skava.hibernate.enabled | This property is used to enable or disable the Hibernate component. |
| 38 | skava.hibernate.formatSql | This property is used to format the generated SQL statement to make it more readable. |
| 39 | skava.hibernate.hbm2ddlAuto | This property is used to set the strategies used for DDL generation. |
| 40 | skava.hibernate.newGeneratorMappings | This property is used to enable or disable the generator mappings. |
| 41 | skava.hibernate.packageToScan | This property is used to specify the package to scan the Hibernate component. |
| 42 | skava.hibernate.password | This property is used to set the password for the Hibernate component. |
| 43 | skava.hibernate.port | This property is used to set the port for Hibernate component. |
| 44 | skava.hibernate.showSql | This property is used to enable or disable the Hibernate generate SQL. |
| 45 | skava.hibernate.url | This property is used to set the database URL. |
| 46 | skava.hibernate.username | This property is used to set the username for Hibernate. |
| 47 | skava.localization.default-locale | This property is used to set the default locale. |
| 48 | skava.localization.enabled | This property is used to enable or disable the localization component. |
| 49 | skava.localization.externalPath | This property is used to set the external path from which the messages are read. |
| 50 | skava.localization.param-name | This property is used to set the parameter name in which the localization component is used. |
| 51 | skava.localization.resourceBundleBaseName | This property is used to set the resource bundle's base name. |
| 52 | skava.log.enabled | This property is used to enable the log component. |
| 53 | skava.log.fileAppenderEnabled | This property is used to enable the file appender log. |
| 54 | skava.log.fluentdAppenderEnabled | This property is used to enable or disable the Fluentd file appender log. |
| 55 | skava.log.fluentdHost | This property is used to set the hostname for Fluentd server. |
| 56 | skava.log.fluentdPattern | This property is used to set the pattern for writing logs in Fluentd server. |
| 57 | skava.log.fluentdPort | This property is used to set the port for Fluentd server. |
| 58 | skava.log.fluentdTagName | This property is used to set the tag name to be added in the logs. |
| 59 | skava.cache.redis.cacheNames | This property is used to set the fully qualified name of the custom implementation class. |
| 60 | skava.cache.redis.clearCacheEventName | This property is used set the event name for cache clear operation. |
| 61 | skava.cache.redis.database | This property indicates the database index used by the connection factory. |
| 62 | skava.cache.redis.enabled | This property is used to enable or disable the Redis component. |
| 63 | skava.cache.redis.expTimeTolive | This property is used to set the expiration time for the Redis messages. |
| 64 | skava.cache.redis.host | This property is used to set the Redis server host. |
| 65 | skava.cache.redis.maxTimeTolive | This property is used to set the maximum time to live in minutes for the Redis cache. |
| 66 | skava.cache.redis.password | This property sets the password of the Redis server. |
| 67 | skava.cache.redis.port | This property is used to set the Redis server port. |
| 68 | skava.cache.redis.timeout | This property sets the connection timeout value. |
| 69 | skava.cache.redis.pool.maxActive | This property indicates the maximum number of connections that can be allocated by the pool at a given time. Use a negative value for no limit. |
| 70 | skava.cache.redis.pool.maxIdle | This property indicates the maximum number of idle connections in the pool. Use a negative value to indicate an unlimited number of idle connections. |
| 71 | skava.cache.redis.pool.minIdle | This property indicates the target for the minimum number of idle connections to maintain in the pool. This setting only has an effect if it is positive. |
| 72 | skava.search.solr.confName | This property is used to define the Solr configuration name. |
| 73 | skava.search.solr.coreName | This property is used to define the Solr core name. |
| 74 | skava.search.solr.embedded | This property is used to define whether the Solr component is embedded or not. |
| 75 | skava.search.solr.enabled | This property is used to define whether the Solr component is enabled or not. |
| 76 | skava.search.solr.home | This property is used to define the Solr configuration's local path. |
| 77 | skava.search.solr.host | This property is used to define the Solr URL. |
| 78 | skava.search.solr.replica | This property indicates Solr index replication. The index replication distributes complete copies of a master index to one or more slave servers. The master server continues to manage updates to the index. All querying is handled by the slaves. |
| 79 | skava.search.solr.shard | This property indicates the Solr sharding. The Solr sharding involves splitting a single Solr index into multiple parts, which may be on different machines. When the data is too large for one node, you can break it up and store it in sections by creating one or more shards, each containing a unique slice of the index. |
| 80 | spring.application.name | This property is used to set the Spring Boot application name. |
| 81 | spring.autoconfigure.exclude | This property is used to set the autoconfiguration exclusion classes. |
| 82 | spring.sleuth.trace-id128 | This property is used to enable or disable the sleuth 128-bit trace ID in the logs. |
| 83 | spring.cloud.zookeeper.enabled | This property is used to enable or disable the ZooKeeper server. |
| 84 | spring.cloud.zookeeper.connect-string | This property is used to specify the location if the server locates somewhere other than localhost:2181. This configuration is required to locate the server. |
| 85 | spring.cloud.zookeeper.config.enabled | This property is used to enable or disable the ZooKeeper's base path. |
| 86 | spring.cloud.zookeeper.config.root | This property is used to configure the ZooKeeper's base path. |
| 87 | spring.cloud.zookeeper.config.watcher.enabled | This property is used to enable or disable the ZooKeeper watcher. |
| 88 | skava.searchsfo.searchServiceURL | This property sets the search microservice URL. |
| 89 | skava.resttemplate.cookiePolicy | This property is used to ignore cookies. |
| 90 | skava.resttemplate.cxn-timeout-m-sec | This property sets the connection timeout in milliseconds. |
| 91 | skava.resttemplate.readTimeout | This property sets the read timeout in milliseconds. |
| 92 | skava.resttemplate.cxnPoolSize | This property sets the connection pool size. |
| 93 | skava.resttemplate.defaultMaxPerRoute | This property sets the total number of concurrent connections to a specific route. The default value is 2. |
| 94 | skava.resttemplate.enabled | This property enables the resttemplate component. |
| 95 | skava.resttemplate.handleRedirects | This property enables the redirects for resttemplate component. |
| 96 | skava.resttemplate.ignore-invalid-h-t-t-p-s-cert | This property enables or disables the invalid https certificate. |
| 97 | skava.resttemplate.keyPass | This property sets the password for keystore. |
| 98 | skava.resttemplate.p12File | This property sets the p12 file path. |
| 99 | skava.resttemplate.supportedProtocols | This property sets the protocols for http calls. |
| 100 | skava.cache.redis.clusterEnabled | This property enables or disables the cluster for the Redis server. |
| 101 | skava.cache.redis.cluster.maxRedirects | This property sets the maximum number of redirects to follow when executing commands across the cluster. |
| 102 | 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. |
| 103 | skava.cache.redis.sentinel.master | This property contains the name of the Redis server. |
| 104 | skava.cache.redis.sentinel.nodes | This property contains a list of comma-separated 'host:port' pairs. |
| 105 | skava.cache.redis.ssl | This property enables or disables the Redis server's SSL. |
| 106 | skava.cache.redis.url | This property contains the URL of the Redis server. |
| 107 | skava.cache.redis.embedded | This property enables or disables the embedded Redis server URL. |
| 108 | skava.authorization.gettesttoken | This property enables the authorization endpoint for JUnit and ReadyAPI testing. |
| 109 | skava.secretsmanager.enabled | This property sets whether the secrets manager component is enabled or not. |
| 110 | skava.hibernate.initialPoolSize | This property contains the number of connections a pool will try to acquire upon startup. The default value is 3. |
| 111 | skava.hibernate.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. |
| 112 | skava.search.solr.solrAuthRequired | This property sets whether the SOLR component authentication is enabled or not. |
| 113 | skava.search.solr.userName | This property specifies the user name, which is used to connect to the SOLR. |
| 114 | skava.search.solr.password | This property specifies the password, which is used to connect to the SOLR. |
| 115 | server.ssl.enabled-protocols | This property holds the protocols enabled for this application, it takes comma separated values. |
| 116 | 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. |
| 117 | skava.event.rabbitmq.ssl.enabled | This property enables or disables the SSL support for RabbitMQ server. |
| 118 | skava.event.rabbitmq.ssl.algorithm | This property sets the SSL algorithm, which is used for the RabbitMQ server. |
| 119 | skava.event.rabbitmq.cluster-enabled | This property enables or disables the cluster for the RabbitMQ server. |
| 120 | skava.event.rabbitmq.addresses | This property sets the addresses for the RabbitMQ server cluster. |
| 121 | skava.hibernate.hikari.enabled | This property enables or disables the Hibernate Hikari component. |
| 122 | skava.hibernate.hikari.poolname | This property represents a user-defined name for the connection pool. It appears mainly in the logging and JMX management consoles to identify pools and pool configurations. The default value is auto-generated. |
| 123 | skava.hibernate.hikari.dataSourceClassName | This property is available only via programmatic configuration or IoC container. This property allows you to directly set the instance of the DataSource to be wrapped by the pool, rather than having HikariCP construct it via reflection. This can be useful in some dependency injection frameworks. When this property is specified, the dataSourceClassName property and all DataSource-specific properties will be ignored. There is no default value. |
| 124 | skava.hibernate.hikari.maximumPoolSize | This property controls the maximum size of the pool, including both idle and in-use connections. This value determines the maximum number of actual connections to the database backend. The value is determined by your execution environment. When the pool reaches to this size and no idle connections are available, the call getConnection() block for up to connectionTimeout milliseconds before timing out. The default value is 10. |
| 125 | skava.hibernate.hikari.maximumlifetime | This property controls the maximum lifetime of a connection in the pool. An in-use connection will never be retired, only when it is closed, it will then be removed. On a connection-by-connection basis, minor negative attenuation is applied to avoid mass-extinction in the pool. It is strongly recommend to set this value, and it should be several seconds shorter than any database or infrastructure imposed connection time limit. A value of 0 indicates no maximum lifetime (infinite lifetime), subject of course to the idleTimeout setting. The default value is 1800000 ms (30 minutes). |
| 126 | skava.hibernate.hikari.idleTimeout | This property controls the maximum amount of time that a connection is allowed to sit idle in the pool. This setting only applies when minimumIdle is defined to be less than maximumPoolSize. The idle connections will not be retired until the pool reaches minimumIdle connections. Whether a connection is retired as idle or not is subject to a maximum variation of +30 seconds, and average variation of +15 seconds. A connection will never be retired as idle before this timeout. A value of 0 indicates the idle connections are never removed from the pool. The minimum allowed value is 10000ms (10 seconds). The default value is 600000 ms (10 minutes). |
| 127 | skava.hibernate.hikari.prepStmtCachesize | This property sets the cache size of the PreparedStatement. |
| 128 | skava.hibernate.hikari.prepStmtCacheSqlLimit | This property sets the SQL limit of the PreparedStatement to be cached. |
| 129 | skava.hibernate.hikari.cache.prepStmts | This property sets whether the PreparedStatement is used or not. |
| 130 | skava.hibernate.hikari.useServerPrepStmt | This property sets whether the server side PreparedStatement is used or not. |
| 131 | skava.event.enabled | This property enables or disables the event component. |
| 132 | skava.event.className | This sets the fully qualified name of the custom implementation class. |
| 133 | skava.event.rabbitmq.concurrentConsumers | This property holds the value for maximum allowed concurrent consumers. |
| 134 | skava.event.rabbitmq.enabled | This property enables or disables the RabbitMQ server for the event component. |
| 135 | skava.event.rabbitmq.host | This property holds the host name of the RabbitMQ server. |
| 136 | skava.event.rabbitmq.userName | This property holds the username of the RabbitMQ server. |
| 137 | skava.event.rabbitmq.password | This property holds the password of the RabbitMQ server. |
| 138 | skava.event.rabbitmq.port | This property holds the port of the RabbitMQ server. |
| 139 | skava.event.rabbitmq.virtualHost | This property sets the virtual host for RabbitMQ server. |
| 140 | skava.cors.exposedHeaders | This property sets exposedHeaders for a CORS request. |
| 141 | skava.cache.cascadeCacheNames | This property enables the Cascade cache by its name. |
| 142 | skava.cache.enableCascade | This property enables or disables the Cascade cache. |
| 143 | skava.cache.enabled | This property enables or disables the cache. |
| 144 | skava.cache.localCache.config.Search_Collection_Attribute_Cache.cacheSize | This property sets the local cache entry size of all the collection attributes. |
| 145 | skava.cache.localCache.config.Search_Collection_Attribute_Cache.maxIdleInSeconds | This property sets the local cache maximum idle time (in seconds) of all the collection attributes. |
| 146 | skava.cache.localCache.config.Search_Collection_Attribute_Cache.timeToLiveInSeconds | This property sets the local cache expiry time (in seconds) of all the collection attributes. |
| 147 | skava.cache.localCache.config.Search_Collection_Cache.cacheSize | This property sets the local cache entry size of all the collections. |
| 148 | skava.cache.localCache.config.Search_Collection_Cache.maxIdleInSeconds | This property sets the local cache maximum idle time (in seconds) of all the collections. |
| 149 | skava.cache.localCache.config.Search_Collection_Cache.timeToLiveInSeconds | This property sets the local cache expiry time (in seconds) of all the collections. |
| 150 | skava.cache.localCache.config.Search_Property_Cache.cacheSize | This property sets the local cache entry size of all the collection properties. |
| 151 | skava.cache.localCache.config.Search_Property_Cache.maxIdleInSeconds | This property sets the local cache maximum idle time (in seconds) of all the collection properties. |
| 152 | skava.cache.localCache.config.Search_Property_Cache.timeToLiveInSeconds | This property sets the local cache expiry time (in seconds) of all the collection properties. |
| 153 | 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). |
| 154 | skava.cache.redis.client | This property indicates the type of client for Redis connection. |
| 155 | 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. |
| 156 | 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. |
| 157 | skava.cache.redis.clusterEnabled | This property enables or disables the cluster of the Redis server. |
| 158 | skava.cache.redis.embedded | This property enables or disables the embedded Redis server URL. |
| 159 | skava.cache.redis.sentinel.master | This property contains the name of the Redis server. |
| 160 | skava.cache.redis.sentinel.nodes | This property contains a list of comma-separated host:port pairs of the Redis server. |
| 161 | skava.cache.redis.ssl | This property enables or disables the SSL in the Redis server:
|
| 162 | skava.cache.redis.url | This property specifies the URL of the Redis server. |
| 163 | skava.cache.useOnlyL2Cache | This property enables or disables the L2 cache (that is, in-memory cache). |
| 164 | skava.secretsmanager.className | This property specifies a class for the secret management. |
| 165 | skava.search.liveEnvironment | This property specifies whether the deployment environment is live or authoring/staging environment. The value can be:
false. |
| 166 | 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. |
| 167 | ZK_REDIS_SSL_ENABLED | This property enables or disables the Redis server SSL. The default value is FALSE. |
| 168 | ZK_REDIS_TIMEOUT | This property holds connection timeout value of Redis in milliseconds. The default value is 10000. |
| 169 | ZK_REDIS_USERNAME | This property holds the login username of the Redis server. The default value is empty. |
| 170 | ZK_PROTOCOLS | This property enables macro support for the TLS protocol version. |
| 171 | ZK_REDIS_PASSWORD | This property holds the Redis password. |
| 172 | skava.cache.redis.username | This property indicates the login username of the Redis server. |
| 173 | ZK_SOLR_ENVIRONMENTVARIABLEENABLED | When this property is set to true for both keystore and keypassword in the environment variable for the Solr server for SSL. The default value is false. |
| 174 | ZK_SOLR_SSLENABLED | This property has a default value of false. However, when the SSL is configured for the Solr server, this property needs to be enabled as true. |
| 175 | ZK_CERT_SOLR_KEYSTORE | This keystore property is required for the SSL enablement for SOLR. |
| 176 | ZK_CERT_SOLR_KEYTOREPASSWORD | This keystore property is required to SSL enablement for SOLR. |
| 177 | endpoints.loggers.enabled | This property is used to enable or disable the logger. |
| 178 | web.exposure.include | This property is used to expose the management endpoints. |
| 179 | server.max-http-header-size | To increase http header size we have externalize this property. |
| 180 | redisScanCmdEnabled | This property is used to enable cache clear using the scan command. |
| 181 | app.apiKey | This property holds the API key which is sent to the App for authentication. The default value is ##ZK_APP_API_KEY##. |
| 182 | app.enabled | This property used to determine if the app is enabled or not. |
| 183 | app.appClassName | This property holds the app component class name (GCP/Azure). The default value is com.skava.core.app.gcp.GCPAppComponent. |
| 184 | app.host | This property holds the service endpoint URL of the App Marketplace service. The default value is ##ZK_SERVICE_END_POINT##. |
| 185 | externalEventConfig.fileHost | This property is used to set the hosting events on external website. |
| 186 | externalEventConfig.tempStoragePath | This property is used to set the file path for the external events. |
| 187 | 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 release 8.17.0 to 8.16.0
2023-10-22 | JP – Updated content for 8.15.4 release.
2022-04-10 | JP – Fixed link and http issues.
2021-12-27 | AN – Updated content for 8.11 release.
2020-12-10 | 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-05-17 | JP – Uploaded to a new table tool.
2019-04-16 | AN – Content updated for April 2019 release.
2019-01-23 | PLK – Page created and content uploaded.