9.3:documentation:generated_values

Generated values

The main functionality of all generators is generating values. In CzechIdM, the principle of generated values is the 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 entity is CREATED. Once an entity has been created, using the generator behavior is no longer possible.

Entities that allow generating values:

  • IdmIdentity (users).

Generators are set up via agenda Generated values (access via Settings). All generators support 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.

At the moment, these generators are available:

IdentityUsernameGenerator

The standard username generator uses firstname and lastname for generating username. Order of firstname or lastname can be setup by settings. The generator also allows checks generated username for unique. The check is done by search in existing identities.

IdentityEmailGenerator

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.

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.