Object Class Process Instance Element (COOWF@1.1:InstanceElement)

Object Class Hierarchy

COOSYSTEM@1.1:Object > COOWF@1.1:InstanceElement

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

Additional Information

Default Background Menu: COODESK@1.1:MenuRootWinContext
Compound: false
Action for Moving Objects: COODESK@1.1:DragIntoMove
Default Context Menu (Container Independent): COOWF@1.1:MenuRootDirectContext
Abstract: true
ACL Object: COOSYSTEM@1.1:DefaultGlobalACL
Default ACL for New Objects: COOWF@1.1:DefaultInstanceACL
Symbol: COODESK@1.1:SymbolActivity
Default Context Menu: COODESK@1.1:MenuRootContext
Base Class: COOSYSTEM@1.1:Object
Action for Linking Objects: COODESK@1.1:DragIntoLink
Action for Copying Objects: COODESK@1.1:DragIntoCopy
Display Mode: DISP_LINES
Default Main Menu: COODESK@1.1:MenuRootFolder

Properties

ReferenceName
COOWF@1.1:actinstadhockeyAd Hoc Process Key
COOWF@1.1:actinstdefinitionActivity Definition
COOWF@1.1:actinstinsertedadhocbyAd Hoc Process Inserted by
COOWF@1.1:actinstparentContainer Element
COOWF@1.1:actinstprocinstProcess
COOWF@1.1:instelemdescriptionProcess Element Description
COOWF@1.1:instjoinexprExpression for Join of Predecessor Activities
COOWF@1.1:instjointypeJoin of Predecessor Activities
COOWF@1.1:instrequiresecuredexpressionsRequire Secured Expression Evaluation for

Actions

ReferenceName
COOATTREDIT@1.1:CheckAppLicense
COODESK@1.1:CopyObject
COOSYSTEM@1.1:AttrObjNameGet
COOSYSTEM@1.1:AttrObjNameGetVersion
COOSYSTEM@1.1:AttrObjNameSet
COOSYSTEM@1.1:ObjectArchive
COOSYSTEM@1.1:ObjectArchiveVersion
COOSYSTEM@1.1:ObjectDelete
COOSYSTEM@1.1:ObjectLoadFromArchive
COOSYSTEM@1.1:ObjectLoadVersionFromArchive
COOSYSTEM@1.1:ObjectPrepareCommit
COOSYSTEM@1.1:ObjectRestoreFromArchive
COOTC@1.1001:AttrObjIsTemplateCtor
COOWASTEBASKET@1.1:GetDeleteAction
COOWF@1.1:AttrInstDefinitionCopy
COOWF@1.1:AttrInstElemDescriptionGet
COOWF@1.1:AttrInstElemSet
COOWF@1.1:CallSendNotifications
COOWF@1.1:CheckDestination
COOWF@1.1:CheckForm
COOWF@1.1:EditObjectAttributesDirect
COOWF@1.1:EditProcessObjectAttributes
COOWF@1.1:GetSecurityAttributes
COOWF@1.1:InsertInstanceElement
COOWF@1.1:InsertInstanceElements
COOWF@1.1:InsertParallelElement
COOWF@1.1:InsertParallelSubProcess
COOWF@1.1:InsertSubProcess
COOWF@1.1:ModifyPage
COOWF@1.1:ReadObjectAttributesDirect
COOWF@1.1:ReadProcessObjectAttributes
COOWF@1.1:RemoveInstanceElement
COOWF@1.1:SetStartable
FSCSCHEDULE@1.1001:GetSuspDeadlineSecContext
FSCSCHEDULE@1.1001:GetSuspDeadlinesContainerLocations
FSCSCHEDULE@1.1001:IsDeadlineContextActive
FSCTEAMROOM@1.1001:ApplyTeamRoom
FSCTEAMROOM@1.1001:AttrObjTeamRoomCopy
FSCVENV@1.1001:IsEditable

Properties

COOWF@1.1:actinstadhockey (Ad Hoc Process Key)

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

Additional Information

Changeable in Installed Component: true
Action Called Before Property Is Saved: COOWF@1.1:AttrInstElemSet
Changeable in User Interface: false
ACL Object: COOSYSTEM@1.1:DefaultDeveloperACL
Type: COOSYSTEM@1.1:STRING
Maximum Length: 254
Changeable: true
Action to Copy Property From Object: COOSYSTEM@1.1:NoOperation
Must Be Defined: false
Visible: true


[top]

COOWF@1.1:actinstdefinition (Activity Definition)

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

Additional Information

Changeable in Installed Component: true
Action Called Before Property Is Saved: COOWF@1.1:AttrInstElemSet
Changeable in User Interface: false
ACL Object: COOSYSTEM@1.1:DefaultDeveloperACL
Type: COOSYSTEM@1.1:OBJECT
Secured: true
Possible Object Class: COOWF@1.1:DefinitionElement
Search for Allowed Classes Only: true
Changeable: true
Must Be Defined: false
Visible: true


[top]

COOWF@1.1:actinstinsertedadhocby (Ad Hoc Process Inserted by)

This property stores the user who inserted the instance element.

Additional Information

Changeable in Installed Component: true
Action Called Before Property Is Saved: COOWF@1.1:AttrInstElemSet
Changeable in User Interface: false
ACL Object: COOSYSTEM@1.1:DefaultDeveloperACL
Type: COOSYSTEM@1.1:OBJECT
Possible Object Class: COOSYSTEM@1.1:User
Search for Allowed Classes Only: true
Changeable: true
Action to Copy Property From Object: COOSYSTEM@1.1:NoOperation
Must Be Defined: false
Visible: true


[top]

COOWF@1.1:actinstparent (Container Element)

This property stores 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.

Additional Information

Changeable in Installed Component: true
Action Called Before Property Is Saved: COOWF@1.1:AttrInstElemSet
ACL Object: COOSYSTEM@1.1:DefaultDeveloperACL
Type: COOSYSTEM@1.1:OBJECT
Possible Object Class: COOSYSTEM@1.1:Object
Search for Allowed Classes Only: true
Changeable: true
Action to Copy Property From Object: COOSYSTEM@1.1:NoOperation
Must Be Defined: false
Automatically Follow Object Pointer: true
Visible: false


[top]

COOWF@1.1:actinstprocinst (Process)

This property stores 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.

Additional Information

Changeable in Installed Component: true
Action Called Before Property Is Saved: COOWF@1.1:AttrInstElemSet
ACL Object: COOSYSTEM@1.1:DefaultDeveloperACL
Type: COOSYSTEM@1.1:OBJECT
Possible Object Class: COOWF@1.1:ProcessInstance
Search for Allowed Classes Only: true
Changeable: true
Action to Copy Property From Object: COOSYSTEM@1.1:NoOperation
Must Be Defined: true
Automatically Follow Object Pointer: true
Visible: true


[top]

COOWF@1.1:instelemdescription (Process Element Description)

Additional Information

Changeable in Installed Component: true
Changeable in User Interface: false
Volatile (Transaction): true
ACL Object: COOSYSTEM@1.1:DefaultDeveloperACL
Type: COOSYSTEM@1.1:STRING
Volatile: true
Action Called After Property Is Read: COOWF@1.1:AttrInstElemDescriptionGet
Maximum Length: 254
Changeable: true
Must Be Defined: false
Visible: true


[top]

COOWF@1.1:instjoinexpr (Expression for Join of Predecessor Activities)

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

Additional Information

Multiple Values (Overrides Type): false
Changeable in Installed Component: true
Action to Get Display String of Property: COODESK@1.1:AttrExpressionGetDisp
ACL Object: COOSYSTEM@1.1:DefaultDeveloperACL
Type: COOSYSTEM@1.1:STRINGLIST
Parameter Passing: PARSCOPE_LOCALSCOPE
Result Type: COOWF@1.1:JoinType
Maximum Length: 254
Changeable: true
Must Be Defined: false
Visible: true


[top]

COOWF@1.1:instjointype (Join of Predecessor Activities)

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

Additional Information

Type: COOWF@1.1:JoinType
Changeable: true
Visible: true
Must Be Defined: false
ACL Object: COOSYSTEM@1.1:DefaultDeveloperACL
Action Called Before Property Is Saved: COOWF@1.1:AttrInstElemSet
Changeable in Installed Component: true


[top]

COOWF@1.1:instrequiresecuredexpressions (Require Secured Expression Evaluation for)

This property defines the expressions attributes which have to be executed in secured mode because they were entered by a user

Additional Information

Changeable in Installed Component: true
Action Called Before Property Is Saved: COOWF@1.1:AttrInstElemSet
Changeable in User Interface: false
Multiple Values (Overrides Type): true
ACL Object: COOSYSTEM@1.1:DefaultDeveloperACL
Type: COOSYSTEM@1.1:OBJECTLISTUNIQ
Possible Object Class: COOSYSTEM@1.1:AttributeDefinition
Search for Allowed Classes Only: true
Changeable: true
Must Be Defined: false
Visible: false


[top]

Actions

COOATTREDIT@1.1:CheckAppLicense

Checks the license of an app. If there is one or more apps defined in the property COOATTREDIT@1.1:classapps of the object class of the object, check if any of these apps is licensed currently.
Thrown errors include
COOATTREDIT@1.1:object_app_license_expired
COOATTREDIT@1.1:object_not_licensed.
ParameterTypeIn/OutOptionalDescription
objdirectCOOSYSTEM@1.1:BOOLEANintrue
instanceCOOSYSTEM@1.1:STRINGintrue Instance to be checked.
disableerrorappsCOOSYSTEM@1.1:BOOLEANintrue Just raise an error, do not set error application.
contextCOOSYSTEM@1.1:OBJECTintrue the current context for the license evaluation. E.g an object of the teamroom to evaluate the correct organization
silentmodeCOOSYSTEM@1.1:BOOLEANintrue if set no errors will be raised
haslicenseCOOSYSTEM@1.1:BOOLEANoutfalse additional to possible errors the result of the license check will be returned in this parameter

Additional Information

Must Be Executed: true
ACL Object: COOSYSTEM@1.1:DefaultDeveloperACL


[top]

COODESK@1.1:CopyObject

Creates a copy of the object and adds it to the object list in the specified relation of the target object.
ParameterTypeIn/OutOptionalDescription
unused1COOSYSTEM@1.1:INTEGERintrue
unused2COOSYSTEM@1.1:INTEGERintrue
viewCOOSYSTEM@1.1:OBJECTinfalse The relation to which the new created object is added.
targetCOOSYSTEM@1.1:OBJECTinfalse The destination object for the created object.
newobjectCOOSYSTEM@1.1:OBJECToutfalse The new created object.
coostoreCOOSYSTEM@1.1:OBJECTin/outtrue The COO Store where the new object should be stored. It returns the COO Store where the object was created.
donotshareCOOSYSTEM@1.1:BOOLEANintrue

Additional Information

Access Types: COOSYSTEM@1.1:AccTypeCopy
ACL Object: COOSYSTEM@1.1:DefaultDeveloperACL


[top]

COOSYSTEM@1.1:AttrObjNameGet

Get action for the property COOSYSTEM@1.1:objname.

Additional Information

Prototype: COOSYSTEM@1.1:AttrGetPrototype
ACL Object: COOSYSTEM@1.1:DefaultDeveloperACL


[top]

COOSYSTEM@1.1:AttrObjNameGetVersion

Get version action for the property COOSYSTEM@1.1:objname.

Additional Information

Prototype: COOSYSTEM@1.1:AttrGetVersionPrototype
ACL Object: COOSYSTEM@1.1:DefaultDeveloperACL


[top]

COOSYSTEM@1.1:AttrObjNameSet

Set action for the property COOSYSTEM@1.1:objname.

Additional Information

Prototype: COOSYSTEM@1.1:AttrSetPrototype
ACL Object: COOSYSTEM@1.1:DefaultDeveloperACL


[top]

COOSYSTEM@1.1:ObjectArchive

Archives the object. The parameter complete determines whether the complete object is archived or only the content properties of the object are archived. If the complete object is archived, all properties are stored in the archive and most properties are deleted from the Fabasoft Components database. Only a few properties are kept, such that the object can be displayed on the desk with the most important properties. Also all object versions, that are not yet archived, are archived completely, if the complete object is archived. The actions for archiving properties assigned to the object properties in property COOSYSTEM@1.1:attractarch are called with the value of the flag complete as parameter.
ParameterTypeIn/OutOptionalDescription
archstCOOSYSTEM@1.1:OBJECTin/outfalse The archive store, where the object is archived. If the parameter is empty, the archive store, where the object has to be stored, is selected depending on the configured archive stores in the objects MMC Store and returned as output parameter.
completeCOOSYSTEM@1.1:BOOLEANinfalse true means that the complete object is archived.
converttofinalformCOOSYSTEM@1.1:BOOLEANintrue
finalformatCOOSYSTEM@1.1:STRINGintrue
archiveversionsCOOSYSTEM@1.1:BOOLEANintrue
retentiondateCOOSYSTEM@1.1:DATETIMEintrue

Additional Information

Access Types: COOSYSTEM@1.1:AccTypeArchive
ACL Object: COOSYSTEM@1.1:DefaultDeveloperACL


[top]

COOSYSTEM@1.1:ObjectArchiveVersion

Archives a version of the object. The current object must be a version object in this action. Object versions can only be archived completely, it is not possible to archive only the contents of a version. All properties of the version are stored in the archive. The properties and contents of the version are removed completely from the Fabasoft Components database and MMC data area. The actions for archiving properties assigned to the object properties in property COOSYSTEM@1.1:attractarch are called on the version of the object with the parameter complete set to true.
ParameterTypeIn/OutOptionalDescription
archstCOOSYSTEM@1.1:OBJECTin/outfalse The archive store, where the object is archived. If the parameter is empty, the archive store, where the object has to be stored, is selected depending on the configured archive stores in the objects MMC Store and returned as output parameter.
remainsCOOSYSTEM@1.1:BOOLEANintrue
retentiondateCOOSYSTEM@1.1:DATETIMEintrue

Additional Information

Access Types: COOSYSTEM@1.1:AccTypeArchive
ACL Object: COOSYSTEM@1.1:DefaultDeveloperACL


[top]

COOSYSTEM@1.1:ObjectDelete

This action is called on an object to destroy it completely.

Additional Information

Access Types: COOSYSTEM@1.1:AccTypeDelete
ACL Object: COOSYSTEM@1.1:DefaultDeveloperACL
Action to Get Audit Value: COOSYSTEM@1.1:GetObjectDeleteAuditValue


[top]

COOSYSTEM@1.1:ObjectLoadFromArchive

Loads the properties of the object from the archive to the kernel cache. The current object must be a completely archived object in this action. The properties that are loaded from the archive exist only in the kernel cache until the kernel unloads them from the cache, or until COOSYSTEM@1.1:ObjectRefresh with the parameter set to true is called. It is not necessary to load objects, that have only archived contents. Archived contents are loaded automatically, when the content is needed. The actions for restoring archived properties assigned to the object properties in property COOSYSTEM@1.1:attractrestarch are called with parameter persistent set to false.

Additional Information

Access Types: COOSYSTEM@1.1:AccTypeRead
ACL Object: COOSYSTEM@1.1:DefaultDeveloperACL


[top]

COOSYSTEM@1.1:ObjectLoadVersionFromArchive

Loads the properties of a version of the object from the archive to the kernel cache. The desired version of the object must be completely archived. If the current version of the object is also completely archived, it must be loaded, before a version of that object can be loaded. The properties that are loaded from the archive exist only in the kernel cache until the kernel unloads them from the cache, or until COOSYSTEM@1.1:ObjectRefresh with the parameter set to true is called on the current version of the object. It is not necessary to load object versions, that have only archived contents. Archived contents for versions are loaded automatically, when the content is needed.
ParameterTypeIn/OutOptionalDescription
versdateCOOSYSTEM@1.1:DATETIMEinfalse The date of the version of the object, for which the properties should be loaded.
objectCOOSYSTEM@1.1:OBJECToutfalse The loaded version object.

Additional Information

Access Types: COOSYSTEM@1.1:AccTypeRead
ACL Object: COOSYSTEM@1.1:DefaultDeveloperACL


[top]

COOSYSTEM@1.1:ObjectPrepareCommit

When an object is changed in a transaction, this action is called by the kernel before the commit is actually done. This action is intended to be overwritten to do some additional work or to override the default behaviour before the transaction starts committing.
ParameterTypeIn/OutOptionalDescription
internalchangeCOOSYSTEM@1.1:BOOLEANinfalse

Additional Information

ACL Object: COOSYSTEM@1.1:DefaultDeveloperACL


[top]

COOSYSTEM@1.1:ObjectRestoreFromArchive

Loads the properties of the object from the archive and stores them in the Fabasoft Components database and MMC data areas again. If the current object is not completely archived, only the contents are restored to the MMC data areas. If the current object is completely archived, also the properties in the Fabasoft Components database are restored. If the current object is an archived version of an object, the properties and contents of that object at that point of time are restored. In any case the current version of the object is saved, and the properties and contents are restored in a new version of the object. The actions for restoring archived properties assigned to the object properties in property COOSYSTEM@1.1:attractrestarch are called with parameter persistent set to true.

Additional Information

Access Types: COOSYSTEM@1.1:AccTypeArchive
ACL Object: COOSYSTEM@1.1:DefaultDeveloperACL


[top]

COOTC@1.1001:AttrObjIsTemplateCtor

Initialize property "Is Template"

Additional Information

Prototype: COOSYSTEM@1.1:AttrConstructorPrototype
ACL Object: COOSYSTEM@1.1:DefaultDeveloperACL


[top]

COOWASTEBASKET@1.1:GetDeleteAction

This action is called to calculate which action or application should be called when an object is deleted
ParameterTypeIn/OutOptionalDescription
_containerCOOSYSTEM@1.1:OBJECTinfalse the container from which the objects should be removed
selobjectsCOOSYSTEM@1.1:OBJECTLISTinfalse the objects to be deleted/moved to waste basket
lastresultCOOSYSTEM@1.1:INTEGERinfalse the last result
captionCOOSYSTEM@1.1:STRINGoutfalse the caption for the confirm dialog
questionCOOSYSTEM@1.1:STRINGoutfalse the question on the confirm dialog
enhancedCOOSYSTEM@1.1:BOOLEANoutfalse unused
delactionCOOSYSTEM@1.1:OBJECTin/outfalse
shiftkeypressedCOOSYSTEM@1.1:BOOLEANintrue unused
deltargetCOOSYSTEM@1.1:OBJECTin/outfalse the target object on which the delete usecase (action or application) should be called
delapplicationCOOSYSTEM@1.1:OBJECTin/outfalse the application to call for object deletion

Additional Information

ACL Object: COOSYSTEM@1.1:DefaultDeveloperACL


[top]

COOWF@1.1:AttrInstDefinitionCopy

This action is used as property copy action for multiple properties of process instance objects. It is called by the kernel, when objects with these properties are copied. It is used, when properties of process instances have to be modified, when they are copied, because they contain information that is relevant only, when a process is executed.

Additional Information

Prototype: COOSYSTEM@1.1:AttrCopyPrototype
ACL Object: COOSYSTEM@1.1:DefaultDeveloperACL


[top]

COOWF@1.1:AttrInstElemDescriptionGet

Get a description for instance elements

Additional Information

Prototype: COOSYSTEM@1.1:AttrGetPrototype
ACL Object: COOSYSTEM@1.1:DefaultDeveloperACL
Private: true


[top]

COOWF@1.1:AttrInstElemSet

This action is used for must properties of the classes derived from COOWF@1.1:InstanceElement, except COOWF@1.1:ActivityInstance and COOWF@1.1:WaitActionInstance. It is called by the kernel before these properties are saved. Most properties of instance elements, that are already executed, must not be changed any more, and during the execution of a process only certain changes of values are valid. This action is used to check these conditions.

Additional Information

Prototype: COOSYSTEM@1.1:AttrSetPrototype
ACL Object: COOSYSTEM@1.1:DefaultDeveloperACL


[top]

COOWF@1.1:CallSendNotifications

Action to send notifications to users about new received activities or expired submissions
ParameterTypeIn/OutOptionalDescription
paramsCOOSYSTEM@1.1:STRINGinfalse the parameters for the notifications
  • newstate the new state of the activity instance
  • oldstate the old state of the activity instance
  • submitdeadline the submission date
isdeadlineCOOSYSTEM@1.1:BOOLEANintrue

Additional Information

ACL Object: COOSYSTEM@1.1:DefaultDeveloperACL
Private: true


[top]

COOWF@1.1:CheckDestination

This action is called on an activity instance, when it is about to get startable, to check, if the workflow participant described in the activity is available, and to check, if background execution is enabled, when it is a background activity. The action is expected to return an appropriate error, if there is a problem with the participant.
ParameterTypeIn/OutOptionalDescription
ignoremetaparticipantCOOSYSTEM@1.1:BOOLEANintrue meta participants will not raise an error when domainenforcepartcheck is set
strictCOOSYSTEM@1.1:BOOLEANintrue is used to override the setting actinstignoreinvpart of the activity
resolvemetaparticipantCOOSYSTEM@1.1:BOOLEANintrue the metaparticipant is resolved before the checks are performed

Additional Information

ACL Object: COOSYSTEM@1.1:DefaultDeveloperACL


[top]

COOWF@1.1:CheckForm

This action is used to check the user input when modifying definitions and instances of processes and activities, if it is valid and complete. It is called by the property editor, after the input is saved and before the form is closed and the input is committed, to verify the user input. It is expected to return an appropriate error, if problems are found.
ParameterTypeIn/OutOptionalDescription
actionCOOSYSTEM@1.1:OBJECTinfalse
attrdefCOOSYSTEM@1.1:OBJECTouttrue
askquestionCOOSYSTEM@1.1:STRINGouttrue
invaffiliatonpartsCOOWF@1.1:WorkFlowParticipantoutfalse
needplaintexterrorsCOOSYSTEM@1.1:BOOLEANintrue

Additional Information

Prototype: COOATTREDIT@1.1:AttrCheckPrototype
ACL Object: COOSYSTEM@1.1:DefaultDeveloperACL


[top]

COOWF@1.1:EditObjectAttributesDirect

Action to edit direct the properties of an object
ParameterTypeIn/OutOptionalDescription
handleCOOSYSTEM@1.1:INTEGERintrue the handle
indexCOOSYSTEM@1.1:INTEGERintrue the index

Additional Information

Prototype: COODESK@1.1:MenuActionPrototype
ACL Object: COOSYSTEM@1.1:DefaultDeveloperACL


[top]

COOWF@1.1:EditProcessObjectAttributes

Action to edit the attributes of an object of the process
ParameterTypeIn/OutOptionalDescription
handleCOOSYSTEM@1.1:INTEGERintrue the handle
indexCOOSYSTEM@1.1:INTEGERintrue the index
objectclassCOOSYSTEM@1.1:OBJECTintrue the objectclass
focusattrCOOSYSTEM@1.1:OBJECTintrue the focusattr
domodalCOOSYSTEM@1.1:BOOLEANintrue the domodal
oleitemCOOSYSTEM@1.1:STRINGintrue the oleitem
attrsCOOSYSTEM@1.1:OBJECTLISTintrue the attrs
formsobjCOOSYSTEM@1.1:OBJECTintrue the formsobj
checkactionCOOSYSTEM@1.1:OBJECTintrue the checkaction
lockedCOOSYSTEM@1.1:BOOLEANintrue the locked
internal11intrue the internal11
internal12intrue the internal12
handleparentCOOSYSTEM@1.1:INTEGERintrue the handleparent
itempathCOOSYSTEM@1.1:STRINGintrue the itempath

Additional Information

Prototype: COODESK@1.1:MenuActionPrototype
ACL Object: COOSYSTEM@1.1:DefaultDeveloperACL


[top]

COOWF@1.1:GetSecurityAttributes

Get the attribute definitions where the security permissions will be stored.
ParameterTypeIn/OutOptionalDescription
usersecattrCOOSYSTEM@1.1:OBJECToutfalse the usersecattr
groupsecattrCOOSYSTEM@1.1:OBJECToutfalse the groupsecattr
userdonesecattrCOOSYSTEM@1.1:OBJECToutfalse the userdonesecattr
groupdonesecattrCOOSYSTEM@1.1:OBJECToutfalse the groupdonesecattr

Additional Information

ACL Object: COOSYSTEM@1.1:DefaultDeveloperACL


[top]

COOWF@1.1:InsertInstanceElement

This action can be called to insert an instance element in a process instance. This element can be inserted before or after the current object and also before or after multiple objects as the single predecessor or successor respectively of these objects.
If the current object is the start of the instance of a CASE switch, an IF condition or a REPEAT loop, and the instance element is inserted after, it is inserted after the corresponding end element. On the opposite, if the current object is the end of the instance of a CASE switch, an IF condition or a REPEAT loop, and the instance element is inserted before, it is inserted before the corresponding start element.
ParameterTypeIn/OutOptionalDescription
instelemCOOSYSTEM@1.1:OBJECTinfalse The instance element to insert.
beforeCOOSYSTEM@1.1:BOOLEANintrue If set to True, the instance element is inserted before the current object and its siblings, otherwise after. The default is False.
siblingsCOOSYSTEM@1.1:OBJECTLISTintrue If this parameter is set and before is True, the instance element is inserted as a single predecessor to all these objects and the current object. Requirement is, that these objects have the same predecessors before that element can be inserted. If this parameter is set and before is False, the instance element is inserted as a single successor to all these objects and the current object. Requirement is, that these objects have the same successors before that element can be inserted.
checksequenceCOOSYSTEM@1.1:BOOLEANintrue

Additional Information

ACL Object: COOSYSTEM@1.1:DefaultDeveloperACL


[top]

COOWF@1.1:InsertInstanceElements

This action can be called to insert multiple interconnected instance elements in a process instance. It is the responsibility of the caller, that the pointers between the inserted elements are correct and complete. The elements can be inserted before or after the current object and also before or after multiple objects as the predecessors or successors respectively of these objects.
If the current object is the start of the instance of a CASE switch, an IF condition or a REPEAT loop, and the instance elements are inserted after, they are inserted after the corresponding end element. On the opposite, if the current object is the end of the instance of a CASE switch, an IF condition or a REPEAT loop, and the instance elements are inserted before, they are inserted before the corresponding start element.
ParameterTypeIn/OutOptionalDescription
startelemsCOOSYSTEM@1.1:OBJECTLISTinfalse The start elements of the new inserted instance elements.
endelemsCOOSYSTEM@1.1:OBJECTLISTinfalse The end elements of the new inserted instance elements. If the start elements and the end elements are not the same, the pointers between these elements (and possibly other elements in between) must be correct and complete. Otherwise the resulting process might not be executable and editable any more.
beforeCOOSYSTEM@1.1:BOOLEANintrue If set to True, the instance elements are inserted before the current object and its siblings, otherwise after. The default is False.
siblingsCOOSYSTEM@1.1:OBJECTLISTintrue If this parameter is set and before is True, the instance elements are inserted as predecessors to all these objects and the current object. Requirement is, that these objects have the same predecessors before the elements can be inserted. If this parameter is set and before is False, the instance elements are inserted as successors to all these objects and the current object. Requirement is, that these objects have the same successors before the elements can be inserted.
checksequenceCOOSYSTEM@1.1:BOOLEANintrue

Additional Information

ACL Object: COOSYSTEM@1.1:DefaultDeveloperACL


[top]

COOWF@1.1:InsertParallelElement

This action can be called to insert a definition or instance element as a parallel element to an existing element in a process definition or instance. To insert the element parallel to multiple other elements the end of the parallel path can be specified as parameter.
ParameterTypeIn/OutOptionalDescription
instelemCOOSYSTEM@1.1:OBJECTinfalse The element to insert.
endparelemCOOSYSTEM@1.1:OBJECTintrue If specified, the end of the path that the element is inserted parallel to. If not specified, the element is inserted only parallel to the current object.
procdefCOOSYSTEM@1.1:OBJECTintrue If the current element is a definition element, the process definition it belongs to. Otherwise it is ignored.
aboveCOOSYSTEM@1.1:BOOLEANintrue
newparallelsequenceCOOSYSTEM@1.1:BOOLEANintrue
nextparaobjsCOOSYSTEM@1.1:OBJECTLISTintrue

Additional Information

ACL Object: COOSYSTEM@1.1:DefaultDeveloperACL


[top]

COOWF@1.1:InsertParallelSubProcess

This action can be called to insert a sub process as a parallel element to an existing element in a process instance. The sub process is expanded before it is inserted. To insert the sub process parallel to multiple other elements the end of the parallel path can be specified as parameter.
ParameterTypeIn/OutOptionalDescription
procdefCOOSYSTEM@1.1:OBJECTinfalse The process definition of the sub process.
endparelemCOOSYSTEM@1.1:OBJECTintrue If specified, the end of the path that the expanded sub process is inserted parallel to. If not specified, the expanded sub process is inserted parallel only to the current object.
aboveCOOSYSTEM@1.1:BOOLEANintrue
newparallelsequenceCOOSYSTEM@1.1:BOOLEANintrue
nextparaobjsCOOSYSTEM@1.1:OBJECTLISTintrue

Additional Information

ACL Object: COOSYSTEM@1.1:DefaultDeveloperACL


[top]

COOWF@1.1:InsertSubProcess

This action can be called to insert a sub process in a process instance. The sub process is expanded before it is inserted. The sub process can be inserted before or after the current object and also before or after multiple objects as the predecessor or successor respectively of these objects.
If the current object is the start of the instance of a CASE switch, an IF condition or a REPEAT loop, and the sub process is inserted after, it is inserted after the corresponding end element. On the opposite, if the current object is the end of the instance of a CASE switch, an IF condition or a REPEAT loop, and the sub process is inserted before, it is inserted before the corresponding start element.
ParameterTypeIn/OutOptionalDescription
procdefCOOSYSTEM@1.1:OBJECTinfalse The process definition of the sub process.
beforeCOOSYSTEM@1.1:BOOLEANintrue If set to True, the expanded sub process is inserted before the current object and its siblings, otherwise after. The default is False.
siblingsCOOSYSTEM@1.1:OBJECTLISTintrue If this parameter is set and before is True, the expanded sub process is inserted as predecessor to all these objects and the current object. Requirement is, that these objects have the same predecessors before the sub process can be inserted. If this parameter is set and before is False, the expanded sub process is inserted as successor to all these objects and the current object. Requirement is, that these objects have the same successors before the sub process can be inserted.

Additional Information

ACL Object: COOSYSTEM@1.1:DefaultDeveloperACL


[top]

COOWF@1.1:ModifyPage

This action is used as display items filter action in the form pages used for process instance properties, activity instance properties and wait action instance properties. It is called by the property editor, when the properties of such an object are edited or viewed with a form page that specifies this action. This action modifies the items presented to the user according to the current state of the object and to the capabilties of the user.

Additional Information

Prototype: COOATTREDIT@1.1:FormPageItemPrototype
ACL Object: COOSYSTEM@1.1:DefaultDeveloperACL


[top]

COOWF@1.1:ReadObjectAttributesDirect

Action to read direct the properties of an object
ParameterTypeIn/OutOptionalDescription
handleCOOSYSTEM@1.1:INTEGERintrue the handle
indexCOOSYSTEM@1.1:INTEGERintrue the index

Additional Information

Prototype: COODESK@1.1:MenuActionPrototype
ACL Object: COOSYSTEM@1.1:DefaultDeveloperACL


[top]

COOWF@1.1:ReadProcessObjectAttributes

Action to read the attributes of an object of the process
ParameterTypeIn/OutOptionalDescription
handleCOOSYSTEM@1.1:INTEGERintrue the handle
indexCOOSYSTEM@1.1:INTEGERintrue the index
objectclassCOOSYSTEM@1.1:OBJECTintrue the objectclass
focusattrCOOSYSTEM@1.1:OBJECTintrue the focusattr
domodalCOOSYSTEM@1.1:BOOLEANintrue the domodal
oleitemCOOSYSTEM@1.1:STRINGintrue the oleitem
attrsCOOSYSTEM@1.1:OBJECTLISTintrue the attrs
formsobjCOOSYSTEM@1.1:OBJECTintrue the formsobj
internal9intrue the internal9
internal10intrue the internal10
internal11intrue the internal11
internal12intrue the internal12
handleparentCOOSYSTEM@1.1:INTEGERintrue the handleparent
itempathCOOSYSTEM@1.1:STRINGintrue the itempath

Additional Information

Prototype: COODESK@1.1:MenuActionPrototype
ACL Object: COOSYSTEM@1.1:DefaultDeveloperACL


[top]

COOWF@1.1:RemoveInstanceElement

This action can be called to remove an instance element from a process instance. The instance element itself is not destroyed, only the pointers of the predecessors and successors of the instance element are modified, so that the element is not longer part of the process instance. If the element is the start or end of a CASE switch, an IF condition or a REPEAT loop, the corresponding end or start element is removed also.

Additional Information

ACL Object: COOSYSTEM@1.1:DefaultDeveloperACL


[top]

COOWF@1.1:SetStartable

This action is called and can be used to set an instance element in a process instance to "Startable". For activity instances and wait action instances this means, that the state of the activity is set, for sub processes this means, that the sub process is expanded and the first activities are set to "Startable", and for conditions and switches this means, that the condition is evaluated and the first activities in the selected path are set to "Startable".
An activity can be set to "Startable" only, if all preceeding activities are completed.
ParameterTypeIn/OutOptionalDescription
nosubmitdeadlineCOOSYSTEM@1.1:BOOLEANintrue
nolocktimeoutCOOSYSTEM@1.1:BOOLEANintrue

Additional Information

Access Types: COOSYSTEM@1.1:AccTypeChange
ACL Object: COOSYSTEM@1.1:DefaultDeveloperACL


[top]

FSCSCHEDULE@1.1001:GetSuspDeadlineSecContext

Retrieve the object which should be taken as security context for the suspended deadline object
ParameterTypeIn/OutOptionalDescription
seccontextobjCOOSYSTEM@1.1:OBJECToutfalse

Additional Information

ACL Object: COOSYSTEM@1.1:DefaultDeveloperACL


[top]

FSCSCHEDULE@1.1001:GetSuspDeadlinesContainerLocations

Retrieve the object where the container for suspended deadlines should be stored at
Note: The deadline container will be stored in the property FSCSCHEDULE@1.1001:objsuspdeadlinescontainer
ParameterTypeIn/OutOptionalDescription
locationsCOOSYSTEM@1.1:OBJECTLISToutfalse the target objects

Additional Information

ACL Object: COOSYSTEM@1.1:DefaultDeveloperACL


[top]

FSCSCHEDULE@1.1001:IsDeadlineContextActive

Checks if the background context is active
ParameterTypeIn/OutOptionalDescription
isactiveCOOSYSTEM@1.1:BOOLEANoutfalse the deadline context is active

Additional Information

ACL Object: COOSYSTEM@1.1:DefaultDeveloperACL


[top]

FSCTEAMROOM@1.1001:ApplyTeamRoom

Pre wrapper of COOSYSTEM@1.1:ObjectFinalizeCommit to perform checks and actions before committing an object
ParameterTypeIn/OutOptionalDescription
attrlistCOOSYSTEM@1.1:OBJECTLISTinfalse The list of properties changed in the current transaction

Additional Information

ACL Object: COOWF@1.1:WorkFlowActionACL
Private: true
Disable Wrapper Actions: true


[top]

FSCTEAMROOM@1.1001:AttrObjTeamRoomCopy

Additional Information

Prototype: COOSYSTEM@1.1:AttrCopyPrototype
ACL Object: COOWF@1.1:WorkFlowActionACL
Private: true


[top]

FSCVENV@1.1001:IsEditable

Used to check whether the object is editable in the property editor. E.g. edit mode will not be enabled:
ParameterTypeIn/OutOptionalDescription
iseditableCOOSYSTEM@1.1:BOOLEANoutfalse true if the property editor should enable edit mode. @see FSCVENV@1.1001:IsEditableAttribute

Additional Information

ACL Object: COOSYSTEM@1.1:DefaultDeveloperACL


[top]