Struct COOWF@1.1:WorkFlowPrescriptionList

This struct is used to store informations about the prescriptions of an object or activity instance.

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
boolean	actdefignorecomplete	Ignore Completion
boolean	actdefignoreinvpart	Skip Invalid Participant
boolean	actdefkeepstarted	Started Activity Remains in All Worklists
boolean	actdefnopersonalsubst	Disable Personal Substitution
boolean	actdefnosubst	Disable Substitution
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
date	actinstenddeadline	To Complete at the Latest by
DeadlineDateDefinition	actinstescalationenddate	To Complete at the Latest by
string[]	actinstescalationenddateexpression	Expression for Computing the Latest Completion
DeadlineDateDefinition	actinstescalationstartdate	To Start at the Latest by
string[]	actinstescalationstartdateexpression	Expression for Computing the Latest Start
DeadlineDateDefinition	actinstescalationsubmitdate	Visible in Worklist From
string[]	actinstescalationsubmitdateexpression	Expression for Computing the Visibility in the Worklist
date	actinststartdeadline	To Start at the Latest by
date	actinstsubmitdeadline	Visible in Worklist From
TypeOfDeadline	actinsttypeofdeadline	Enter Deadline as
ActivityDefinition	wfsactdefback	Activity Back
ActivityDefinition	wfsactdefprescr	Activity
EscalationDefinition	wfsescalation	Escalation
Group	wfsgroup	Group
string	wfsinstcommonid	Identifier for Activities in Related Processes
MultiInstanceType	wfsmultiple	Multi-Instance
Object	wfspartdefinition	Distribution List
WorkFlowParticipant	wfsparticipant	Participant
WorkFlowParticipant	wfspartmansubst	Manual Entry by
string	wfsremark	Hint
WorkFlowSubPrescriptionBlockList[]	wfssubprescrblocks	Nested Prescription Blocks
LanguageStringList[]	wfstitle	Name
User	wfsuser	User

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

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

Disable Personal Substitution (COOWF@1.1:actdefnopersonalsubst)

This property defines if personal substitution is allowed during execution of the activity instance.

boolean COOWF@1.1:actdefnopersonalsubst

Disable Substitution (COOWF@1.1:actdefnosubst)

This property defines if the activity instance can be executed as substitute of the assigned participant.

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

boolean COOWF@1.1:actdefnosubst

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

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 Complete at the Latest by (COOWF@1.1:actinstescalationenddate)

Defines the end date deadline as a time span with a base date and an operator.

Explanation:
Defines by when the activity should be completed at the latest. If a holiday table is defined, the days are working days.

DeadlineDateDefinition COOWF@1.1:actinstescalationenddate

Expression for Computing the Latest Completion (COOWF@1.1:actinstescalationenddateexpression)

Defines the end date deadline as an expression

string[] COOWF@1.1:actinstescalationenddateexpression (
  optional object object,
  optional ProcessInstance process,
  optional ActivityInstance activity,
  optional datetime basedate)

Local Scope: dictionary

Name	Description
object	the object of the process
process	the process instance
activity	the current activity instance
basedate	the basedate for deadline calculation retrieved form property `actdefdeadlinebase` of the activity definition

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

Defines the start date deadline as a time span with a base date and an operator.

Explanation:
Defines by when the activity should be started at the latest. If a holiday table is defined, the days are working days.

DeadlineDateDefinition COOWF@1.1:actinstescalationstartdate

Expression for Computing the Latest Start (COOWF@1.1:actinstescalationstartdateexpression)

Defines the start date deadline as an expression

string[] COOWF@1.1:actinstescalationstartdateexpression (
  optional object object,
  optional ProcessInstance process,
  optional ActivityInstance activity,
  optional datetime basedate)

Local Scope: dictionary

Name	Description
object	the object of the process
process	the process instance
activity	the current activity instance
basedate	the basedate for deadline calculation retrieved form property `actdefdeadlinebase` of the activity definition

Visible in Worklist From (COOWF@1.1:actinstescalationsubmitdate)

Defines the submit date deadline as a time span with a base date and an operator.

Explanation:
Defines by when the activity should be visible in the worklist. If a holiday table is defined, the days are working days.

DeadlineDateDefinition COOWF@1.1:actinstescalationsubmitdate

Expression for Computing the Visibility in the Worklist (COOWF@1.1:actinstescalationsubmitdateexpression)

Defines the submit date deadline as an expression

string[] COOWF@1.1:actinstescalationsubmitdateexpression (
  optional object object,
  optional ProcessInstance process,
  optional ActivityInstance activity,
  optional datetime basedate)

Local Scope: dictionary

Name	Description
object	the object of the process
process	the process instance
activity	the current activity instance
basedate	the basedate for deadline calculation retrieved form property `actdefdeadlinebase` of the activity definition

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

Enter Deadline as (COOWF@1.1:actinsttypeofdeadline)

This property is used to store which type of deadline was used to calculate the escalation dates

TypeOfDeadline COOWF@1.1:actinsttypeofdeadline not null

Activity Back (COOWF@1.1:wfsactdefback)

This property is used to store in a prescription entry the activity definition, that is used to generate an activity instance back to the current user after the prescribed activity. In contrast to actdefprescrback this is an individual activity back for every single prescribed activity, not a common activity back to the current user for all prescribed activities. If not defined, no activity back to the current user is created.

Explanation:
In this field an Activity Instance can be selected which must be executed once the prescribed activity has been completed.

ActivityDefinition COOWF@1.1:wfsactdefback invisible

Activity (COOWF@1.1:wfsactdefprescr)

Defines the prescribed activity definition, that is used to create an activity instance, when the prescription is executed.

Explanation:
This field contains the Activity Instance, the subfile has been prescribed with.

ActivityDefinition COOWF@1.1:wfsactdefprescr not null readonly

Escalation (COOWF@1.1:wfsescalation)

Defines the escalation definition that is to be used for activity. If set this property overrides the inheritance of the activity definition.

EscalationDefinition COOWF@1.1:wfsescalation

Group (COOWF@1.1:wfsgroup)

This property defines the group the prescribed activity is assigned to. This property duplicates the group in property wfsparticipant for the purpose of easier editing by the user.

Group COOWF@1.1:wfsgroup readonly

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

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

string COOWF@1.1:wfsinstcommonid readonly invisible

Multi-Instance (COOWF@1.1:wfsmultiple)

This property stores if the line represents a single activity or if the line should be resolved to a multiple instance activity.

Explanation:
The "No Multi-Instance" entry is intended for the case that the activity should be processed by one single participant. Multi-instance activities, on the other hand, can be used for processing an activity sequentially or in parallel by several participants.

MultiInstanceType COOWF@1.1:wfsmultiple not null readonly

Distribution List (COOWF@1.1:wfspartdefinition)

This property defines the distribution list the prescribe activity is assigned to. The distribution list will be resolve when the prescription is completed and each participant will receive an own instance of the prescribed activity definition.

Explanation:
In this field a Distribution List can be selected, whose user receives the prescribed activity.

Object COOWF@1.1:wfspartdefinition readonly

Additional Information

Object Classes Allowed: WorkGroup, ParticipantDefinition, ParticipantInstance

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

Hint (COOWF@1.1:wfsremark)

Defines the remark to a prescription.

Explanation:
In this field remarks and notes can be typed.

string COOWF@1.1:wfsremark readonly

Nested Prescription Blocks (COOWF@1.1:wfssubprescrblocks)

The nested prescription blocks of the current prescription are stored in this property

WorkFlowSubPrescriptionBlockList[] COOWF@1.1:wfssubprescrblocks

Name (COOWF@1.1:wfstitle)

Defines the title of the activity instance which is insterted in a prescription. If set this property override the initialization from the activity definition.

Explanation:
In this field a title for the prescribed activity can be typed.

unique LanguageStringList[] COOWF@1.1:wfstitle readonly

User (COOWF@1.1:wfsuser)

This property defines the user the prescribed activity is assigned to. This property duplicates the user in property wfsparticipant for the purpose of easier editing by the user.

User COOWF@1.1:wfsuser readonly