Class COOWF@1.1:ActivityInstance

This object class is used to describe an activity (a logical step) in a process instance. It defines who has to do what when. An activity instance can be created on the fly in a process instance or it can be created based on an activity definition as template. If an activity instance is created from an activity definition the relative deadlines are replaced with absolute dates (based on calendar days).

Class Hierarchy

Object > InstanceElement > ActivityInstance

Direct Subclasses

ExternalActivityInstance

Additional Information

Commonly usable

Properties

Type	Property	Name
integer	actdefendworkdays	Days to the Latest Possible Completion
integer	actdefstartworkdays	Days to the Latest Possible Start
integer	actdefsubmitworkdays	Days Until Visibility in Worklist
AccessType[]	actinstaccess	Required Access Types
boolean	actinstactivatedmanually	Activated Manually
ActivityInstance	actinstbackactivityfor	Back-Activity for
User	actinstbfinishedby	Finished by
string	actinstcommonid	Identifier for Activities in Related Processes
date	actinstcompletedat	Completed on/at
boolean	actinstdisplayonlywithaccess	Display Activity Only if the Participant Has Access to Affected Object
string	actinstenclosure	Enclosures
date	actinstenddeadline	To Complete at the Latest by
date	actinstescalatedat	Escalated on/at
EscalationDefinition	actinstescalation	Escalation
ActivityExecutionType	actinstexecutiontype	Execution Type
boolean	actinstignorecomplete	Ignore Completion
boolean	actinstignoreinvpart	Skip Invalid Participant
boolean	actinstkeepstarted	Started Activity Remains in All Worklists
ActivityInstanceState	actinstlaststate	Last State of Activity
string	actinstmultiinstancekey	Multi Instance Key
MultiInstanceType	actinstmultiple	Multi-Instance
InstanceElement[]	actinstnext	Successor Activities
boolean	actinstnopersonalsubst	Disable Personal Substitution
boolean	actinstnosubst	Disable Substitution
Object[]	actinstobject	Applies to
Object	actinstpartdefinition	Distribution List
WorkFlowParticipant	actinstparticipant	Workflow Participant
User	actinstpartuser	As Substitute of
InstanceElement[]	actinstprev	Predecessor Activities
WorkFlowPriority	actinstpriority	Workflow Priority
Object	actinstprocdefinition	Process Definition
date	actinstreceivedat	Received on/at
string	actinstremark	Hint
boolean	actinstretractable	Is Retractable
SignatureList[]	actinstsignatures	Signatures
date	actinststartdeadline	To Start at the Latest by
date	actinststartedat	Started on/at
ActivityInstanceState	actinststate	State of Activity
User	actinststatechangedby	Last State Change by
ActivityStatistic	actinststatistic	Activity Instance Statistic
date	actinstsubmitdeadline	Visible in Worklist From
date	actinstsubmittedat	Ready to Receive on/at
Group[]	actinstsubstgroups	Substitutions (Groups)
User	actinstsubstuser	As Substitute of
User[]	actinstsubstusers	Substitutions (Users)
LanguageStringList[]	actinsttitle	Title
WorkFlowWorkList[]	actinstwork	Work Items
WorkFlowParticipant	wfsparticipant	Participant
WorkFlowParticipant	wfspartmansubst	Manual Entry by

Actions

Return Type	Signature
object[]	GetDefinitionElements( out retval object[] defelems, optional object objclass)
NotificationEntryList[]	GetNotificationSettings( out retval NotificationEntryList[] notificationentries)
object[]	GetParticipantUsers( out retval object[] users, optional boolean ignoregroupposition, optional boolean activeusersonly)
PushNotificationEntryList[]	GetPushNotificationSettings( out retval PushNotificationEntryList[] pushnotificationentries)
integer	GetWorkItemIndex( string wfwkey, out retval integer wfwindex, integer wfworigindex)
string	GetWorkItemKey( integer wfwindex, out retval string wfwkey, optional boolean silent)
ProcessInstance	PrescribeObject( optional integer handle, optional integer index, ref optional WorkFlowPrescriptionList[] prescription, optional boolean prescrparallel, optional object prescrback, optional string remark, optional boolean remarkdefined, optional datetime receivedat, optional datetime startedat, optional datetime completedat, ref optional WorkFlowPrescriptionBlockList[] prescrblocks, optional boolean notcomplete, optional object[] additionalobjects, optional object[] concernedobjects, optional string processname, optional WorkFlowDiagram processdiagram, optional boolean delayedprocessstart, optional string adhocprocesskey, out retval ProcessInstance procinst, optional WorkFlowParticipantMapping[] partmapping, optional boolean expandsubprocesses, optional dictionary processparams, optional string procinstcommonid)
boolean	UserIsParticipant( out retval boolean isparticipant, optional object user, optional WorkFlowParticipant checkpart)

Properties

Days to the Latest Possible Completion (COOWF@1.1:actdefendworkdays)

This property supplies the deadline for completion of the activity instance using work days.

Explanation:
In this field the number of days until the desired completion date can be defined. If a holiday table is defined, the days are working days.

unsigned integer COOWF@1.1:actdefendworkdays readonly

Days to the Latest Possible Start (COOWF@1.1:actdefstartworkdays)

This property supplies the deadline for starting the activity instance using work days.

Explanation:
In this field the number of days until the desired start date can be defined. If a holiday table is defined, the days are working days.

unsigned integer COOWF@1.1:actdefstartworkdays readonly

Days Until Visibility in Worklist (COOWF@1.1:actdefsubmitworkdays)

This property supplies the deadline for submission of the activity instance using work days.

Explanation:
In this field the number of days until the desired submission date can be defined. If a holiday table is defined, the days are working days.

unsigned integer COOWF@1.1:actdefsubmitworkdays readonly

Required Access Types (COOWF@1.1:actinstaccess)

Defines the access type assigned to the activity definition.
The access type for the activity definition is checked when the activity definition is inserted by an prescription for the user who is dedicated to execute the activity definition.

If the activity instance defines the option actinstdisplayonlywithaccess the activity will only be displayed in the worklist if the user has the access type required by the activity definition.
If no access types are specified the access type AccTypeRead is used.

unique AccessType[] COOWF@1.1:actinstaccess readonly

Activated Manually (COOWF@1.1:actinstactivatedmanually)

boolean COOWF@1.1:actinstactivatedmanually readonly invisible

Back-Activity for (COOWF@1.1:actinstbackactivityfor)

ActivityInstance COOWF@1.1:actinstbackactivityfor readonly invisible

Finished by (COOWF@1.1:actinstbfinishedby)

Defines the user who finished this activity. This property is the backlink property for userfactivities;

User COOWF@1.1:actinstbfinishedby readonly invisible

Additional Information

Property for Back Link: userfactivities

Identifier for Activities in Related Processes (COOWF@1.1:actinstcommonid)

This property stores an identifier activity instances which are started at the same time for the commonly started processes

string COOWF@1.1:actinstcommonid readonly

Completed on/at (COOWF@1.1:actinstcompletedat)

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

Explanation:
Point in time, on which the processing of the activity was finished.

date COOWF@1.1:actinstcompletedat local readonly

Display Activity Only if the Participant Has Access to Affected Object (COOWF@1.1:actinstdisplayonlywithaccess)

The activity instance will only be display in the worklist if the participant has access to the object of the process.
Note: If the participant is a specific user and the user has no access to the object of the process, the workflow will not continue until the user gets access permissions.

Explanation:
Defines whether the activity is only displayed in the worklist if the participant has at least read rights to the affected object of the process. Note: If the activity is not visible to any participant, the process stops.

boolean COOWF@1.1:actinstdisplayonlywithaccess readonly

Enclosures (COOWF@1.1:actinstenclosure)

This property stores information about enclosures necessary for the activity instance. This is an informal text field.

string COOWF@1.1:actinstenclosure readonly

To Complete at the Latest by (COOWF@1.1:actinstenddeadline)

Defines the date and time the activity instance must be completed by the concerned user. If this date is exceeded, the user concerned gets a message when he opens his worklist, and the font effect of the activity instance changes to italic.
If the activity instance is generated from an activity definition, the completion deadline is computed from the property actdefenddeadline of the activity definition, when the activity instance gets startable.

Explanation:
Defines by when the activity should be completed at the latest.

date COOWF@1.1:actinstenddeadline local readonly

Escalated on/at (COOWF@1.1:actinstescalatedat)

Defines the date and time an escalation message was sent for the activity instance, because either a start deadline or end deadline was not met, and an escalation definition is set for this activity instance or for this process instance. This property is used to record the time of the last escalation message, to be able to repeat it according to the definitions in the escalation definition.

Explanation:
The point in time on which the activity has been escalated.

date COOWF@1.1:actinstescalatedat local readonly

Escalation (COOWF@1.1:actinstescalation)

Defines the escalation definition that is used for this activity instance, if the start or end deadline is not met.
If the activity instance is generated from an activity definition, this property is initialized with the value of actdefescalation of the activity definition.

Explanation:
The defined escalation definition determines the escalation rules for this activity. If the standard escalation is used, a reminder e-mail is sent if the start or completion date is exceeded.

EscalationDefinition COOWF@1.1:actinstescalation readonly

Additional Information

Object Classes Allowed: EscalationDefinition

Execution Type (COOWF@1.1:actinstexecutiontype)

This property is used to define if the activity is executed by a human using the workitems defined in property actinstwork
If the activity should be executed by a background job using a deadline the value AET_SCRIPTTASK should be used and the expression defined in property actinstbackgroundexpression is executed.
Note: The evaluation of the background task is done by an background user which is calculated by use of the abstract metaparticiant WFMP_OBJGROUPBGUSER other recipients are not allowed.

The property actinstbackground is used for background processing of activities with the AT job CheckBackgroundWork and is not compatible with the setting AET_SCRIPTTASK
Currently activities of type AET_SCRIPTTASK are only usable for BPMN-MODELING.

ActivityExecutionType COOWF@1.1:actinstexecutiontype readonly

Ignore Completion (COOWF@1.1:actinstignorecomplete)

This property defines if the following activities are started before this activity has been completed. This is useful if the current activity is just for notification.

Explanation:
Defines whether subsequent activities can be started although this activity has not yet been completed.

boolean COOWF@1.1:actinstignorecomplete readonly

Skip Invalid Participant (COOWF@1.1:actinstignoreinvpart)

The activity instance, will be marked as not executed during start and the following activities are started, if the participant is not a valid workflow participant.

Explanation:
Defines whether the activity is skipped for an invalid participant (e.g. inactive user, missing license).

boolean COOWF@1.1:actinstignoreinvpart readonly

Started Activity Remains in All Worklists (COOWF@1.1:actinstkeepstarted)

Defines whether to keep the started activity instance in all worklists. If an activity instance is assigned to several users - e.g. by assigning it to a group - it is displayed in the worklists of these users in state "Startable". If a user started this activity instance and this property has value True, the activity instance remains in all other worklists and several users are able to work on this activity. If the activity instance is started and this property is set to False, the activity instance is removed from the worklists of the other users.
If the activity instance is generated from an activity definition, this property is initialized with the value of actdefkeepstarted.

Explanation:
Defines whether the corresponding activity is removed from the worklists of the additional affected participants when the activity is started.

boolean COOWF@1.1:actinstkeepstarted readonly

Last State of Activity (COOWF@1.1:actinstlaststate)

Defines the last state the activity had. This property is used to determine if an activity was activated from a suspension.

ActivityInstanceState COOWF@1.1:actinstlaststate readonly invisible

Multi Instance Key (COOWF@1.1:actinstmultiinstancekey)

This property stores an identifier to mark instance element which were inserted into the process. All elements which were inserted with one operation have the same key.

string COOWF@1.1:actinstmultiinstancekey readonly

Multi-Instance (COOWF@1.1:actinstmultiple)

This property defines if the current activity instance is resolved to multiple activity instances when the state changes to ACTINST_STARTABLE. If the activity instance is created from an activity definition, this property is initialized with the value of actdefmultiple.

MultiInstanceType COOWF@1.1:actinstmultiple readonly

Successor Activities (COOWF@1.1:actinstnext)

Defines the list of process instance elements that follow the instance element in the process instance.

unique InstanceElement[] COOWF@1.1:actinstnext readonly

Disable Personal Substitution (COOWF@1.1:actinstnopersonalsubst)

This property stores if personal substitutions are prohibited for this activity.

boolean COOWF@1.1:actinstnopersonalsubst readonly

Disable Substitution (COOWF@1.1:actinstnosubst)

This property stores if all substitutions are prohibited for this activity.

Explanation:
Defines whether the activity may be executed by a substitute.

boolean COOWF@1.1:actinstnosubst readonly

Applies to (COOWF@1.1:actinstobject)

This property contains the objects attached to the process instance, the activity instance is part of. If objects are stored in this property, they are automatically stored as objects of the process instance.

Object[] COOWF@1.1:actinstobject readonly

Additional Information

Object Classes Allowed: Object

Distribution List (COOWF@1.1:actinstpartdefinition)

This property defines the distribution list the activity is assigned to. When the activity get's startable the distribution list is resolved to single activity instances for each member of the distribution list. If the distribution list defines that it should expand immediately the distribution list is resolved to single instances at start of the process. Note: This property of the participant can only be used for activities which are populated as multiple instance activities.

Object COOWF@1.1:actinstpartdefinition readonly

Additional Information

Object Classes Allowed: WorkGroup, ParticipantDefinition, ParticipantInstance

Workflow Participant (COOWF@1.1:actinstparticipant)

Defines the organization element which is concerned by the activity instance. An activity instance can be prescribed to a user, a group, a position, an organizational unit type, a position in context of a group or a position in context of an organizational unit type. The workflow participant can be defined as an abstract participant, too. The abstract participant is evaluated and stored in this property when the state of the activity instance changes from "Waiting" to "Startable". Changes of the evaluated properties (e.g. the object owner) made afterwards are not considered.
It is also possible to define a person who is not a system user. In this case a system user who substitutes this person must be defined.
If the activity instance is created from an activity definition, this property is initialized with the value of actdefparticipant.

Explanation:
In this field the user who is responsible for the process is inserted. This User receives the activity in his Workflow.

WorkFlowParticipant COOWF@1.1:actinstparticipant not null readonly

As Substitute of (COOWF@1.1:actinstpartuser)

User COOWF@1.1:actinstpartuser readonly volatile

Predecessor Activities (COOWF@1.1:actinstprev)

Defines the list of process instance elements that preceed the instance element in the process instance.

unique InstanceElement[] COOWF@1.1:actinstprev readonly

Workflow Priority (COOWF@1.1:actinstpriority)

Defines the priority of the activity instance.
If the activity instance is created from an activity definition, this property is initialized with the value of actdefpriority.

Explanation:
The priority of the activity is not relevant for the execution of the process and will be documented in escalations.

WorkFlowPriority COOWF@1.1:actinstpriority not null readonly

Process Definition (COOWF@1.1:actinstprocdefinition)

This property displays the process definition or process diagram from which the activity instance was created.
In case of ad-hoc processes this property does no have any value.

Object COOWF@1.1:actinstprocdefinition readonly

Received on/at (COOWF@1.1:actinstreceivedat)

Defines the date and time the concerned user(s) received the activity instance in their worklist. This property is set automatically and must not be changed afterwards.

Explanation:
Point in time, on which the activity was assigned to the worklist.

date COOWF@1.1:actinstreceivedat local readonly

Hint (COOWF@1.1:actinstremark)

This property stores a remark about the activity instance. This is an informal textual field.

Explanation:
In this field hints can be entered.

string COOWF@1.1:actinstremark

Is Retractable (COOWF@1.1:actinstretractable)

Defines whether the activity instance can be reatracted

boolean COOWF@1.1:actinstretractable readonly

Signatures (COOWF@1.1:actinstsignatures)

SignatureList[] COOWF@1.1:actinstsignatures readonly volatile

To Start at the Latest by (COOWF@1.1:actinststartdeadline)

Defines the date and time the activity instance must be started by the user. If this date is exceeded, the user concerned gets a message when he opens his worklist. If the activity instance is to be executed in background this time defines when the AT service should execute it.
If the activity instance is generated from an activity definition, the start deadline is computed from the property actdefstartdeadline of the activity definition, when the activity instance gets startable.

Explanation:
Defines by when the activity should be started at the latest.

date COOWF@1.1:actinststartdeadline local readonly

Started on/at (COOWF@1.1:actinststartedat)

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

Explanation:
Point in time, on which the processing of the activity has begun.

date COOWF@1.1:actinststartedat local readonly

State of Activity (COOWF@1.1:actinststate)

Defines the state of the activity instance. The state of an activity instance is the central element of the workflow engine. Only certain changes of the state of an activity instance are allowed, and the change of the state can trigger state changes in other instance elements, the evaluation of conditions etc.

Explanation:
Shows the current state of the activity.

ActivityInstanceState COOWF@1.1:actinststate not null

Last State Change by (COOWF@1.1:actinststatechangedby)

The property defines who performed the last state change of the activity instance.

User COOWF@1.1:actinststatechangedby readonly invisible

Activity Instance Statistic (COOWF@1.1:actinststatistic)

Defines the working statistic of the activity

ActivityStatistic COOWF@1.1:actinststatistic readonly

Visible in Worklist From (COOWF@1.1:actinstsubmitdeadline)

Defines the date and time, when the activity must be submitted in the work list. If a user opens the work list and this deadline is reached, the activity is automatically put into the "To Do" list and removed from the list of suspended activities.

Explanation:
Defines by when the activity should be visible in the worklist.

date COOWF@1.1:actinstsubmitdeadline local readonly

Ready to Receive on/at (COOWF@1.1:actinstsubmittedat)

Defines the date and time, when an activity instance was ready to be received. This is the time, when all preceeding activities are completed and the activity could become startable, but a date and time for submission is defined, and this time is still in the future. Only after the submission date is reached, and the user opens the work list, then the activity instance is received and becomes startable.

date COOWF@1.1:actinstsubmittedat local readonly

Substitutions (Groups) (COOWF@1.1:actinstsubstgroups)

This property is used to store the substitute groups which can execute the activity.

unique Group[] COOWF@1.1:actinstsubstgroups readonly

As Substitute of (COOWF@1.1:actinstsubstuser)

Defines the originally assigned user if the activity was completed in a personal substitution.

User COOWF@1.1:actinstsubstuser readonly volatile

Substitutions (Users) (COOWF@1.1:actinstsubstusers)

This property is used to store the substitute users which can execute the activity.

unique User[] COOWF@1.1:actinstsubstusers readonly

Title (COOWF@1.1:actinsttitle)

Defines the title of the activity instance. This is a multilingual string.
If the activity instance is created from an activity definition, this property is initialized with the value of actdeftitle.

unique LanguageStringList[] COOWF@1.1:actinsttitle

Work Items (COOWF@1.1:actinstwork)

Defines the list of work items are to be executed in order to complete the activity instance. A work item can be described textually or planned for an automatic execution by defining an object and an action or an ActiveX script.

WorkFlowWorkList[] COOWF@1.1:actinstwork readonly

Participant (COOWF@1.1:wfsparticipant)

This property defines the organizational element the prescribed activity is assigned to.

Explanation:
In this field the participants of the prescription are inserted. These Users receive the activity in their Workflow.

WorkFlowParticipant COOWF@1.1:wfsparticipant readonly

Manual Entry by (COOWF@1.1:wfspartmansubst)

Defines the organizational element that is the substitute for a person that is not a system user and that has the prescribed acitivity assigned to.

WorkFlowParticipant COOWF@1.1:wfspartmansubst readonly

Actions

COOWF@1.1:GetDefinitionElements

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

object[] COOWF@1.1:GetDefinitionElements(
out retval object[] defelems,
optional object objclass)

Name	Description
defelems	The list of definition elements.
objclass	The desired class.

COOWF@1.1:GetNotificationSettings

Retrieve the configured notification entries for an activity instance.
Notification entries can be configured on activity definition, process definition level and global by use of an notification definition.

After the available notification settings have been calculated the action ExtendNotificationSettings is called to allow to do additional customizing of the notification settings.

NotificationEntryList[] COOWF@1.1:GetNotificationSettings(
out retval NotificationEntryList[] notificationentries)

Name	Description
notificationentries	the configured notification entries

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:GetPushNotificationSettings

Retrieve the configured push notification entries for an activity instance.
Push notification entries can be configured on activity definition, process definition level and global by use of an notification definition.

After the available push notification settings have been calculated the action ExtendPushNotificationSettings is called to allow to do additional customizing of the notification settings.

PushNotificationEntryList[] COOWF@1.1:GetPushNotificationSettings(
out retval PushNotificationEntryList[] pushnotificationentries)

Name	Description
pushnotificationentries	the configured push notification entries

COOWF@1.1:GetWorkItemIndex

Gets the index of the workitem matching the workitem key.

integer COOWF@1.1:GetWorkItemIndex(
  string wfwkey,
  out retval integer wfwindex,
  integer wfworigindex)

Name	Description
wfwkey	the key of the work item
wfwindex	the index of the work item matching the key
wfworigindex	the index of the key at the last call

COOWF@1.1:GetWorkItemKey

Gets the key of the work item matching the supplied index.

string COOWF@1.1:GetWorkItemKey(
  integer wfwindex,
  out retval string wfwkey,
  optional boolean silent)

Name	Description
wfwindex	the index of the work item
wfwkey	the key of the work item matching the index
silent	if set to true no error will be returned if no work item was found by the key

COOWF@1.1:PrescribeObject

Adds following activities to the process of the current activity. If this action is called on an object, a new process is started.

ProcessInstance COOWF@1.1:PrescribeObject(
  optional integer handle,
  optional integer index,
  ref optional WorkFlowPrescriptionList[] prescription,
  optional boolean prescrparallel,
  optional object prescrback,
  optional string remark,
  optional boolean remarkdefined,
  optional datetime receivedat,
  optional datetime startedat,
  optional datetime completedat,
  ref optional WorkFlowPrescriptionBlockList[] prescrblocks,
  optional boolean notcomplete,
  optional object[] additionalobjects,
  optional object[] concernedobjects,
  optional string processname,
  optional WorkFlowDiagram processdiagram,
  optional boolean delayedprocessstart,
  optional string adhocprocesskey,
  out retval ProcessInstance procinst,
  optional WorkFlowParticipantMapping[] partmapping,
  optional boolean expandsubprocesses,
  optional dictionary processparams,
  optional string procinstcommonid)

Name	Description
handle	unused deprecated
index	unused deprecated
prescription	the prescription list contains the following activities and participants
prescrparallel	defines if following activities defined in parameter prescription will be added parallel
prescrback	this activity will be added after the inserted activity instances.
remark	the entered remark will be stored to the current activity instance.
remarkdefined	determines if a remark is supplied
receivedat	the time stamp when the current activity was received. Only important for manual activities!
startedat	the time stamp when the current activity was started Only important for manual activities!
completedat	the time stamp when the current activity was completed Only important for manual activities!
prescrblocks	the prescription blocks contains the following activities and participants
notcomplete	internal: is used for integrity checks if the current activity was already completed
additionalobjects	when creating a new process this objects will be added to `COOWF@1.1:procinstobjects`
concernedobjects	the objects which are dependent for the prescription
processname	the name of the newly created process
processdiagram	the supplied diagram initiates the process on the current object
delayedprocessstart	the process is not started immediately
adhocprocesskey	the key for the ad hoc process. This parameter is for internal reasons and should not be set.
procinst	the process instance where the ad hoc elements were inserted to
partmapping	the supplied mapping is used to replace the participants defined in the process diagram when the activities are created.
expandsubprocesses	If set to `True`, all subprocesses contained in the supplied process diagram are expanded directly when the process is started
processparams	if defined the process parameters are merged into the process parameters of the process diagram
procinstcommonid	if defined the identification is stored in property `procinstcommonid` for newly created processes. This identification is used to allow to combine commonly started process instances

Additional Information

Prototype: MenuActionPrototype

COOWF@1.1:UserIsParticipant

Checks if the user is a valid workflow participant

boolean COOWF@1.1:UserIsParticipant(
  out retval boolean isparticipant,
  optional object user,
  optional WorkFlowParticipant checkpart)

Name	Description
isparticipant	the result
user	the requested user. If not set the current user is used
checkpart	if set the supplied participant will be checked