Skip to content

Commit

Permalink
Lifecycle state: suspended
Browse files Browse the repository at this point in the history
  • Loading branch information
semancik committed Aug 30, 2023
1 parent b1bbd47 commit af003de
Show file tree
Hide file tree
Showing 3 changed files with 33 additions and 2 deletions.
33 changes: 31 additions & 2 deletions docs/concepts/object-lifecycle/index.adoc
Original file line number Diff line number Diff line change
Expand Up @@ -21,14 +21,14 @@ image::schemas-lifecycle-statechart.png[]

If no explicit lifecycle state is defined then the `active` state is assumed.
In addition to the pre-defined states custom lifecycle states can be used.
However currently (midPoint 3.5) all the custom lifecycle states are considered to be non-active.
However, currently all the custom lifecycle states are considered to be non-active.


== Pre-defined Lifecycle States

[%autowidth]
|===
| State | Focus active | Assignments active | Description
| State | Focus active | Assignments active | Description | Examples

| draft
| no
Expand All @@ -37,6 +37,7 @@ However currently (midPoint 3.5) all the custom lifecycle states are considered
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
Expand All @@ -45,13 +46,27 @@ It is not ready yet.
| 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. +
Self-registered user, not yet validated.


| active
| YES
| YES
| Active and working definition.
Ready to be used without any unusual limitations.
| Active employee. +
Role in production use.

| 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). +
Resource temporarily disabled for maintenance.


| deprecated
Expand All @@ -61,6 +76,8 @@ Ready to be used without any unusual limitations.
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. +
Legacy resource: we still want to read the data, but we do not want to create new accounts.


| archived
Expand All @@ -69,6 +86,8 @@ E.g. it should not be requested, it should not be approved, etc.
| 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. +
Phased-out role definition, kept for historical reasons.


| failed
Expand All @@ -78,6 +97,9 @@ It is maintained only for historical, auditing and sentimental reasons.
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. +
Role definition identified to be in violation of the policy, immediately taken out of use. +
Resource with unexpected critical errors, requiring attention od administrators.


|===
Expand Down Expand Up @@ -113,6 +135,13 @@ E.g. there is a pending approval.
| Active and working assignment.


| suspended
| no
| Temporarily disabled assignment.

Available since midPoint 4.8.


| deprecated
| YES
| *NOT USED*
Expand Down
Binary file modified docs/concepts/object-lifecycle/schemas-lifecycle-statechart.png
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.
2 changes: 2 additions & 0 deletions release-notes.adoc
Original file line number Diff line number Diff line change
Expand Up @@ -69,6 +69,8 @@ For more info see: xref:/midpoint/reference/security/audit/index.adoc[Auditing]
*** Optional configuration contains attributes description, exclusive, authoritative, channel and except channel.
** Identifiers _arw-construction-mapping_,_rw-attribute-inbound_ and _rw-attribute-outbound_ of old wizard panels is ignored, so we can remove it from configuration.

* xref:/midpoint/reference/concepts/object-lifecycle/[Lifecycle state] `suspended` was introduced to represent temporarily-disabled objects.

=== Miscellaneous Improvements

* TODO
Expand Down

0 comments on commit af003de

Please sign in to comment.