The following table describes the ZooKeeper properties of the Tax microservice:
| S.NO | PROPERTY | DESCRIPTION |
|---|---|---|
| 1 | hystrix.command.tax-key.circuitBreaker.enabled | This property enable or disable for histrix. |
| 2 | hystrix.command.tax-key.circuitBreaker.requestVolumeThreshold | This property sets the minimum number of requests in a rolling window that will trip the circuit. |
| 3 | hystrix.command.tax-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. |
| 4 | hystrix.command.tax-key.execution.enabled | This property enable or disable for histrix. |
| 5 | hystrix.command.tax-key.execution.isolation.thread.timeoutInMilliseconds | 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. |
| 6 | hystrix.command.tax-key.fallback.enabled | This property enable or disable for histrix. |
| 7 | server.servlet.contextPath | This property holds the Spring Boot application's context path. |
| 8 | server.ssl.enabled | This property controls the SSL configuration for the boot application. |
| 9 | server.ssl.enabled-protocols | This property holds the protocols enabled for this application, it takes comma separated values. |
| 10 | server.ssl.key-alias | This property holds the keystore alias name set during the import using keytool utility. |
| 11 | server.ssl.key-store | This property holds the keystore PrivateKeyEntry which will be used as the SSL certificate for the microservice. |
| 12 | server.ssl.key-store-password | This property holds the keystore password for opening the keystore mentioned in key-store property. |
| 13 | server.ssl.key-store-type | This property holds the keystore type. |
| 14 | 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. |
| 15 | server.tomcat.accesslog.enabled | This property controls the Tomcat logs for the Boot application. |
| 16 | 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 of 10 |
| 17 | server.tomcat.accesslog.pattern | This property holds the pattern of the access logs to be printed. This will follow the Apache Tomcat parameters. |
| 18 | server.tomcat.max-threads | This property controls the tomcat requst thread. |
| 19 | skava.auditlog.customLayoutFormat | This property set to customize the layout option |
| 20 | skava.auditlog.db.driverClassName | This property is used to connect to the mysql db for audit logs. |
| 21 | skava.auditlog.db.enabled | This property is used to enable/disable the db for audit logs. |
| 22 | skava.auditlog.db.password | This property is used to connect to the mysql db for audit logs. |
| 23 | skava.auditlog.db.url | This property is used to connect to the mysql db for audit logs. |
| 24 | skava.auditlog.db.userName | This property is used to connect to the mysql db for audit logs. |
| 25 | skava.auditlog.enabled | This property set to enable/disable the auditlog component |
| 26 | skava.auditlog.file-location | This property set to configure the file location |
| 27 | skava.auditlog.layout-type | This property set to configure the layout type |
| 28 | skava.authorization.authExpiryTimeMins | This property holds the expiry time of authorization token generated using the getTestToken API call. The value is mentioned in minutes. |
| 29 | skava.authorization.authHeader | This property holds the HTTP request header name in which the authorization token (JWT) is passed by the caller. Since the functionality of validating token is inherited from the framework, this property's value is used for identifying the correct header and its value is considered for access/authorization checks. |
| 30 | 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). |
| 31 | skava.authorization.gettesttoken.enabled | This property is used to enable the authorization endpoint for junit and readyapi testing |
| 32 | skava.authorization.superAdminRoleName | The property indicates the Super Admin role name for the corresponding microservice. |
| 33 | skava.authorization.tokenSecret | This property holds the secret which will be used to verify the signature of the JWT passed by the caller. Only if the JWT passed by the caller found valid with respect to signature, expiry and having necessary privileges, the request will be processed further. |
| 34 | skava.cache.cascadeCacheNames | This property enables cascade cache by its name |
| 35 | skava.cache.enableCascade | This property enables cascade cache |
| 36 | skava.cache.enabled | This property enables cache |
| 37 | skava.cache.localCache.config.taxcollectionattributes.cacheSize | This property sets the local cache entry size |
| 38 | skava.cache.localCache.config.taxcollectionattributes.maxIdleInSeconds | This property sets the local cache maximum idle time in seconds |
| 39 | skava.cache.localCache.config.taxcollectionattributes.timeToLiveInSeconds | This property sets the local cache expiry time in seconds |
| 40 | skava.cache.localCache.config.taxcollections.cacheSize | This property sets the local cache entry size |
| 41 | skava.cache.localCache.config.taxcollections.maxIdleInSeconds | This property sets the local cache maximum idle time in seconds |
| 42 | skava.cache.localCache.config.taxcollections.timeToLiveInSeconds | This property sets the Local cache expiry time in seconds |
| 43 | skava.cache.localCache.type | This property set the local cache type for L1 cache used in cascade cache |
| 44 | 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. |
| 45 | skava.cache.redis.cacheNames | This property holds the Redis cache names used by the application. |
| 46 | skava.cache.redis.clearCacheEventName | This property is used to set the event name for cache clear operation. |
| 47 | skava.cache.redis.client | This property sets the type of client for redis connection. |
| 48 | skava.cache.redis.cluster.maxRedirects | This property contains the maximum number of redirects to follow when executing commands across the cluster. |
| 49 | skava.cache.redis.cluster.nodes | This property contains a list of comma-separated list of 'host:port' pairs to bootstrap from. This represents an 'initial' list of cluster nodes and is required to have at least one entry |
| 50 | skava.cache.redis.clusterEnabled | This property sets the Toggle cluster for Redis server |
| 51 | skava.cache.redis.database | This property holds the Redis database index used by the connection factory. |
| 52 | 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). |
| 53 | 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. |
| 54 | skava.cache.redis.host | This property holds the Redis server's hostname/IP for caching objects. |
| 55 | skava.cache.redis.maxTimeTolive | This property sets the max time to live in minutes time for redis cache |
| 56 | 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. |
| 57 | 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. |
| 58 | 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. |
| 59 | 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. |
| 60 | skava.cache.redis.port | This property holds the Redis server's port for the application to connect for both read and write cache operations. |
| 61 | skava.cache.redis.sentinel.master | This property contains the name of the Redis server. |
| 62 | skava.cache.redis.sentinel.nodes | This property contains a list of comma-separated list of 'host:port' pairs. |
| 63 | skava.cache.redis.timeout | This property holds the connection timeout value of all Redis connections for both read and write. |
| 64 | skava.cache.useOnlyL1Cache | This property enables L1 cache |
| 65 | skava.cache.useOnlyL2Cache | This property enables L2 cache |
| 66 | skava.core.releasedefinition.enabled | This property is used to enable the release definition endpoint |
| 67 | skava.cors.allowedHeaders | This property is used to set allowedHeaders for cors request |
| 68 | skava.cors.allowedMethods | This property is used to set allowedMethods for cors request |
| 69 | skava.cors.allowedOrigins | This property is used to set allowedOrigins for cors request |
| 70 | skava.cors.enabled | This property is used to enable the cors component |
| 71 | skava.cors.exposedHeaders | This property is used to set exposedHeaders for cors request |
| 72 | skava.cors.maxAge | This property is used to set maxAge for cors request in seconds |
| 73 | skava.cors.pathPattern | This property is used to set pathPattern for cors request |
| 74 | skava.crypto.alias | This property is used to set alias for crypto component |
| 75 | skava.crypto.enabled | This property is used to enable/disable the crypto component |
| 76 | skava.crypto.salt | This property is used to set the salt value for crypto component |
| 77 | skava.crypto.textEncryptorClass | This property is used to set the fully qualified name of the custom implementation class |
| 78 | skava.event.className | This property is used to set the fully qualified name of the custom implementation class |
| 79 | skava.event.deadLetterExchange | This property is used to set the dead letter exchange for failed messages in rabbitmq server |
| 80 | skava.event.defaultMaxRetryCount | This property is used to set maximum retries for the failed messages in rabbitmq server |
| 81 | skava.event.enabled | This property is used to enable/disable the event component |
| 82 | skava.event.enableExternalEvent | This property is used to enable/disable the external event component |
| 83 | skava.event.enableFatEvent | This property is used to enable/disable the fat event |
| 84 | skava.event.eventbridge.eventBusName | This property is used to set the fully qualified name of the custom implementation class |
| 85 | skava.event.eventbridge.region | This property is used to set the fully qualified name of the custom implementation class |
| 86 | skava.event.externalClassName | This property is used to set the fully qualified name of the custom implementation class |
| 87 | skava.event.externalFatEventClass | This property is used to set the fully qualified name of the custom implementation class |
| 88 | skava.event.rabbitmq.addresses | This property sets the addresses for the RabbitMQ server cluster. |
| 89 | skava.event.rabbitmq.cluster-enabled | This property enables or disables the cluster for the RabbitMQ server. |
| 90 | skava.event.rabbitmq.concurrentConsumers | This property is used to set the maximum allowed concurrent consumers |
| 91 | skava.event.rabbitmq.enabled | This property is used to enable/disable the rabbitmq server for the event component |
| 92 | skava.event.rabbitmq.host | This property is used to set the host for rabbitmq server |
| 93 | skava.event.rabbitmq.password | This property is used to set password for rabbitmq server |
| 94 | skava.event.rabbitmq.port | This property is used to set the port for rabbitmq server |
| 95 | skava.event.rabbitmq.queueName | This property is used to set the queue name used by the event component |
| 96 | skava.event.rabbitmq.routingKey | This property is used to set the routing key for rabbitmq server |
| 97 | skava.event.rabbitmq.ssl.algorithm | This property sets the SSL algorithm, which is used for the RabbitMQ server. |
| 98 | skava.event.rabbitmq.ssl.enabled | This property enables or disables the SSL support for RabbitMQ server. |
| 99 | skava.event.rabbitmq.topicExchange | This property is used to set the topic exchange for rabbitmq server |
| 100 | skava.event.rabbitmq.userName | This property is used to set the username for rabbitmq server |
| 101 | skava.event.rabbitmq.virtualHost | This property is used to set the virtual host for rabbitmq server |
| 102 | skava.hibernate.acquireIncrement | Determines how many connections at a time c3p0 will try to acquire when the pool is exhausted. Default- 3 |
| 103 | skava.hibernate.c3p0IdleTestPeriod | idle time in seconds before a connection is automatically validated |
| 104 | skava.hibernate.c3p0MaxSize | Maximum number of JDBC connections in the pool. Hibernate default- 100 |
| 105 | skava.hibernate.c3p0MaxStatements | Number of prepared statements will be cached. Increase performance. Hibernate default- 0 , caching is disable. |
| 106 | skava.hibernate.c3p0MinSize | Minimum number of JDBC connections in the pool. Hibernate default- 1 |
| 107 | skava.hibernate.c3p0Timeout | When an idle connection is removed from the pool (in second). Hibernate default- 0, never expire. |
| 108 | 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. |
| 109 | skava.hibernate.driverClassName | This property holds the JDBC driver class name for making the connections to the database. |
| 110 | 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. |
| 111 | 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. |
| 112 | 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. |
| 113 | skava.hibernate.hibernateReader.acquireIncrement | Determines how many connections at a time c3p0 will try to acquire when the pool is exhausted. Default- 3 |
| 114 | skava.hibernate.hibernateReader.c3p0IdleTestPeriod | idle time in seconds before a connection is automatically validated |
| 115 | skava.hibernate.hibernateReader.c3p0MaxSize | Maximum number of JDBC connections in the pool. Hibernate default- 100 |
| 116 | skava.hibernate.hibernateReader.c3p0MaxStatements | Number of prepared statements will be cached. Increase performance. Hibernate default- 0 , caching is disable. |
| 117 | skava.hibernate.hibernateReader.c3p0MinSize | Minimum number of JDBC connections in the pool. Hibernate default- 1 |
| 118 | skava.hibernate.hibernateReader.c3p0Timeout | When an idle connection is removed from the pool (in second). Hibernate default- 0, never expire. |
| 119 | skava.hibernate.hibernateReader.enabled | This property is used to enable reader DB. |
| 120 | skava.hibernate.hibernateReader.initialPoolSize | Number of Connections a pool will try to acquire upon startup. Default- 3 |
| 121 | skava.hibernate.hibernateReader.url | This property is used to read the database url |
| 122 | skava.hibernate.initialPoolSize | Number of Connections a pool will try to acquire upon startup. Default- 3 |
| 123 | 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. |
| 124 | skava.hibernate.packageToScan | This property indicates the Java package having all the database entity objects to be used by Hibernate component. |
| 125 | skava.hibernate.password | This property holds the data store password to be used by Hibernate component to connect to the database. |
| 126 | skava.hibernate.port | This property holds the port number of the database to be used by Hibernate component to connect to the database. |
| 127 | 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. |
| 128 | skava.hibernate.url | This property holds the database JDBC URL to enable the database connection. |
| 129 | skava.hibernate.username | This property holds the username to be used by Hibernate component to connect to the database. |
| 130 | skava.hikari.cachePrepStmts | This property is used to enable/disable true |
| 131 | skava.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. |
| 132 | skava.hikari.enabled | This property enables or disables the Hibernate Hikari component. |
| 133 | skava.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). |
| 134 | skava.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. |
| 135 | skava.hikari.maxLifetime | 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 will it then be removed. On a connection-by-connection basis, minor negative attenuation is applied to avoid mass-extinction in the pool. We strongly recommend setting 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. Default- 1800000 (30 minutes) |
| 136 | skava.hikari.poolName | This property represents a user-defined name for the connection pool and appears mainly in logging and JMX management consoles to identify pools and pool configurations. Default- auto-generated |
| 137 | skava.hikari.prepStmtCacheSize | This property is used to set prepStmtCacheSize |
| 138 | skava.hikari.prepStmtCacheSqlLimit | This property sets the SQL limit of the PreparedStatement to be cached. |
| 139 | skava.hikari.useServerPrepStmts | This property is used to set useServerPrepStmts |
| 140 | skava.keyprovider.algorithm | This property is used to set the algorithm to be used for encryption |
| 141 | skava.keyprovider.enabled | This property is used to enable/disable the key provider |
| 142 | skava.keyprovider.keyProviderClass | This property is used to set the fully qualified name of the custom implementation class |
| 143 | skava.keyprovider.keySize | This property is used to set the key size |
| 144 | skava.keyprovider.keystorePassword | This property is used to set the keystore password |
| 145 | skava.keyprovider.keystorePath | This property is used to set the keystore path |
| 146 | skava.localization.default-locale | This property holds the default locale to be used for all response messages if it has not been provided in the request. |
| 147 | skava.localization.enabled | This property indicates whether the localization component is enabled or not. The value true indicates it is enabled and false indicates it is disabled. |
| 148 | skava.localization.externalPath | This property holds the external path from where the localized messages are to be read from. |
| 149 | skava.localization.param-name | This property holds the parameter name in which the localization component is used. |
| 150 | skava.localization.resourceBundleBaseName | This property holds the resource bundle's base name. |
| 151 | skava.log.enabled | This property is used to set the resource bundle's base name. |
| 152 | skava.log.fileAppenderEnabled | This property indicates whether the log needs to be appended to a log file or not. If it is set to true the log is written to the log file as specified in log4j2.yml. |
| 153 | skava.log.fluentdAppenderEnabled | This property indicates whether the log file should be aggregated to Fluentd directly rather than to a file or not. |
| 154 | skava.log.fluentdHost | This property holds the hostname of Fluentd server instance where the log will be aggregated. |
| 155 | skava.log.fluentdPattern | This property holds the pattern for writing logs into the Fluentd server. |
| 156 | skava.log.fluentdPort | This property holds the port of Fluentd server instance where the log will be aggregated. |
| 157 | skava.log.fluentdTagName | This property holds the tag name to be added to the logs. |
| 158 | skava.resttemplate.cookiePolicy | This property is used to set the cookie policy |
| 159 | skava.resttemplate.cxnPoolSize | This property is used set the connection pool size. |
| 160 | skava.resttemplate.cxnTimeoutMSec | This property is used set the connection time out in milli sec. |
| 161 | skava.resttemplate.defaultMaxPerRoute | This property is used set the maximum templates per route. |
| 162 | skava.resttemplate.enabled | This property is used to enable/disable the resttemplate |
| 163 | skava.resttemplate.handleRedirects | This property is used say if it should handle redirects or not. |
| 164 | skava.resttemplate.ignoreInvalidHTTPSCert | This property is say if it should ignore invalid httpscert. |
| 165 | skava.resttemplate.keyPass | This property is used set the keyPass value |
| 166 | skava.resttemplate.p12File | This property is used set the p12File path. |
| 167 | skava.resttemplate.supportedProtocols | This property is used set the supported protocols name |
| 168 | skava.secretsmanager.className | This property is used to specify which class to be used for secret management |
| 169 | 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. |
| 170 | spring.application.name | This property holds the application name of the Spring Boot application. |
| 171 | spring.autoconfigure.exclude | This property holds the classes that are to be excluded from the Spring's autoconfiguration. |
| 172 | spring.sleuth.trace-id128 | This property is used to enable/disable the sleuth 128 bit traceid in the logs. |
| 173 | ZK_REDIS_SSL_ENABLED | This property enables or disables the Redis server SSL. The default value is FALSE. |
| 174 | ZK_REDIS_TIMEOUT | This property holds connection timeout value of Redis in milliseconds. The default value is 10000. |
| 175 | ZK_REDIS_USERNAME | This property holds the login username of the Redis server. The default value is empty. |
| 176 | ZK_PROTOCOLS | This property enables macro support for the TLS protocol version. |
| 177 | ZK_REDIS_PASSWORD | This property holds the Redis password. |
| 178 | skava.cache.redis.username | This property indicates the login username of the Redis server. |
| 179 | endpoints.loggers.enabled | This property is used to enable or disable the logger. |
| 180 | web.exposure.include | This property is used to expose the management endpoints. |
| 181 | server.max-http-header-size | To increase http header size we have externalize this property. |
| 182 | externalEventConfig.fileHost | This property is used to set the hosting events on external website. |
| 183 | externalEventConfig.tempStoragePath | This property is used to set the file path for the external events. |
| 184 | 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 | SW – Updated content for 8.13 release.
2022-04-10 | JP – Fixed link and http issues.
2021-12-27 | AN – Updated content for 8.11 release.
2020-12-10 | SW – Added missing properties.
2020-03-09 | AN – Updated content for April 2020 release.
2020-01-14 | AN – Updated content for February 2020 release.
2019-07-12 | AM – Updated ZK properties for July 2019 release.
2019-05-17 | AM – Updated to a new table tool.
2019-01-23 | PLK – Content uploaded.