You are viewing the documentation for an outdated or unreleased devel version.
This page is also available in versions: 7.4, 7.5, 7.6, 7.7, 7.8, 8.0, 8.1, 9.0, 9.1, 9.2, 9.3, 9.4, 9.5 (current), devel

Differences

This shows you the differences between two versions of the page.

Link to this comparison view

Both sides previous revision Previous revision
devel:adm:czechidm_configuration [2017/09/13 11:21]
poulm links
devel:adm:czechidm_configuration [2017/11/06 22:19] (current)
poulm moved to tutorials
Line 1: Line 1:
 <- .:audit | Audit ^ .:start | Administrator'​s guide ^ .:workflow | Workflow -> <- .:audit | Audit ^ .:start | Administrator'​s guide ^ .:workflow | Workflow ->
  
 +
 +<note important>​moved to [[devel:​documentation:​start|Documentation]] </​note>​
  
 ====== Application configuration ====== ====== Application configuration ======
  
-===== Configuration file ===== 
- 
-CzechIdm configuration is in the file //​application.properties//​. This configuration is read at the application start. If changed, new options will be applied after application restart.  ​ 
- 
-===== Application settings in GUI ===== 
- 
-All keys in configuration file can be overridden via GUI in menu Settings -> Configuration. If the configuration property is set, the change take place instantly. 
- 
-If you want to do so, click on the green button Add in the right upper corner. Copy the desired key from the configuration file and then fill in your own value for the key. You can also store the value in the confidential storage, it means that the value is not visible in GUI (only starts represent the value) and the application keeps the reference into encrypted storage. If the value is to be used, the application use the reference and get the value for temporary usage. 
- 
-Then there is a checkbox //public//. If turned on, then the configuration can be read via REST for all users even those not authenticated. It is advised not to use it if not necessary. 
- 
-{{ :​devel:​en:​adm:​new_configuration_property.png?​600 |}} 
- 
-Of course you can define also keys that are not present in the configuration file. 
- 
-The menu Settings -> Configuration list both: 
-  * Configurable items - table with configuration properties defined in application itself. It is kept in DB and can be managed in GUI. 
-  * Static environment configuration items - read only list of configuration properties from the file. 
- 
-{{ :​devel:​en:​adm:​application_setting.png?​600 |}}  
-  
-If the key is present in both tables then only the value of the //​Configurable items// is applied. Filtering by the key name is available for //​Configurable items//. 
- 
-===== Module activation ===== 
- 
-You can activate/​deactivate CzechIdM modules via menu Settings -> Modules. There are currently 3 cards 
-  * Modules(backend) - list of all installed backend modules, administrator can Activate/​Deactivate backend modules{{ :​devel:​en:​adm:​modules_backend.png?​600 |}} 
-  * Modules(frontend) - ddto{{ :​devel:​en:​adm:​modules_frontend.png?​600 |}} 
-  * Processors - list of all application processors. Processors are responsible for event handling at the application backend.{{ :​devel:​en:​adm:​processors_list.png?​600 |}} 
- 
-If you want to activate/​deactivate module. Use Modules (backend) or Modules (frontend) card, find the module you want to activate and click the button at the end of the line. It does not matter if you choose BE or FE part of the module, the complement will be activated/​deactivated automatically. 
- 
-===== Processor activation ===== 
- 
-Processors in Setting -> Modules -> Processors are read only list. If you want to activate the processor use the following approach: 
-  - In the menu //Settings -> Modules -> Processors//​ find the processor you want to disable. Copy the configuration property key e.g. //​identity-monitored-fields-processor//​ and check the name of the module that the processor is in (first row). In our example it is //core// module. 
-  - In the menu //Settings -> Configuration//​ add new configuration property with the following format: //​[idm.sec|idm.pub].<​module_name>​.processor.<​processor_name>​.enabled//​. idm.sec means that the configuration is not public - see previous sections. //​module_name//​ and //​processor_name//​ we got in previous step. In our example the key is //​idm.sec.core.processor.identity-monitored-fields-processor.enabled//​.{{ :​devel:​en:​adm:​example_turn_on_processor_add.png?​600 |}} 
-  - Add the value //true// and save. 
  
-{{ :​devel:​en:​adm:​example_turn_on_processor.png?​600 |}} 
-If you want to deactivate processor, use //false// in the step 3.