TaskType (Object Definition)

Items

• name

  Flags: RAM,runtime

  Multiplicity: [0,1]

  Human-readable, mutable name of the object. It may also be an identifier (login name, group name). It is usually unique in the respective context of interpretation. E.g. the name of the UserType subtype is usually unique in the whole system. The name of the ShadowType subtype is usually unique in the scope of resource (target system) that it belongs to.

  The name may not be human-readable in a sense to display to a common end-user. It is intended to be displayed to IDM system administrator. Therefore it may contain quite a "ugly" structures such as LDAP DN or URL.

  Name is mutable. It is considered to be ordinary property of the object. Therefore it can be changed by invoking usual modifyObject operations. However, change of the name may have side effects (rename process).

  Although name is specified as optional by this schema, it is in fact mandatory for most object types. The reason for specifying the name as optional is that the name may be generated by the system instead of supplied by the clients. However, all objects stored in the repository must have a name.

• description

  Flags: RAM,runtime

  Multiplicity: [0,1]

  Free-form textual description of the object. This is meant to be displayed in the user interface.

• subtype

  Flags: RAM,runtime

  Multiplicity: [0,-1]

  Type of the object. It is used to distinguish what a specific object represents. Whether it is a different kind of organizational unit, project, team, or different kind of user, etc.

• fetchResult

  Flags: RAM,runtime,oper

  Multiplicity: [0,1]

  Result of the operation that fetched this instance of the object. It is mostly used to indicate that the object is not complete or there is some problem with the object. This is used instead of exception if the object is part of larger structures (lists as in list/search operations or composite objects). If not present then the "SUCCESS" state is assumed.

  This field is TRANSIENT. It must only be used in runtime. It should never be stored in the repository.

• extension

  Flags: RAM,runtime

  Multiplicity: [0,1]

  Extension container that provides generic extensibility mechanism. Almost any extension property can be placed in this container. This mechanism is used to extend objects with new properties. The extension is treated exactly the same as other object properties by the code (storage, modifications, etc), except that the system may not be able to understand their meaning.

• parentOrgRef

  Flags: RAM,oper

  Multiplicity: [0,-1]

  Set of the orgs (organizational units, projects, teams) that the object relates to. This usually means that the object belongs to them but it may have other meanings as well (e.g. user manages an organizational unit).

• trigger

  Flags: RAM,runtime,oper

  Multiplicity: [0,-1]

  Triggers for this object. They drive invocations of corresponding trigger handlers at specified time.

• metadata

  Flags: RAM,runtime,oper

  Multiplicity: [0,1]

  Meta-data about object creation, modification, etc.

• tenantRef

  Flags: RAM

  Multiplicity: [0,1]

  Reference to the tenant to which this object belongs. It is a computed value set automatically by midPoint. It is determined from the organizational structure. Even though this value is computed it is also stored in the repository due to performance reasons.

• lifecycleState

  Flags: RAM,runtime

  Multiplicity: [0,1]

  Lifecycle state of the object. This property defines whether the object represents a draft, proposed definition, whether it is active, deprecated, and so on.

  There are few pre-defined lifecycle states. But custom lifecycle states may also be defined. Pre-defined lifecycle states are:

  • draft: Definition of the new object in progress. The object is NOT active. The definition may change at any moment. It is not ready yet.
  • proposed: 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.
  • active: Active and working definition. Ready to be used without any unusual limitations.
  • deprecated: 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.
  • archived: Inactive historical definition. It is no longer used. It is maintained only for historical, auditing and sentimental reasons.
  • failed: 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.

• operationExecution

  Flags: RAM,runtime,oper

  Multiplicity: [0,-1]

  Description of recent operations executed on this object (or related objects, e.g. shadows in case of a focal object). The number of operations to be kept here is configurable.

• lensContext

  Flags: RAM,runtime

  Multiplicity: [0,1]

  Model context describing executed operation

• policySituation

  Flags: RAM,runtime,oper

  Multiplicity: [0,-1]

  The policy situation(s) of this object. The situations are result of evaluation of the policy rules. This property is recorded for each object and can be used for reporting, diagnostics, target selection in certification campaigns, etc.

• triggeredPolicyRule

  Flags: RAM,runtime,oper

  Multiplicity: [0,-1]

  Triggered policy rules for this assignment. (Not necessarily complete; subject to specified storage strategy.) This is EXPERIMENTAL functionality. It is possibly to change in the near future.

• policyException

  Flags: RAM,runtime

  Multiplicity: [0,-1]

  Recorded exception from a policy rule. The exceptions that are approved are recoded here to avoid re-evaluating and re-approving them all the time. This is EXPERIMENTAL functionality. It is likely to change in the near future.

• diagnosticInformation

  Flags: RAM,runtime

  Multiplicity: [0,-1]

  Diagnostic information attached to this object.

• assignment

  Flags: RAM,runtime

  Multiplicity: [0,-1]

  Set of object's assignments. Assignments define the privileges and "features" that this object should have, that this object is entitled to. Typical assignment will point to a role or define a construction of an account.

  Assignments represent what the object SHOULD HAVE. The assignments represent a policy, a desired state of things (cf. linkRef).

• iteration

  Flags: RAM,runtime,oper

  Multiplicity: [0,1]

  Iteration number. Starts with 0. It is used to iteratively find unique identifier for the object.

• iterationToken

  Flags: RAM,runtime,oper

  Multiplicity: [0,1]

  Iteration token. String value that is usually a suffix to the identifier based on iteration number. E.g. ".007". It is used to iteratively find unique identifier for the object.

• archetypeRef

  Flags: RAM,oper

  Multiplicity: [0,-1]

  References to all applicable archetypes, including "indirect" archetypes such as archetype supertypes. Contains references to active archetypes only.

  Note: the value of this reference is only updated when object is recomputed. Therefore if a role definition changes then all the affected objects must be recomputed for this reference to be consistent.

  This is an operational property. It is set and managed by the system. It is used for efficient use of archetypes.

• roleMembershipRef

  Flags: RAM,oper

  Multiplicity: [0,-1]

  References to abstract roles (roles, orgs, services) that this focus currently belongs to - directly or indirectly. This reference points to all the roles in the role hierarchy. It only points to the roles that were evaluated as active during last recompute (conditions were true, validity constraints not violated).

  Note: the value of this reference is only updated when a focal object is recomputed. Therefore if a role definition changes then all the affected focal objects must be recomputed for this reference to be consistent.

  Roles mentioned here are those that are NOT obtained via delegation, i.e. "deputy" relations. Relations acquired by delegation are listed in delegatedRef item.

  This is an operational property. It is set and managed by the system. It is used for efficient search of all current role members, e.g. for the purpose of displaying this information in the GUI.

• delegatedRef

  Flags: RAM,oper

  Multiplicity: [0,-1]

  References to objects (abstract roles as well as users) obtained via delegation. If A1 is a deputy of A, its delegatedRef contains a union of A, A.roleMembershipRef and A.delegatedRef.

  This is an operational property. It is set and managed by the system. It is used for efficient search of all current role members, e.g. for the purpose of displaying this information in the GUI.

• roleInfluenceRef

  Flags: RAM,oper

  Multiplicity: [0,-1]

  References to abstract roles (roles and orgs) that this focus may directly belong to. This reference only points to the next role in the hierarchy. However, it is backed by a "closure" index in the repository subsystem. Therefore it can efficiently support tree-like queries. This reference points to the roles for whose the condition is not true. Therefore it does not reliably show who actually has a role. It shows potential role members - all the object that are possibly influenced when a role definition changes.

  This is an operational property. It is set and managed by the system. It is used for efficient search of all possible role members, e.g. for the purpose of recomputing all role members after the role definition is changed.

  TODO. NOT IMPLEMENTED YET. EXPERIMENTAL. UNSTABLE.

• taskIdentifier

  Flags: RAM,runtime

  Multiplicity: [0,1]

  Task (lightweight) identifier. This is an unique identification of any task, regardless whether it is persistent or transient (cf. OID). Therefore this can be used to identify all tasks, e.g. for the purposes of auditing and logging.

  Task identifier is assigned automatically when the task is created. It is immutable. It is formally set as optional, however it is mandatory for any task to work. Setting it to optional allows creating a task without identifier and generating the identifier during import. However any tasks that live inside midPoint (running or stored in repository) must have valid task identifier.

• ownerRef

  Flags: RAM

  Multiplicity: [1,1]

  The user that owns this task. It usually means the user that started the task or a system user that is used to execute the task. The owner will be used to determine access rights of the task, will be used for auditing, etc.

• channel

  Flags: RAM,runtime

  Multiplicity: [0,1]

• parent

  Flags: RAM,runtime

  Multiplicity: [0,1]

  Parent task, used to implement task hierarchies. A task can have a number of children (subtasks) that carry out some of the work. For example, a parent task can contain a complex model operation, and its subtasks contain individual approvals and/or elementary model operations. If null, this task is a "root-level" task that has no parent. Task identifier (not OID) is used here.

• subtaskRef

  Flags: RAM

  Multiplicity: [0,-1]

  Set of task's subtasks references. TRANSIENT attribute. In the repository the parent-child relationship is stored using "parent" property.

• dependent

  Flags: RAM,runtime

  Multiplicity: [0,-1]

  Dependent tasks, i.e. tasks that wait for the completion of this task. Task identifiers (not OIDs) are used here.

• dependentTaskRef

  Flags: RAM

  Multiplicity: [0,-1]

  Dependent tasks references, i.e. tasks that wait for the completion of this task. TRANSIENT attribute. In the repository only the identifiers are stored (see "dependent" attribute).

• executionStatus

  Flags: RAM,runtime,AVals:4

  Multiplicity: [1,1]

  Execution status provides information about the task overall high-level execution state. It tells whether the task is running/runnable, waits for something or is done.

• waitingReason

  Flags: RAM,runtime,AVals:2

  Multiplicity: [0,1]

  What is this task waiting for?

• unpauseAction

  Flags: RAM,runtime,AVals:3

  Multiplicity: [0,1]

  What to do after task is unpaused (i.e. stopped waiting)? The default for single-run tasks is executeImmediately (mainly for backwards compatibility reasons); the default for recurring tasks is reschedule. It is expected that this item is set by the code that puts the task into waiting state.

• stateBeforeSuspend

  Flags: RAM,runtime,AVals:4

  Multiplicity: [0,1]

  What was the task state before it was suspended? It could be either runnable or waiting. This is important because we want to restore the correct state on resume.

• node

  Flags: RAM,runtime

  Multiplicity: [0,1]

  Identifier of the node that currently executes this task. (In case of node crash, the value here may be out-of-date.)

• nodeAsObserved

  Flags: RAM,runtime

  Multiplicity: [0,1]

  Identifier of the node that executes this task, as observed by querying cluster nodes about tasks that are currently executing. TRANSIENT. This value is not stored in the repository. (It is currently not possible to use it for filtering or sorting.)

• category

  Flags: RAM,runtime

  Multiplicity: [0,1]

  Kind of the task, e.g. live sync, reconciliation, workflow, import from resource. Used mainly for the GUI.

• handlerUri

  Flags: RAM,runtime

  Multiplicity: [0,1]

  Handler URI indirectly specifies which class is responsible to handle the task. The handler will execute reaction to a task lifecycle events such as executing the task, task heartbeat, etc.

• otherHandlersUriStack

  Flags: RAM,runtime

  Multiplicity: [0,1]

  A stack of handlers that should be called after the primary one (handlerUri) finishes.

• result

  Flags: RAM,runtime

  Multiplicity: [0,1]

  OperationResult that is used to compile task results (parent result).

• resultStatus

  Flags: RAM,runtime,AVals:8

  Multiplicity: [0,1]

  Top-level state of the 'result' (OperationResultType). It is put here for ease of use - mainly filtering, displaying, and so on.

• objectRef

  Flags: RAM

  Multiplicity: [0,1]

  Object that the task is associated with. Tasks may be associated with a particular objects. For example a "import from resource" task is associated with the resource definition object that it imports from. Similarly for synchronization and reconciliation tasks (cycles).

• lastRunStartTimestamp

  Flags: RAM,runtime

  Multiplicity: [0,1]

  The time when the task execution was last started.

• lastRunFinishTimestamp

  Flags: RAM,runtime

  Multiplicity: [0,1]

  The time when the (last) task execution was finished, successfully or unsuccessfully. (If node crashes, this attribute is not updated.)

• completionTimestamp

  Flags: RAM,runtime

  Multiplicity: [0,1]

  The moment when the task was marked as closed. (May be different from lastRunFinishTimestamp, e.g. when task waits for its children to finish and then closes automatically.)

• cleanupAfterCompletion

  Flags: RAM,runtime

  Multiplicity: [0,1]

  If set, the task is automatically cleaned up after this time following its completion.

• nextRunStartTimestamp

  Flags: RAM,runtime

  Multiplicity: [0,1]

  The time when the task should start again, according to the task's defined schedule. (Null if no further execution is scheduled.) Ad-hoc (retry) run times, like those stemming from unsatisfied execution constraints, are NOT considered here. They are covered by nextRetryTimestamp property. TRANSIENT. This value is not stored in the repo, it is queried dynamically. (It is currently not possible to use it for filtering or sorting.)

• nextRetryTimestamp

  Flags: RAM,runtime

  Multiplicity: [0,1]

  If the start of a task was delayed (typically because of unsatisfied execution constraints), the planned retry time is reported here. EXPERIMENTAL. TRANSIENT. This value is not stored in the repo, it is queried dynamically. (It is currently not possible to use it for filtering or sorting.)

• progress

  Flags: RAM,runtime

  Multiplicity: [0,1]

  Relative metric of task progress. The meaning of this attribute is specific to particular task handler.

• operationStats

  Flags: RAM,runtime

  Multiplicity: [0,1]

  Operation statistics/state.

• workState

  Flags: RAM,runtime

  Multiplicity: [0,1]

  State of the work the task is supposed to do (or has done). This information is used e.g. to distribute the work or to provide stateful suspend+resume feature. The information here is managed by the system (by task manager and task handler).

• workManagement

  Flags: RAM,runtime

  Multiplicity: [0,1]

  Configuration of how the work should be managed: segmented into buckets and processed by workers.

• stalledSince

  Flags: RAM,runtime

  Multiplicity: [0,1]

  From which moment is this task stalled (if applicable)? TRANSIENT. This value is not stored in the repo, it is queried dynamically. (It is currently not possible to use it for filtering or sorting.)

• expectedTotal

  Flags: RAM,runtime

  Multiplicity: [0,1]

  Expected target (goal) value of task progress. Perceived progress is computed as a ratio of progress/expectedTotal. May be null; in that case we just do not know how much progress we should expect.

• recurrence

  Flags: RAM,runtime,AVals:2

  Multiplicity: [1,1]

  Whether the task activity is to be executed only once (single-run tasks) or periodically (recurring tasks).

• binding

  Flags: RAM,runtime,AVals:2

  Multiplicity: [0,1]

  Whether a recurring task is bound tightly to one node (having allocated a thread on this node for the whole time of task execution) or it should by dynamically placed on any suitable node when its execution time comes.

• executionConstraints

  Flags: RAM,runtime

  Multiplicity: [0,1]

  Constraints on task execution, e.g. a execution group, allowed/disallowed nodes, etc. EXPERIMENTAL

• executionEnvironment

  Flags: RAM,runtime

  Multiplicity: [0,1]

  Specification of the environment in which the task should execute. An example is caching profile that should be used.

• schedule

  Flags: RAM,runtime

  Multiplicity: [0,1]

  Task schedule. Specifies when and how often to execute the task.

• threadStopAction

  Flags: RAM,runtime,AVals:4

  Multiplicity: [0,1]

  What is to be done when the thread allocated to this task stops (e.g. via node shutdown or node crash).

• modelOperationContext

  Flags: RAM,runtime

  Multiplicity: [0,1]

  Model context of the operation that is to be executed within this task. This is NOT a live information: it is a serialized form of a model context. Currently there is a specialized task handler that takes this context, unmarshals and executes it.

• policyRule

  Flags: RAM,runtime

  Multiplicity: [0,1]

  Policy rule for the task. E.g notify user 5 days before their account expires.