Differences

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

Link to this comparison view

Both sides previous revision Previous revision
Next revision		 Previous revision
devel:documentation:modules [2019/03/01 11:38] – [Admin guide (to be completed)] change of title kotisovamdevel:documentation:modules [2025/08/11 05:28] (current) – [Table] kopro
Line 1: Line 1:
-<- .:confidential_storage | Confidential storage agenda ^ .:start | Documentation ^ .:modules_reg | Modules: User registration -> 
- 
 ====== Modules ====== ====== Modules ======
  
-The Architecture of CzechIdM is highly [[.architecture:dev:modularity| modular]]. The core module serves as a basic module and is essential for the application run. All other modules are usually dependent on the Core module. The Acc module users Core module services and is also very important to the application, but the application can run with the module turned off. The module takes care of user accounts on connected systems. Usually the module is ON on almost all cases.  +The Architecture of CzechIdM is highly [[.:architecture:dev:modularity|modular]]. The core module serves as a basic module and is essential for the application run. All other modules are usually dependent on the Core module. The Acc module users Core module services and is also very important to the application, but the application can run with the module turned off. The module takes care of user accounts on connected systems. Usually the module is ON on almost all cases. Other important module for the application is IC module. It manages the communication with the connected systems. The module is ON in almost all cases.
-Other important module for the application is IC module. It manages the communication with the connected systems. The module is ON in almost all cases.+
  
-Except basic application modules, there are other complementary modules available. [[https://www.czechidm.com/blog/slide/modules/| Modules Pricing]]+<note important>Supported modules in IDM 14 with their dependencies are in this table: [[https://docs.google.com/spreadsheets/d/1icIENKkdeN5ADmD3UOYusonkkkhcETlmQqQmxFoBIhc/edit#gid=0|Google Sheets]]</note>
  
-^ Basic application modules  ^ description                                                                                                       ^ documentation                   ^ license  ^ available  ^ +Except basic application modules, there are other complementary modules available.
-| core                       | Application core - basic services, entities and REST interface                                                    | [[.:start]]                     | MIT      | for free   | +
-| acc                        | user account management                                                                                           |                                 | MIT      | for free   | +
-| ic                         | Connectors for the communication with other systems. At the time mainly ConnId project connectors are supported.  | [[.systems:dev:ic-connectors]]  | MIT      | for free   | +
-| example                    | Example module, servers for new developers as example                                                             |                                 | MIT      | for free   | +
-| vs                         | Virtual systems - manage accounts on systems via tasks                                                            | [[.:modules_vs]]                | MIT      | for free   | +
-| rpt                        | Reports module. Interfaces for creating new reporst                                                               | [[.:modules_rpt]]               | MIT      | for free   | +
-| extras                     | Contains various features, which are not suited to be in any other module                                         | [[.:modules_extras]]            | MIT      | for free   | +
-^ Complementary modules      ^ description                                                                                                       ^ documentation                   ^ license  ^ available  ^ +
-| reg                        | Users registration to CzechIdM via web GUI                                                                        | [[.:modules_reg]]               |          | paid       | +
-| ca                         | Internal certificate authority with RESTful API (deprecated)                                                      | [[.:modules_ca|]]               |          | paid       | +
-| openam                     | OpenAM user authentication, user data exchange                                                                    | [[.:modules_openam]]            |          | paid       | +
-| pwd-reset                  | Password reset module. User can reset lost password via email link                                                | [[.:modules_pwd]]               |          | paid       | +
-| reports                    | Reports module. Admins can prepare a report of users or roles and download it                                     | [[.:modules_reports]]           |          | paid       | +
-| crt                        | Managing of certificates and certificate authorities                                                              | [[.:modules_crt|]]              |          | paid       | +
-| sms                        | Sms gateway module with implementation of some gateways                                                           | [[.:modules_sms|]]              |          | paid       |+
  
 +^ Basic application modules  ^ description                                                                                                       ^ documentation                                                  ^ license  ^ available  ^
 +| core                       | Application core - basic services, entities and REST interface                                                    | [[.:start|]]                                                   | MIT      | for free   |
 +| acc                        | user account management                                                                                           |                                                                | MIT      | for free   |
 +| ic                         | Connectors for the communication with other systems. At the time mainly ConnId project connectors are supported.  | [[.:systems:dev:ic-connectors|]]                               | MIT      | for free   |
 +| example                    | Example module, servers for new developers as example                                                             |                                                                | MIT      | for free   |
 +| vs                         | Virtual systems - manage accounts on systems via tasks                                                            | [[.:modules_vs|Modules - Virtual systems [vs]]]                | MIT      | for free   |
 +| rpt                        | Reports module. Interfaces for creating new reporst                                                               | [[.:modules_rpt|Modules - Reports [rpt]]]                      | MIT      | for free   |
 +| extras                     | Contains various features, which are not suited to be in any other module                                         | [[.:modules_extras|]]                                          | MIT      | for free   |
 +^ Complementary modules      ^ description                                                                                                       ^ documentation                                                  ^ license  ^ available  ^
 +| reg                        | Users registration to CzechIdM via web GUI                                                                        | [[.:modules_reg|Modules - User registration [reg]]]            |          | paid       |
 +| ca                         | Internal certificate authority with RESTful API (deprecated - use crt instead)                                    | [[.:modules_ca|Modules - Certificate authority [ca]]]          |          | paid       |
 +| openam                     | OpenAM user authentication, user data exchange                                                                    | [[.:modules_openam|Modules - OpenAM authentication [openam]]]  |          | paid       |
 +| pwd-reset                  | Password reset module. User can reset lost password via email link                                                | [[.:modules_pwd|Modules - Password reset [pwd-reset]]]         |          | paid       |
 +| reports                    | Reports module. Admins can prepare a report of users or roles and download it                                     | [[.:modules_reports|Modules - Implemented reports [reports]]]  |          | paid       |
 +| crt                        | Managing of certificates and certificate authorities                                                              | [[.:modules_crt|Modules - Certificates [crt]]]                 |          | paid       |
 +| sms                        | Sms gateway module with implementation of some gateways                                                           | [[.:modules_sms|Modules - SMS [sms]]]                          |          | paid       |
 +| tech                       | Technical accounts managing                                                                                       | [[.:modules_tech|Modules - Technical accounts [tech]]]         |          | paid       |
 +| prp                        | Property and License - manage a list of property or licenses via IdM roles                                        | [[.:modules_prp|Modules - Property and licences [prp]]]        |          | paid       |
 +| pwd-sync                   | AD Domain Password synchronization to IdM (ctrl+alt+del)                                                          | TODO                                                           |          | paid       |
 +| ntf                        | Notifications - sending notification to users after executed events                                               | [[.:modules_ntf|Modules - Notifications [ntf]]]                |          | paid       |
 +| gdpr                       | Archives or deletes users from IdM                                                                                | [[.:modules_gdpr|Modules - GDPR]]                              |          | paid       |
 +^ Future modules             ^ description                                                                                                       ^ documentation                                                  ^ license  ^ available  ^
 +| ms-teams-module            | Managing Microsoft Teams                                                                                          | [[.:modules_ms_teams|Modules - MS Teams]]                      |          | paid       |
 +| ms-spo-module              | Managing Microsoft SharePoint Online sites                                                                        | [[.:modules_ms_spo|Modules - MS SharePoint Online]]            |          | paid       |
 +| ms-exo-module              | Managing Microsoft Exchange Online                                                                                | [[.:modules_ms_exo|Modules - MS Exchange Online]]              |          | paid       |
  
 In CzechIdM modules can be switched on and off in GUI. In CzechIdM modules can be switched on and off in GUI.
Line 30: Line 37:
 ====== Read more ====== ====== Read more ======
  
-===== Admin guide  ===== +===== Admin guide ===== 
-  * [[.adm:modules|Modules overview]]+ 
 +  * [[.:adm:modules|]]
  
 ===== Devel tutorials ===== ===== Devel tutorials =====
-  * [[tutorial:dev:create_new_czechidm_module| How to create a new module]] + 
-  * [[tutorial:dev:override_filter| Custom module - overwrite filters]] +  * [[:tutorial:dev:create_new_czechidm_module|How to create a new module]] 
-  * [[tutorial:dev:module_development| Module development process]]+  * [[:tutorial:dev:override_filter|Custom module - overwrite filters]] 
 +  * [[:tutorial:dev:module_development|Module development process]] 
 + 
  • by kotisovam