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
Next revision Both sides next revision
devel:documentation:generated_values [2018/11/07 07:47]
kopro
devel:documentation:generated_values [2019/09/10 15:20]
svandav
Line 1: Line 1:
 +<- .:bulk_actions |  ^ .:start | Documentation ^ .:long-polling | ->
 +====== Generated values ======
  
 +{{tag> generated generator values value generable}}
 +
 +The main functionality of all generator is generating values. In CzechIdM is princip of generated values same. During creating entity is called generator manager. Manager will iterate over all available and enabled generator for currently created identity. Generators are used only when is entity **CREATED**. Afte creating isn't possible use generators behavior.
 +
 +
 +**Entities that allow generating values:**
 +  * IdmIdentity (users).
 +
 +===== Generators =====
 +Generators are setup via agenda *Generated values* (access via Settings). All generators supports these settings:
 +
 +  * **Order**: generators are ordered by this attribute, generating is done from lower to higher 0 -> +10 -> +20 -> ...
 +  * **description**: description for created generator
 +  * **regenerate value**: generators not regenerated values that was send with entity, (BEWARE, these settings must be explicit implement in script generators),
 +  * **disable**: generator can be created and set as disabled, generators marked as disabled is skipped during generating,
 +  * **system generator**: Generator created by system, can't be deleted and changed order.
 +
 +==== Identities ====
 +
 +Currently are available these generators
 +
 +=== IdentityUsernameGenerator ===
 +Standard username generator uses firstname and lastname for generating username. Order of firstname or lastname can be setup by settings. Generator also allow check generated username for unique. The check is done by search in existing identities.
 +
 +{{ :devel:documentation:username_generator.png |}}
 +=== IdentityEmailGenerator ===
 +{{ :devel:documentation:email_generator.png |}}
 +
 +Standard email generator uses firstname, lastname or username for generating email. Base for generating you can choose by settings. Also characters count and connection character.
 +
 +Generator is very similiar to username generator. And behavior with compose is same.
 +
 +=== IdentityScriptValueGenerator ===
 +Scripted generator uses script from category '''SYSTEM''' for generating values. Into script is passed whole identity and the identity must be also returned. The script also contain definition for generator. For example information about settings.
 +
 +{{ :devel:documentation:gen003.png?nolink |}}
 +
 +=== IdentityFormDefaultValueGenerator ===
 +Form default generator is used for add default values into identity eavs. The generator is also created during CzechIdM init phase. The generator skip permissions for Form values - values will be created even user hasn't permissions for create.
 +
 +{{ :devel:documentation:gen004.png?nolink |}}
 +
 +===== Admin guide (to be completed)  =====
 +  * [[.adm:generators|Generators overview]]
 +
 +===== Devel guide =====
 +  * [[devel:documentation:generated_values:dev:generated_values|Generated values developer guide]]
  • by husniko