Class Hierarchy
Object > InstanceElement > ActivityInstance
Direct Subclasses
Additional Information
Type |
Property |
Name |
Days to the Latest Possible Completion |
||
Days to the Latest Possible Start |
||
Days Until Visibility in Worklist |
||
Required Access Types |
||
Activated Manually |
||
Back-Activity for |
||
Finished by |
||
Identifier for Activities in Related Processes |
||
Completed on/at |
||
Display Activity Only if the Participant Has Access to Affected Object |
||
Enclosures |
||
To Complete at the Latest by |
||
Escalated on/at |
||
Escalation |
||
Execution Type |
||
Ignore Completion |
||
Skip Invalid Participant |
||
Started Activity Remains in All Worklists |
||
Last State of Activity |
||
Multi Instance Key |
||
Multi-Instance |
||
Successor Activities |
||
Disable Personal Substitution |
||
Disable Substitution |
||
Applies to |
||
Distribution List |
||
Workflow Participant |
||
As Substitute of |
||
Predecessor Activities |
||
Workflow Priority |
||
Process Definition |
||
Received on/at |
||
Hint |
||
Is Retractable |
||
Signatures |
||
To Start at the Latest by |
||
Started on/at |
||
State of Activity |
||
Last State Change by |
||
Activity Instance Statistic |
||
Visible in Worklist From |
||
Ready to Receive on/at |
||
Substitutions (Groups) |
||
As Substitute of |
||
Substitutions (Users) |
||
Title |
||
Work Items |
||
Participant |
||
Manual Entry by |
Return Type |
Signature |
GetDefinitionElements( |
|
GetNotificationSettings( |
|
GetParticipantUsers( |
|
GetPushNotificationSettings( |
|
GetWorkItemIndex( |
|
GetWorkItemKey( |
|
PrescribeObject( |
|
UserIsParticipant( |
Days to the Latest Possible Completion (COOWF@1.1:actdefendworkdays)
unsigned integer COOWF@1.1:actdefendworkdays readonly
Days to the Latest Possible Start (COOWF@1.1:actdefstartworkdays)
unsigned integer COOWF@1.1:actdefstartworkdays readonly
Days Until Visibility in Worklist (COOWF@1.1:actdefsubmitworkdays)
unsigned integer COOWF@1.1:actdefsubmitworkdays readonly
Required Access Types (COOWF@1.1:actinstaccess)
actinstdisplayonlywithaccess
the
activity will only be displayed in the worklist if the user has the access type required by
the activity definition.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)
User COOWF@1.1:actinstbfinishedby readonly invisible
Additional Information
Identifier for Activities in Related Processes (COOWF@1.1:actinstcommonid)
string COOWF@1.1:actinstcommonid readonly
Completed on/at (COOWF@1.1:actinstcompletedat)
date COOWF@1.1:actinstcompletedat local readonly
Display Activity Only if the Participant Has Access to Affected Object (COOWF@1.1:actinstdisplayonlywithaccess)
boolean COOWF@1.1:actinstdisplayonlywithaccess readonly
Enclosures (COOWF@1.1:actinstenclosure)
string COOWF@1.1:actinstenclosure readonly
To Complete at the Latest by (COOWF@1.1:actinstenddeadline)
actdefenddeadline
of the activity definition, when the activity
instance gets startable.date COOWF@1.1:actinstenddeadline local readonly
Escalated on/at (COOWF@1.1:actinstescalatedat)
date COOWF@1.1:actinstescalatedat local readonly
Escalation (COOWF@1.1:actinstescalation)
actdefescalation
of the activity definition.EscalationDefinition COOWF@1.1:actinstescalation readonly
Additional Information
Execution Type (COOWF@1.1:actinstexecutiontype)
actinstwork
AET_SCRIPTTASK
should be used and the expression defined in property
actinstbackgroundexpression
is executed.WFMP_OBJGROUPBGUSER
other
recipients are not allowed.actinstbackground
is used for background processing of activities with
the AT job CheckBackgroundWork
and is not compatible with the setting
AET_SCRIPTTASK
AET_SCRIPTTASK
are only usable for BPMN-MODELING.ActivityExecutionType COOWF@1.1:actinstexecutiontype readonly
Ignore Completion (COOWF@1.1:actinstignorecomplete)
boolean COOWF@1.1:actinstignorecomplete readonly
Skip Invalid Participant (COOWF@1.1:actinstignoreinvpart)
boolean COOWF@1.1:actinstignoreinvpart readonly
Started Activity Remains in All Worklists (COOWF@1.1:actinstkeepstarted)
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.actdefkeepstarted
.boolean COOWF@1.1:actinstkeepstarted readonly
Last State of Activity (COOWF@1.1:actinstlaststate)
ActivityInstanceState COOWF@1.1:actinstlaststate readonly invisible
Multi Instance Key (COOWF@1.1:actinstmultiinstancekey)
string COOWF@1.1:actinstmultiinstancekey readonly
Multi-Instance (COOWF@1.1:actinstmultiple)
actdefmultiple
.MultiInstanceType COOWF@1.1:actinstmultiple readonly
Successor Activities (COOWF@1.1:actinstnext)
unique InstanceElement[] COOWF@1.1:actinstnext readonly
Disable Personal Substitution (COOWF@1.1:actinstnopersonalsubst)
boolean COOWF@1.1:actinstnopersonalsubst readonly
Disable Substitution (COOWF@1.1:actinstnosubst)
boolean COOWF@1.1:actinstnosubst readonly
Applies to (COOWF@1.1:actinstobject)
Object[] COOWF@1.1:actinstobject readonly
Additional Information
Distribution List (COOWF@1.1:actinstpartdefinition)
Object COOWF@1.1:actinstpartdefinition readonly
Additional Information
Workflow Participant (COOWF@1.1:actinstparticipant)
actdefparticipant
.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)
unique InstanceElement[] COOWF@1.1:actinstprev readonly
Workflow Priority (COOWF@1.1:actinstpriority)
actdefpriority
.WorkFlowPriority COOWF@1.1:actinstpriority not null readonly
Process Definition (COOWF@1.1:actinstprocdefinition)
Object COOWF@1.1:actinstprocdefinition readonly
Received on/at (COOWF@1.1:actinstreceivedat)
date COOWF@1.1:actinstreceivedat local readonly
Hint (COOWF@1.1:actinstremark)
string COOWF@1.1:actinstremark
Is Retractable (COOWF@1.1:actinstretractable)
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)
actdefstartdeadline
of the
activity definition, when the activity instance gets startable.date COOWF@1.1:actinststartdeadline local readonly
Started on/at (COOWF@1.1:actinststartedat)
date COOWF@1.1:actinststartedat local readonly
State of Activity (COOWF@1.1:actinststate)
ActivityInstanceState COOWF@1.1:actinststate not null
Last State Change by (COOWF@1.1:actinststatechangedby)
User COOWF@1.1:actinststatechangedby readonly
Activity Instance Statistic (COOWF@1.1:actinststatistic)
ActivityStatistic COOWF@1.1:actinststatistic readonly
Visible in Worklist From (COOWF@1.1:actinstsubmitdeadline)
date COOWF@1.1:actinstsubmitdeadline local readonly
Ready to Receive on/at (COOWF@1.1:actinstsubmittedat)
date COOWF@1.1:actinstsubmittedat local readonly
Substitutions (Groups) (COOWF@1.1:actinstsubstgroups)
unique Group[] COOWF@1.1:actinstsubstgroups readonly
As Substitute of (COOWF@1.1:actinstsubstuser)
User COOWF@1.1:actinstsubstuser readonly volatile
Substitutions (Users) (COOWF@1.1:actinstsubstusers)
unique User[] COOWF@1.1:actinstsubstusers readonly
Title (COOWF@1.1:actinsttitle)
actdeftitle
.unique LanguageStringList[] COOWF@1.1:actinsttitle
Work Items (COOWF@1.1:actinstwork)
WorkFlowWorkList[] COOWF@1.1:actinstwork readonly
Participant (COOWF@1.1:wfsparticipant)
WorkFlowParticipant COOWF@1.1:wfsparticipant readonly
Manual Entry by (COOWF@1.1:wfspartmansubst)
WorkFlowParticipant COOWF@1.1:wfspartmansubst readonly
COOWF@1.1:GetDefinitionElements
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
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
|
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
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
|
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
|
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
|
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
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
|