...
Config Key | Mandatory/Optional | Type | Purpose | ||||||
|---|---|---|---|---|---|---|---|---|---|
Category: Other configuration references | |||||||||
CT_SECURITY_BUNDLE | Mandatory | Bundle Name | This key is a pointer to the bundle from where the security configuration for Canvas must be loaded. | ||||||
CT_CACHE_BUNDLE | Mandatory | Bundle Name | This key is a pointer to the bundle from where the Cache configuration of the application can be provided to Canvas | ||||||
CT_DB_BUNDLE | Mandatory | Bundle Name | This key is a pointer to the bundle from where CT gets the details of the various data sources that the CT database framework must be aware of. | ||||||
CT_EXPORT_BUNDLE | Mandatory | Bundle Name | This key is a pointer to the bundle from where the CT Export framework must get initialized from. | ||||||
CT_MULTILINGUAL_BUNDLE | Mandatory | Bundle Name | This key is a pointer to the bundle from where the CT multilingual framework must get initialized from. | ||||||
| Mandatory | Bundle Name | This key is a pointer to the bundle from where the CT gets the web utilities related configuration. | ||||||
CT_IMPL_CLASS | Mandatory | Bundle Name | This key is a pointer to the bundle from where the CT gets the list of CT Classes implemented. | ||||||
CT_COMP_PREF_BUNDLE | Mandatory | Bundle Name | This key is a pointer to the bundle from where the CT gets the preferences to enable or disable apps, workspace, and sub workspace features. | ||||||
CT_SYSTEM_PREF_BUNDLE | Mandatory | Bundle Name | This key is a pointer to the bundle from where the CT gets the preferences to enable or disable system level features. | ||||||
CT_LOGGING_CONFIG_BUNDLE | Mandatory | Bundle Name | This key is a pointer to the bundle that provides the configuration details specific to logging done by CT. | ||||||
| CT_INFO_REPORT_BUNDLE | Optional | Bundle Name | This key is a pointer to the bundle that provides the configuration details specific to Information Report (Sigma). It is mandatory when Information Report is enabled. | ||||||
Category: Common Folders needed by Canvas | |||||||||
CT_WORK_FOLDER_PATH | Mandatory | Folder Path | This key is the working folder to CT. The CT creates additional child folders within this working folder for its various needs.In a clustered environment, this folder is expected to be specific to the node where the application is running and not shared with other nodes. For example, the log files applicable for that particular node. | ||||||
CT_WORK_CENTRALIZED_FOLDER_PATH | Mandatory | Folder Path | This key is a folder on the SAN that is available across all the nodes. This is critical on a clustered setup for any content that is shared across nodes. An example could be the user image file that needs to be accessible across all nodes in a cluster. | ||||||
| Category: Object Pool Allocation | |||||||||
| MIN_OBJECT_POOL | Mandatory | Number | This key defines the minimum number of objects that can be allocated by the pool. | ||||||
| MAX_OBJECT_POOL | Mandatory | Number | This key defines the maximum number of objects that can be allocated by the pool. | ||||||
| CACHE_IMPL_HANDLER | Mandatory | String | This key is used to define the implementation class path of the cache handler. The specified class must implement the usage of the cache handler and the default class is provided as follows:
| ||||||
| JACHE_IMPL_CLASS | Mandatory | String | This key is used to define the implementation class of the JCACHE or java-based caching mechanism to handle the data caching process. The specified class must implement the usage of the JCACHE mechanism and the default class is provided as follows:
| ||||||
| ENABLE_HAZELCAST_MANAGEMENT | Mandatory | Boolean | This key is used to enable the hazelcast caching mechanism. To enable the hazelcast caching mechanism, the value should be specified as Y. By default, N is the provided value. | ||||||
| ENABLE_JCACHE_SERVER | Mandatory | Boolean | This key is used to enable the usage of JCACHE or the java-based caching mechanism. To enable the JCACHE caching mechanism, the value should be specified as Y. By default, N is the provided value. | ||||||
| ACCESS_ENTITLEMENT_DS | Mandatory | String | This key is used to specify the usage of role access based on which the entitlements are configured, thereby paving the users with the apt user roles to access the application based on the configured user roles and entitlements. By default, this implementation class is defined as follows:
| ||||||
| ENABLE_RATE_LIMIT_CHECK | Optional | Boolean | This key is used to restrict the rate limiting threats. Rate limiting is a process in which the server requests can be restricted as part of the network controlling management, in order to restrict the repetitive application access controls so as to avert the denial of service attacks. To enable the rate limiting restriction, the value should be specified as Y, whereas if there is no need to restrict the rate limiting requests, then the value can be specified as N. | ||||||
| REQ_RATE_LIMIT | Optional | Number | This key is used to restrict the processing of multiple requests while accessing the Sigma Application, preventing the execution of multiple server requests at the same point of time. The purpose of this key is to ensure that a restriction mechanism in processing the number of multiple requests will prevent the data extraction and denial of service attacks. It is essential that this key should be specified only in seconds. | ||||||
| RUN_REQ_TIME_LIMIT | Optional | Number | This key is used to restrict the processing of multiple requests while generating the report in Sigma Application, preventing the execution of multiple server requests at the same point of time. The purpose of this key is to ensure that a restriction mechanism in processing the number of multiple requests will prevent the data extraction and denial of service attacks. It is essential that this key should be specified only in seconds. | ||||||
| SAVE_REQ_TIME_LIMIT | Optional | Number | This key is used to restrict the processing of multiple requests while saving or creating a new instance of the report in Sigma Application, preventing the execution of multiple server requests at the same point of time. The purpose of this key is to ensure that a restriction mechanism in processing the number of multiple requests will prevent the data extraction and denial of service attacks. It is essential that this key should be specified only in seconds. | ||||||
| ALLOW_DELEGATION | Optional | String | This key will return "Y" if delegation is allowed for the application. | ||||||
RATE_LIMIT_INITIAL_CAPACITY = 50 | Optional | Number | This key is a parameter to configure capacity of the bucket to fill the tokens which are used for the incoming requests. | ||||||
RATE_LIMIT_REFILL_PER_SECOND = 5 | Optional | Number | This key is a parameter to configure the no of token to refill the bucket per second. | ||||||
...