About Identifier Assignment

Registry is capable of automatically assigning Identifiers to for entities within COs. Identifiers may be assigned on demand, as part of an Enrollment Flow, or as part of a Pipeline. Multiple algorithms for assigning Identifiers are supported via >lugins.

Supported Contexts

Identifier Assignment can be applied to

Supported Character Sets

Identifier Assignment works best with standard ASCII characters. UTF-8 characters are not currently supported (CO-454).

Configuring Identifier Assignments

Identifier Assignments are configured via Configuration > Identifier Assignments.

Identifier Assignment Configuration

Context

Each Identifier Assignment applies to one context, from the set of Supported Contexts. For example, an Identifier Assignment used to generate a Person Identifier cannot also be used to generate a Group Identifier – a second Identifier Assignment is required.

Identifier or Email Address Type

Each Identifier Assignment generates an Identifier of the specified type.

If an Identifier Type is set, the generated Identifier may be flagged as usable for logging in to Registry by ticking the Login option.

If an Email Address type is set, the generated Identifier will be persisted as an Email Address instead of an Identifier.

An Identifier Assignment cannot be used to generate both an Identifier and an Email Address at the same time, however the Format Identifier Assignment Plugin supports generating Identifiers from other Identifiers, and so (for example) could be used to create an Email Address from an Identifier (using a second Identifier Assignment). See also Order, below.

Order

Identifier Assignments may be ordered, which is useful when generating Identifiers based on other Identifiers. Identifier Assignments with the lowest order (eg: 1) will be run first.


Identifier Assignment can generate both Identifiers and Email Addresses (using multiple configurations, AR-IdentifierAssignment-1). Unless otherwise specified in this documentation, everything that applies to generating Identifiers also applies to generating Email Addresses.

When a new Email Address is assigned, it is considered verified (AR-IdentifierAssignment-3).

When Identifier Assignment Happens

Identifier Assignment happens at several points:

  • During an Enrollment Flow, via the Identifier Assignment Enroller Plugin (not yet implemented: CFM-307)
  • Via a Pipeline (not yet implemented: CFM-137)
  • When a new Department or Group is added (not yet implemented: CFM-57)
  • Manually, by clicking Assign Identifiers on the entity's canvas page

Identifier Assignment can be run for the same entity multiple times. Any eligible but unassigned Identifiers will be assigned.

Assigning Identifiers for All Entities

Not currently supported (CFM-169).

Identifier Assignment Constraints

  1. Identifiers of a given type must be unique within a CO (AR-Identifier-2), including any Suspended Identifiers.
  2. Uniqueness checks are case insensitive (AR-IdentifierAssignment-2).
  3. If an entity already has an Identifier of a given type, no additional Identifier will be created.
  4. An Identifier can be reassigned if the original Identifier was deleted (as opposed to being set to Suspended status).
  5. Identifier Assignment is subject to Identifier Validation (not yet implemented: CFM-309)

It is possible for an Identifier Assignment to fail because a Plugin algorithm is unable to construct a valid, available Identifier.

See Also

Changes From Earlier Versions

Prior to Registry v5.0.0

  • The functionality provided by the Format Assigner Plugin was implemented in core code.
  • Uniqueness checks did not include Suspended Identifiers.
  • Email Address uniqueness checks ignored the Email Address type.
  • No labels