Differences
This shows you the differences between two versions of the page.
Both sides previous revision Previous revision Next revision | Previous revision | ||
devel:documentation:identities:adm:user-type [2020/03/27 10:35] tomiskar |
devel:documentation:identities:adm:user-type [2021/03/29 08:54] tomiskar [User type] |
||
---|---|---|---|
Line 1: | Line 1: | ||
====== User type ====== | ====== User type ====== | ||
+ | |||
+ | {{tag> form projection}} | ||
User type (projection) was added in CzechIdM version 10.2.0. Projection defines frontend form to read, create and edit user. We can create and edit user by different form. For example externe and internal employee can be created and edited differently (different attributes has to be filled). Used projection for user creation is set as user type. | User type (projection) was added in CzechIdM version 10.2.0. Projection defines frontend form to read, create and edit user. We can create and edit user by different form. For example externe and internal employee can be created and edited differently (different attributes has to be filled). Used projection for user creation is set as user type. | ||
- | Provided projection can be configured by administrator. New projection type and localization can be provided by developer. | + | Provided projection can be configured by administrator. New projection type and localization can be provided by [[..: |
Configurable form (projection) with configurable features is provided in product: | Configurable form (projection) with configurable features is provided in product: | ||
* **Show user personal data** - show selected or all user personal data (e.g. login, first name, surname). | * **Show user personal data** - show selected or all user personal data (e.g. login, first name, surname). | ||
- | * **Show contract** - prime contract is shown by default. If currenly logged user has permission to read prime contract. First other contract is shown otherwise. Contract are sorted by priority the same way, as prime contract is evaluated. | + | * **Show contract** - prime contract is shown by default. If currenly logged user has permission to read prime contract. First other contract is shown otherwise. Contract are sorted by priority the same way, as prime contract is evaluated. Contracts can be shown n two modes: |
- | * **Show other contract position** - first contract other position | + | * **Show prime contract** - show (and update) prime user contract only. |
+ | * **Show all user contracts** - show (and update) all user contracts. Code list '' | ||
+ | * **Validations** for basic user personal data and basic contract attributes can be defined. | ||
+ | * **Show other contract position** - first contract other position | ||
* **Show extended identity attributes** - show selected extended attributes from selected form definitions. | * **Show extended identity attributes** - show selected extended attributes from selected form definitions. | ||
* **Show extended contract attributes** - show selected extended attributes from selected form definitions. Contract are sorted by priority. Prime contract extended attributes can be edited, if logged user can read and edit prime contract. If logged user cannot read prime contract, next contract which identity can read is shown. | * **Show extended contract attributes** - show selected extended attributes from selected form definitions. Contract are sorted by priority. Prime contract extended attributes can be edited, if logged user can read and edit prime contract. If logged user cannot read prime contract, next contract which identity can read is shown. | ||
* **Set or change user password** - user can be created with or without password. Link to password change is shown for edited user. | * **Set or change user password** - user can be created with or without password. Link to password change is shown for edited user. | ||
* **Request to change roles** - roles can be requested for newly added user. Assigned roles are shown with button to change assigned roles by role request for edited user. | * **Request to change roles** - roles can be requested for newly added user. Assigned roles are shown with button to change assigned roles by role request for edited user. | ||
+ | * **Set direct guarantee for new contract** - set currently logged user as direct guarantee for newly created contract. | ||
<note tip> | <note tip> | ||
- | ===== Configure and use new projection ===== | + | <note tip>Code list '' |
- | ==== Projection agenda | + | ===== Configure and use form projection ===== |
- | New projection | + | How to configure and use product form projection |
- | {{ :devel:documentation: | + | How to register new form projection type is described in [[..:dev:user-type|devel guide]]. |
- | ==== Add new projection | + | ===== Configuration ===== |
- | We can configure new projection to introduce all features: | + | ==== Available configuration properties ==== |
- | * Code - **Externe user**. Projection simple name. | + | |
- | * Module - we can leave it empty, **core** module is used by default. | + | |
- | * Basic attributes - select | + | |
- | * Form definitions - we need to prepare extended attributes form definition before to use then here, we will use this definitions and attributes as example: | + | |
- | * **default - IdmIdentity** - default form definition for users, select attributes: | + | |
- | * **Mobile phone** - text attribute | + | |
- | * **Reqistration** - boolean attribute | + | |
- | * **default - default - IdmIdentityContract** - default form definition for cntracts, select attributes: | + | |
- | * **Environment** - codelist ith available environments | + | |
- | * **Manager** - user select box | + | |
- | * Description - **Create and edit externe user.** Description is shown in projection list (into about projection and for filter). | + | |
- | {{ : | + | In the application profile (application.properties) and overloadable via ConfigurationService. |
- | <note tip>We filled simple | + | <code properties> |
+ | # show default form for newly created user | ||
+ | # default form can be disabled => at least one configured form projection | ||
+ | idm.pub.app.show.identity.formProjection.default=true | ||
+ | # | ||
+ | # default password change type for custom users, one of values: | ||
+ | # DISABLED - password change is disable | ||
+ | # ALL_ONLY - users can change passwords only for all accounts | ||
+ | # CUSTOM - users can choose for which accounts change password | ||
+ | # Needed on FE (=> public) | ||
+ | idm.pub.core.identity.passwordChange=CUSTOM | ||
+ | </code> | ||
- | <note tip>Authorization policies | + | ==== Authorization policies |
- | <note tip> | + | === Administrator === |
- | ==== Choose | + | Aministrator for create, edit and delete configured form projection. |
- | When new user is created (menu **Users** -> **Create user** button.), then newly created projection can be chosen: | + | |
+ | * Permission to autocomplete and read form attributes: Forms - attributes (IdmFormAttribute) | - | FormAttributteByDefinitionEvaluator | ||
+ | * Permission to admin form projections: | ||
- | {{ : | + | === Manager === |
- | <note tip> | + | Manager for create and edit user with form projection usage with all features enabled. |
- | === User detail | + | <note tip>User detail |
- | {{ :devel:documentation:identities:adm:projection-user-create.png | + | * Permission to work with identities: Users (IdmIdentity) | View in select box (autocomplete), |
+ | * Permission to read contracts according to identity: Industrial relations (IdmIdentityContract) | - | IdentityContractByIdentityEvaluator | ||
+ | * Permission to read other contract positions according to contract: Other contract positions (IdmContractPosition) | - | ContractPositionByIdentityContractEvaluator | ||
+ | * Permission to read the assigned identity roles: Roles assigned to users (IdmIdentityRole)| - | IdentityRoleByIdentityEvaluator | ||
+ | * Permission to request roles (which can be requested): Role (IdmRole) | Can be requested | RoleCanBeRequestedEvaluator | ||
+ | * Permission to read role requests according to identity: Requests for assigned roles (IdmRoleRequest) | - | RoleRequestByIdentityEvaluator | ||
+ | * Permission to autocomplete form projections: | ||
+ | * Permission to autocomplete form definitions: | ||
+ | * Permission to read and update all identity attributes in main definition: Forms - values (IdmIdentityFormValue) | View in select box (autocomplete) | IdentityFormValueEvaluator | ||
+ | * Permission to read and update all contract attributes in main definition: Forms - values (IdmIdentityContractFormValue) | View in select box (autocomplete) | IdentityContractFormValueEvaluator | ||
+ | * Permission to read codelist '' | ||
+ | * Enabling the autocomplete for entities: | ||
+ | * Role (IdmRole) | Displaying in autocomplete, | ||
+ | * Structure types (IdmTreeType) | View in select box (autocomplete) | BasePermissionEvaluator | ||
+ | * Tree nodes (IdmTreeNode) | View in select box (autocomplete) | BasePermissionEvaluator | ||
+ | * Accounts (AccAccount) | - | ReadAccountByIdentityEvaluator (← use this only when using acc module) | ||
+ | * Identity accounts (AccIdentityAccount) | - | IdentityAccountByAccountEvaluator (← use this only when using acc module) | ||
+ | * Code lists (IdmCodeList) | Displaying in autocomplete, | ||
+ | * Code lists - items (IdmCodeListItem) | Displaying in autocomplete, | ||
- | We can create | + | === Manager - create and edit identity only === |
- | === User detail | + | Manager |
- | {{ : | + | * Permission to work with identities: |
+ | * Permission to autocomplete form projections: Forms - projections(IdmFormDefiniton) | View in select box (autocomplete) | ||
- | === Default full detail | + | === Normal user === |
- | Default full detail can be shown for each user with projection usage. New button was added into user (and projection) | + | Other user doesn' |
- | {{ : | + | |
- | Button is available for all logged user without any additional permission is needed. Quick link to default full detail is available from top profile menu. Buttons on dashboard ane any other link to user detail will lead to projection form. | + | ==== Localization ==== |
- | The same way is posible to go back to form by projection from full default | + | Two projections are [[..: |
- | ==== Change | + | Localization can be added or changed by developer, read more in [[..:dev:user-type# |
- | User type (projection) can be changed from default full identity detail: | + | ==== Tips ==== |
- | After user type is changed and user is saved, then button in detail header (see above) can be used for show user in form projection. | + | === Skip user dashboard |
- | <note tip> | + | If we want to show user detail immediatelly (skip user dasboard or skip info card), we can hold '' |
- | ==== Set or change user password ==== | + | === Validations |
- | Add **password** ... | + | Validations for basic user personal data and contracts can be defined. Validations are evaluated in whole application even on standard user and contract details for user in given projection. |
- | <note tip> | + | ===== Admin tutorials ===== |
+ | * [[tutorial: | ||
- | ==== Add or change user roles ==== | + | ===== Devel guide ===== |
- | + | | |
- | Add / change request | + | |
- | + | ||
- | <note tip> | + | |
- | + | ||
- | + | ||
- | ===== Configuration ===== | + | |
- | + | ||
- | ==== Available configuration properties ==== | + | |
- | + | ||
- | how to disable default projection | + | |
- | + | ||
- | ==== Authorization policies ==== | + | |
- | + | ||
- | security - projection / identity eav / contract eav | + | |
- | + | ||
- | Administrator - configure projection + eav | + | |
- | User - create | + | |
- | User - change user type - ' | + | |
- | Normal user: don't need any new policy configuration. Form projection is saved together with user and when user detail is shown, then this projection is used. | + | |
- | + | ||
- | ==== Localization ==== | + | |
- | + | ||
- | ==== Tips ==== | + | |
- | + | ||
- | === Skip user dashboard | + | |
- | + | ||
- | If we want to show user detail immediatelly (skip user dasboard or skip info card), we can hold '' | + | |
- | TODO: | ||
- | * how to add projection (devel + override + localization) | ||
- | * split to developer guide / admin tutorial? | ||
- | * identity roles are assigned asynchronously => requests |