2022 April Release

Class COOWF@1.1:WorkList Permanent link for this heading

Class Hierarchy

Object > CompoundObject > WorkList

An object of this class defines the worklist of a user, which contains the activities that are assigned to the user and that he can complete ("To Do List"). New activity instances (with state Startable) are displayed in the worklist with a bold name. If the user completes an activity instance it is removed from the worklist.
The object list worklistitems contains all activity instances the user has to complete. The object list worklistmanitems contains all activity instances a user without a user environment has to complete and for which the user is reponsible to track start and completion. The object list worklistbackitems contains the activities and wait actions that are executed in the background for the user. The object list worklistsuspitems contains the list of suspended activities and of activities that are not yet ready to be submitted to the user.
If the completion of an activity instance is not started or completed in time an appropriate message is displayed when the user opens his worklist. Such activities are displayed in the worklist with italic name.
By default the worklist is checked for new activity instances automatically every 5 minutes. You can change this interval in the User Timer objects of the users.

Additional Information

Properties Permanent link for this heading

Type

Property

Name

InstanceElement[]

worklistbackitems

Background

WorkListCommonActivities[]

worklistcommonacts

Activities of Related Processes

WorkListCommonActWorkItems[]

worklistcommonworkitemsmapping

Key for Work Items of Activities Started Together

InstanceElement[]

worklistextitems

External Synchronization

InstanceElement[]

worklistitems

To Do

Object[]

worklistitemsobjects

Concerned Objects

InstanceElement[]

worklistlastitems

Last Finished

InstanceElement[]

worklistmanitems

Manual Entry Pending

WorkListQueryType

worklistquerytype

Worklist Query Type

WorkFlowStatisticsDashboard[]

workliststatistics

Process Statistics

WorkListStatProcesses[]

workliststatisticsrunningprocs

Process Statistics

InstanceElement[]

worklistsubst2items

Suspended/Pending as Substitute

ActivityInstance[]

worklistsubstakenover

Overtaken Activities

InstanceElement[]

worklistsubstitems

To Do as Substitute

InstanceElement[]

worklistsuspitems

Suspended/Pending

Object[]

worklisttracking

Tracking

Actions Permanent link for this heading

Return Type

Signature

void

AddRecentlyUsed(
  object context,
  optional object[] additionalobjects)

void

AttrObjNameGet(
  AttributeDefinition attrdef,
  ref any value,
  out optional boolean volatile,
  out optional boolean volatiletx)

void

AttrObjNameGetVersion(
  AttributeDefinition attrdef,
  integer versnr,
  ref any value,
  out optional boolean volatile,
  out optional boolean volatiletx)

void

AttrWorkListItemsGet(
  AttributeDefinition attrdef,
  ref any value,
  out optional boolean volatile,
  out optional boolean volatiletx)

void

AttrWorkListItemsSet(
  AttributeDefinition attrdef,
  ref optional any value,
  any oldvalue)

boolean

CanAddToRecentlyUsed(
  object context,
  out retval boolean canadd)

boolean

CheckAppLicense(
  optional boolean objdirect,
  optional string instance,
  optional boolean disableerrorapps,
  optional object context,
  optional boolean silentmode,
  out retval boolean haslicense)

void

DefineWFSubstitutes(
  optional integer unused1,
  optional integer unused2)

boolean

DoShowWorkListItem(
  object attrdef,
  out retval boolean show)

void

GetEnterObjectStatus(
  out boolean venv_closeenterobject,
  object venv_parent,
  object venv_object,
  object venv_view,
  out boolean venv_navigatetonext)

ActivityInstance[]

GetLongTermSuspendedActivities(
  out retval ActivityInstance[] activities)

void

GetMenuEditPasteShare(
  optional integer unused1,
  optional integer unused2,
  ref MenuStructList[] menuentries,
  optional object menu,
  optional object[] selobjects,
  out optional boolean addchildren)

object

GetPreferredList(
  out retval object preferredlist,
  out boolean ignoredashboardinbreadcrumb)

integer

GetWorkListItemCountFromTx(
  object attrdef,
  out retval integer itemcount)

object[]

GetWorkListItemsFlat(
  object attrdef,
  out retval object[] worklistitems)

boolean

IsProcessAdministrator(
  out retval boolean isprocadmin,
  optional Group targetgroup)

boolean

IsProcessOwner(
  out retval boolean isprocessowner,
  optional Group targetgroup)

boolean

IsTeamRoomChild(
  out retval boolean isvalidchild)

void

ObjectRefresh(
  optional AttributeDefinition[] attrdefs,
  optional boolean broadcast)

void

OpenStatisticsDashboard(
  optional integer unused1,
  optional integer unused2)

void

RefreshWorkList()

void

RenameObject(
  optional integer unused1,
  optional integer unused2,
  ref string name,
  boolean clear,
  string caption)

void

ShowLongTermSuspended(
  optional integer unused1,
  optional integer unused2)