Object Class Process Definition (COOWF@1.1:ProcessDefinition)

Object Class Hierarchy

COOSYSTEM@1.1:Object > COOSYSTEM@1.1:ComponentObject > COOSYSTEM@1.1:ConfigurationObject > COOWF@1.1:ProcessDefinition

This object class is used to define process templates for a workflow process. A process definition is a predefined process which can be used to initialize a process instance (a workflow, that is executed). It consists of a sequence of activity definitions, CASE switches, IF-THEN-ELSE conditons, REPEAT loops and/or other process definitions (subprocesses), which are connected with each other.
Process definitions are used to add a process to an object. Thereby a process instance is created from the process definition and instance elements are created from the definition elements. Embedded subprocesses are resolved either when the process instance is created or when the subprocess is actually initiated. Resolving the subprocess means inserting activity instances into the current process instance. If the process definition is modified after the process instance was created, the modifications are not reflected in the running process instances (with the exception of loops and subprocesses that are not expanded immediately).
Note: When an object is initialized with a process definition the created process instance is stored as a property of the object. Therefore the object class of that object or a base class of the object class must include the property COOWF@1.1:workflow. By default no object class has this property assigned. You have to add this property to your object classes and to the existing object classes depending on the object model of your solution.

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: false
ACL Object: COOSYSTEM@1.1:DefaultAdministratorACL
Secured: true
Default ACL for New Objects: COOSYSTEM@1.1:DefaultAdministratorACL
Symbol: COODESK@1.1:SymbolProcessDefinition
Default Context Menu: COODESK@1.1:MenuRootContext
Base Class: COOSYSTEM@1.1:ConfigurationObject
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:MenuRootAdmin

Properties

ReferenceName
COOSYSTEM@1.1:contentFile
COOSYSTEM@1.1:explanationsExplanation Texts
COOSYSTEM@1.1:mlnameMultilingual Name
COOWF@1.1:procdefallowedparentsApplicable Files
COOWF@1.1:procdefbpmnmodelBPMN Process Diagram
COOWF@1.1:procdefcommonCommonly Usable
COOWF@1.1:procdefcopyinstCopy Process With Object of Process
COOWF@1.1:procdefdefdispviewDefault Display Properties
COOWF@1.1:procdefescalationEscalation
COOWF@1.1:procdefexpandExpand Immediately
COOWF@1.1:procdefforcategoriesApplicable for Object Categories
COOWF@1.1:procdefgroupdonesecattrSecurity Property for Groups Having Participated in Workflow
COOWF@1.1:procdefgroupsecattrSecurity Property for Groups Participating in Workflow
COOWF@1.1:procdefloadsharingvalueValue for Load Sharing
COOWF@1.1:procdefnocompleteProcesses Are Not Completed Automatically
COOWF@1.1:procdefnostartProcesses Are Not Started Automatically
COOWF@1.1:procdefnosubstDisable Substitution
COOWF@1.1:procdefnotforclassesNot Applicable for Object Classes
COOWF@1.1:procdefnotificationDefined Notifications
COOWF@1.1:procdefparticipantsWorkflow Actors
COOWF@1.1:procdefpriorityWorkflow Priority
COOWF@1.1:procdefrefobjclassesUsed Object Classes
COOWF@1.1:procdefremoveorgsSecurity for Users/Groups After Completion
COOWF@1.1:procdefsecinitiatorSecurity for Process Initiator
COOWF@1.1:procdefstartStart Activities
COOWF@1.1:procdefstateState of Process Definition
COOWF@1.1:procdefuseforclassesApplicable for Object Classes
COOWF@1.1:procdefuserdonesecattrSecurity Property for Users Having Participated in Workflow
COOWF@1.1:procdefusersecattrSecurity Property for Users Participating in Workflow

Actions

ReferenceName
COOATTREDIT@1.1:CheckAppLicense
COOSYSTEM@1.1:AttrContentGet
COOSYSTEM@1.1:ObjectCopy
COOSYSTEM@1.1:ObjectDelVersion
COOSYSTEM@1.1:ObjectFixVersion
COOWF@1.1:AttachToProcess
COOWF@1.1:AttrProcDefParticipantsGet
COOWF@1.1:AttrProcDefRefObjClassesGet
COOWF@1.1:CheckForm
COOWF@1.1:EditObjectAttributesDirect
COOWF@1.1:EditProcessObjectAttributes
COOWF@1.1:GetDefinitionElements
COOWF@1.1:InitializeProcessInstance
COOWF@1.1:InsertFirstElement
COOWF@1.1:NextProcessWorkItem
COOWF@1.1:ReadObjectAttributesDirect
COOWF@1.1:ReadProcessObjectAttributes
COOWF@1.1:StartProcessDefinition
FSCDIAGRAM@1.1001:CheckDiagramSyntax
FSCDIAGRAM@1.1001:GetAllowedStencilSets
FSCDIAGRAM@1.1001:GetDiagramPreview
FSCDIAGRAM@1.1001:GetDiagramSVG
FSCDIAGRAMEDITOR@1.1001:EditDiagramCondition
FSCDIAGRAMEDITOR@1.1001:EditProcessDiagram
FSCDIAGRAMEDITOR@1.1001:ExportProcessDiagram
FSCDIAGRAMEDITOR@1.1001:SelectDiagram

Properties

COOSYSTEM@1.1:content (File)

Stores the multimedia content of the object and information like the size of the content or the date of the last change.

Additional Information

Access Types for Reading Property: COOSYSTEM@1.1:AccTypeReadContent
Changeable in Installed Component: true
Action to Get Display String of Property: COOSYSTEM@1.1:AttrGetDisp
Action Called Before Property Is Saved: COOSYSTEM@1.1:AttrContentSet
Type: COOSYSTEM@1.1:Content
ACL Object: COOSYSTEM@1.1:DefaultDeveloperACL
Constructor Action: COOSYSTEM@1.1:AttrContentConstructor
Action Called After Property Is Read: COOSYSTEM@1.1:AttrContentGet
Access Types for Changing Property: COOSYSTEM@1.1:AccTypeChangeContent
Action Called After Property of Version Is Read: COOSYSTEM@1.1:AttrContentGetVersion
Changeable: true
Must Be Defined: false
Action to Get Property for Full-Text Search: COOSYSTEM@1.1:AttrContentGetFTS
Visible: true


[top]

COOSYSTEM@1.1:explanations (Explanation Texts)

Additional Information

Type: COOSYSTEM@1.1:ExplanationTextList
Multiple Values (Overrides Type): true
Changeable: true
Visible: true
Must Be Defined: false
ACL Object: COOSYSTEM@1.1:DefaultDeveloperACL
Action Called Before Property Is Saved: COOSYSTEM@1.1:AttrCompContentSet
Changeable in Installed Component: true


[top]

COOSYSTEM@1.1:mlname (Multilingual Name)

Stores the multilingual name of the object. It stores one name for each supported language.

Additional Information

Changeable in Installed Component: true
Action to Get Display String of Property: COOSYSTEM@1.1:AttrGetDisp
Action Called Before Property Is Saved: COOSYSTEM@1.1:AttrObjNameBuildSet
Multiple Values (Overrides Type): true
ACL Object: COOSYSTEM@1.1:DefaultDeveloperACL
Type: COOSYSTEM@1.1:LanguageStringList
Secured: true
Changeable: true
Must Be Defined: false
Visible: true


[top]

COOWF@1.1:procdefallowedparents (Applicable Files)

This property defines the categories for which the diagram is usable.

Additional Information

Lockable: true
Changeable in Installed Component: true
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:Object
Search for Allowed Classes Only: true
Changeable: true
Must Be Defined: false
Visible: true


[top]

COOWF@1.1:procdefbpmnmodel (BPMN Process Diagram)

BPMN 2 process definition model.

Additional Information

Type: FSCDIAGRAM@1.1001:Diagram
Multiple Values (Overrides Type): true
Changeable: true
Visible: true
Must Be Defined: false
ACL Object: COOSYSTEM@1.1:DefaultDeveloperACL
Changeable in Installed Component: true


[top]

COOWF@1.1:procdefcommon (Commonly Usable)

This property defines if a process definition is commonly used. A commonly used process definition can be selected by the user when initializing a process if workflow preferences are defined.

Additional Information

Type: COOSYSTEM@1.1:BOOLEAN
Changeable: true
Visible: true
Must Be Defined: false
ACL Object: COOSYSTEM@1.1:DefaultDeveloperACL
Changeable in Installed Component: false


[top]

COOWF@1.1:procdefcopyinst (Copy Process With Object of Process)

This propery can be used to define, if process instances, that are generated from this process definition, should be automatically copied, if an object is copied, that has such a process instance attached.
This property is used to initialize the property COOWF@1.1:procinstcopyinst of a process instance.

Additional Information

Type: COOSYSTEM@1.1:BOOLEAN
Changeable: true
Visible: true
Must Be Defined: false
ACL Object: COOSYSTEM@1.1:DefaultDeveloperACL
Changeable in Installed Component: true


[top]

COOWF@1.1:procdefdefdispview (Default Display Properties)

This property is used to defined default display view setting for activity instances in process instances generated from this definition. This setting is used, when an activity instance is display in a graphical user interface. It defines the properties, that are displayed in the box representing the activity instance. The used setting of the default display view object is the setting for the property COOWF@1.1:actinstinstance.
This property is used to initialize the property COOWF@1.1:procinstdefdispview of a process instance.

Additional Information

Search for Allowed Classes Only: true
Type: COOSYSTEM@1.1:OBJECT
Changeable: true
Visible: true
Must Be Defined: false
Possible Object Class: COOSYSTEM@1.1:Object
ACL Object: COOSYSTEM@1.1:DefaultDeveloperACL
Changeable in Installed Component: true


[top]

COOWF@1.1:procdefescalation (Escalation)

This property stores the escalation definition that is to be used for activity instances in process instances generated from this definition.
This property is used to initialize the property COOWF@1.1:procinstescalation of a process instance.

Additional Information

Search for Allowed Classes Only: true
Type: COOSYSTEM@1.1:OBJECT
Changeable: true
Visible: true
Must Be Defined: false
Possible Object Class: COOWF@1.1:EscalationDefinition
ACL Object: COOSYSTEM@1.1:DefaultDeveloperACL
Changeable in Installed Component: true


[top]

COOWF@1.1:procdefexpand (Expand Immediately)

This property stores the information, whether the process definition should be expanded immediately or not. If the value is True, the process definition is expanded immediately.
If a process instance is created from a process definition with this property set to True, all sub processes within this process definition are expanded immediately, even if the sub process has this property set to False.
The advantage of setting this property to False is that activity instances are not created, if a path of an IF-element or CASE-element is not executed. A disadvantage could be that the sub process is expanded after the creation of the process instance. This means that modifications of the sub process definitions between the creation and the expansion do influence the process.

Additional Information

Type: COOSYSTEM@1.1:BOOLEAN
Changeable: true
Visible: true
Must Be Defined: false
ACL Object: COOSYSTEM@1.1:DefaultDeveloperACL
Changeable in Installed Component: true


[top]

COOWF@1.1:procdefforcategories (Applicable for Object Categories)

This property defines for which template categories the process definition is usable. If no template category is defined the use of the process definition is not restricted.

Additional Information

Type: COOWF@1.1:UsableCategoryList
Multiple Values (Overrides Type): true
Changeable: true
Visible: true
Must Be Defined: false
ACL Object: COOSYSTEM@1.1:DefaultDeveloperACL
Changeable in Installed Component: true


[top]

COOWF@1.1:procdefgroupdonesecattr (Security Property for Groups Having Participated in Workflow)

Additional Information

Search for Allowed Classes Only: true
Type: COOSYSTEM@1.1:OBJECT
Changeable: true
Visible: true
Must Be Defined: false
Possible Object Class: COOSYSTEM@1.1:AttributeObjectDef
ACL Object: COOSYSTEM@1.1:DefaultDeveloperACL
Changeable in Installed Component: true


[top]

COOWF@1.1:procdefgroupsecattr (Security Property for Groups Participating in Workflow)

Additional Information

Search for Allowed Classes Only: true
Type: COOSYSTEM@1.1:OBJECT
Changeable: true
Visible: true
Must Be Defined: false
Possible Object Class: COOSYSTEM@1.1:AttributeObjectDef
ACL Object: COOSYSTEM@1.1:DefaultDeveloperACL
Changeable in Installed Component: true


[top]

COOWF@1.1:procdefloadsharingvalue (Value for Load Sharing)

This property defines the load sharing value for the process definition.

Additional Information

Sign: false
Type: COOSYSTEM@1.1:INTEGER
Changeable: true
Visible: true
Must Be Defined: false
Maximum Length: 3
ACL Object: COOSYSTEM@1.1:DefaultDeveloperACL
Changeable in Installed Component: true


[top]

COOWF@1.1:procdefnocomplete (Processes Are Not Completed Automatically)

Update the Data Source for the selected Objects

Additional Information

Type: COOSYSTEM@1.1:BOOLEAN
Changeable: true
Visible: true
Must Be Defined: false
ACL Object: COOSYSTEM@1.1:DefaultDeveloperACL
Changeable in Installed Component: true


[top]

COOWF@1.1:procdefnostart (Processes Are Not Started Automatically)

Additional Information

Type: COOSYSTEM@1.1:BOOLEAN
Changeable: true
Visible: true
Must Be Defined: false
ACL Object: COOSYSTEM@1.1:DefaultDeveloperACL
Changeable in Installed Component: true


[top]

COOWF@1.1:procdefnosubst (Disable Substitution)

Expressions to compute deadlines

Additional Information

Type: COOSYSTEM@1.1:BOOLEAN
Changeable: true
Visible: true
Must Be Defined: false
ACL Object: COOSYSTEM@1.1:DefaultDeveloperACL
Changeable in Installed Component: true


[top]

COOWF@1.1:procdefnotforclasses (Not Applicable for Object Classes)

This property definies for which object classes the process definition is not usable. If no object class is define the process definition is usable for all object classes.

Additional Information

Type: COOWF@1.1:UsableClassList
Multiple Values (Overrides Type): true
Changeable: true
Visible: true
Must Be Defined: false
ACL Object: COOSYSTEM@1.1:DefaultDeveloperACL
Changeable in Installed Component: true


[top]

COOWF@1.1:procdefnotification (Defined Notifications)

Configured notification settings for instances of the process definition. Each configured event type setting overrides the settings of notification definition stored at the current domain.

Additional Information

Type: COOWF@1.1:NotificationEntryList
Multiple Values (Overrides Type): true
Changeable: true
Visible: true
Must Be Defined: false
ACL Object: COOSYSTEM@1.1:DefaultDeveloperACL
Changeable in Installed Component: true


[top]

COOWF@1.1:procdefparticipants (Workflow Actors)

This property defines the participants of the process definition.

Additional Information

Changeable in Installed Component: true
Multiple Values (Overrides Type): true
ACL Object: COOSYSTEM@1.1:DefaultDeveloperACL
Type: COOWF@1.1:WorkFlowActorList
Action to Search Object Property: COOSYSTEM@1.1:AttrSearchNotPossible
Action Called After Property Is Read: COOWF@1.1:AttrProcDefParticipantsGet
Action Called After Property of Version Is Read: COOSYSTEM@1.1:AttrGetVersionUsingAttrGet
Changeable: true
Must Be Defined: false
Visible: true


[top]

COOWF@1.1:procdefpriority (Workflow Priority)

This property stores the priority of the process definition. This property is used to initialize the property COOWF@1.1:procinstpriority of a process instance.

Additional Information

Initialization Value: 2
Type: COOWF@1.1:WorkFlowPriority
Changeable: true
Visible: true
Must Be Defined: true
ACL Object: COOSYSTEM@1.1:DefaultDeveloperACL
Changeable in Installed Component: true


[top]

COOWF@1.1:procdefrefobjclasses (Used Object Classes)

Additional Information

Changeable in Installed Component: true
Multiple Values (Overrides Type): true
ACL Object: COOSYSTEM@1.1:DefaultDeveloperACL
Type: COOSYSTEM@1.1:OBJECTLISTUNIQ
Possible Object Class: COOSYSTEM@1.1:ObjectClass
Action to Search Object Property: COOSYSTEM@1.1:AttrSearchNotPossible
Action Called After Property Is Read: COOWF@1.1:AttrProcDefRefObjClassesGet
Search for Allowed Classes Only: true
Changeable: true
Action Called After Property of Version Is Read: COOSYSTEM@1.1:AttrGetVersionUsingAttrGet
Must Be Defined: false
Visible: true


[top]

COOWF@1.1:procdefremoveorgs (Security for Users/Groups After Completion)

Additional Information

Type: COOWF@1.1:WorkFlowOrgSecurity
Changeable: true
Visible: true
Must Be Defined: false
ACL Object: COOSYSTEM@1.1:DefaultDeveloperACL
Changeable in Installed Component: true


[top]

COOWF@1.1:procdefsecinitiator (Security for Process Initiator)

Additional Information

Type: COOWF@1.1:WorkFlowSecurityUsage
Changeable: true
Visible: true
Must Be Defined: false
ACL Object: COOSYSTEM@1.1:DefaultDeveloperACL
Changeable in Installed Component: true


[top]

COOWF@1.1:procdefstart (Start Activities)

This property stores the list of start activities of the process definition.

Additional Information

Changeable in Installed Component: true
Destructor Action: COOWF@1.1:AttrObjectListDestructor
Multiple Values (Overrides Type): true
ACL Object: COOSYSTEM@1.1:DefaultDeveloperACL
Type: COOSYSTEM@1.1:OBJECTLISTUNIQ
Possible Object Class: COOWF@1.1:DefinitionElement
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:procdefstate (State of Process Definition)

This property stores the state of the process definition. The process definition can be in definition, visible to other users (enabled), and not visible to other users (disabled).

Additional Information

Initialization Value: 1
Type: COOWF@1.1:ProcessDefinitionState
Changeable: true
Visible: true
Must Be Defined: true
ACL Object: COOSYSTEM@1.1:DefaultDeveloperACL
Changeable in Installed Component: true


[top]

COOWF@1.1:procdefuseforclasses (Applicable for Object Classes)

This property defines for which object classes the process definition is usable. If no object class is defined the process definition is usable for all object classes.

Additional Information

Type: COOWF@1.1:UsableClassList
Multiple Values (Overrides Type): true
Changeable: true
Visible: true
Must Be Defined: false
ACL Object: COOSYSTEM@1.1:DefaultDeveloperACL
Changeable in Installed Component: true


[top]

COOWF@1.1:procdefuserdonesecattr (Security Property for Users Having Participated in Workflow)

Additional Information

Search for Allowed Classes Only: true
Type: COOSYSTEM@1.1:OBJECT
Changeable: true
Visible: true
Must Be Defined: false
Possible Object Class: COOSYSTEM@1.1:AttributeObjectDef
ACL Object: COOSYSTEM@1.1:DefaultDeveloperACL
Changeable in Installed Component: true


[top]

COOWF@1.1:procdefusersecattr (Security Property for Users Participating in Workflow)

Additional Information

Search for Allowed Classes Only: true
Type: COOSYSTEM@1.1:OBJECT
Changeable: true
Visible: true
Must Be Defined: false
Possible Object Class: COOSYSTEM@1.1:AttributeObjectDef
ACL Object: COOSYSTEM@1.1:DefaultDeveloperACL
Changeable in Installed Component: true


[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]

COOSYSTEM@1.1:AttrContentGet

Reads the primary content of the object.

Additional Information

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


[top]

COOSYSTEM@1.1:ObjectCopy

Creates a new object as the copy of the object. This action called on the source object. This action sets the property COOSYSTEM@1.1:objsource on the copied object.
ParameterTypeIn/OutOptionalDescription
coostdomCOOSYSTEM@1.1:OBJECTin/outtrue
objectCOOSYSTEM@1.1:OBJECToutfalse The created copy of the object.
addressCOOSYSTEM@1.1:STRINGintrue The object address for the new object. If this parameter is used, it overrides the specified object store in parameter coost or the automatically chosen object store, if no object store was specified.
virtualobjectCOOSYSTEM@1.1:BOOLEANintrue

Additional Information

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


[top]

COOSYSTEM@1.1:ObjectDelVersion

Deletes the version of the object.

Additional Information

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


[top]

COOSYSTEM@1.1:ObjectFixVersion

Stores the current object version of the object with a short description of the version and starts a new version.
ParameterTypeIn/OutOptionalDescription
autofixedCOOSYSTEM@1.1:BOOLEANinfalse If it is true, the new version was started automatically. Otherwise the user started a new version.
versdescCOOSYSTEM@1.1:STRINGinfalse The version description.
newversnrCOOSYSTEM@1.1:INTEGERoutfalse The new version number.
fixcontentsCOOSYSTEM@1.1:BOOLEANintrue
converttofinalformCOOSYSTEM@1.1:BOOLEANintrue
finalformatCOOSYSTEM@1.1:STRINGintrue
noautopurgeCOOSYSTEM@1.1:BOOLEANintrue

Additional Information

ACL Object: COOSYSTEM@1.1:DefaultDeveloperACL


[top]

COOWF@1.1:AttachToProcess

Attaches an object to the process definition
ParameterTypeIn/OutOptionalDescription
processstateCOOSYSTEM@1.1:DICTIONARYin/outfalse the processstate
objCOOSYSTEM@1.1:OBJECTinfalse the obj

Additional Information

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


[top]

COOWF@1.1:AttrProcDefParticipantsGet

This action is used to get all participants used in the process definition

Additional Information

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


[top]

COOWF@1.1:AttrProcDefRefObjClassesGet

This action is used as property get action for the property COOWF@1.1:procdefrefobjclasses. It is called by the kernel, when the value of that property is read.

Additional Information

Prototype: COOSYSTEM@1.1:AttrGetPrototype
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:GetDefinitionElements

This action can be called to retrieve all definition element objects of a process definition that have the specified class. If no class is specified, all definition elements in the process definition are returned.
ParameterTypeIn/OutOptionalDescription
defelemsCOOSYSTEM@1.1:OBJECTLISToutfalse The list of definition elements.
objclassCOOSYSTEM@1.1:OBJECTintrue The desired class.

Additional Information

ACL Object: COOSYSTEM@1.1:DefaultDeveloperACL


[top]

COOWF@1.1:InitializeProcessInstance

This action is called when a process instance object is created from a process definition object. This happens, when a new process instance is created from a process definition.
If a software component has derived new classes for process definitions and process instances, it has to implement a method for this action on its new class for process definitions to create the appropriate class for the process instance. Otherwise just the default class for process instances would be used, if an instance is created from the definition.
This action does not create instance elements for the definition elements of the process definition. This has to be done separately.
ParameterTypeIn/OutOptionalDescription
coostCOOSYSTEM@1.1:OBJECToutfalse The Fabasoft Components COO Store, where the new object should be created.
procinstCOOSYSTEM@1.1:OBJECTin/outfalse If defined, when the action is called, no new object is created. Only the properties of the object are initialized with the templates from the process definition. If not defined, a new object with an appropriate class is created and returned in this parameter.
refobjectCOOSYSTEM@1.1:OBJECTinfalse The object used in the computation of the affinity of the new process instance objects. This should be the object this process instance will be attached to, if any.

Additional Information

ACL Object: COOSYSTEM@1.1:DefaultDeveloperACL
Secured: true


[top]

COOWF@1.1:InsertFirstElement

This action can be called to insert a definition or instance element into a process definition or instance as the first element in the specified part.
The meaning of part depends on which object this action is called. On an IF condition a value of zero selects the THEN part and a value of one the ELSE part. On a CASE switch the value of part is used as zero-based index in the list of paths. Otherwise part has no meaning.
ParameterTypeIn/OutOptionalDescription
elemCOOSYSTEM@1.1:OBJECTinfalse The element to insert.
partCOOSYSTEM@1.1:INTEGERintrue In the case of an IF condition or CASE switch selects the part where the element is inserted.

Additional Information

ACL Object: COOSYSTEM@1.1:DefaultDeveloperACL


[top]

COOWF@1.1:NextProcessWorkItem

This action retrieves the next work item which is ready for processing.
ParameterTypeIn/OutOptionalDescription
processstateCOOSYSTEM@1.1:DICTIONARYin/outfalse the processstate
applicationsCOOSYSTEM@1.1:OBJECTLISToutfalse the applications
applobjectsCOOSYSTEM@1.1:OBJECTLISToutfalse the applobjects
completeCOOSYSTEM@1.1:BOOLEANoutfalse the complete

Additional Information

Access Types: COOSYSTEM@1.1:AccTypeRead
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:StartProcessDefinition

Start a new process instance from the process definition
ParameterTypeIn/OutOptionalDescription
processstateCOOSYSTEM@1.1:DICTIONARYoutfalse the processstate

Additional Information

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


[top]

FSCDIAGRAM@1.1001:CheckDiagramSyntax

Checks the diagram syntax.
ParameterTypeIn/OutOptionalDescription
checkreleaseCOOSYSTEM@1.1:BOOLEANinfalse defines if the diagram should be checked for release
diagtypeFSCDIAGRAM@1.1001:DiagramTypeintrue the diagram type
jsonresultCOOSYSTEM@1.1:STRINGoutfalse the result as json value
isvalidCOOSYSTEM@1.1:BOOLEANoutfalse the result
attrdefCOOSYSTEM@1.1:OBJECTintrue the attribute definition where the diagram is stored
expandCOOSYSTEM@1.1:BOOLEANintrue the all diagram elements are resolved
expandedresultCOOSYSTEM@1.1:STRINGouttrue a backuped dictionary storing the result of the expansion

Additional Information

ACL Object: COOSYSTEM@1.1:DefaultDeveloperACL


[top]

FSCDIAGRAM@1.1001:GetAllowedStencilSets

Defines a set of tools for the diagram editor.
ParameterTypeIn/OutOptionalDescription
ssetsFSCDIAGRAM@1.1001:StencilSetoutfalse

Additional Information

ACL Object: COOSYSTEM@1.1:DefaultDeveloperACL


[top]

FSCDIAGRAM@1.1001:GetDiagramPreview

Generates a preview image of the given svg content.
ParameterTypeIn/OutOptionalDescription
svgCOOSYSTEM@1.1:CONTENTinfalse the svg representation
widthCOOSYSTEM@1.1:INTEGERinfalse
heightCOOSYSTEM@1.1:INTEGERinfalse
previewCOOSYSTEM@1.1:CONTENToutfalse

Additional Information

ACL Object: COOSYSTEM@1.1:DefaultDeveloperACL


[top]

FSCDIAGRAM@1.1001:GetDiagramSVG

Extracts the svg representation of the editor xml.
ParameterTypeIn/OutOptionalDescription
presentationCOOSYSTEM@1.1:CONTENTinfalse the presentation
svgCOOSYSTEM@1.1:CONTENToutfalse

Additional Information

ACL Object: COOSYSTEM@1.1:DefaultDeveloperACL


[top]

FSCDIAGRAMEDITOR@1.1001:EditDiagramCondition

Usecase to show the query editor for diagram conditions
ParameterTypeIn/OutOptionalDescription
venv_objectCOOSYSTEM@1.1:OBJECTinfalse
diagramcategoriesCOOSYSTEM@1.1:OBJECTLISTinfalse
diagramconditionCOOSYSTEM@1.1:STRINGin/outfalse

Additional Information

ACL Object: COOWF@1.1:WorkFlowActionACL


[top]

FSCDIAGRAMEDITOR@1.1001:EditProcessDiagram

Edit process diagram.

Additional Information

Symbol: COODESK@1.1:SymbolProcessDiagram
Prototype: COODESK@1.1:MenuActionPrototype
ACL Object: COOWF@1.1:WorkFlowActionACL


[top]

FSCDIAGRAMEDITOR@1.1001:ExportProcessDiagram

Export processs diagram data (model data, presentation data)

Additional Information

Symbol: COODESK@1.1:SymbolExport
Prototype: COODESK@1.1:MenuActionPrototype
ACL Object: COOWF@1.1:WorkFlowActionACL


[top]

FSCDIAGRAMEDITOR@1.1001:SelectDiagram

Import diagram data (model data, presentation data)

Additional Information

Symbol: COODESK@1.1:SymbolImport
Prototype: COODESK@1.1:MenuActionPrototype
ACL Object: COOWF@1.1:WorkFlowActionACL


[top]