2024 April Release

Class COOWF@1.1:WaitActionInstance Permanent link for this heading

Objects of this class are used for an activity in a process instance that represents a wait action instead of a list of work items. This action can be a Action or an ActiveX script. It can be used to delay the workflow process e.g. until a certain state in an external resource is reached. Wait actions are always executed in the background, therefore this functionality requires the installation of an AT service.
E.g. you can use a wait action definition for asynchronous calls of an external application server. The first execution of the action starts as asynchronous query in the application server, the further calls wait for the query result. The wait action is called until the result of the application server is finished. The amount of time after which the execution of the action is repeated can be specified.
You can also use a wait action definition to execute activities that wait for the availability of certain external application server resources. A customer should be registered in a billing system. The workflow continues only when the registration in the billing system has been done. The wait action instance is just called again, if the registration failed (e.g. because the system is not available).

Class Hierarchy

Object > InstanceElement > WaitActionInstance

Properties Permanent link for this heading

Type

Property

Name

string

actinstcommonid

Identifier for Activities in Related Processes

date

actinstcompletedat

Completed on/at

date

actinstenddeadline

To Complete at the Latest by

date

actinstescalatedat

Escalated on/at

EscalationDefinition

actinstescalation

Escalation

ActivityInstanceState

actinstlaststate

Last State of Activity

MultiInstanceType

actinstmultiple

Multi-Instance

InstanceElement[]

actinstnext

Successor Activities

integer

actinstnrcall

Number of Calls

Object[]

actinstobject

Applies to

Object

actinstpartdefinition

Distribution List

WorkFlowParticipant

actinstparticipant

Workflow Participant

InstanceElement[]

actinstprev

Predecessor Activities

Object

actinstprocdefinition

Process Definition

date

actinstreceivedat

Received on/at

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

LanguageStringList[]

actinsttitle

Title

date

actinstwaitactionextcheckat

Next Condition Evaluation on/at

Actions Permanent link for this heading

Return Type

Signature

NotificationEntryList[]

GetNotificationSettings(
  out retval NotificationEntryList[] notificationentries)

object[]

GetParticipantUsers(
  out retval object[] users,
  optional boolean ignoregroupposition,
  optional boolean activeusersonly)

PushNotificationEntryList[]

GetPushNotificationSettings(
  out retval PushNotificationEntryList[] pushnotificationentries)

boolean

UserIsParticipant(
  out retval boolean isparticipant,
  optional object user,
  optional WorkFlowParticipant checkpart)

Properties Permanent link for this heading


Identifier for Activities in Related Processes (COOWF@1.1:actinstcommonid) Permanent link for this heading

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) Permanent link for this heading

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

date COOWF@1.1:actinstcompletedat local readonly


To Complete at the Latest by (COOWF@1.1:actinstenddeadline) Permanent link for this heading

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.

date COOWF@1.1:actinstenddeadline local readonly


Escalated on/at (COOWF@1.1:actinstescalatedat) Permanent link for this heading

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.

date COOWF@1.1:actinstescalatedat local readonly


Escalation (COOWF@1.1:actinstescalation) Permanent link for this heading

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.

EscalationDefinition COOWF@1.1:actinstescalation readonly

Additional Information


Last State of Activity (COOWF@1.1:actinstlaststate) Permanent link for this heading

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 (COOWF@1.1:actinstmultiple) Permanent link for this heading

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) Permanent link for this heading

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

unique InstanceElement[] COOWF@1.1:actinstnext readonly


Number of Calls (COOWF@1.1:actinstnrcall) Permanent link for this heading

Defines the number of calls of the wait action instance. It is incremented automatically every time the action or ActiveX script defined in the wait action instance is called.

unsigned integer COOWF@1.1:actinstnrcall readonly


Applies to (COOWF@1.1:actinstobject) Permanent link for this heading

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) Permanent link for this heading

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


Workflow Participant (COOWF@1.1:actinstparticipant) Permanent link for this heading

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.

WorkFlowParticipant COOWF@1.1:actinstparticipant not null readonly


Predecessor Activities (COOWF@1.1:actinstprev) Permanent link for this heading

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

unique InstanceElement[] COOWF@1.1:actinstprev readonly


Process Definition (COOWF@1.1:actinstprocdefinition) Permanent link for this heading

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) Permanent link for this heading

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.

date COOWF@1.1:actinstreceivedat local readonly


Signatures (COOWF@1.1:actinstsignatures) Permanent link for this heading

SignatureList[] COOWF@1.1:actinstsignatures readonly volatile


To Start at the Latest by (COOWF@1.1:actinststartdeadline) Permanent link for this heading

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.

date COOWF@1.1:actinststartdeadline local readonly


Started on/at (COOWF@1.1:actinststartedat) Permanent link for this heading

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

date COOWF@1.1:actinststartedat local readonly


State of Activity (COOWF@1.1:actinststate) Permanent link for this heading

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.

ActivityInstanceState COOWF@1.1:actinststate not null


Last State Change by (COOWF@1.1:actinststatechangedby) Permanent link for this heading

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) Permanent link for this heading

Defines the working statistic of the activity

ActivityStatistic COOWF@1.1:actinststatistic readonly


Title (COOWF@1.1:actinsttitle) Permanent link for this heading

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


Next Condition Evaluation on/at (COOWF@1.1:actinstwaitactionextcheckat) Permanent link for this heading

The time stamp when the next check for the condition of the wait action will be performed.

date COOWF@1.1:actinstwaitactionextcheckat local readonly volatile

Actions Permanent link for this heading


COOWF@1.1:GetNotificationSettings Permanent link for this heading

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 Permanent link for this heading

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 Permanent link for this heading

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:UserIsParticipant Permanent link for this heading

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