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_extras [2019/11/06 11:14]
kopro [Get titles before and after] 		devel:documentation:modules_extras [2024/04/15 14:51] (current)
cabelkal
Line 1: Line 1:
 ====== CzechIdM - extras ====== ====== CzechIdM - extras ======
-CzechIdM - extras contains various features, which are not suited to be in any other module. List of the currently supported features is bellow. 
  
-Currently supported CzechIdM version : 9.2.2+CzechIdM - extras contains various features, which are not suited to be in any other module. List of the currently supported features is below. 
 + 
 +Currently supported CzechIdM version : 11.0.x 
 + 
 +[[https://github.com/bcvsolutions/czechidm-extras|https://github.com/bcvsolutions/czechidm-extras]] 
 + 
 +===== Table of compatible versions ===== 
 + 
 +^Extras version  ^Min dependency versions  ^Max dependency versions  ^Note  | 
 +|2.5.0  |idm-core-10.3.3  |UNKNOWN  |   | 
 +|2.6.0  |idm-core-10.4.4  |UNKNOWN  |   | 
 +|2.6.1  |idm-core-10.4.8  |UNKNOWN  |This version is needed for [[:tutorial:adm:import_automatic_roles_on_tree_nodes|]]  | 
 +|2.7.0  |idm-core-10.4.9  |UNKNOWN  |   |
  
 ===== Developing and releasing ===== ===== Developing and releasing =====
-<note important>Code contributions missing tests and/or documentation will be rejected. If such code is somehow present in the ''develop'' branch, the ''develop'' is considered unstable and no new releases of the module (and merges into ''master'') can be made.</note>+ 
 +How to develop a new feature in extras: 
 + 
 +  - Create a specification page in private section and consult it with module owner and other colleagues. Specification page should contain: 
 +  - Usecases - why we or user need this feature, what problem does it solve? 
 +  - Why is it in extras and not in core, or other module? 
 +  - Functional specification - how should it work, edge cases 
 +  - Ask a module owner, if this feature can be a part of extras and in which version it will be published 
 +  - Create ticket in Redmine with final requirements and with correct target version 
 +  - Implement the feature in a separate GIT branch 
 +  - Create merge request to develop or LTS version 
 +  - Get someone from product team, or module owner to review your changes 
 +  - After successfull review, ask module owner to merge you code 
 + 
 +Rules for code review: 
 + 
 +  * All new features have at least 80 percent test coverage 
 +  * All features are documented (tutorials are welcomed and may even be required if the feature is complicated) 
 +  * There are no sonar issues in commited code 
 +  * Changelog is updated 
 +  * Feature is by default turned off (can be enabled either by processor, or configuration property) 
 + 
 +<note important>If your code does not meet the requirements mentioned above, it may be rejected.</note>
  
   * When developing, use our standard gitflow:   * When developing, use our standard gitflow:
-    * Branch per feature. Branch naming as usual. +      * Branch per feature. Branch naming as usual. 
-    * Develop on top of the ''develop''. +      * Develop on top of the ''develop''. 
-    * Master branch contains tagged releases. +      * Master branch contains tagged releases. 
-    * The **only** way for code to get into master is by pull request ''develop -> master''.+      * The **only**  way for code to get into master is by pull request ''develop → master''.
  
   * Release process   * Release process
-    - After merging all features wanted for the release, one (selected) developer builds the develop. If it builds fine and tests are also OK, the developer edits module version in ''pom.xml'' and ''package.json'' files and sets it to ''X.Y.Z''. +      - After merging all features wanted for the release, one (selected) developer builds the develop. If it builds fine and tests are also OK, the developer edits module version in ''pom.xml''  and ''package.json''  files and sets it to ''X.Y.Z''. 
-    - Developer creates pull request on GitHub to merge ''develop -> master''. +      - Developer creates pull request on GitHub to merge ''develop → master''. 
-    - Repo admin (or any other authorized user) reviews the pull request, can request changes if necessary. Unresolved TODOs, missing comments, bad codestyle or documentation, suspected bugs, etc. - all those things can be grounds for change request. +      - Repo admin (or any other authorized user) reviews the pull request, can request changes if necessary. Unresolved TODOs, missing comments, bad codestyle or documentation, suspected bugs, etc. - all those things can be grounds for change request. 
-    - If the pull request is OK, repo admin merges it. +      - If the pull request is OK, repo admin merges it. 
-    - Repo admin creates a new release in GitHub interface, version is set to ''X.Y.Z'' to correspond with version set in project sources. +      - Repo admin creates a new release in GitHub interface, version is set to ''X.Y.Z''  to correspond with version set in project sources. 
-    - Repo admin pushes release into BCV Nexus. +      - Repo admin pushes release into BCV Nexus. 
-    - After release, repo admin makes changes on the ''develop'' branch: upps module version to ''X(+1).Y(+1).Z(+1)-SNAPSHOT'' in the ''pom.xml'' and ''package.json''. What the next version of the module will be is up to discussion preceding the release.+      - After release, repo admin makes changes on the ''develop''  branch: upps module version to ''X(+1).Y(+1).Z(+1)-SNAPSHOT''  in the ''pom.xml''  and ''package.json''. What the next version of the module will be is up to discussion preceding the release.
  
 ===== Virtual system import LRT ===== ===== Virtual system import LRT =====
-Documentation is available here: [[tutorial:adm:systems_-_import_of_data_from_csv|]]+ 
 +Documentation is available here: [[:tutorial:adm:systems_-_import_of_data_from_csv|]]
  
 ===== Automatic role definitions - Import of data from CSV LRT ===== ===== Automatic role definitions - Import of data from CSV LRT =====
-Documentation is available here: [[tutorial:adm:automatic_role_definitions_-_import_of_data_from_csv|]]+ 
 +Documentation is available here: [[:tutorial:adm:automatic_role_definitions_-_import_of_data_from_csv|]] 
 + 
 +===== Automatic role definitions - Import all rules LRT ===== 
 + 
 +Since module version **1.9.0**. Documentation is available here: [[:tutorial:adm:automatic_role_definitions_-_import_all_rules|]]
  
 ===== Assign roles to contract EAV - Import of data from CSV LRT ===== ===== Assign roles to contract EAV - Import of data from CSV LRT =====
-Documentation is available here: [[tutorial:adm:assign_roles_to_contract_-_import_of_data_from_csv|]]+ 
 +Documentation is available here: [[:tutorial:adm:assign_roles_to_contract_-_import_of_data_from_csv|]]
  
 ===== Roles - Import of data from CSV LRT ===== ===== Roles - Import of data from CSV LRT =====
-Documentation is available here: [[tutorial:adm:roles_-_import_data_from_csv|]]+ 
 +Documentation is available here: [[:tutorial:adm:roles_-_import_data_from_csv|]]
  
 ===== Automatic roles - adding role by node in structure ===== ===== Automatic roles - adding role by node in structure =====
-Documentation is available here: [[tutorial:adm:automatic-roles-structure-and-attribute|]]+ 
 +Documentation is available here: [[:tutorial:adm:automatic-roles-structure-and-attribute|]] 
 + 
 +===== Create automatic roles by tree structure, based on user's roles LRT ===== 
 + 
 +Since module version **2.8.0**  Documentation is available here: [[:tutorial:adm:auto_roles_based_on_user|]]
  
 ===== Status task ===== ===== Status task =====
-Documentation is available here: [[tutorial:adm:status_task_how_to_set_up|]]+ 
 +Documentation is available here: [[:tutorial:adm:status_task_how_to_set_up|]] Information about content is here: [[.:modules_extras:status_task_content|]]
  
 ===== SSO authenticate ===== ===== SSO authenticate =====
-Documentation is available here: [[documentation:security:sso_authentificate|]]+ 
 +Documentation is available here: [[:documentation:security:sso_authentificate|sso_authentificate]] 
 + 
 +===== Role force provisioning to particular system ===== 
 + 
 +The tutorial is available here: [[:tutorial:adm:force_provisioning_for_roles|]]
  
 ===== Guarantees of roles can assign their roles to everybody ===== ===== Guarantees of roles can assign their roles to everybody =====
-This feature enable that if you are guarantee at least for one role then you will see all users and you can assign/delete/edit roles for which you are guarantee. + 
-You can see all user's roles but you can't change the others for which you are not guarantee+This feature enable that if you are guarantee at least for one role then you will see all users and you can assign/delete/edit roles for which you are guarantee. You can see all user's roles but you can't change the others for which you are not guarantee
  
 For correct behavior you need to configure three new evaluators to userRole: For correct behavior you need to configure three new evaluators to userRole:
 +
   * IdentityAccessForRoleGuaranteeEvaluator   * IdentityAccessForRoleGuaranteeEvaluator
   * IdentityRoleAccessForRoleGuaranteeEvaluator   * IdentityRoleAccessForRoleGuaranteeEvaluator
   * RoleRequestAccessForRoleGuaranteeEvaluator   * RoleRequestAccessForRoleGuaranteeEvaluator
  
-Other thing you need to do is to enable service ExtrasIdmConceptRoleRequestService. This service is by default turned off in extras module. +Other thing you need to do is to enable service ExtrasIdmConceptRoleRequestService. This service is by default turned off in extras module. Go to your project modul and create new service which will inherit from ExtrasIdmConceptRoleRequestService and add annotation Primary and Service.
-Go to your project modul and create new service which will inherit from ExtrasIdmConceptRoleRequestService and add annotation Primary and Service.+
  
 Update IdmConceptRoleRequestDto is allowed everybody that will change only audited fields or systemState field (this is for update state of whole request after retry mechanism or approving virtual request). Update IdmConceptRoleRequestDto is allowed everybody that will change only audited fields or systemState field (this is for update state of whole request after retry mechanism or approving virtual request).
  
 ===== Report Compare values in IdM with values in system ===== ===== Report Compare values in IdM with values in system =====
-Report will compare value of attributes with connected system. Connected system does not need to be in read only. + 
-More information is available here: [[tutorial:adm:report_compare_value_idm_to_system|]]+Report will compare value of attributes with connected system. Connected system does not need to be in read only. More information is available here: [[:tutorial:adm:report_compare_value_idm_to_system|]]
  
 ===== Notification about the end of identity's last contract ===== ===== Notification about the end of identity's last contract =====
-A notification about the end of identity's last contract will be sent to those who have a specified role assigned and optionally the manager of the user. A different notification can be sent before the contract ends and when it ends.  
-More information is available here: [[tutorial:adm:notification_-_identity_s_last_contract_is_ending|]] 
  
-===== Get titles before and after =====+A notification about the end of identity's last contract will be sent to those who have a specified role assigned and optionally the manager of the user. A different notification can be sent before the contract ends and when it ends. More information is available here: [[:tutorial:adm:notification_-_identity_s_last_contract_is_ending|]] 
 + 
 +Edit: full IdmIdentityDto was added for use in a template in 1.7.0 
 + 
 +Edit: Support for technical identities added for use in version 1.9.0 
 + 
 +===== Notification about the start of identity's contract ===== 
 + 
 +Since version 3.2.3 
 + 
 +A notification about start of identity's contract will be send to specific persons. You can also set the topic which will be used for notification. More information is available here: [[:tutorial:adm:notification_-_identity_s_contract_is_starting|]] 
 + 
 +===== Notification about the change of identity's contract ===== 
 + 
 +Since version 3.4.1 
 + 
 +A notification about a change of identity's contract will be sent to specific persons. You can also set the topic which will be used for notification. More information is available here: [[:tutorial:adm:notification_-_identity_s_contract_was_changed|]] 
 + 
 +===== Script split titles before and after ===== 
 Almost every project receive all titles in one string and IdM allow separates titles before and after. For this case was created in *ExtrasUtils* two methods *getTitlesAfter* and *getTitlesBefore*. And transformation scripts *extrasGetTitlesBefore* and *extrasGetTitlesAfter*, transformation scripts calls method from utils. Almost every project receive all titles in one string and IdM allow separates titles before and after. For this case was created in *ExtrasUtils* two methods *getTitlesAfter* and *getTitlesBefore*. And transformation scripts *extrasGetTitlesBefore* and *extrasGetTitlesAfter*, transformation scripts calls method from utils.
  
-Dictionary with titles can be setup by configuration properties. Default values exists.+Dictionary with titles can be setup by configuration properties. Default values exists in [[https://github.com/bcvsolutions/czechidm-extras/blob/2.6.1/Realization/backend/idm-extras/src/main/java/eu/bcvsolutions/idm/extras/util/ExtrasUtils.java#L62|BE]]
 <code> <code>
-idm.sec.extras.configuration.titlesAfter="Ph.D.", "Th.D.", "CSc.", "DrSc.", "dr. h. c.","DiS.", "MBA" + 
-idm.sec.extras.configuration.titlesBefore="Bc.", "BcA.", "Ing.", "Ing. arch.", "MUDr.","MVDr.", "MgA.", "Mgr.", "JUDr.", "PhDr.", "RNDr.", "PharmDr.", "ThLic.", "ThDr.", "prof.", "doc.","PaedDr.", "Dr.", "PhMr."+idm.sec.extras.configuration.titlesAfter=Ph.D.,Th.D.,CSc.,DrSc.,dr. h. c.,DiS.,MBA,LL.M.,FESC,MHA,FEBO,FESO,FEBU,FACC 
 +idm.sec.extras.configuration.titlesBefore=Bc.,BcA.,Ing.,Ing. arch.,MUDr.,MVDr.,MgA.,Mgr.,JUDr.,PhDr.,RNDr.,PharmDr.,ThLic.,ThDr.,prof.,doc.,PaedDr.,Dr.,PhMr.,MDDr. 
 + 
 +</code> 
 + 
 +in version 2.8.0 was added the option to select a separator for source string and for titles before and after values in IdM. 
 + 
 +<code> 
 +idm.sec.extras.configuration.titlesSourceSeparator - a character, that separates titles in the source. Default" " 
 +idm.sec.extras.configuration.titlesBeforeSeparator - titles before separator for IdM. Default", " 
 +idm.sec.extras.configuration.titlesAfterSeparator - titles before separator for IdM. Default", " 
 </code> </code>
  
 ===== Import automatic roles on tree nodes ===== ===== Import automatic roles on tree nodes =====
-You can use this tool to create automatic roles which are assigned based on the position within the organization structure using a CSV file as a source.  + 
-More information is available here: [[tutorial:adm:import_automatic_roles_on_tree_nodes|]]   +You can use this tool to create automatic roles which are assigned based on the position within the organization structure using a CSV file as a source. More information is available here: [[:tutorial:adm:import_automatic_roles_on_tree_nodes|]] 
 + 
 +===== Groups synchronization workflow ===== 
 + 
 +Since module version **1.4.0**  there exists improved workflow in the extras module for groups synchronization than in the core module. The workflow **Extras Synchronization - Roles from LDAP**  (extrasSyncRoleLdap) has more features and some fixed bugs than the product workflow syncRoleLdap. The workflow in the product is not developed anymore, because we plan to add more user-friendly configuration of the feature in future versions of the product. 
 + 
 +Documentation for configuration is available in [[:tutorial:dev:ad_groups_sync_workflow#set_aplication_properties|Group synchronization workflow - Application properties]]. 
 + 
 +Note: the workflow extrasSyncRoleLdap depends on some services implemented in the extras module, so to use this workflow, you must deploy the whole module to CzechIdM. 
 + 
 +===== Workflow to disable contract on MISSING_ACCOUNT ===== 
 + 
 +Setting this workflow (extrasDisableMissingContract) as workflow for action in contract reconciliation will disable contract, when its being synchronized. It can be used for example, in situations when contracts are being deleted from source data after expiration and they keep being stuck in MISSING_ACCOUNT state. 
 + 
 +Note: When using this workflow, please consider the possibility that the contracts may "reappear" in the source data. In such case, it would make sense to enable the contracts again, e.g. by mapping the attribute "state" and filling it by value ''null''  (= active contract). 
 + 
 +===== Groups membership in multi domain (cross domain) AD environment ===== 
 + 
 +Since module version **1.8.0** 
 + 
 +Documentation is available [[:tutorial:adm:systems_-_manage_groups_membership_in_multi_domain_cross_domain_ad_environment|]] 
 + 
 +===== Evaluator (permissions) for identities that has relationship on defined organization unit ===== 
 + 
 +Since module version **1.9.0**. **Available only on LTS version!** 
 + 
 +Documentation is available [[.:modules_extras:identity_evaluator_by_work_position|there]] 
 + 
 +===== Evaluator (permissions) for roles that is inside defined role catalogue ===== 
 + 
 +Since module version **1.9.0**. **Available only on LTS version!** 
 + 
 +Documentation is available [[.:modules_extras:role_evaluator_by_role_catalogue|there]]. 
 + 
 +===== Import code list and it's items ===== 
 + 
 +Since module version **1.9.0**  and **2.4.0** 
 + 
 +Documentation is available [[.:modules_extras:import_code_list_an_it_s_items|there]] 
 + 
 +===== Synchronize code list items from end system ===== 
 + 
 +Since module version **3.2.0** 
 + 
 +Documentation is available [[.:modules_extras:sync_code_list_items|there]] 
 + 
 +===== Evaluators (permissions) for Identities and Contracts which are both subordinate and have given projection ===== 
 + 
 +Since module version **2.4.0**. 
 + 
 +Documentation is available [[.:modules_extras:subordinate_projection_evaluators|there]]. 
 + 
 +===== Workflows for approval of role assignment ===== 
 + 
 +Since module version **2.3.0** 
 + 
 +Documentation is available [[:tutorial:adm:modules_extras_wf|there]] 
 + 
 +===== Script for soft abbreviate strings (extrasAbbreviateString) ===== 
 + 
 +Since module version **3.2.0** 
 + 
 +Script called **extrasAbbreviateString**  abbreviate given string by default with maximum length 255. Maximum length can be defined by adding parameter **maximum**. For example: 
 + 
 +  * .addParameter('maximum', 60) 
 + 
 +Result examples: 
 + 
 +  * "Hi how are you" - maximum: 9 - "Hi how" 
 +  * "Ing. Mgr. at Mgr. MBA" - maximum: 20 - "Ing. Mgr. at Mgr." 
 +  * "Ing." - maximum: 20 - "Ing." 
 + 
 +===== Copying assigned roles from the main contract to a contract valid in the future ===== 
 + 
 +This feature allows you to automatically copy roles from the existing main contract to a contract valid in the future. This serves to handle the issue with cases when contract validity is not extended but rather a new contract is created altogether. 
 + 
 +Since module version **3.3.0** 
 + 
 +Documentation is available [[.:modules_extras:copy_roles_to_new_contract|there]] 
 + 
 +===== Deduplication for automatic roles by organization structure ===== 
 + 
 +The feature process deduplication existing automatic roles that are assigned onto organization units. 
 + 
 +Since module version **3.4.0** 
 + 
 +Complete documentation is available [[.:modules_extras:automatic_role_by_organization_deduplication|there]]. 
 + 
 +===== Check whether a value is unique in a system ===== 
 + 
 +This feature enables you to check that a certain value is unique in a system. This is typically useful for generators creating emails or usernames which need to be unique. 
 + 
 +Since module version **3.5.0** 
 + 
 +Complete documentation is available [[.:modules_extras:check_that_value_is_unique_in_system|here]]. 
 + 
 +===== Notify user of account creation ===== 
 + 
 +This feature enables users to receive notifications about account creation on a particular system or systems. 
 + 
 +Since module version **3.6.0** 
 + 
 +Complete documentation is available [[.:modules_extras:account_creation_notification|there]]. 
 + 
 +===== Create automatic role for organization group ===== 
 + 
 +This feature creates automatic organization role for group. 
 + 
 +Since module version **3.7.0** 
 + 
 +Complete documentation is available [[.:modules_extras:create_automatic_role_for_organization_group|there.]] 
 + 
 +===== Notification about roles without guarantees ===== 
 + 
 +This feature sends notification about roles with expiring/expired/missing role guarantees. 
 + 
 +Since module version **3.8.0** 
 + 
 +Complete documentation is available [[.:modules_extras:notification_about_roles_without_guarantees|there.]] 
 + 
 +===== Resize profile photo to defined size ===== 
 + 
 +This feature allows you to resize user profile photos to a defined size. 
 + 
 +Since module version **3.9.0** 
 + 
 +Complete documentation is available [[.:modules_extras:resize_profile_photo|there.]] 
 + 
 +===== Evaluator (permissions) for users with given form projection who do not have contract in denied organization ===== 
 + 
 +Since module version **4.3.0**. 
 + 
 +Documentation is available [[.:modules_extras:identity_evaluator_by_projection_denied_org|there]]. 
 + 
 +===== Recalculate identities with roles ===== 
 + 
 +Since module version **4.5.0**. 
 + 
 +Documentation is available [[.:modules_extras:recalculate_identities_with_roles|there]]. 
 + 
 +===== Send custom notification to identities ===== 
 + 
 +Since module version **4.5.0**. 
 + 
 +Documentation is available [[.:modules_extras:send_custom_notification_to_identities|there]]. 
 + 
  • by kopro