Object Lifecycle
|
feature
This page is an introduction to midPoint feature.
Please see the feature page for more details.
|
There are few pre-defined lifecycle states. But custom lifecycle states may also be defined. The pre-defined lifecycle states are designed to work in a state machine described in the following diagram.
If no explicit lifecycle state is defined then the Active state is assumed. In addition to the pre-defined states, you can define custom lifecycle states. However, all the custom lifecycle states are currently considered to be non-active, meaning that if you need to an object to be treated as active, use either Active or Deprecated lifecycle state.
Pre-defined Lifecycle States
| State | Focus active | Assignments active | Description | Examples |
|---|---|---|---|---|
draft |
no |
no |
Definition of the new object in progress. The object is NOT active. The definition may change at any moment. It is not ready yet. |
Role definition in preparation (not finished yet). |
proposed |
no |
no |
Definition of a new object is ready for use, but there is still a review process to be applied (e.g. approval). The object is NOT active. However the definition should not change in this state. |
Finished new role definition in approval process. |
active |
YES |
YES |
Active and working definition. Ready to be used without any unusual limitations. |
Active employee. |
suspended |
no |
YES |
Suspended definition, temporarily disabled. It is expected that the object will return to Active state eventually. Available since midPoint 4.8. |
Employee on temporary leave (maternal leave, sabbatical). |
deprecated |
YES |
YES |
Active definition which is being phased out. The definition is still fully operational. But it should not be used for new assignments. E.g. it should not be requested, it should not be approved, etc. |
Deprecated role: still working, but not intended to be assigned any more. |
archived |
no |
no |
Inactive historical definition. It is no longer used. It is maintained only for historical, auditing and sentimental reasons. |
Retired employee, keeping minimal record for accounting reasons and to avoid identifier recycling. |
failed |
no |
no |
Unexpected error has occurred during object lifecycle. Result of that event is that the object is rendered inactive. The situation cannot be automatically remedied. Manual action is needed. |
Role definition rejected during approvals, without obvious continuation of the process. |
The "Active" column specifies whether the object is active (enabled) in that particular lifecycle state. The effective activation status will always be disabled in the states that are marked as not active in the above table. In these states the object will not be active even if the activation administrative status is explicitly set to enabled. See Activation page for more details.
Assignment Lifecycle
The same lifecycle property is also present in assignment and inducement. The meaning of the lifecycle states is equivalent to object lifecycle:
| State | Active | Description |
|---|---|---|
draft |
no |
Definition of a new assignment in progress (e.g. being selected in the shopping cart, but not yet requested) - EXPERIMENTAL. NOT USED. |
proposed |
no |
Requested assignment. The assignment was requested but it was not yet being granted. E.g. there is a pending approval. |
active |
YES |
Active and working assignment. |
suspended |
no |
Temporarily disabled assignment. Available since midPoint 4.8. |
deprecated |
YES |
NOT USED |
archived |
no |
Assignment that was active in the past but it was revoked. It is kept for historical reasons. |
failed |
no |
Unexpected error has occurred during assignment lifecycle. Result of that event is that the assignment is rendered inactive. The situation cannot be automatically remedied. Manual action is needed. |
As described above, the assignment state is also determined by the focus (user) lifecycle state. When the focus (user) is in state marked as "Assignments active: no" (like Draft, Proposed, Archived) then the assignments are considered inactive regardless of their lifecycle state.
Relation of Task Configurations and Lifecycle States
When configuring tasks, you can select a task execution configuration to reflect whether you want to simulate what would happen or execute the changes for real. The task configuration is tightly related to the lifecycle states of objects with which your tasks work.
-
In the Development configuration, tasks work with objects in the Active and Proposed lifecycle states.
-
In the Production configuration, tasks work with objects in the Active and Deprecated lifecycle states.
Figure 1. Diagram of which lifecycle states are processed by which task configurations
Was this page helpful?
YES
NO
Thanks for your feedback