Class COOWF@1.1:ActivityDefinition

This class is used to describe an activity (a logical step) in a process definition. It defines who has to do what when and additional settings (presentation, priority, ...). The deadlines in activity definitions are specified relative to the time the activity is received in a worklist, e.g. three days.

Class Hierarchy

Object > ComponentObject > ConfigurationObject > SimpleConfigurationObject > DefinitionElement > ActivityDefinition

Properties

Type	Property	Name
boolean	actdefdisplayonlywithaccess	Display Activity Only if the Participant Has Access to Affected Object
integer	actdefenddeadline	Period of Time to the Latest Possible Completion
integer	actdefendworkdays	Days to the Latest Possible Completion
EscalationDefinition	actdefescalation	Escalation
ActivityExecutionType	actdefexecutiontype	Execution Type
boolean	actdefignorecomplete	Ignore Completion
boolean	actdefignoreinvpart	Skip Invalid Participant
boolean	actdefkeepstarted	Started Activity Remains in All Worklists
MultiInstanceType	actdefmultiple	Multi-Instance
DefinitionElement[]	actdefnext	Successor Activities
NotificationEntryList[]	actdefnotification	Defined Notifications
Object	actdefpartdefinition	Distribution List
WorkFlowParticipant	actdefparticipant	Workflow Participant
DefinitionElement[]	actdefprev	Predecessor Activities
PushNotificationEntryList[]	actdefpushnotification	Defined Push Notifications
integer	actdefstartdeadline	Period of Time to the Latest Possible Start
integer	actdefstartworkdays	Days to the Latest Possible Start
integer	actdefsubmitdeadline	Period of Time Until Visibility in Worklist
integer	actdefsubmitworkdays	Days Until Visibility in Worklist
LanguageStringList[]	actdeftitle	Title
date	actinstenddeadline	To Complete at the Latest by
date	actinststartdeadline	To Start at the Latest by
date	actinstsubmitdeadline	Visible in Worklist From

Properties

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

An activity instance that was generate from this activity definition, 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 an 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:actdefdisplayonlywithaccess readonly

Period of Time to the Latest Possible Completion (COOWF@1.1:actdefenddeadline)

Defines the period of time, in which the activity instance generated from this activity definition has to be completed. The period of time is stored as number of seconds and is displayed and entered in days, hours, minutes, and seconds.
Note: The period of time is entered in days, hours, minutes or seconds. The unit for the time is d, day and days for the specification of days (e.g. 2d for 2 days), h, hour and hours for the specification of hours, min, minute and minutes for the specification of minutes and sec, second and seconds for the specification of seconds. If only a number is specified, the used unit is minute.

unsigned integer COOWF@1.1:actdefenddeadline readonly

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

Escalation (COOWF@1.1:actdefescalation)

Defines the escalation definition that is to be used for activity instances generated from this 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:actdefescalation readonly

Additional Information

Object Classes Allowed: EscalationDefinition

Execution Type (COOWF@1.1:actdefexecutiontype)

This property is used to define if the activity is executed by a human using the workitems defined in property actdefwork
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 actdefbackgroundexpression 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 actdefbackground 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:actdefexecutiontype readonly

Ignore Completion (COOWF@1.1:actdefignorecomplete)

Defines whether the following activities are started before the current activity was completed.

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

boolean COOWF@1.1:actdefignorecomplete readonly

Skip Invalid Participant (COOWF@1.1:actdefignoreinvpart)

An activity instance that was generated from this activity definition, will be marked as not executed 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:actdefignoreinvpart readonly

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

Defines whether a started activity instance, that was generated from this activity definition, is removed from the worklists of other users.
If an activity is prescribed to a group of users, this activity is visible in the worklists of the users of that group, if it has state "Startable". This property defines what should happen, if a user starts the activity. If it is True, the activity remains in all worklists so several users can work on this activity. If the value of this property is False, the activity is left only in the worklist of the user who has started it and is removed from all other worklists.

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:actdefkeepstarted readonly

Multi-Instance (COOWF@1.1:actdefmultiple)

This property defines if the current activity definition is resolved to multiple activity instances when the state changes to ACTINST_STARTABLE

MultiInstanceType COOWF@1.1:actdefmultiple readonly

Successor Activities (COOWF@1.1:actdefnext)

Defines the list of definition elements that follow this definition element in the process definition.

unique DefinitionElement[] COOWF@1.1:actdefnext readonly

Defined Notifications (COOWF@1.1:actdefnotification)

Configured notification settings for instances of the activity definition. Each configured event type setting overrides the settings of notification definition stored at the process definition or the current domain.

Explanation:
Defines in which case a notification is sent.

unique NotificationEntryList[] COOWF@1.1:actdefnotification readonly

Distribution List (COOWF@1.1:actdefpartdefinition)

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:actdefpartdefinition readonly

Additional Information

Object Classes Allowed: ParticipantDefinition

Workflow Participant (COOWF@1.1:actdefparticipant)

Defines the organizational element concerned by the activity definition. An activity definition 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.

Explanation:
In this field the participant responsible for completing the activity is defined.

WorkFlowParticipant COOWF@1.1:actdefparticipant readonly

Predecessor Activities (COOWF@1.1:actdefprev)

Defines the list of process definition elements that preceed this definition element in the process definition.

unique DefinitionElement[] COOWF@1.1:actdefprev readonly

Defined Push Notifications (COOWF@1.1:actdefpushnotification)

Configured push notification settings for instances of the activity definition. Each configured event type setting overrides the settings of push notification definition stored at the process definition or the current domain.

unique PushNotificationEntryList[] COOWF@1.1:actdefpushnotification readonly

Period of Time to the Latest Possible Start (COOWF@1.1:actdefstartdeadline)

Defines the starting time for the execution of activity instances generated from this activity definition relative to the time the activity instance is received in a worklist. The period of time is stored as number of seconds and is displayed and entered in days, hours, minutes, and seconds.
Note: The period of time is entered in days, hours, minutes or seconds. The unit for the time is d, day and days for the specification of days (e.g. 2d for 2 days), h, hour and hours for the specification of hours, min, minute and minutes for the specification of minutes and sec, second and seconds for the specification of seconds. If only a number is specified, the used unit is minute.

unsigned integer COOWF@1.1:actdefstartdeadline 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

Period of Time Until Visibility in Worklist (COOWF@1.1:actdefsubmitdeadline)

This property is used to define the period of time for submission for activity instances created from this activity definition after the activity instance becomes startable. The period of time is stored as number of seconds and is displayed and entered in days, hours, minutes, and seconds.
Note: The period of time is entered in days, hours, minutes or seconds. The unit for the time is d, day and days for the specification of days (e.g. 2d for 2 days), h, hour and hours for the specification of hours, min, minute and minutes for the specification of minutes and sec, second and seconds for the specification of seconds. If only a number is specified, the used unit is minute.

unsigned integer COOWF@1.1:actdefsubmitdeadline 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

Title (COOWF@1.1:actdeftitle)

Defines the title of an activity definition. This is a multilingual string.

Explanation:
In this field the title of the activity can be defined.

unique LanguageStringList[] COOWF@1.1:actdeftitle 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

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

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