2022 June Release

Class COOWF@1.1:InstanceElement Permanent link for this heading

Class Hierarchy

Object > InstanceElement

This object class is used as abstract base class for elements in a process instance.

Properties Permanent link for this heading

Type

Property

Name

string

actinstadhockey

Ad Hoc Process Key

DefinitionElement

actinstdefinition

Activity Definition

User

actinstinsertedadhocby

Ad Hoc Process Inserted by

Object

actinstparent

Container Element

ProcessInstance

actinstprocinst

Process

JoinType

instjointype

Join of Predecessor Activities

Actions Permanent link for this heading

Return Type

Signature

integer

GetInstanceElementColor(
  out retval integer colorcode)

InstanceElement[]

GetNextActivityInstances(
  optional boolean skipconditions,
  optional boolean includecontrolelements,
  out retval InstanceElement[] nextactinst)

boolean

HasValidParticipant(
  optional boolean checkactivesubstitution,
  optional boolean checkaccess,
  out retval boolean hasvalidpart,
  out optional string invalidpartreason)

boolean

IsActivityCompleted(
  out retval boolean iscompleted)

boolean

IsInstanceElementEvaluated(
  out retval boolean isevaluated,
  optional boolean allowstartable)

ProcessInstance

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)

Properties Permanent link for this heading


Ad Hoc Process Key (COOWF@1.1:actinstadhockey) Permanent link for this heading

This property stores an identifier to mark instance element which were inserted into the process. All elements which were inserted with one operation have the same key.

string COOWF@1.1:actinstadhockey readonly


Activity Definition (COOWF@1.1:actinstdefinition) Permanent link for this heading

Defines the definition element the instance element was created from. This property is set automatically and cannot be changed afterwards.

DefinitionElement COOWF@1.1:actinstdefinition readonly


Ad Hoc Process Inserted by (COOWF@1.1:actinstinsertedadhocby) Permanent link for this heading

Defines the user who inserted the instance element.

User COOWF@1.1:actinstinsertedadhocby readonly


Container Element (COOWF@1.1:actinstparent) Permanent link for this heading

Defines the parent of the instance element. If the instance element is contained in a sub process the sub process will be stored. Otherwhise the process instance will be stored.

Object COOWF@1.1:actinstparent readonly invisible

Additional Information


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

Defines the process instance the instance element is a part of. This property has to be set, when an instance element is added to a process instance.

ProcessInstance COOWF@1.1:actinstprocinst not null readonly


Join of Predecessor Activities (COOWF@1.1:instjointype) Permanent link for this heading

This property defines if all previous activites must be completed before the current activity gets startable.

JoinType COOWF@1.1:instjointype readonly

Actions Permanent link for this heading


COOWF@1.1:GetInstanceElementColor Permanent link for this heading

Retrieve the color used to display the object in the process editor

integer COOWF@1.1:GetInstanceElementColor(
  out retval integer colorcode)

Name

Description

colorcode

the color code

COOWF@1.1:GetNextActivityInstances Permanent link for this heading

Retrieve the following activity instances of an instance element.
By default control elements like condition, case and repeat elements are not included in the result.
Only the following activities of all paths of the control elements are included.

Subprocesses:
If the follower of the current instance element is a subprocess. The subprocess is not expanded and the subprocess instance is included in the result.

Gateways: To get the following activity instance of a specific gateway path the transaction variable WFVAR_GATEWAY_PATHREFERENCE is used to identify the requested gateway path by the reference and returns the activity instances of this path.
During evaluation of the gateway conditions the transaction variable WFVAR_GATEWAY_PATHREFERENCE is automatically set to the reference of the gateway path which is currently evaluated. Additionally the reference of the gateway path is included in the local scope of the condition expression of the gateway.
Note.: If a gateway path does not contain any activity instance the activity instance following the end of the gateway is returned.

InstanceElement[] COOWF@1.1:GetNextActivityInstances(
  optional boolean skipconditions,
  optional boolean includecontrolelements,
  out retval InstanceElement[] nextactinst)

Name

Description

skipconditions

if defined the conditions of gateways are not evaluated and all following activities are returned

includecontrolelements

if defined the search for the next activity instance is stopped at a control element and the control element is part of the result

nextactinst

the following activity instances

COOWF@1.1:HasValidParticipant Permanent link for this heading

Check if the participant of the activity instance is valid.

boolean COOWF@1.1:HasValidParticipant(
  optional boolean checkactivesubstitution,
  optional boolean checkaccess,
  out retval boolean hasvalidpart,
  out optional string invalidpartreason)

Name

Description

checkactivesubstitution

if set the participant is checked for active substitutions. The participant will be marked as invalid if the is a substitution defined

checkaccess

if defined the participant is checked for read access on the object of the process

hasvalidpart

the result

invalidpartreason

a description if the participant is not valid

COOWF@1.1:IsActivityCompleted Permanent link for this heading

Check if an activity instance was already completed

boolean COOWF@1.1:IsActivityCompleted(
  out retval boolean iscompleted)

Name

Description

iscompleted

the result

COOWF@1.1:IsInstanceElementEvaluated Permanent link for this heading

Checks if a specific instance element is already evaluated by the workflow engine. This means the condition of a control element was already evaluated or an activity is no is no longer pending.

boolean COOWF@1.1:IsInstanceElementEvaluated(
  out retval boolean isevaluated,
  optional boolean allowstartable)

Name

Description

isevaluated

allowstartable

if set startable activities are not treated as evaluted

COOWF@1.1:PrescribeObject Permanent link for this heading

Adds following activities to the process of the current activity. If this action is called on an object, a new process is started.

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