Class COOWF@1.1:ProcessInstance

Objects of this class are used for an instance of a running process, that is assigned to an object. It consists of a sequence of activity instances, CASE switches, IF-THEN-ELSE conditions, REPEAT loops and/or nested process definitions (subprocesses), which are connected with each other. A process instance can be created on the fly without an attachment to an object, it can be created on the fly attached to an object and it can be created by assigning a process definition to an object.
When a process definition is assigned to an object a process instance is created from the process definition and instance elements are created from the definition elements. Embedded subprocesses are resolved either when the process instance is created or when the subprocess is actually initiated. Resolving the subprocess means inserting activity instances into the current process instance. If the process definition is modified after the process instance was created, the modifications are not reflected in the running process instance (with the exception of loops and subprocesses that are not expanded immediately). Changes of the process instance have no effect on the process definition.
Note: When an object is initialized with a process definition the created process instance is stored as a property of the object. Therefore the object class of that object or a base class of the object class must include the property workflow. By default no object class has this property assigned. You have to add this property to your object classes and to the existing object classes depending on the object model of your solution.

Class Hierarchy

Object > ProcessInstance

Additional Information

Commonly usable

Properties

Type	Property	Name
ActivityInstance[]	objactivepastactivities	Completed Activities
ActivityInstance[]	objallactiveactivities	All Activities of Running or Completed Processes
ActivityInstance[]	objfutureactivities	Planned Activities
ProcessInstance[]	objinprogressproclist	Running Processes
ActivityInstance[]	objrunningactivities	Current Activities
InstanceElement[]	procinstactivities	Activities of the Process
date	procinstarchivedat	Archived on/at
User	procinstarchivedby	Archived by
ArchivedProcessStatistic	procinstarchivedstatistic	Process Statistic
Object	procinstcalcdefinition	Process Definition
User	procinstchangedby	Last Change in User Interface by
string	procinstcommonid	Identifier for Related Processes
date	procinstcompletedat	Completed on/at
ProcessDefinition	procinstdefinition	Process Definition
WorkFlowDiagram	procinstdiagram	BPMN Process Diagram
EscalationDefinition	procinstescalation	Escalation
WorkFlowParticipant	procinstinitiator	Process Initiator
boolean	procinstnosubst	Disable Substitution
Object[]	procinstobject	Affected Object
WorkFlowParticipantMapping[]	procinstpartmapping	Overwritten Process Definition Participants
WorkFlowDiagram	procinstpubdiagram	BPMN Process Diagram (Released for Execution)
WorkFlowParticipant	procinstrespmansubst	Manual Entry by
WorkFlowParticipant	procinstresponsible	Responsible for Process
InstanceElement[]	procinststart	Start Activities
date	procinststartedat	Started on/at
ProcessInstanceState	procinststate	State of Process
ProcessStatistic	procinststatistic	Process Statistic
User[]	procinstusers	Users Concerned
InstanceElement[]	procinstwork	To Do
integer	procstatnrcompleted	Activities Completed
integer	procstatnrinst	Number of Activities
integer	procstatnrreceived	Activities Waiting to Be Started
integer	procstatnrreceivedoverdue	Activities Waiting to Be Started (Delayed)
integer	procstatnrstarted	Activities Started
integer	procstatnrstartedoverdue	Activities Started (Delayed)
integer	procstatnrsuspended	Suspended Started
integer	procstatnrsuspendedoverdue	Suspended Started (Delayed)
integer	procstatnrwaiting	Activities Waiting to Become Startable
integer	procstatnrwaitingoverdue	Activities Waiting to Become Startable (Delayed)
integer	procstatpercentcomp	Percent Completed
integer	procstatreceivedtime	Waiting Period for Received Activities
integer	procstatstartedtime	Working Period for Started Activities
integer	procstattotaltime	Running Period of Process

Actions

Return Type	Signature
boolean	AllowChangeProcessState( out retval boolean statechangeable)
void	ArchiveProcess()
void	ClearProcessParameters( optional boolean separatetx)
ArchivedProcessStatistic	GenerateArchivedProcessStatistic( out retval ArchivedProcessStatistic statistics)
object[]	GetInstanceElements( ref retval object[] instelems, optional object[] objclass, optional ActivityInstanceState[] actinststate, optional boolean ordered, optional string adhockey, optional string multiinstancekey)
object[]	GetLastInstanceElements( out retval object[] instelems)
object[]	GetParticipantUsers( out retval object[] users, optional boolean ignoregroupposition, optional boolean activeusersonly)
any	GetProcessParameter( string key, out retval any value)
dictionary	GetProcessParameters( out retval dictionary params)
object	ObjectCopy( ref optional object placement, out retval object object, optional string address, optional boolean virtualobject)
integer	ObjectFixVersion( boolean autofixed, string versdesc, out retval integer newversnr, optional boolean fixcontents, optional boolean converttofinalform, optional string finalformat, optional boolean noautopurge, optional datetime verschangedat, optional datetime verssavedat, optional User versby)
void	SetProcessActive()
void	SetProcessParameter( string key, optional any value, optional boolean separatetx)
void	SetProcessSuspended()
void	SetProcessTerminated()
boolean	UserIsResponsible( out retval boolean isresponsible, optional object user, optional ResponsibilityContext respcontext)

Properties

Completed Activities (COOWF@1.1:objactivepastactivities)

Contains completed activities of active/completed processes.

ActivityInstance[] COOWF@1.1:objactivepastactivities readonly volatile

Additional Information

Access Types for Reading Property: AccTypeReadWorkFlow
Object Classes Allowed: ActivityInstance

All Activities of Running or Completed Processes (COOWF@1.1:objallactiveactivities)

Contains all activities of all active and completed (PROCINST_INPROGRESS, PROCINST_COMPLETED) processes. If the user does not have access to the teamroom no activities are returned.

ActivityInstance[] COOWF@1.1:objallactiveactivities readonly volatile invisible

Additional Information

Access Types for Reading Property: AccTypeReadWorkFlow
Object Classes Allowed: ActivityInstance

Planned Activities (COOWF@1.1:objfutureactivities)

Contains all future activities.

Explanation:
If more activities were sequentially defined, planned activities can be started only when the previous activity was completed.

ActivityInstance[] COOWF@1.1:objfutureactivities readonly volatile

Additional Information

Access Types for Reading Property: AccTypeReadWorkFlow

Running Processes (COOWF@1.1:objinprogressproclist)

Contains all in progress processes

ProcessInstance[] COOWF@1.1:objinprogressproclist readonly volatile

Additional Information

Access Types for Reading Property: AccTypeReadWorkFlow
Object Classes Allowed: ProcessInstance

Current Activities (COOWF@1.1:objrunningactivities)

Contains all running activities.

Explanation:
These activities can be started by the workflow participant. As long as these activities are not completed, they are displayed in this list.

ActivityInstance[] COOWF@1.1:objrunningactivities readonly volatile

Additional Information

Access Types for Reading Property: AccTypeReadWorkFlow

Activities of the Process (COOWF@1.1:procinstactivities)

This property stores a list of all activitiy instance and wait action instances of the current process

unique InstanceElement[] COOWF@1.1:procinstactivities readonly volatile

Additional Information

Object Classes Allowed: ActivityInstance, InstanceElement

Archived on/at (COOWF@1.1:procinstarchivedat)

Defines the date and time the process instance was completed. A process instance is completed when all activity instances are completed.

date COOWF@1.1:procinstarchivedat local readonly

Archived by (COOWF@1.1:procinstarchivedby)

The property defines who has archived the process instance.

User COOWF@1.1:procinstarchivedby readonly

Process Statistic (COOWF@1.1:procinstarchivedstatistic)

This property contains statistic values for the archived process instance.

ArchivedProcessStatistic COOWF@1.1:procinstarchivedstatistic readonly

Process Definition (COOWF@1.1:procinstcalcdefinition)

This property is used to display the source of the running process.
The source could be a process diagram (calculated by use of procinstpubdiagram and procinstdiagram) or a process definition (procinstdefinition).
For ad-hoc processes this property will stay empty.

Object COOWF@1.1:procinstcalcdefinition readonly volatile

Last Change in User Interface by (COOWF@1.1:procinstchangedby)

The property defines who has done the last modification in the user interface.

User COOWF@1.1:procinstchangedby readonly

Identifier for Related Processes (COOWF@1.1:procinstcommonid)

This property stores an identifier to mark process instances which are started at the same time and for whome the activity instances can be displayed combined in the worklist

string COOWF@1.1:procinstcommonid readonly

Completed on/at (COOWF@1.1:procinstcompletedat)

Defines the date and time the process instance was completed. A process instance is completed when all activity instances are completed.

Explanation:
This field contains the completion date.

date COOWF@1.1:procinstcompletedat local readonly

Process Definition (COOWF@1.1:procinstdefinition)

Defines the process definition the process instance is created from. This property is set automatically and must not be changed afterwards.

ProcessDefinition COOWF@1.1:procinstdefinition readonly

BPMN Process Diagram (COOWF@1.1:procinstdiagram)

Defines the source version of the BPMN process diagram the process instance is created from. This property is set automatically and must not be changed afterwards.

Explanation:
Shows the BPMN process diagram the process is based on.

WorkFlowDiagram COOWF@1.1:procinstdiagram readonly

Escalation (COOWF@1.1:procinstescalation)

Defines the escalation definition that is to be used for activity instances in this process instance.
If the process instance is created from a definition, this property is initialized with the value of procdefescalation.

EscalationDefinition COOWF@1.1:procinstescalation readonly

Additional Information

Object Classes Allowed: EscalationDefinition

Process Initiator (COOWF@1.1:procinstinitiator)

Defines the organizational element that initiated the process instance. This is the user who created the process instance and the role the user had at the time he initialized the process instance.
This property is set automatically and must not be changed afterwards.

WorkFlowParticipant COOWF@1.1:procinstinitiator readonly(ui)

Disable Substitution (COOWF@1.1:procinstnosubst)

Substitutions can be disabled for process instances

boolean COOWF@1.1:procinstnosubst readonly

Affected Object (COOWF@1.1:procinstobject)

Defines the objects of the process instance, if the process instance is assigned to objects. If the process is not assigned to particular objects, no object is stored in this property.

Explanation:
This field shows all objects that are involved in the process.

Object[] COOWF@1.1:procinstobject readonly

Overwritten Process Definition Participants (COOWF@1.1:procinstpartmapping)

This property is used to define a participant mapping to replace a participant defined in the process definition or process diagram with custom participants.

unique WorkFlowParticipantMapping[] COOWF@1.1:procinstpartmapping readonly(ui)

BPMN Process Diagram (Released for Execution) (COOWF@1.1:procinstpubdiagram)

This property stores released version the BPMN process diagram the process instance is created from. from. This property is set automatically and must not be changed afterwards.

Explanation:
Shows the released BPMN process diagram the process is based on.

WorkFlowDiagram COOWF@1.1:procinstpubdiagram readonly

Manual Entry by (COOWF@1.1:procinstrespmansubst)

Defines the organizational element that substitutes the person, who is responsible for the process instance and does not have a user environment.

WorkFlowParticipant COOWF@1.1:procinstrespmansubst

Responsible for Process (COOWF@1.1:procinstresponsible)

Defines the organizational element that is responsible for the process instance. This organizational element has additional privileges when working with the process instance. By default this property contains the user who instantiated the process, but its value can be changed afterwards.
It is also possible to define a person who is not a system user. In this case an organizational element, who substitutes this person, must be defined.

WorkFlowParticipant COOWF@1.1:procinstresponsible

Start Activities (COOWF@1.1:procinststart)

Defines the list of process instance elements the process instance starts with.

unique InstanceElement[] COOWF@1.1:procinststart readonly

Started on/at (COOWF@1.1:procinststartedat)

Defines the date and time the process instance was started. This property is set automatically and must not be changed afterwards.

date COOWF@1.1:procinststartedat local readonly

State of Process (COOWF@1.1:procinststate)

Defines the state of the process instance.

Explanation:
This field shows the current state of the process.

ProcessInstanceState COOWF@1.1:procinststate not null

Process Statistic (COOWF@1.1:procinststatistic)

This property contains statistic values about the process instance.

ProcessStatistic COOWF@1.1:procinststatistic readonly

Users Concerned (COOWF@1.1:procinstusers)

This property contains the list of users concerned by activities of this process instance. This list is built from the users that have or will have activities of this process instance assigned to.

Explanation:
This field contains all Users who are involved in this proceeding (Processing, Approval etc.).

unique User[] COOWF@1.1:procinstusers readonly

To Do (COOWF@1.1:procinstwork)

This property contains the activity instances of the process instance, where work can be done currently. These are the activities that are startable or started and not yet completed.

Explanation:
This field shows all current activities of the process.

unique InstanceElement[] COOWF@1.1:procinstwork readonly volatile

Activities Completed (COOWF@1.1:procstatnrcompleted)

This property contains the number of activity instances that have been completed yet. This are activity instances with a valid value in property actinstcompletedat (i.e. essentialy all activities in state Completed, Delegated or Rejected).

unsigned integer COOWF@1.1:procstatnrcompleted readonly volatile

Number of Activities (COOWF@1.1:procstatnrinst)

This property contains the number of activity instances that are part of the process instance. This includes all activity instances and wait actions.

unsigned integer COOWF@1.1:procstatnrinst readonly volatile

Activities Waiting to Be Started (COOWF@1.1:procstatnrreceived)

This property contains the number of activity instances that are visible in the worklists of the users but not started yet. These are activity instances that have a valid value in actinstreceivedat and that are not yet started. Essentially the activities in state Startable are counted.

unsigned integer COOWF@1.1:procstatnrreceived readonly volatile

Activities Waiting to Be Started (Delayed) (COOWF@1.1:procstatnrreceivedoverdue)

This property contains the number of activity instances that are visible in the worklists of the users but not started yet and the defined deadlines of this activities are expired. These are activity instances that have a valid value in actinstreceivedat and that are not yet started. Essentially the activities in state Startable are counted.

unsigned integer COOWF@1.1:procstatnrreceivedoverdue readonly volatile

Activities Started (COOWF@1.1:procstatnrstarted)

This property contains the number of activity instances with a valid value in property actinststartedat and that are not yet completed. Essentially the activity instances in state Started are counted.

unsigned integer COOWF@1.1:procstatnrstarted readonly volatile

Activities Started (Delayed) (COOWF@1.1:procstatnrstartedoverdue)

This property contains the number of activity instances with a valid value in property actinststartedat and that are not yet completed and the defined deadlines of this activities are expired. Essentially the activity instances in state Started are counted.

unsigned integer COOWF@1.1:procstatnrstartedoverdue readonly volatile

Suspended Started (COOWF@1.1:procstatnrsuspended)

This property contains the number of activity instances with are suspended.

unsigned integer COOWF@1.1:procstatnrsuspended readonly volatile

Suspended Started (Delayed) (COOWF@1.1:procstatnrsuspendedoverdue)

This property contains the number of activity instances with are suspended and the defined deadlines of this activities are expired.

unsigned integer COOWF@1.1:procstatnrsuspendedoverdue readonly volatile

Activities Waiting to Become Startable (COOWF@1.1:procstatnrwaiting)

This property contains the number of activity instances that are neither completed, started nor startable, but which can be started in the future. Essentially this includes the activity instances in state Waiting.

unsigned integer COOWF@1.1:procstatnrwaiting readonly volatile

Activities Waiting to Become Startable (Delayed) (COOWF@1.1:procstatnrwaitingoverdue)

This property contains the number of activity instances that are neither completed, started nor startable, but which can be started in the future and the defined deadlines of this activities are expired. Essentially this includes the activity instances in state Waiting.

unsigned integer COOWF@1.1:procstatnrwaitingoverdue readonly volatile

Percent Completed (COOWF@1.1:procstatpercentcomp)

This property contains the number of activity instances that have been completed yet in percent. It shows the relation of (completed + not to be executed activities)/entier number of activities.

unsigned integer COOWF@1.1:procstatpercentcomp readonly volatile

Waiting Period for Received Activities (COOWF@1.1:procstatreceivedtime)

This property contains the sum of the time periods the activity instances of the process instance waited in the worklists of the users for being started.
For all activity instances with a value in property actinstreceivedat the difference in actinstreceivedat and actinststartedat is added. If property actinststartedat does not have a value, the current date is used.

unsigned integer COOWF@1.1:procstatreceivedtime readonly volatile

Working Period for Started Activities (COOWF@1.1:procstatstartedtime)

This property contains the sum of the time periods users worked on the activity instances of the process instance in their worklists after they were started.
For all activity instances with a valid value in actinststartedat the difference in actinststartedat and actinstcompletedat are added up. If property actinstcompletedat does not have a value yet, the current date is used.

unsigned integer COOWF@1.1:procstatstartedtime readonly volatile

Running Period of Process (COOWF@1.1:procstattotaltime)

This property contains the running period of the process instance in seconds. The value of this property depends on the state the process is in.

Completed process: the difference of the properties procinstcompletedat and procinststartedat.
All activity instances are completed, the process instance itself is not completed: the difference in completing the last activity instance and the property procinststartedat.
Running process: the difference in the current date and the property procinststartedat.

unsigned integer COOWF@1.1:procstattotaltime readonly volatile

Actions

COOWF@1.1:AllowChangeProcessState

Check if the current user is allowed to change the state of the process

boolean COOWF@1.1:AllowChangeProcessState(
out retval boolean statechangeable)

Name	Description
statechangeable	is set to `true` if the process state is changeable

COOWF@1.1:ArchiveProcess

The instance elements like activities and control elements of the process are deleted. Only the process instance is kept with some meta data about the process statistic.

void COOWF@1.1:ArchiveProcess()

COOWF@1.1:ClearProcessParameters

Action clear process parameters for a specified process. This action fails for users with are no participant of the process or have no access on the object of the process.

void COOWF@1.1:ClearProcessParameters(
optional boolean separatetx)

Name	Description
separatetx	the changes are stored in a separate transaction and directly saved

COOWF@1.1:GenerateArchivedProcessStatistic

This action can be used to generate a process statistic before archiving the process instance.

ArchivedProcessStatistic COOWF@1.1:GenerateArchivedProcessStatistic(
out retval ArchivedProcessStatistic statistics)

Name	Description
statistics	the archived statistics of the process instance.

COOWF@1.1:GetInstanceElements

This action can be called to retrieve all instance element objects of a process instance that have the specified class and the specified state. If no class is specified, the instance elements in the process instance are returned regardless of their class. If no state is specified, the instance elements in the process instance are returned regardless of their state.

object[] COOWF@1.1:GetInstanceElements(
  ref retval object[] instelems,
  optional object[] objclass,
  optional ActivityInstanceState[] actinststate,
  optional boolean ordered,
  optional string adhockey,
  optional string multiinstancekey)

Name	Description
instelems	The list of instance elements.
objclass	The desired class.
actinststate	The desired state.
ordered	The instance elements are returned in their graphical order. Starting at the top going to the bottom and from left to right
adhockey	the instance elements with the matching ad hockey will be returned
multiinstancekey	the instance elements with the matching multi instance key will be returned

COOWF@1.1:GetLastInstanceElements

This action can be called to retrieve the last instance elements in a process instance. These are those elements, that do not have a successor any more. If the last element in a process instance is a CASE switch, IF condition or REPEAT loop, the end element of these elements is returned.

object[] COOWF@1.1:GetLastInstanceElements(
out retval object[] instelems)

Name	Description
instelems	The list of last instance elements.

COOWF@1.1:GetParticipantUsers

Get the user which are used as participants

object[] COOWF@1.1:GetParticipantUsers(
  out retval object[] users,
  optional boolean ignoregroupposition,
  optional boolean activeusersonly)

Name	Description
users	the users
ignoregroupposition	the ignoregroupposition
activeusersonly	the activeusersonly

COOWF@1.1:GetProcessParameter

Action to get a process parameter for a specified process. This action fails for users with are no participant of the process or have no access on the object of the process.

any COOWF@1.1:GetProcessParameter(
string key,
out retval any value)

Name	Description
key	the identifier for the process parameter
value	the parameter value

COOWF@1.1:GetProcessParameters

Action read all process parameters for a specified process. This action fails for users with are no participant of the process or have no access on the object of the process.

dictionary COOWF@1.1:GetProcessParameters(
out retval dictionary params)

Name	Description
params	process parameters

COOSYSTEM@1.1:ObjectCopy

Creates a new object as the copy of the object. This action called on the source object. This action sets the property objsource on the copied object.

object COOSYSTEM@1.1:ObjectCopy(
  ref optional object placement,
  out retval object object,
  optional string address,
  optional boolean virtualobject)

Name	Description
placement
object	The created copy of the object.
address	The object address for the new object. If this parameter is used, it overrides the specified COO store in parameter `coost` or the automatically chosen COO store, if no COO store was specified.
virtualobject

COOSYSTEM@1.1:ObjectFixVersion

Defines the current object version of the object with a short description of the version and starts a new version.

For the purpose of migrations, version metadata set by the kernel can be overridden. The implementation attemps to make migration metadata available in both, objversions as well as corresponding properties in associated versions. Kernel values are stored in corresponding backup properties.

The following properties can be overridden:

Version Property	Override Mechanism	Requirements
`verscreatedat`	`objcreatedat`	Object creation
	`objactverscreated`	Object creation
	`ObjectFixVersion` parameter verschangedat	Subsequent `ObjectFixVersion`
`versby`	`objchangedby`	`ObjectFixVersion` before commit
	`ObjectFixVersion` parameter versby
`verschangedat`	`ObjectFixVersion` parameter verschangedat
`verschangedby`	`objcreatedby`	Object creation
	`objchangedby`	`ObjectFixVersion` after commit
`verssavedat`	`ObjectFixVersion` parameter verschangedat

Limitations:

Despite date overrides, the current date and time (coonow / CooRuntime.GetCurrentDateTime) remains unaffected. Undesired values must be handled manually.
Despite user overrides, the current user (coouser / CooRuntime.GetCurrentUser) remains unaffected. Undesired values must be handled manually.

To maximize date and user correctness, disable functionality leading to undesired date and time / user values by means of FSCCOLD@1.1001 class and mapping options, configuration changes, and transaction variables.

integer COOSYSTEM@1.1:ObjectFixVersion(
  boolean autofixed,
  string versdesc,
  out retval integer newversnr,
  optional boolean fixcontents,
  optional boolean converttofinalform,
  optional string finalformat,
  optional boolean noautopurge,
  optional datetime verschangedat,
  optional datetime verssavedat,
  optional User versby)

Name	Description
autofixed	If it is `true`, the new version was started automatically. Otherwise the user started a new version.
versdesc	The version description.
newversnr	The new version number.
fixcontents
converttofinalform
finalformat
noautopurge
verschangedat	The value to override `verschangedat` with. The kernel value is stored in `versrealchangedat` and `objrealactverscreated`.
verssavedat	The value to override `verssavedat` with. The kernel value is stored in `versrealsavedat`. If `verschangedat` is specified and `verssavedat` is not, the value is based on `verschangedat`.
versby	The value to override `COOSYSTEM@1.1:verssby` with. The kernel value is stored in `versrealsavedby`. If not specified and `objchangedby` is set in the current transaction, the value is based on `verschangedat`. Otherwise, the value is based on the current user (`coouser` / `CooRuntime.GetCurrentUser`).

COOWF@1.1:SetProcessActive

Activates a suspended process

void COOWF@1.1:SetProcessActive()

COOWF@1.1:SetProcessParameter

Action to set a process parameter for a specified process. This action fails for users with are no participant of the process or have no access on the object of the process.

void COOWF@1.1:SetProcessParameter(
  string key,
  optional any value,
  optional boolean separatetx)

Name	Description
key	the identifier for the process parameter
value	the parameter value
separatetx	the changes are stored in a separate transaction and directly saved

COOWF@1.1:SetProcessSuspended

Suspends a process

void COOWF@1.1:SetProcessSuspended()

COOWF@1.1:SetProcessTerminated

Terminated a process

void COOWF@1.1:SetProcessTerminated()

COOWF@1.1:UserIsResponsible

Checks if the user is the responsible of the process

boolean COOWF@1.1:UserIsResponsible(
  out retval boolean isresponsible,
  optional object user,
  optional ResponsibilityContext respcontext)

Name	Description
isresponsible	the result
user	the for whom the responsibility should be checked
respcontext	the context of process responsibility. The default value is RESPCTX_OTHER