WfProcessInstanceType (Complex Type)

Items

• name

  Flags: RAM

  Multiplicity: [0,1]

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

  This 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 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).

  Name is mutable. It can change any time. However, a special handling may be needed in some cases (e.g. "rename" provisioning flow).

  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

  Multiplicity: [0,1]

  Free-form textual description of the object.

• fetchResult

  Flags: RAM

  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 objets). 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: dyn,RAM,runtime

  Multiplicity: [0,1]

  Container that provides generic extensibility mechanism. Almost any extension property can be placed in this container. 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

  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

  Multiplicity: [0,-1]

  Defines triggers for an object. Trigger is an action that should take place at specified time or under some other condition.

• metadata

  Flags: RAM,runtime

  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 compted it is also stored in the repository due to performance reasons.

• processInstanceId

  Flags: RAM

  Multiplicity: [1,1]

• startTimestamp

  Flags: RAM

  Multiplicity: [0,1]

• endTimestamp

  Flags: RAM

  Multiplicity: [0,1]

• finished

  Flags: RAM

  Multiplicity: [0,1]

• answer

  Flags: RAM

  Multiplicity: [0,1]

• stateRef

  Flags: RAM

  Multiplicity: [0,1]

  (Externalized) process instance state stored as PrismObject. Actually, it is always a subtype of ProcessInstanceState, but this structure is defined in separate XSD file. TODO consider moving all wf-related structures to that file in order to allow correct references among them.

• workItemsRef

  Flags: RAM

  Multiplicity: [0,-1]

  Work items that are part of this process instance. This attribute may or may not be filled-in.