Actions of Workflow (COOWF@1.1)

ReferenceName
COOWF@1.1:ActivityInstanceGetPreviewCheckPropertyHook
COOWF@1.1:AddPrescription
COOWF@1.1:AllowChangeProcessState
COOWF@1.1:AllowDeleteUsedDiagram
COOWF@1.1:AmendSubstitutePermissions
COOWF@1.1:ApplyProcessFolder
COOWF@1.1:AttachToProcess
COOWF@1.1:AttrActInstCopy
COOWF@1.1:AttrActInstInstanceGet
COOWF@1.1:AttrActInstInstanceGetVersion
COOWF@1.1:AttrActInstNotificationParamsSet
COOWF@1.1:AttrActInstObjectGet
COOWF@1.1:AttrActInstObjectGetVersion
COOWF@1.1:AttrActInstObjectSet
COOWF@1.1:AttrActInstObjectsGet
COOWF@1.1:AttrActInstObjectsGetVersion
COOWF@1.1:AttrActInstSet
COOWF@1.1:AttrActInstStateSet
COOWF@1.1:AttrActInstStatisticGet
COOWF@1.1:AttrActInstSubstUserGet
COOWF@1.1:AttrActInstSubstUserGetVersion
COOWF@1.1:AttrBackLinkDefaultSet
COOWF@1.1:AttrDefCaseNextDestructor
COOWF@1.1:AttrDefGatewayNextDestructor
COOWF@1.1:AttrDefRefObjClassesGet
COOWF@1.1:AttrGetActinstworkDisp
COOWF@1.1:AttrGetCompoundParticipantDisp
COOWF@1.1:AttrGetParticipantDisp
COOWF@1.1:AttrGrAdditionalProcAdminsSet
COOWF@1.1:AttrGrCalcProcStatisticsSet
COOWF@1.1:AttrGrCalculateStatisticIntervalSet
COOWF@1.1:AttrGrCalculateStatisticsAtGet
COOWF@1.1:AttrGrCalculateStatisticsAtSet
COOWF@1.1:AttrGrWFPreferencesSet
COOWF@1.1:AttrInstCaseNextDestructor
COOWF@1.1:AttrInstConditionGet
COOWF@1.1:AttrInstConditionGetVersion
COOWF@1.1:AttrInstDefinitionCopy
COOWF@1.1:AttrInstElemDescriptionGet
COOWF@1.1:AttrInstElemSet
COOWF@1.1:AttrInstGatewayNextDestructor
COOWF@1.1:AttrLoadSharingScoreGet
COOWF@1.1:AttrObjCanceledSetPreWrapper
COOWF@1.1:AttrObjectDestructor
COOWF@1.1:AttrObjectListDestructor
COOWF@1.1:AttrPrescriptionBlockConstructor
COOWF@1.1:AttrPrescriptionLineConstructor
COOWF@1.1:AttrProcDefParticipantsGet
COOWF@1.1:AttrProcDefRefObjClassesGet
COOWF@1.1:AttrProcInstCopy
COOWF@1.1:AttrProcInstParametersSet
COOWF@1.1:AttrProcInstSet
COOWF@1.1:AttrProcInstStatisticGet
COOWF@1.1:AttrProcInstUsersGet
COOWF@1.1:AttrProcInstWorkGet
COOWF@1.1:AttrProcStatisticChartGet
COOWF@1.1:AttrProcessListExpItemsGet
COOWF@1.1:AttrProcessListExpItemsSet
COOWF@1.1:AttrProcessListItemsGet
COOWF@1.1:AttrProcessListItemsSet
COOWF@1.1:AttrSetPendingList
COOWF@1.1:AttrStatisticsContainerSet
COOWF@1.1:AttrUseForClassGet
COOWF@1.1:AttrUsrEnvNewActivityInformationGet
COOWF@1.1:AttrUsrEnvOpenNextActitiyGet
COOWF@1.1:AttrWFAllOutputsGet
COOWF@1.1:AttrWFAllParticipantsGet
COOWF@1.1:AttrWFAllProcessesGet
COOWF@1.1:AttrWFAllReferencesGet
COOWF@1.1:AttrWFDiagramElementsSet
COOWF@1.1:AttrWFPartRelatedProcGet
COOWF@1.1:AttrWFProcFldrOutputsSet
COOWF@1.1:AttrWFProcFldrParticipantsSet
COOWF@1.1:AttrWFProcFldrProcessesSet
COOWF@1.1:AttrWFProcFldrReferencesSet
COOWF@1.1:AttrWFWasteBasketOutputsGet
COOWF@1.1:AttrWFWasteBasketParticipantsGet
COOWF@1.1:AttrWFWasteBasketProcessesGet
COOWF@1.1:AttrWfdTimeIntervalGet
COOWF@1.1:AttrWfdTimeIntervalSet
COOWF@1.1:AttrWfdTranslationsSet
COOWF@1.1:AttrWorkFlowConstructor
COOWF@1.1:AttrWorkFlowCopy
COOWF@1.1:AttrWorkFlowDeadLinesGet
COOWF@1.1:AttrWorkFlowDelVersion
COOWF@1.1:AttrWorkFlowFixVersion
COOWF@1.1:AttrWorkFlowSet
COOWF@1.1:AttrWorkFlowStatisticsDashboardUIFilter
COOWF@1.1:AttrWorkFlowSubstituteForGet
COOWF@1.1:AttrWorkListItemsGet
COOWF@1.1:AttrWorkListItemsSet
COOWF@1.1:AttrWorkListPreferencesUIFilter
COOWF@1.1:AttrWorkListStatisticsDashboardsGet
COOWF@1.1:AttrWorkListStatisticsGet
COOWF@1.1:AttrWorkListStatisticsUIFilter
COOWF@1.1:CalculateProcessStatistics
COOWF@1.1:CalculateSubtitutionDeadlineDates
COOWF@1.1:CallObjectWorkItem
COOWF@1.1:CallSendNotifications
COOWF@1.1:CallWorkItem
COOWF@1.1:CanBeUsedForSubProcessesOnly
COOWF@1.1:CanChangeProcessState
COOWF@1.1:CanDeleteWorkFlow
COOWF@1.1:CanManageWorkFlowDiagrams
COOWF@1.1:ChangeAppWorkFlowState
COOWF@1.1:ChangeResponsible
COOWF@1.1:CheckAction
COOWF@1.1:CheckActive
COOWF@1.1:CheckAdditionalParticipantRestrictions
COOWF@1.1:CheckAffiliationWithWorkFlowPermissions
COOWF@1.1:CheckAllowedActions
COOWF@1.1:CheckAllowedElements
COOWF@1.1:CheckAutoComplete
COOWF@1.1:CheckBPMNProcessParticipants
COOWF@1.1:CheckBackgroundWork
COOWF@1.1:CheckConditionalWaitAction
COOWF@1.1:CheckCopy
COOWF@1.1:CheckDatesForm
COOWF@1.1:CheckDelegateForm
COOWF@1.1:CheckDelegateMultipleForm
COOWF@1.1:CheckDestination
COOWF@1.1:CheckExpiredActivities
COOWF@1.1:CheckForm
COOWF@1.1:CheckInsertTemplate
COOWF@1.1:CheckLongTermActivities
COOWF@1.1:CheckParticipant
COOWF@1.1:CheckParticipantAffiliation
COOWF@1.1:CheckParticipantRules
COOWF@1.1:CheckPrescriptionsForm
COOWF@1.1:CheckReferencedDiagramExecutionRestriction
COOWF@1.1:CheckReleaseReferencedDiagrams
COOWF@1.1:CheckRemoveOrgElements
COOWF@1.1:CheckRetracted
COOWF@1.1:CheckSimplePrescriptionsForm
COOWF@1.1:CheckStart
COOWF@1.1:CheckSubmissionRepetitionPeriod
COOWF@1.1:CheckTakenOver
COOWF@1.1:CheckWorkDay
COOWF@1.1:CheckWorkFlowAppLicense
COOWF@1.1:CheckWorkListCheck Worklist
COOWF@1.1:ChooseProcessDefinition
COOWF@1.1:ClearProcessParameters
COOWF@1.1:CollectFolderItems
COOWF@1.1:ComputeDeadLine
COOWF@1.1:ConfirmStart
COOWF@1.1:ConvertDateToWorkDays
COOWF@1.1:ConvertPrescription
COOWF@1.1:ConvertWorkDaysToDate
COOWF@1.1:CopyWorkFlowObject
COOWF@1.1:CreateProcessInstance
COOWF@1.1:CreateProcessOutput
COOWF@1.1:CreateProcessParticipant
COOWF@1.1:CreateProcessStatisticsCache
COOWF@1.1:CreateStatisticsDashboard
COOWF@1.1:CreateWorkFlowDiagram
COOWF@1.1:CreateWorkFlowObject
COOWF@1.1:CreateWorkFlowPreferences
COOWF@1.1:DeadlineStartProcessDiagram
COOWF@1.1:DefineWFSubstitutes
COOWF@1.1:DelegateActivityHook
COOWF@1.1:DelegateActivityMultipleHook
COOWF@1.1:DeleteObjectPostWrapper
COOWF@1.1:DeleteSelectedObjectsWorkFlow
COOWF@1.1:DeleteWasteBasketObjects
COOWF@1.1:DeleteWasteBasketObjectsSelected
COOWF@1.1:DeleteWorkFlow
COOWF@1.1:DeleteWorkFlowDiagram
COOWF@1.1:DeleteWorkFlowDiagramSelected
COOWF@1.1:DeleteWorkFlowObject
COOWF@1.1:DeskLoggedIn
COOWF@1.1:DisplayActionsInWorkflowTaskPane
COOWF@1.1:DisplayParticipantWithLabels
COOWF@1.1:DoShowWorkListItem
COOWF@1.1:EditObjectAttributesDirect
COOWF@1.1:EditProcessObjectAttributes
COOWF@1.1:EscalateObject
COOWF@1.1:EscalateToRecipients
COOWF@1.1:EvaluateCase
COOWF@1.1:EvaluateCondition
COOWF@1.1:EvaluatePrecondition
COOWF@1.1:EvaluateWorkFlowExpression
COOWF@1.1:ExecuteBackgroundWork
COOWF@1.1:ExecuteScriptActivity
COOWF@1.1:ExpandPrescribeParticipants
COOWF@1.1:ExtendNotificationSettings
COOWF@1.1:ExtractSubPrescription
COOWF@1.1:FillEvents
COOWF@1.1:FilterPossibleReferencedDiagrams
COOWF@1.1:FilterUsableDefinitions
COOWF@1.1:FilterUsableDiagramsHook
COOWF@1.1:FilterUsableObjects
COOWF@1.1:FixParticipantAffiliation
COOWF@1.1:GetActivityInstanceMenu
COOWF@1.1:GetAdditionalPrescriptionTemplatesHook
COOWF@1.1:GetAdditionalWorkFlowDiagramsHook
COOWF@1.1:GetAllWorkListActInsts
COOWF@1.1:GetAllowedProcessStatisticTargets
COOWF@1.1:GetCommonPrescribeDefault
COOWF@1.1:GetCommonUsableProcessDefinitions
COOWF@1.1:GetConditionString
COOWF@1.1:GetConfiguredProcessStatisticsUsers
COOWF@1.1:GetConfiguredSender
COOWF@1.1:GetContextByMultiInstanceType
COOWF@1.1:GetCurrentActivityInstances
COOWF@1.1:GetCurrentUserActivities
COOWF@1.1:GetDefaultProcessDefinitions
COOWF@1.1:GetDefinitionElements
COOWF@1.1:GetDelegateDefault
COOWF@1.1:GetDelegateMultipleDefault
COOWF@1.1:GetDiagramProcessParticipants
COOWF@1.1:GetDisplayProperties
COOWF@1.1:GetInheritedWorkFlowSettings
COOWF@1.1:GetInitialResponsible
COOWF@1.1:GetInsertActivityDef
COOWF@1.1:GetInstanceElementColor
COOWF@1.1:GetInstanceElements
COOWF@1.1:GetLastInstanceElements
COOWF@1.1:GetLongTermSuspendedActivities
COOWF@1.1:GetLowestLoadSharingScoreUsers
COOWF@1.1:GetManageableWorkFlowPreferenceGroupLocations
COOWF@1.1:GetMenuDefineWFSubstitutes
COOWF@1.1:GetMenuRemoveFromProcessFolder
COOWF@1.1:GetMenuShowUsageList
COOWF@1.1:GetMetaParticipantProperties
COOWF@1.1:GetMultiInstanceTypeByContext
COOWF@1.1:GetNextActivityInstances
COOWF@1.1:GetNextInstanceElements
COOWF@1.1:GetNextSuspensionDate
COOWF@1.1:GetNotificationSettings
COOWF@1.1:GetObjectWorkFlowMenu
COOWF@1.1:GetObjectsConcerned
COOWF@1.1:GetPartMultipleContextDispInfos
COOWF@1.1:GetParticipantContext
COOWF@1.1:GetParticipantParentAttribute
COOWF@1.1:GetParticipantUsers
COOWF@1.1:GetPrescribeActivityDefinitions
COOWF@1.1:GetPrescribeDefault
COOWF@1.1:GetPrescribeTemplate
COOWF@1.1:GetPrescriptionEditorMode
COOWF@1.1:GetPrescriptionHeadLine
COOWF@1.1:GetProcessParameter
COOWF@1.1:GetProcessParameters
COOWF@1.1:GetProcessStatisticsCache
COOWF@1.1:GetProcessStatisticsTitle
COOWF@1.1:GetReferencedBPMNObject
COOWF@1.1:GetReferencedDiagrams
COOWF@1.1:GetReleaseDiagramsHook
COOWF@1.1:GetReleasedDiagrams
COOWF@1.1:GetReleasedWorkFlowDiagram
COOWF@1.1:GetResolvedProcessStatisticsUsers
COOWF@1.1:GetSecurityAttributes
COOWF@1.1:GetSubmissionDefault
COOWF@1.1:GetSubstGroupActivities
COOWF@1.1:GetSuspendDefault
COOWF@1.1:GetTerminateDefault
COOWF@1.1:GetTerminateDenyDefault
COOWF@1.1:GetUsableActivityDefinitions
COOWF@1.1:GetUsableObjectsConcerned
COOWF@1.1:GetUsableOrgElements
COOWF@1.1:GetUsableProcessDefinitions
COOWF@1.1:GetUsableUsersGroups
COOWF@1.1:GetUserSubstitution
COOWF@1.1:GetWorkFlowConfigProperty
COOWF@1.1:GetWorkFlowPreferenceGroupLocations
COOWF@1.1:GetWorkFlowPreferenceLocations
COOWF@1.1:GetWorkFlowSettings
COOWF@1.1:GetWorkFlowStatisticsContainer
COOWF@1.1:GetWorkItemIndex
COOWF@1.1:GetWorkItemKey
COOWF@1.1:GetWorkItemsMenu
COOWF@1.1:GetWorkList
COOWF@1.1:GetWorkListItemCountFromTx
COOWF@1.1:HandleSuspendedByCancelProcesses
COOWF@1.1:HasAdditionalParticipantRestrictions
COOWF@1.1:HasValidParticipant
COOWF@1.1:HasWorkOnSubstTabSet
COOWF@1.1:HighchartsJSONAllowMultipleTypesWrapper
COOWF@1.1:InitializeInstance
COOWF@1.1:InitializeProcessInstance
COOWF@1.1:InitializeWorkFlow
COOWF@1.1:InsertActivityInstance
COOWF@1.1:InsertDefinitionElement
COOWF@1.1:InsertExternalActivity
COOWF@1.1:InsertFirstElement
COOWF@1.1:InsertFirstSubProcess
COOWF@1.1:InsertInstanceElement
COOWF@1.1:InsertInstanceElements
COOWF@1.1:InsertParallelElement
COOWF@1.1:InsertParallelSubProcess
COOWF@1.1:InsertSubProcess
COOWF@1.1:InstanceElementStateChangedHook
COOWF@1.1:IsActivityCompleted
COOWF@1.1:IsEditableWFAttribute
COOWF@1.1:IsInstanceElementEvaluated
COOWF@1.1:IsProcessAdministrator
COOWF@1.1:IsProcessOwner
COOWF@1.1:IsReferencedDiagram
COOWF@1.1:IsValidPublishedDiagram
COOWF@1.1:IsWFSubstitutionActive
COOWF@1.1:IsWFSubstitutionEnabled
COOWF@1.1:IsWorkFlowServiceUser
COOWF@1.1:LockProcessObjectHook
COOWF@1.1:LockWorkFlowObjects
COOWF@1.1:LogWorkFlowHistory
COOWF@1.1:LoggedIn
COOWF@1.1:ModifyDelegatePage
COOWF@1.1:ModifyPage
COOWF@1.1:ModifyPrescriptions
COOWF@1.1:ModifySubmissionsPage
COOWF@1.1:ModifyTerminatePage
COOWF@1.1:MovePrescription
COOWF@1.1:NextProcessWorkItem
COOWF@1.1:NormalizeNestedPrescriptions
COOWF@1.1:ObjectAccTypesGet
COOWF@1.1:OpenStatisticsDashboard
COOWF@1.1:ParseBPMNModel
COOWF@1.1:PatchBPMNDiagramTranslations
COOWF@1.1:PrescribeObject
COOWF@1.1:PrescribeObjectDirect
COOWF@1.1:PrescribeOnScope
COOWF@1.1:PrescribeSelectedObjects
COOWF@1.1:ProcessSettings
COOWF@1.1:ProcessStateChangedHook
COOWF@1.1:ProcessStatisticsEnabled
COOWF@1.1:ReadObjectAttributesDirect
COOWF@1.1:ReadProcessObjectAttributes
COOWF@1.1:RefreshProcessListRefresh Process List
COOWF@1.1:RefreshProcessStatistics
COOWF@1.1:RefreshWorkListRefresh Worklist
COOWF@1.1:RefreshWorklistDisplayEffect
COOWF@1.1:RemoveDefinitionElement
COOWF@1.1:RemoveFromProcessFolder
COOWF@1.1:RemoveFromProcessFolderSelected
COOWF@1.1:RemoveInstanceElement
COOWF@1.1:RemovePrescription
COOWF@1.1:ResetObjectHighlighting
COOWF@1.1:ResetSecurityOrgElements
COOWF@1.1:ResolveDistributionList
COOWF@1.1:ResolveMetaParticipant
COOWF@1.1:ResolveMultiInstanceActivity
COOWF@1.1:ResolvePropertyRole
COOWF@1.1:RestoreObjectPostWrapper
COOWF@1.1:SavePrescriptionTemplate
COOWF@1.1:SavePrescriptionTemplateHook
COOWF@1.1:SelectPrescriptionTemplate
COOWF@1.1:SetActive
COOWF@1.1:SetCompleted
COOWF@1.1:SetCompletedSubmission
COOWF@1.1:SetDelegated
COOWF@1.1:SetDelegatedMultiple
COOWF@1.1:SetProcessActive
COOWF@1.1:SetProcessParameter
COOWF@1.1:SetProcessSuspended
COOWF@1.1:SetProcessTerminated
COOWF@1.1:SetRetracted
COOWF@1.1:SetSelectedObjectsActive
COOWF@1.1:SetSelectedObjectsCompleted
COOWF@1.1:SetSelectedObjectsCompleted2
COOWF@1.1:SetSelectedObjectsCompletedSubmission
COOWF@1.1:SetSelectedObjectsDelegated
COOWF@1.1:SetSelectedObjectsDelegatedMultiple
COOWF@1.1:SetSelectedObjectsRetracted
COOWF@1.1:SetSelectedObjectsStarted
COOWF@1.1:SetSelectedObjectsSuspended
COOWF@1.1:SetSelectedObjectsTakenOver
COOWF@1.1:SetSelectedObjectsTerminated
COOWF@1.1:SetSelectedObjectsTerminatedDenied
COOWF@1.1:SetSkipped
COOWF@1.1:SetStartable
COOWF@1.1:SetStarted
COOWF@1.1:SetSubmission
COOWF@1.1:SetSuspended
COOWF@1.1:SetTakenOver
COOWF@1.1:SetTerminated
COOWF@1.1:SetTerminatedDenied
COOWF@1.1:ShowConcernedObjectsSelection
COOWF@1.1:ShowLongTermSuspended
COOWF@1.1:ShowOpenPersonalCollectionWastebasket
COOWF@1.1:ShowUsageListShow Related Prozesses
COOWF@1.1:ShowUsageListSelected
COOWF@1.1:StartProcessDefinition
COOWF@1.1:StartProcessDiagram
COOWF@1.1:StartSelectedObjectsWorkFlowProcess
COOWF@1.1:StartWorkFlow
COOWF@1.1:StartWorkFlowProcess
COOWF@1.1:StatisticSettings
COOWF@1.1:StoreReleasedWorkFlowDiagram
COOWF@1.1:UpdatePartMultipleContextInfos
COOWF@1.1:UpdatePrescriptions
COOWF@1.1:UserIsParticipant
COOWF@1.1:UserIsResponsible
COOWF@1.1:WorkListNavigate
COOWF@1.1:WorkflowCreateFolder

COOWF@1.1:ActivityInstanceGetPreviewCheckPropertyHook

ParameterTypeIn/OutOptionalDescription
venv_checkpropertyCOOSYSTEM@1.1:OBJECTin/out

Additional Information

ACL Object: COOSYSTEM@1.1:DefaultDeveloperACL
Private: true


[top]

COOWF@1.1:AddPrescription

Adds a prescription
ParameterTypeIn/OutOptionalDescription
prescriptionCOOWF@1.1:WorkFlowPrescriptionListin/out the prescription which should be added or modified
actionCOOWF@1.1:SavePresciptionActionTypein the option how the prescription should be modified
pblockidxCOOSYSTEM@1.1:INTEGERin/outtrue the index of the prescription block
pidxCOOSYSTEM@1.1:INTEGERin/outtrue the the index of the prescription in the prescription block
prescriptionblocksCOOWF@1.1:WorkFlowPrescriptionBlockListintrue the prescription block which should be added or modified

Additional Information

ACL Object: COOSYSTEM@1.1:DefaultDeveloperACL


[top]

COOWF@1.1:AllowChangeProcessState

Check if the current user is allowed to change the state of the process
ParameterTypeIn/OutOptionalDescription
statechangeableCOOSYSTEM@1.1:BOOLEANretval

Additional Information

ACL Object: COOSYSTEM@1.1:DefaultDeveloperACL
Secured: SECURED_READWRITE


[top]

COOWF@1.1:AllowDeleteUsedDiagram

ParameterTypeIn/OutOptionalDescription
usedbyCOOSYSTEM@1.1:OBJECTin
allowCOOSYSTEM@1.1:BOOLEANretval

Additional Information

ACL Object: COOSYSTEM@1.1:DefaultDeveloperACL
Private: true


[top]

COOWF@1.1:AmendSubstitutePermissions

Correct the permissions of substitutes when executing activities.
ParameterTypeIn/OutOptionalDescription
lockedCOOSYSTEM@1.1:BOOLEANintrue defines if the current object is already locked

Additional Information

ACL Object: COOSYSTEM@1.1:DefaultDeveloperACL


[top]

COOWF@1.1:ApplyProcessFolder

The process folder of the current BPMN 2.0 object will be applied to all of it's children
ParameterTypeIn/OutOptionalDescription
procfldrCOOSYSTEM@1.1:OBJECTin the process folder which should be applied
objsvisitedCOOSYSTEM@1.1:OBJECTLISTin/out the children which have already been checked

Additional Information

ACL Object: COOSYSTEM@1.1:DefaultDeveloperACL
Private: true


[top]

COOWF@1.1:AttachToProcess

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

Additional Information

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


[top]

COOWF@1.1:AttrActInstCopy

This action is used as property copy action for multiple properties of activity and wait actions instances. It is called by the kernel, when objects with these properties are copied.
It is used when properties of these classes have to be modified, when objects are copied, because they contain information that is relevant only, when an activity was already executed.

Additional Information

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


[top]

COOWF@1.1:AttrActInstInstanceGet

This action is used as property get action for the property COOWF@1.1:actinstinstance. 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:AttrActInstInstanceGetVersion

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

Additional Information

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


[top]

COOWF@1.1:AttrActInstNotificationParamsSet

Additional Information

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


[top]

COOWF@1.1:AttrActInstObjectGet

This action is used as property get action for the property COOWF@1.1:actinstobject. 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:AttrActInstObjectGetVersion

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

Additional Information

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


[top]

COOWF@1.1:AttrActInstObjectSet

This action is used as property set action for the property COOWF@1.1:actinstobject. It is called by the kernel, before that property is saved.

Additional Information

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


[top]

COOWF@1.1:AttrActInstObjectsGet

This action is used as property get action for the property COOWF@1.1:actinstobjects. 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:AttrActInstObjectsGetVersion

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

Additional Information

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


[top]

COOWF@1.1:AttrActInstSet

This action is used for must properties of COOWF@1.1:ActivityInstance and COOWF@1.1:WaitActionInstance. It is called by the kernel before these properties are saved. Most properties of activity instances, 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:AttrActInstStateSet

This action is used as property set action for the property COOWF@1.1:actinststate. It is called by the kernel, before that property is saved. During the execution of a process only certain state transitions are allowed. This action is used to check the changes of the state of an activity instance, if they are valid.

Additional Information

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


[top]

COOWF@1.1:AttrActInstStatisticGet

This action is used as property get action for the property COOWF@1.1:actinststatistic. 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:AttrActInstSubstUserGet

This action is used as property get action for the property COOWF@1.1:actinstsubstuser. 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:AttrActInstSubstUserGetVersion

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

Additional Information

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


[top]

COOWF@1.1:AttrBackLinkDefaultSet

This action is used as property set action for the property COOWF@1.1:domainbacklinkdefault of a current domain object. It is called by the kernel, before the value of that property is saved.

Additional Information

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


[top]

COOWF@1.1:AttrDefCaseNextDestructor

This action is used as property destructor action for the property COOWF@1.1:defcasenext. It is called by the kernel, when an object with that property is destroyed. When an element in a process definition or instance is destroyed automatically all successor elements are to be destroyed also.

Additional Information

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


[top]

COOWF@1.1:AttrDefGatewayNextDestructor

This action is used as property destructor action for the property COOWF@1.1:defgwnext. It is called by the kernel, when an object with that property is destroyed. When an element in a process definition or instance is destroyed automatically all successor elements are to be destroyed also.

Additional Information

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


[top]

COOWF@1.1:AttrDefRefObjClassesGet

This action is used as property get action for the property COOWF@1.1:defrefobjclasses. 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:AttrGetActinstworkDisp

This action is used as get display string action for all properties, that use the type for workflow worklist COOWF@1.1:WorkFlowWorkList. It is called by the kernel or other components, when the string representation of such a property is required.

Additional Information

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


[top]

COOWF@1.1:AttrGetCompoundParticipantDisp

This action is used as get display string action for all properties, that use the type for workflow compound participants COOWF@1.1:WorkFlowCompoundParticipant. It is called by the kernel or other components, when the string representation of such a property is required.

Additional Information

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


[top]

COOWF@1.1:AttrGetParticipantDisp

This action is used as get display string action for all properties, that use the type for workflow participants COOWF@1.1:WorkFlowParticipant. It is called by the kernel or other components, when the string representation of such a property is required.

Additional Information

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


[top]

COOWF@1.1:AttrGrAdditionalProcAdminsSet

Additional Information

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


[top]

COOWF@1.1:AttrGrCalcProcStatisticsSet

Additional Information

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


[top]

COOWF@1.1:AttrGrCalculateStatisticIntervalSet

Additional Information

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


[top]

COOWF@1.1:AttrGrCalculateStatisticsAtGet

Additional Information

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


[top]

COOWF@1.1:AttrGrCalculateStatisticsAtSet

Additional Information

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


[top]

COOWF@1.1:AttrGrWFPreferencesSet

Additional Information

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


[top]

COOWF@1.1:AttrInstCaseNextDestructor

This action is used as property destructor action for the property COOWF@1.1:instcasenext. It is called by the kernel, when an object with that property is destroyed. When an element in a process definition or instance is destroyed, automatically all successor elements are to be destroyed also.

Additional Information

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


[top]

COOWF@1.1:AttrInstConditionGet

This action is used as property get action for the property COOWF@1.1:instcondstr. It is called by the kernel, when that property is read. This action is used as migration path for the property COOWF@1.1:instcondition, which is not used any more.

Additional Information

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


[top]

COOWF@1.1:AttrInstConditionGetVersion

This action is used as property get version action for the property COOWF@1.1:instcondstr. It is called by the kernel, when that property is read for a version. This action is used as migration path for the property COOWF@1.1:instcondition, which is not used any more.

Additional Information

Prototype: COOSYSTEM@1.1:AttrGetVersionPrototype
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:AttrInstGatewayNextDestructor

This action is used as property destructor action for the property COOWF@1.1:instgwnext. It is called by the kernel, when an object with that property is destroyed. When an element in a process definition or instance is destroyed, automatically all successor elements are to be destroyed also.

Additional Information

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


[top]

COOWF@1.1:AttrLoadSharingScoreGet

This action is used as property get action for the property COOWF@1.1:userloadsharingscore. 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:AttrObjCanceledSetPreWrapper

ParameterTypeIn/OutOptionalDescription
attrdefCOOSYSTEM@1.1:OBJECTin/out
valuein/outtrue
oldvaluein/out

Additional Information

ACL Object: COOSYSTEM@1.1:DefaultDeveloperACL
Private: true


[top]

COOWF@1.1:AttrObjectDestructor

This action is used as property desctructor action for all object pointer properties, where the object pointed to should be destroyed, if the object is destroyed. It is called by the kernel, when an object with these properties is destroyed. When an element in a process definition or instance is destroyed, automatically all successor elements are to be destroyed also.

Additional Information

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


[top]

COOWF@1.1:AttrObjectListDestructor

This action is used as property desctructor action for all object list properties, where the objects pointed to should be destroyed, if the object is destroyed. It is called by the kernel, when an object with these properties is destroyed. When an element in a process definition or instance is destroyed, automatically all successor elements are to be destroyed also.

Additional Information

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


[top]

COOWF@1.1:AttrPrescriptionBlockConstructor

Create a new block in the prescription
ParameterTypeIn/OutOptionalDescription
attrdefCOOSYSTEM@1.1:OBJECTin
valueout
oldvaluesin

Additional Information

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


[top]

COOWF@1.1:AttrPrescriptionLineConstructor

Create a new line in the prescription
ParameterTypeIn/OutOptionalDescription
attrdefCOOSYSTEM@1.1:OBJECTin
valueout
oldvaluesin

Additional Information

Prototype: COOSYSTEM@1.1:AttrLineConstructorPrototype
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:AttrProcInstCopy

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:AttrProcInstParametersSet

Additional Information

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


[top]

COOWF@1.1:AttrProcInstSet

This action is used as property set action for most properties of COOWF@1.1:ProcessInstance. It is called by the kernel, before these properties are saved. During the execution of a process, only certain changes in a process instance 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:AttrProcInstStatisticGet

This action is used as property get action for the property COOWF@1.1:procinststatistic. 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:AttrProcInstUsersGet

This action is used as property get action for the property COOWF@1.1:procinstusers. 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:AttrProcInstWorkGet

This action is used as property get action for the property COOWF@1.1:procinstwork. 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:AttrProcStatisticChartGet

Additional Information

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


[top]

COOWF@1.1:AttrProcessListExpItemsGet

This action is used as property get action for the properties of a COOWF@1.1:ProcessList, that are used for the expired activities in the process instances in the process list. It is called by the kernel, when these properties are read.

Additional Information

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


[top]

COOWF@1.1:AttrProcessListExpItemsSet

This action is used as property set action for the properties of a COOWF@1.1:ProcessList, that are used for the expired activities in the process instances in the process list. It is called by the kernel, before these properties are saved.

Additional Information

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


[top]

COOWF@1.1:AttrProcessListItemsGet

This action is used as property get action for the property COOWF@1.1:proclistitems. 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:AttrProcessListItemsSet

This action is used as property set action for the property COOWF@1.1:proclistitems. It is called by the kernel, before that property is saved.

Additional Information

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


[top]

COOWF@1.1:AttrSetPendingList

This action is used as wrapper for the property set action of the property COOPENDING@1.1:pendinglist to check for activity instances, that are dropped in the pending box. It is called by the kernel as wrapper, before that property is saved.

Additional Information

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


[top]

COOWF@1.1:AttrStatisticsContainerSet

Additional Information

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


[top]

COOWF@1.1:AttrUseForClassGet

This action is used as property get action for the property COOWF@1.1:wfdforclass. 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:AttrUsrEnvNewActivityInformationGet

Additional Information

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


[top]

COOWF@1.1:AttrUsrEnvOpenNextActitiyGet

Additional Information

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


[top]

COOWF@1.1:AttrWFAllOutputsGet

Get action to collect all process outputs of the process folder

Additional Information

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


[top]

COOWF@1.1:AttrWFAllParticipantsGet

Get action to collect all participants of the process folder

Additional Information

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


[top]

COOWF@1.1:AttrWFAllProcessesGet

Get action to collect all diagrams of the process folder

Additional Information

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


[top]

COOWF@1.1:AttrWFAllReferencesGet

Get action to collect all references of the process folder

Additional Information

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


[top]

COOWF@1.1:AttrWFDiagramElementsSet

Set action called when the process output, subelements, participants or the references were changed. This action applies the process folder of the container on values

Additional Information

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


[top]

COOWF@1.1:AttrWFPartRelatedProcGet

Get action to retrieve all diagrams where the process participant is used

Additional Information

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


[top]

COOWF@1.1:AttrWFProcFldrOutputsSet

Set action called when the process output of a process folder was changed

Additional Information

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


[top]

COOWF@1.1:AttrWFProcFldrParticipantsSet

Set action called when the participants of a process folder were changed

Additional Information

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


[top]

COOWF@1.1:AttrWFProcFldrProcessesSet

Set action called when the subprocess of a process folder were changed

Additional Information

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


[top]

COOWF@1.1:AttrWFProcFldrReferencesSet

Set action called when the references of a process folder were changed

Additional Information

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


[top]

COOWF@1.1:AttrWFWasteBasketOutputsGet

Get action to collect all process outputs of the process folder

Additional Information

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


[top]

COOWF@1.1:AttrWFWasteBasketParticipantsGet

Get action to collect all process participants of the process folder

Additional Information

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


[top]

COOWF@1.1:AttrWFWasteBasketProcessesGet

Get action to collect all subprocess of the process folder

Additional Information

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


[top]

COOWF@1.1:AttrWfdTimeIntervalGet

Additional Information

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


[top]

COOWF@1.1:AttrWfdTimeIntervalSet

Additional Information

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


[top]

COOWF@1.1:AttrWfdTranslationsSet

Additional Information

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


[top]

COOWF@1.1:AttrWorkFlowConstructor

This action is used as property constructor action for the property COOWF@1.1:workflow. It is called by the kernel, when an object is created, that has this property assigned in its object class or that inherits this property.

Additional Information

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


[top]

COOWF@1.1:AttrWorkFlowCopy

This action is used as property copy action for the property COOWF@1.1:workflow. It is called by the kernel, when an object is copied, that has this property assigned in its object class or that inherits this property.

Additional Information

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


[top]

COOWF@1.1:AttrWorkFlowDeadLinesGet

This action is used as property get action for the property COOWF@1.1:workflowdeadlines. 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:AttrWorkFlowDelVersion

This action is used as property delete version action for the property COOWF@1.1:workflow. It is called by the kernel, when a version of the object is destroyed, that has this property assigned in its object class or that inherits this property.

Additional Information

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


[top]

COOWF@1.1:AttrWorkFlowFixVersion

This action is used as property fix version action for the property COOWF@1.1:workflow. It is called by the kernel, when a version is saved and a new version is created of an object, that has this property assigned in its object class or that inherits this property.

Additional Information

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


[top]

COOWF@1.1:AttrWorkFlowSet

This action is used as property set action for the property COOWF@1.1:workflow. It is called by the kernel, when that property is saved for an object, that has this property assigned in its object class or that inherits this property.

Additional Information

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


[top]

COOWF@1.1:AttrWorkFlowStatisticsDashboardUIFilter

Additional Information

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


[top]

COOWF@1.1:AttrWorkFlowSubstituteForGet

Additional Information

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


[top]

COOWF@1.1:AttrWorkListItemsGet

This action is used as property get action for the various lists of activities in COOWF@1.1:WorkList, that represent the different types of "To Do" lists. It is called by the kernel, when the value of such a property is read.

Additional Information

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


[top]

COOWF@1.1:AttrWorkListItemsSet

This action is used as property set action for the various lists of activities in COOWF@1.1:WorkList, that represent the different types of "To Do" lists. It is called by the kernel, before such a property is saved.

Additional Information

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


[top]

COOWF@1.1:AttrWorkListPreferencesUIFilter

Additional Information

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


[top]

COOWF@1.1:AttrWorkListStatisticsDashboardsGet

Additional Information

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


[top]

COOWF@1.1:AttrWorkListStatisticsGet

Additional Information

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


[top]

COOWF@1.1:AttrWorkListStatisticsUIFilter

Additional Information

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


[top]

COOWF@1.1:CalculateProcessStatistics

Calculate the process statistics for a group
ParameterTypeIn/OutOptionalDescription
separatetxCOOSYSTEM@1.1:BOOLEANin use a separate transaction to calculate the cache
processesCOOSYSTEM@1.1:OBJECTLISTintrue the processes for which the statistics should be calculated. If not processes were supplied the processes are calculated
useprogressCOOSYSTEM@1.1:BOOLEANintrue
backgroundCOOSYSTEM@1.1:BOOLEANintrue

Additional Information

ACL Object: COOSYSTEM@1.1:DefaultDeveloperACL


[top]

COOWF@1.1:CalculateSubtitutionDeadlineDates

ParameterTypeIn/OutOptionalDescription
startdateCOOSYSTEM@1.1:DATETIMEintrue
enddateCOOSYSTEM@1.1:DATETIMEintrue
substusersCOOSYSTEM@1.1:OBJECTLISTintrue

Additional Information

ACL Object: COOSYSTEM@1.1:DefaultDeveloperACL
Private: true


[top]

COOWF@1.1:CallObjectWorkItem

Calls the work item with the supplied index.
ParameterTypeIn/OutOptionalDescription
handleCOOSYSTEM@1.1:INTEGERintrue is no longer used
indexCOOSYSTEM@1.1:INTEGERintrue is no longer used
wfwindexCOOSYSTEM@1.1:INTEGERin the index of the work item
refreshCOOSYSTEM@1.1:BOOLEANout the refresh
remarkCOOSYSTEM@1.1:STRINGintrue the entered remark will be stored to the current activity instance.
remarkdefinedCOOSYSTEM@1.1:BOOLEANintrue determines if a remark is supplied
receivedatCOOSYSTEM@1.1:DATETIMEintrue the time stamp when the current activity was received. Only important for manual activities!
startedatCOOSYSTEM@1.1:DATETIMEintrue the time stamp when the activity was started
completedatCOOSYSTEM@1.1:DATETIMEintrue the time stamp when the activity was completed
workstartedatCOOSYSTEM@1.1:DATETIMEintrue the time stamp when the work item was executed
handledCOOSYSTEM@1.1:BOOLEANintrue if set the default implementation like executing the work item is not done

Additional Information

Prototype: COODESK@1.1:MenuActionPrototype
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:STRINGin 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
foundrecipientsCOOSYSTEM@1.1:OBJECTLISTout

Additional Information

ACL Object: COOSYSTEM@1.1:DefaultDeveloperACL
Private: true


[top]

COOWF@1.1:CallWorkItem

Calls an workitem from the menu

Additional Information

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


[top]

COOWF@1.1:CanBeUsedForSubProcessesOnly

Checks if the current workflow diagram is only usable as sub process
ParameterTypeIn/OutOptionalDescription
subprocessesonlyCOOSYSTEM@1.1:BOOLEANretval the result

Additional Information

ACL Object: COOSYSTEM@1.1:DefaultDeveloperACL


[top]

COOWF@1.1:CanChangeProcessState

Perform additional checks on the process object if the process state can be changed
ParameterTypeIn/OutOptionalDescription
procinstCOOSYSTEM@1.1:OBJECTin the process instance
statechangeableCOOSYSTEM@1.1:BOOLEANretval in/out the result

Additional Information

ACL Object: COOSYSTEM@1.1:DefaultDeveloperACL
Secured: SECURED_READWRITE


[top]

COOWF@1.1:CanDeleteWorkFlow

This action is called during COOWF@1.1:DeleteWorkFlow to check if the current user is allowed to delete a process instance.
ParameterTypeIn/OutOptionalDescription
candeleteCOOSYSTEM@1.1:BOOLEANretval the result
procinstCOOSYSTEM@1.1:OBJECTintrue the process instance which should be deleted

Additional Information

ACL Object: COOSYSTEM@1.1:DefaultDeveloperACL


[top]

COOWF@1.1:CanManageWorkFlowDiagrams

ParameterTypeIn/OutOptionalDescription
contextCOOSYSTEM@1.1:OBJECTin
silentCOOSYSTEM@1.1:BOOLEANintrue
canmanageCOOSYSTEM@1.1:BOOLEANretval

Additional Information

ACL Object: COOSYSTEM@1.1:DefaultDeveloperACL


[top]

COOWF@1.1:ChangeAppWorkFlowState

Action called when the user changes the activation state of the app AppWorkFlow

Additional Information

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


[top]

COOWF@1.1:ChangeResponsible

This action can be called to change the organizational element, that is responsible for the process instance. Except during delegation, the responsible for a process can only be changed by a person, that is responsible for the process or by a substitute of that person.
ParameterTypeIn/OutOptionalDescription
responsibleCOOWF@1.1:WorkFlowParticipantin The organizational element, that will be responsible.
respmansubstCOOWF@1.1:WorkFlowParticipantintrue If responsible specifies an organizational element outside of Fabasoft Components, the organizational element in Fabasoft Components that has to do the work.

Additional Information

ACL Object: COOSYSTEM@1.1:DefaultDeveloperACL


[top]

COOWF@1.1:CheckAction

This action is called to check, if and how one of the following workflow actions is usable in a Web environment: COODESK@1.1:OpenObject, COODESK@1.1:SelectTreeObject, COOATTREDIT@1.1:EditObjectAttributes, COOWF@1.1:SetStarted, COOWF@1.1:SetSuspended, COOWF@1.1:SetCompleted, COOWF@1.1:SetDelegated, COOWF@1.1:SetTerminated, COOWF@1.1:PrescribeObject and COOWF@1.1:CallObjectWorkItem.
This action returns, what questions must be asked, what date values have to be specified by the user, what applications have to be executed on behalf of executing work items.
ParameterTypeIn/OutOptionalDescription
actionCOOSYSTEM@1.1:OBJECTin One of the actions listed above.
indexCOOSYSTEM@1.1:INTEGERin/out The index of the work item to check, if the action is COOWF@1.1:CallObjectWorkItem. If not specified, the next not yet executed work item is searched, and the index is returned.
ignoreallCOOSYSTEM@1.1:BOOLEANout If set to True, the caller should ignore everything other and should not execute, what he intended to do.
asktostartCOOSYSTEM@1.1:BOOLEANout If set to True, the user should be asked, if he wants to start the activity instance. This has to be done, if the user agrees.
setstartedCOOSYSTEM@1.1:BOOLEANout If set to True, the activity instance has to be started in any case before continuing.
verifydatesCOOSYSTEM@1.1:BOOLEANout If set to True, the user should be asked to verify and change the date values, where default values are returned in the following parameters.
defreceivedatCOOSYSTEM@1.1:DATETIMEout The default value for "Received on/at".
defstartedatCOOSYSTEM@1.1:DATETIMEout The default value for "Started on/at".
defcompletedatCOOSYSTEM@1.1:DATETIMEout The default value for "Completed on/at".
askquestionCOOSYSTEM@1.1:STRINGouttrue If defined, ask the user this question.
applicationsCOOSYSTEM@1.1:OBJECTLISTouttrue On behalf of executing work items execute the applications returned in this list on the corresponding objects in applobjects. Only valid, if the action is COOWF@1.1:CallObjectWorkItem.
applobjectsCOOSYSTEM@1.1:OBJECTLISTouttrue The corresponding objects for the list in applications. Only valid, if the action is COOWF@1.1:CallObjectWorkItem.
workstartedatCOOSYSTEM@1.1:DATETIMEouttrue The value of this parameter has to be passed to the following call of COOWF@1.1:CallObjectWorkItem. The applications returned in applications have to be executed before that call.
selobjectsCOOSYSTEM@1.1:OBJECTLISTintrue The selected objects
setsubstituteCOOSYSTEM@1.1:BOOLEANouttrue The the current user is a substitute and the workitem can be executed as substitute
skippermlockcheckCOOSYSTEM@1.1:BOOLEANintrue The check for permanent locks should be skipped

Additional Information

ACL Object: COOSYSTEM@1.1:DefaultDeveloperACL


[top]

COOWF@1.1:CheckActive

This action checks if the current group or user is active. In case of users the action checks if the user has licensed the app COOWF@1.1:AppWorkFlow. If the license is not valid the action returns with an error
ParameterTypeIn/OutOptionalDescription
activeCOOSYSTEM@1.1:BOOLEANretval The parameter return if the object is active. If the license check is performed and retrieves error the parameter active will remain empty.
checkapplicenseCOOSYSTEM@1.1:BOOLEANintrue if the parameter is set the license check is performed or skipped. If the parameter is not set the workflow config is asked if the license check should be performed.
contextCOOSYSTEM@1.1:OBJECTintrue

Additional Information

ACL Object: COOSYSTEM@1.1:DefaultDeveloperACL


[top]

COOWF@1.1:CheckAdditionalParticipantRestrictions

If the process has additional participant restrictions the participants will be filtered by this action
ParameterTypeIn/OutOptionalDescription
participantsCOOSYSTEM@1.1:OBJECTLISTretval in/out

Additional Information

ACL Object: COOSYSTEM@1.1:DefaultDeveloperACL


[top]

COOWF@1.1:CheckAffiliationWithWorkFlowPermissions

Check if the supplied user would have access to the current object if the user or group would be stored in the properties COOWF@1.1:workflowusers, COOWF@1.1:workflowgroups or COOWF@1.1:workflowroleusers.
ParameterTypeIn/OutOptionalDescription
targetuserCOOSYSTEM@1.1:OBJECTin the user the access is checked for
targetgroupCOOSYSTEM@1.1:OBJECTin the group which should be added to COOWF@1.1:workflowgroups for access check reasons.
secclearanceCOOSYSTEM@1.1:OBJECTintrue the security clearance of the user
hasaccessCOOSYSTEM@1.1:BOOLEANretval the result
accesstypesCOOSYSTEM@1.1:OBJECTLISTintrue the required access types. If no access type is supplied the COOSYSTEM@1.1:AccTypeRead is used.

Additional Information

ACL Object: COOSYSTEM@1.1:DefaultDeveloperACL
Private: true


[top]

COOWF@1.1:CheckAllowedActions

Checks which workflow actions are allowed for the current object
ParameterTypeIn/OutOptionalDescription
actionsCOOSYSTEM@1.1:OBJECTLISTin/out the actions

Additional Information

ACL Object: COOSYSTEM@1.1:DefaultDeveloperACL


[top]

COOWF@1.1:CheckAllowedElements

This action is called by the process editor to check, which types of elements are allowed to be created by the user on the fly in a process instance. It is intended to by overwritten or wrapped by software components, that want to restrict the ability of the end user to manipulate process instances.
ParameterTypeIn/OutOptionalDescription
objclassesCOOSYSTEM@1.1:OBJECTLISTin/out On input, the list of object classes of the elements, that can be created in a process instance. On output, the list of object classes of the elements actually offered to the user.

Additional Information

ACL Object: COOSYSTEM@1.1:DefaultDeveloperACL


[top]

COOWF@1.1:CheckAutoComplete

Checks if the process can be completed automatically
ParameterTypeIn/OutOptionalDescription
autocompleteCOOSYSTEM@1.1:BOOLEANretval the result value

Additional Information

ACL Object: COOSYSTEM@1.1:DefaultDeveloperACL


[top]

COOWF@1.1:CheckBPMNProcessParticipants

ParameterTypeIn/OutOptionalDescription
processobjCOOSYSTEM@1.1:OBJECTin
invaffiliatonpartsCOOWF@1.1:WorkFlowPartAccessMappingretval
skipdisplaywithaccesspartsCOOSYSTEM@1.1:BOOLEANintrue
workflowsubstitutioninfosCOOSYSTEM@1.1:DICTIONARYout
skipignoreinvpartactivitiesCOOSYSTEM@1.1:BOOLEANintrue
forcereferenceddraftversionCOOSYSTEM@1.1:BOOLEANintrue

Additional Information

ACL Object: COOSYSTEM@1.1:DefaultDeveloperACL
Private: true


[top]

COOWF@1.1:CheckBackgroundWork

This action is used in the task list of the Fabasoft Components/AT service, that is used to executed background activities. A task, that calls this action every two minutes, is automatically created, when a Fabasoft Components/AT service is used and this software component is installed.

Additional Information

ACL Object: COOSYSTEM@1.1:DefaultDeveloperACL


[top]

COOWF@1.1:CheckConditionalWaitAction

Additional Information

ACL Object: COOSYSTEM@1.1:DefaultDeveloperACL
Private: true


[top]

COOWF@1.1:CheckCopy

This action is called on every process instance attached to an object, when that object is copied. It is used to check, if that process instance should be copied also, and the copied process instance should be attached to the copy of the object.
ParameterTypeIn/OutOptionalDescription
copyableCOOSYSTEM@1.1:BOOLEANretval If set to True, the process instance is copied and attached to the copy of the object.

Additional Information

ACL Object: COOSYSTEM@1.1:DefaultDeveloperACL


[top]

COOWF@1.1:CheckDatesForm

This action is used to check the user input if the supplied dates are holidays.
ParameterTypeIn/OutOptionalDescription
actionCOOSYSTEM@1.1:OBJECTin
attrdefCOOSYSTEM@1.1:OBJECTouttrue
askquestionCOOSYSTEM@1.1:STRINGouttrue
needplaintexterrorsCOOSYSTEM@1.1:BOOLEANintrue

Additional Information

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


[top]

COOWF@1.1:CheckDelegateForm

This action is used to check the user input when modifying the responsible of an activity.
ParameterTypeIn/OutOptionalDescription
actionCOOSYSTEM@1.1:OBJECTin
attrdefCOOSYSTEM@1.1:OBJECTouttrue
askquestionCOOSYSTEM@1.1:STRINGouttrue
affiliationusableCOOSYSTEM@1.1:BOOLEANouttrue
needplaintexterrorsCOOSYSTEM@1.1:BOOLEANintrue
workflowsubstitutioninfosCOOSYSTEM@1.1:DICTIONARYout
invaffiliationpartsCOOWF@1.1:WorkFlowPartAccessMappingout

Additional Information

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


[top]

COOWF@1.1:CheckDelegateMultipleForm

This action is used to check the user input when modifying the responsible of an activity.
ParameterTypeIn/OutOptionalDescription
actionCOOSYSTEM@1.1:OBJECTin
attrdefCOOSYSTEM@1.1:OBJECTouttrue
askquestionCOOSYSTEM@1.1:STRINGouttrue
affiliationusableCOOSYSTEM@1.1:BOOLEANouttrue
needplaintexterrorsCOOSYSTEM@1.1:BOOLEANintrue
workflowsubstitutioninfosCOOSYSTEM@1.1:DICTIONARYout
invaffiliationpartsCOOWF@1.1:WorkFlowPartAccessMappingout

Additional Information

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


[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:CheckExpiredActivities

This action can be used in a task for the Fabasoft Components/AT service to check periodically for expired activities. A task for that action is not created automatically as for the action COOWF@1.1:CheckBackgroundWork, it has to be done by a system administrator. You can copy the task created for the action COOWF@1.1:CheckBackgroundWork and change the action to do that.
ParameterTypeIn/OutOptionalDescription
escalationerrorsCOOSYSTEM@1.1:STRINGretval errors ocurred during escalations

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:OBJECTin
attrdefCOOSYSTEM@1.1:OBJECTouttrue
askquestionCOOSYSTEM@1.1:STRINGouttrue
invaffiliatonpartsCOOWF@1.1:WorkFlowPartAccessMappingout
needplaintexterrorsCOOSYSTEM@1.1:BOOLEANintrue

Additional Information

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


[top]

COOWF@1.1:CheckInsertTemplate

Check a prescription template can be inserted at the current position
ParameterTypeIn/OutOptionalDescription
pblockidxCOOSYSTEM@1.1:INTEGERin the index of the precription block
pidxCOOSYSTEM@1.1:INTEGERin the index of the prescription in the prescription block
allowedCOOSYSTEM@1.1:BOOLEANretval the result

Additional Information

ACL Object: COOSYSTEM@1.1:DefaultDeveloperACL


[top]

COOWF@1.1:CheckLongTermActivities

This action can be used in a task for the Fabasoft Components/AT service to check periodically for expiring submissions of long term suspended activities. A task for that action is not created automatically as for the action COOWF@1.1:CheckBackgroundWork, it has to be done by a system administrator. You can copy the task created for the action COOWF@1.1:CheckBackgroundWork and change the action to do that.

Additional Information

ACL Object: COOSYSTEM@1.1:DefaultDeveloperACL


[top]

COOWF@1.1:CheckParticipant

Check if the supplied participant is a valid workflow participant
ParameterTypeIn/OutOptionalDescription
participantCOOWF@1.1:WorkFlowParticipantin the participant which should be checked
partmansubstCOOWF@1.1:WorkFlowParticipantintrue the manual participant which should be checked
metaallowedCOOSYSTEM@1.1:BOOLEANintrue the parameter defines if meta participants are allowed
askquestionCOOSYSTEM@1.1:STRINGouttrue the question which is displayed to the uses to decide if he wants to use the participant which the displayed warnings (plain text)
acttypeCOOWF@1.1:ActivityTypeintrue the activity type of the activity instance
errortextCOOSYSTEM@1.1:STRINGouttrue the question which is displayed to the uses to decide if he wants to use the participant which the displayed warnings (html)
enforcepartcheckCOOSYSTEM@1.1:BOOLEANintrue the warnings are treated as errors
remembercheckedparticipantsCOOSYSTEM@1.1:BOOLEANintrue already checked participants are skipped
checkactivesubstitutionCOOSYSTEM@1.1:BOOLEANintrue the substitution check can be enabled or disabled
affiliationusableCOOSYSTEM@1.1:BOOLEANouttrue the participant is allowed by affilation checks
needplaintexterrorsCOOSYSTEM@1.1:BOOLEANintrue the errortext and askquestion will be returned as plain text
separatesubstitutioncheckCOOSYSTEM@1.1:BOOLEANintrue the errors concerning participant abscense are not contained in the errortext the parameters of the substitution are returned in the dictionary workflowsubstitutioninfos
workflowsubstitutioninfosCOOSYSTEM@1.1:DICTIONARYout the infos about the substitution
skipdisplaywithaccesspartsCOOSYSTEM@1.1:BOOLEANintrue if defined only one member of the group of the participant needs access to the object

Additional Information

ACL Object: COOSYSTEM@1.1:DefaultDeveloperACL


[top]

COOWF@1.1:CheckParticipantAffiliation

This action is used as hook to perform additional checks if supplied the participant is valid for the current process. The action is currently called when the integrity of the participant is checked.
ParameterTypeIn/OutOptionalDescription
participantCOOWF@1.1:WorkFlowParticipantin The participant which should be checked.
actinstCOOSYSTEM@1.1:OBJECTin The current activity of the current process.
usableparticipantCOOSYSTEM@1.1:BOOLEANretval The participant can be used and the action does not need to throw an error message
skipdisplaywithaccesspartsCOOSYSTEM@1.1:BOOLEANintrue the current activity should be displayed only for participants with access permissions
requiredaccesstypesCOOSYSTEM@1.1:OBJECTLISTintrue the access types which should be checked to execute the activity

Additional Information

ACL Object: COOSYSTEM@1.1:DefaultDeveloperACL


[top]

COOWF@1.1:CheckParticipantRules

This action is intended to do additional validation checks for a participant, when a participant is entered for example in the prescription or delegation form.

The additional rule checks will be evaluated after the roles of the participant and active users and groups have been checked. After the rule checks is performed the participant will be checked for active substitutions and access of to the object of the process.

The action is called in several actions where participant input validation is performed.
Caller Actions:
ParameterTypeIn/OutOptionalDescription
partCOOWF@1.1:WorkFlowParticipantin the participant which should be checked
processelementCOOSYSTEM@1.1:OBJECTintrue the process element for which the participant check is performed. (e.g.: ActivityInstance, ProcessInstance, ActivityDefinition, ProcessDefinition, WorkFlowDiagram)
acttypeCOOWF@1.1:ActivityTypeintrue the type of the activity

Additional Information

ACL Object: COOSYSTEM@1.1:DefaultDeveloperACL


[top]

COOWF@1.1:CheckPrescriptionsForm

This action is used to check the user input when doing prescriptions to other users, 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:OBJECTin
attrdefCOOSYSTEM@1.1:OBJECTouttrue
askquestionCOOSYSTEM@1.1:STRINGouttrue
invaffiliatonpartsCOOWF@1.1:WorkFlowPartAccessMappingout
needplaintexterrorsCOOSYSTEM@1.1:BOOLEANintrue
prescriptionsCOOWF@1.1:WorkFlowPrescriptionListintrue
prescriptionblocksCOOWF@1.1:WorkFlowPrescriptionBlockListintrue
workflowsubstitutioninfosCOOSYSTEM@1.1:DICTIONARYout

Additional Information

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


[top]

COOWF@1.1:CheckReferencedDiagramExecutionRestriction

Check if the execution restrictions of the current diagram can be used in context of the referencing diagrams
ParameterTypeIn/OutOptionalDescription
allowedCOOSYSTEM@1.1:BOOLEANretval the current restrictions are allowed in context of the superior processes
restrictionconflictsCOOSYSTEM@1.1:OBJECTLISTouttrue the superior processes where execution restrictions exist

Additional Information

ACL Object: COOSYSTEM@1.1:DefaultDeveloperACL


[top]

COOWF@1.1:CheckReleaseReferencedDiagrams

Check if the current workflow diagram has referenced workflow diagrams and if it is required to release the referenced diagrams to release the current diagram
ParameterTypeIn/OutOptionalDescription
hasrefdiagramsCOOSYSTEM@1.1:BOOLEANretval the current workflow diagram has referenced diagrams which have a newer draft version than the released version
isreleasepossibleCOOSYSTEM@1.1:BOOLEANout it is possible to release the current diagram because all referenced diagrams have already been released or the user is able to rerelease the referenced diagrams.
notreleaseablediagramsCOOSYSTEM@1.1:OBJECTLISTout this diagrams can not be released by the current user
requireddiagramsCOOSYSTEM@1.1:OBJECTLISTout this diagrams are required to be released to release the diagram

Additional Information

ACL Object: COOSYSTEM@1.1:DefaultDeveloperACL


[top]

COOWF@1.1:CheckRemoveOrgElements

Retrieve the configuration setting if the users and groups with permissions on the activity are removed after completion.
ParameterTypeIn/OutOptionalDescription
orgsecurityCOOWF@1.1:WorkFlowOrgSecurityretval the configuration how the permissions are handled after completion

Additional Information

ACL Object: COOSYSTEM@1.1:DefaultDeveloperACL


[top]

COOWF@1.1:CheckRetracted

Checks if an activity instance can be retracted
ParameterTypeIn/OutOptionalDescription
allowedCOOSYSTEM@1.1:BOOLEANretval the retraction of the activity instances is allowed

Additional Information

ACL Object: COOSYSTEM@1.1:DefaultDeveloperACL


[top]

COOWF@1.1:CheckSimplePrescriptionsForm

Check the entered values in the simple prescription editor
ParameterTypeIn/OutOptionalDescription
actionCOOSYSTEM@1.1:OBJECTin
attrdefCOOSYSTEM@1.1:OBJECTouttrue
askquestionCOOSYSTEM@1.1:STRINGouttrue
invaffiliatonpartsCOOWF@1.1:WorkFlowPartAccessMappingout
needplaintexterrorsCOOSYSTEM@1.1:BOOLEANintrue
prescriptionCOOWF@1.1:WorkFlowPrescriptionListintrue
prescriptionblocksCOOWF@1.1:WorkFlowPrescriptionBlockListintrue
workflowsubstitutioninfosCOOSYSTEM@1.1:DICTIONARYout

Additional Information

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


[top]

COOWF@1.1:CheckStart

Checks if the process instance will be started automatically.
ParameterTypeIn/OutOptionalDescription
startableCOOSYSTEM@1.1:BOOLEANretval the result value

Additional Information

ACL Object: COOSYSTEM@1.1:DefaultDeveloperACL


[top]

COOWF@1.1:CheckSubmissionRepetitionPeriod

Check the submission period
ParameterTypeIn/OutOptionalDescription
repetitionperiodCOOWF@1.1:SubmissionRepetitionPeriodin the repetitionperiod
checkresultCOOSYSTEM@1.1:STRINGout the checkresult
errorCOOSYSTEM@1.1:BOOLEANout the error
askquestionCOOSYSTEM@1.1:STRINGout the question displayed in the user interface

Additional Information

ACL Object: COOSYSTEM@1.1:DefaultDeveloperACL


[top]

COOWF@1.1:CheckTakenOver

Checks if the activity instance can be taken over.
ParameterTypeIn/OutOptionalDescription
allowedCOOSYSTEM@1.1:BOOLEANretval the allowed

Additional Information

ACL Object: COOSYSTEM@1.1:DefaultDeveloperACL


[top]

COOWF@1.1:CheckWorkDay

Checks if the supplied date is a vaild work day
ParameterTypeIn/OutOptionalDescription
checkdateCOOSYSTEM@1.1:DATETIMEin the checkdate
checkpastCOOSYSTEM@1.1:BOOLEANintrue the checkpast

Additional Information

ACL Object: COOSYSTEM@1.1:DefaultDeveloperACL


[top]

COOWF@1.1:CheckWorkFlowAppLicense

Check if the app workflow is licensed for the current user
ParameterTypeIn/OutOptionalDescription
disableerrorappsCOOSYSTEM@1.1:BOOLEANintrue
silentmodeCOOSYSTEM@1.1:BOOLEANintrue
haslicenseCOOSYSTEM@1.1:BOOLEANretval

Additional Information

ACL Object: COOSYSTEM@1.1:DefaultDeveloperACL


[top]

COOWF@1.1:CheckWorkList (Check Worklist)

This action is used as timer action to check periodically, if new items have arrived in the work list and to notify the user, if he has configured interest in the some or all item lists of the work list. If a user logs in and this software component is installed, an entry in the list of timers for this user is created automatically, that checks periodically, if the user has configured interest on the work list, and that checks, if new items have arrived. The default period is 5 minutes, this can be changed by modifying the entry in the user timer object directly.

Additional Information

ACL Object: COOSYSTEM@1.1:DefaultDeveloperACL


[top]

COOWF@1.1:ChooseProcessDefinition

Selected action for InitializeWorkFlow
ParameterTypeIn/OutOptionalDescription
handleCOOSYSTEM@1.1:INTEGERintrue is no longer used
indexCOOSYSTEM@1.1:INTEGERintrue is no longer used

Additional Information

Call Mode for Actions on Selected Objects: CALLMODE_SELECTEDONLY
Called Action on Selected Objects: COOWF@1.1:InitializeWorkFlow
Prototype: COODESK@1.1:MenuActionPrototype
ACL Object: COOSYSTEM@1.1:DefaultDeveloperACL


[top]

COOWF@1.1:ClearProcessParameters

Action clear process parameters for a specified process. This action fails for users with are no participant of the process or have no access on the object of the process.
ParameterTypeIn/OutOptionalDescription
separatetxCOOSYSTEM@1.1:BOOLEANintrue the changes are stored in a separate transaction and directly saved

Additional Information

ACL Object: COOSYSTEM@1.1:DefaultDeveloperACL
Secured: SECURED_READWRITE


[top]

COOWF@1.1:CollectFolderItems

Recursive collect all children of the folder
ParameterTypeIn/OutOptionalDescription
foldersvisitedCOOSYSTEM@1.1:OBJECTLISTin/out the objects which have already been checked
propertyCOOSYSTEM@1.1:OBJECTintrue the property where the children are located
itemsCOOSYSTEM@1.1:OBJECTLISTretval the collected children.

Additional Information

ACL Object: COOSYSTEM@1.1:DefaultDeveloperACL
Private: true


[top]

COOWF@1.1:ComputeDeadLine

This action is called during the execution of a process instance, when an activity reaches the state ACTINST_STARTABLE, to compute the various deadlines for submission, start and completion of the activity. This action can be wrapped or overwritten to apply different rules for computing deadlines. The computed deadline is stored in the specified property.
ParameterTypeIn/OutOptionalDescription
attrdefCOOSYSTEM@1.1:OBJECTin The deadline property that has to be computed. Must be one of COOWF@1.1:actinstsubmitdeadline, COOWF@1.1:actinststartdeadline or COOWF@1.1:actinstenddeadline.

Additional Information

ACL Object: COOSYSTEM@1.1:DefaultDeveloperACL


[top]

COOWF@1.1:ConfirmStart

This action is called during the execution of a process instance in several situations, to confirm if an activity instance, that is not yet started, but that needs to be started to continue, should be set to the state ACTINST_STARTED now. The action can decide depending on the context, if it should be started in any case, or it can ask the user, if the activity should be started.
ParameterTypeIn/OutOptionalDescription
parenthandleCOOSYSTEM@1.1:INTEGERin The handle of the parent window that can be used as parents for dialogs in the user interface.
contextCOOSYSTEM@1.1:OBJECTin The action object of the context, where this action is called.
yesCOOSYSTEM@1.1:BOOLEANretval If set to True, the activity will be started, and the caller will continue to execute its method. If set to False, the activity is not started. Depending if the caller requires a started activity instance (e.g. when executing a work item) or a started activity instance is not required (e.g. when viewing the process) the caller will continue to execute its method or not.

Additional Information

ACL Object: COOSYSTEM@1.1:DefaultDeveloperACL


[top]

COOWF@1.1:ConvertDateToWorkDays

Converts the distance between two dates into workdays.
ParameterTypeIn/OutOptionalDescription
startdateCOOSYSTEM@1.1:DATETIMEin the startdate
enddateCOOSYSTEM@1.1:DATETIMEin the enddate
workdaysCOOSYSTEM@1.1:INTEGERretval the distrance between the start and enddate in workdays

Additional Information

ACL Object: COOSYSTEM@1.1:DefaultDeveloperACL


[top]

COOWF@1.1:ConvertPrescription

ParameterTypeIn/OutOptionalDescription
needsingleCOOSYSTEM@1.1:BOOLEANin
prescrlistCOOWF@1.1:WorkFlowPrescriptionListin/outtrue
lastusedactdefCOOSYSTEM@1.1:OBJECTintrue

Additional Information

ACL Object: COOSYSTEM@1.1:DefaultDeveloperACL
Private: true


[top]

COOWF@1.1:ConvertWorkDaysToDate

Converts the startdate and the defined amount of workdays to the enddate.
ParameterTypeIn/OutOptionalDescription
startdateCOOSYSTEM@1.1:DATETIMEin the startdate
workdaysCOOSYSTEM@1.1:INTEGERin the workdays
enddateCOOSYSTEM@1.1:DATETIMEretval the enddate

Additional Information

ACL Object: COOSYSTEM@1.1:DefaultDeveloperACL


[top]

COOWF@1.1:CopyWorkFlowObject

This action should be called, if an object used in process instances is copied. It uses the defined affinity for workflow objects of the current domain (COOWF@1.1:domainworkflowaffinity) to modify the placement of the copied object as desired.
ParameterTypeIn/OutOptionalDescription
refobjectCOOSYSTEM@1.1:OBJECTin The object used in the computation of the affinity. This can be the process instance, where the copy of the object will be inserted or the object that has this process instance attached.
resultobjectCOOSYSTEM@1.1:OBJECTretval The copied object.

Additional Information

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


[top]

COOWF@1.1:CreateProcessInstance

Creates a process instance for the current object
ParameterTypeIn/OutOptionalDescription
procinstCOOSYSTEM@1.1:OBJECTretval the created process instance

Additional Information

ACL Object: COOSYSTEM@1.1:DefaultDeveloperACL


[top]

COOWF@1.1:CreateProcessOutput

Creates a new process output

Additional Information

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


[top]

COOWF@1.1:CreateProcessParticipant

Creates a new process participant

Additional Information

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


[top]

COOWF@1.1:CreateProcessStatisticsCache

Create a process statistics cache for a group
ParameterTypeIn/OutOptionalDescription
processdefinitionCOOSYSTEM@1.1:OBJECTin the process definition or BPMN diagram object
cacheCOOSYSTEM@1.1:OBJECTretval the created cache object

Additional Information

ACL Object: COOSYSTEM@1.1:DefaultDeveloperACL


[top]

COOWF@1.1:CreateStatisticsDashboard

ParameterTypeIn/OutOptionalDescription
typeCOOWF@1.1:WorkFlowStatisticsTypein
contextCOOSYSTEM@1.1:OBJECTintrue
parentdashboardCOOSYSTEM@1.1:OBJECTintrue
dashboardCOOSYSTEM@1.1:OBJECTretval

Additional Information

ACL Object: COOSYSTEM@1.1:DefaultDeveloperACL
Private: true


[top]

COOWF@1.1:CreateWorkFlowDiagram

Creates a new process diagram

Additional Information

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


[top]

COOWF@1.1:CreateWorkFlowObject

This action should be called, if an object used in process instances is created. It uses the defined affinity for workflow objects of the current domain (COOWF@1.1:domainworkflowaffinity) to modify the placement of the created object as desired.
ParameterTypeIn/OutOptionalDescription
refobjectCOOSYSTEM@1.1:OBJECTin The object used in the computation of the affinity. This can be the process instance, where the new object will be inserted or the object that has this process instance attached.
objCOOSYSTEM@1.1:OBJECTretval
separatetxCOOSYSTEM@1.1:BOOLEANintrue the create operation will be performed in a separate transaction and automatically commited

Additional Information

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


[top]

COOWF@1.1:CreateWorkFlowPreferences

Creates a workflow preference object
ParameterTypeIn/OutOptionalDescription
separatetransactionCOOSYSTEM@1.1:BOOLEANin the object will be created in a separate transaction
wfprefsCOOSYSTEM@1.1:OBJECTretval the created object

Additional Information

ACL Object: COOSYSTEM@1.1:DefaultDeveloperACL
Private: true


[top]

COOWF@1.1:DeadlineStartProcessDiagram

This action is used to start the designed process of a released workflow diagram for the current object. The supplied workflow diagram must be released and executeable for the current object.
ParameterTypeIn/OutOptionalDescription
diagramCOOSYSTEM@1.1:OBJECTin the released version of the supplied diagram which fits to the current user will be initialized for the current object
silentCOOSYSTEM@1.1:BOOLEANintrue do not raise errors
onbehalfofCOOSYSTEM@1.1:OBJECTintrue
procinstCOOSYSTEM@1.1:OBJECTretval
partmappingCOOWF@1.1:WorkFlowParticipantMappingintrue the supplied mapping is used to replace the participants defined in the process diagram when the activities are created.
expandsubCOOSYSTEM@1.1:BOOLEANintrue If set to True, all subprocesses contained in the supplied process diagram are expanded directly when the process is started
processparamsCOOSYSTEM@1.1:DICTIONARYintrue if defined the process parameters are merged into the process parameters of the process diagram
considereroomcontextCOOSYSTEM@1.1:BOOLEANintrue if set the room restrictions will be considered when calculating diagrams

Additional Information

Access Types: COOWF@1.1:AccTypeChangeWorkFlow
ACL Object: COOSYSTEM@1.1:DefaultDeveloperACL
Private: true


[top]

COOWF@1.1:DefineWFSubstitutes

Use case to the define the current users substitutions

Additional Information

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


[top]

COOWF@1.1:DelegateActivityHook

Hook action called on the object of the process during COOWF@1.1:SetDelegate before the participant of the activity is changed
ParameterTypeIn/OutOptionalDescription
participantCOOWF@1.1:WorkFlowParticipantretval in/out the participant
partmansubstCOOWF@1.1:WorkFlowParticipantin/outtrue the substitute of a manual participant
activityCOOSYSTEM@1.1:OBJECTin the activity which should be delegated
processCOOSYSTEM@1.1:OBJECTin the process instance the activity is assigned to.

Additional Information

ACL Object: COOSYSTEM@1.1:DefaultDeveloperACL


[top]

COOWF@1.1:DelegateActivityMultipleHook

Hook action called on the object of the process during COOWF@1.1:SetDelegateMultiple before the participant of the activity is changed
ParameterTypeIn/OutOptionalDescription
participantsCOOWF@1.1:PrescriptionMetaDataWhoretval in/out the participants who should get the activity of the current user additionally
activityCOOSYSTEM@1.1:OBJECTin the activity which should be delegated to multiple participants
processCOOSYSTEM@1.1:OBJECTin the process instance the activity is assigned to.

Additional Information

ACL Object: COOSYSTEM@1.1:DefaultDeveloperACL


[top]

COOWF@1.1:DeleteObjectPostWrapper

ParameterTypeIn/OutOptionalDescription
handleCOOSYSTEM@1.1:INTEGERintrue
indexCOOSYSTEM@1.1:INTEGERintrue
ownerCOOSYSTEM@1.1:OBJECTintrue
aclCOOSYSTEM@1.1:OBJECTintrue
viewCOOSYSTEM@1.1:OBJECTintrue
sourceCOOSYSTEM@1.1:OBJECTintrue

Additional Information

ACL Object: COOSYSTEM@1.1:DefaultDeveloperACL
Private: true


[top]

COOWF@1.1:DeleteSelectedObjectsWorkFlow

Selected action for DeleteWorkFlow
ParameterTypeIn/OutOptionalDescription
handleCOOSYSTEM@1.1:INTEGERintrue is no longer used
indexCOOSYSTEM@1.1:INTEGERintrue is no longer used

Additional Information

Call Mode for Actions on Selected Objects: CALLMODE_SELECTEDONLY
Called Action on Selected Objects: COOWF@1.1:DeleteWorkFlow
Prototype: COODESK@1.1:MenuActionPrototype
ACL Object: COOSYSTEM@1.1:DefaultDeveloperACL


[top]

COOWF@1.1:DeleteWasteBasketObjects

Delete objects in a process folder wastebasket

Additional Information

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


[top]

COOWF@1.1:DeleteWasteBasketObjectsSelected

Additional Information

Call Mode for Actions on Selected Objects: CALLMODE_SELECTEDONLY
Called Action on Selected Objects: COOWF@1.1:DeleteWasteBasketObjects
Prototype: COODESK@1.1:MenuActionPrototype
ACL Object: COOSYSTEM@1.1:DefaultDeveloperACL


[top]

COOWF@1.1:DeleteWorkFlow

This action can be called to delete the specified process instances attached to the object. If no process is specified, all process instances attached to the object are destroyed.
In general, process instances can only be destroyed, if they are executed completely, or if the object they are attached to is destroyed also.
ParameterTypeIn/OutOptionalDescription
procinstsCOOSYSTEM@1.1:OBJECTLISTintrue Process instances that should be deleted. If empty, all process instances attached to the object are deleted.

Additional Information

Access Types: COOWF@1.1:AccTypeChangeWorkFlow
ACL Object: COOSYSTEM@1.1:DefaultDeveloperACL


[top]

COOWF@1.1:DeleteWorkFlowDiagram

Delete the work flow diagram including its released versions.

Additional Information

Prototype: COODESK@1.1:MenuActionPrototype
Access Types: COOSYSTEM@1.1:AccTypeDelete
ACL Object: COOSYSTEM@1.1:DefaultDeveloperACL


[top]

COOWF@1.1:DeleteWorkFlowDiagramSelected

Additional Information

Call Mode for Actions on Selected Objects: CALLMODE_SELECTEDONLY
Called Action on Selected Objects: COOWF@1.1:DeleteWorkFlowDiagram
Prototype: COODESK@1.1:MenuActionPrototype
ACL Object: COOSYSTEM@1.1:DefaultDeveloperACL


[top]

COOWF@1.1:DeleteWorkFlowObject

This action should be called, to delete instance elements in process instances. The deleted elements will be stored in property COOWF@1.1:procinstdeleted of the process instance.
ParameterTypeIn/OutOptionalDescription
separatetxCOOSYSTEM@1.1:BOOLEANintrue the delete operation will be performed in a separate transaction and automatically commited

Additional Information

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


[top]

COOWF@1.1:DeskLoggedIn

This action is used as a post wrapper for the action COODESK@1.1:LoggedIn to initialize the timer, that periodically checks the work list for new items, if the user has configured interest in all or some parts of the work list. It is called by the Fabasoft Components desk, after the user has successfully logged in.

Additional Information

ACL Object: COOSYSTEM@1.1:DefaultDeveloperACL


[top]

COOWF@1.1:DisplayActionsInWorkflowTaskPane

This action is defined as hook action to display the context menu actions in the task pane of an activity instance
ParameterTypeIn/OutOptionalDescription
displayactionsCOOSYSTEM@1.1:BOOLEANretval the context menu actions should be diplayed

Additional Information

ACL Object: COOSYSTEM@1.1:DefaultDeveloperACL


[top]

COOWF@1.1:DisplayParticipantWithLabels

Action used to format a participant for the workflow editor control
ParameterTypeIn/OutOptionalDescription
partCOOWF@1.1:WorkFlowParticipantin the participant
uselabelplaceholderCOOSYSTEM@1.1:BOOLEANin if defined the placeholder <%label%> is inserted before each label
dontshowprefixCOOSYSTEM@1.1:BOOLEANintrue if defined the attribute names of the properties specified in param domainprophiddenprefixes are not displayed for the participant
domainprophiddenprefixesCOOSYSTEM@1.1:OBJECTLISTin
formattedpartCOOSYSTEM@1.1:STRINGLISTretval the result

Additional Information

ACL Object: COOSYSTEM@1.1:DefaultDeveloperACL


[top]

COOWF@1.1:DoShowWorkListItem

Define if a WorkList item showed be shown
ParameterTypeIn/OutOptionalDescription
attrdefCOOSYSTEM@1.1:OBJECTin the requested property of the WorkList
showCOOSYSTEM@1.1:BOOLEANretval return flag

Additional Information

Access Types: COOSYSTEM@1.1:AccTypeRead
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 is no longer used
indexCOOSYSTEM@1.1:INTEGERintrue is no longer used

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:EscalateObject

Escalates the objects regarding to the defined escalation specification
ParameterTypeIn/OutOptionalDescription
escalationsCOOWF@1.1:EscalationEntryListin the defined escalation
deadlinetypeCOOWF@1.1:ExpiryCheckin the expired deadline
deadlineCOOSYSTEM@1.1:DATETIMEin the deadline which triggered the escalation
priorityCOOWF@1.1:WorkFlowPriorityin the priority of the escalated process
escalatedatCOOSYSTEM@1.1:DATETIMEin/out the escalation date
nrsuccessCOOSYSTEM@1.1:INTEGERretval the amount of successful escalation
nrfailureCOOSYSTEM@1.1:INTEGERout the amount of failures during the escalation
errormsgsCOOSYSTEM@1.1:STRINGLISTout the occurred errors during the escalation process

Additional Information

ACL Object: COOSYSTEM@1.1:DefaultDeveloperACL


[top]

COOWF@1.1:EscalateToRecipients

Send an escalation message to a recipient
ParameterTypeIn/OutOptionalDescription
escalrecipientsCOOSYSTEM@1.1:OBJECTLISTin the recipients of the escalation
deadlinetypeCOOWF@1.1:ExpiryCheckin the expired deadline
escalationtypeCOOWF@1.1:EscalationTypein defines if the escalation is done before or after expiration obj the deadline
deadlineCOOSYSTEM@1.1:DATETIMEin the deadline which triggered the escalation
textCOOSYSTEM@1.1:LanguageStringListin the text of the escalation message
nrsuccessCOOSYSTEM@1.1:INTEGERretval the amount of successful escalation
nrfailureCOOSYSTEM@1.1:INTEGERout the amount of failures during the escalation
errormsgsCOOSYSTEM@1.1:STRINGLISTout the occurred errors during the escalation process
textxslCOOSYSTEM@1.1:OBJECTintrue the xsl transformation to format the body of the escalation mail
subjectexprCOOSYSTEM@1.1:STRINGLISTintrue an expression to define the subject of the mail
subjectaddsuiteprefixCOOSYSTEM@1.1:BOOLEANintrue define if the suite name should be included in the subject of the mail
mailimportanceFSCSMTP@1.1001:Importanceintrue the importance of the sent escalation mail

Additional Information

ACL Object: COOSYSTEM@1.1:DefaultDeveloperACL


[top]

COOWF@1.1:EvaluateCase

This action is called on the start of a CASE switch, when the execution of a process instance reaches that point, to decide which path of the case switch has to be entered.
ParameterTypeIn/OutOptionalDescription
caseresultCOOSYSTEM@1.1:INTEGERretval The result of the evaluation. Since CASE switches can be based on various enumeration types, this parameter is an integer value. It is casted to the enumeration type specified in the CASE switch.
activatedpathsCOOSYSTEM@1.1:STRINGLISTouttrue The activated outgoing flows of the diverging gateway instance

Additional Information

ACL Object: COOSYSTEM@1.1:DefaultDeveloperACL


[top]

COOWF@1.1:EvaluateCondition

This action is called on the start of an IF condition or the end of a REPEAT loop, when the execution of a process instance reaches that point, to decide which path has to be entered. In the case of an IF condition it decides, if the THEN or the ELSE part is entered. In the case of a REPEAT loop it decides, if the loop will be repeated.
ParameterTypeIn/OutOptionalDescription
condresultCOOSYSTEM@1.1:BOOLEANretval If set to True, the THEN part is entered or the loop is terminated. If set to False, the ELSE part is entered or the loop is repeated.

Additional Information

ACL Object: COOSYSTEM@1.1:DefaultDeveloperACL


[top]

COOWF@1.1:EvaluatePrecondition

Helper action to evaluate the precondition expressions of an activity instance
ParameterTypeIn/OutOptionalDescription
wfwidxCOOSYSTEM@1.1:INTEGERin the index of the work item for which the conditions should be evaluated
notexecuteableCOOSYSTEM@1.1:BOOLEANretval if true the work item is not executable
hiddenCOOSYSTEM@1.1:BOOLEANout if true the work item is hidden
silentCOOSYSTEM@1.1:BOOLEANintrue

Additional Information

ACL Object: COOSYSTEM@1.1:DefaultDeveloperACL


[top]

COOWF@1.1:EvaluateWorkFlowExpression

ParameterTypeIn/OutOptionalDescription
exprtextCOOSYSTEM@1.1:STRINGLISTin
globalscopein/out
localscopein/out
flagsCOOSYSTEM@1.1:INTEGERintrue
resultretval

Additional Information

ACL Object: COOSYSTEM@1.1:DefaultDeveloperACL
Private: true


[top]

COOWF@1.1:ExecuteBackgroundWork

This action is used as action in the automated task, that executes a particular activity instance or wait action instance in the background. When the task, that checks work lists for background activities, recognizes that new activity instances or wait action instances are available, it schedules these objects for execution by using COOAT@1.1001:ScheduleTask or COOAT@1.1001:ScheduleLocal with this action as the action, that will execute these tasks.

Additional Information

ACL Object: COOSYSTEM@1.1:DefaultDeveloperACL


[top]

COOWF@1.1:ExecuteScriptActivity

Executes an activity instance with an expression instead of work items

Additional Information

ACL Object: COOSYSTEM@1.1:DefaultDeveloperACL
Private: true


[top]

COOWF@1.1:ExpandPrescribeParticipants

Expands the participants of a workflow prescription. E.g.: Distribution lists are resolved.
ParameterTypeIn/OutOptionalDescription
prescriptionCOOWF@1.1:WorkFlowPrescriptionListin/outtrue the prescription
prescrblocksCOOWF@1.1:WorkFlowPrescriptionBlockListin/outtrue the prescription blocks
resolvetouserCOOSYSTEM@1.1:BOOLEANintrue defines of the participants should be resolved to users

Additional Information

ACL Object: COOSYSTEM@1.1:DefaultDeveloperACL


[top]

COOWF@1.1:ExtendNotificationSettings

Hook action called during COOWF@1.1:GetNotificationSettings to allow additional customizing of the notification settings.
All available notification settings are passed into this action an can be modified.
ParameterTypeIn/OutOptionalDescription
procinstCOOSYSTEM@1.1:OBJECTin the process of the instance element
processobjectsCOOSYSTEM@1.1:OBJECTLISTin the objects of the process
participantCOOWF@1.1:WorkFlowParticipantin the participant of the instance element
notificationentriesCOOWF@1.1:NotificationEntryListretval in/out the notification settings

Additional Information

ACL Object: COOSYSTEM@1.1:DefaultDeveloperACL


[top]

COOWF@1.1:ExtractSubPrescription

Converts a subprescription to a prescription
ParameterTypeIn/OutOptionalDescription
sourceCOOWF@1.1:WorkFlowSubPrescriptionListin
extractedprescriptionCOOWF@1.1:WorkFlowPrescriptionListretval

Additional Information

ACL Object: COOSYSTEM@1.1:DefaultDeveloperACL


[top]

COOWF@1.1:FillEvents

ParameterTypeIn/OutOptionalDescription
eventsFSCVENV@1.1001:InfoListout
iswelcomescreenCOOSYSTEM@1.1:BOOLEANin/out
prerequfailedCOOSYSTEM@1.1:OBJECTLISTin/out

Additional Information

ACL Object: COOSYSTEM@1.1:DefaultDeveloperACL
Private: true


[top]

COOWF@1.1:FilterPossibleReferencedDiagrams

Filter the possible diagrams
ParameterTypeIn/OutOptionalDescription
possiblediagramsCOOSYSTEM@1.1:OBJECTLISTretval in/out the diagrams which will be filterd
considereroomcontextCOOSYSTEM@1.1:BOOLEANintrue if set the room restrictions will be considered when calculating diagrams

Additional Information

ACL Object: COOSYSTEM@1.1:DefaultDeveloperACL


[top]

COOWF@1.1:FilterUsableDefinitions

Filters the supplied definition objects for usable ones in the supplied context
ParameterTypeIn/OutOptionalDescription
contextCOOSYSTEM@1.1:OBJECTin the context
objectsCOOSYSTEM@1.1:OBJECTLISTin/out the objects

Additional Information

ACL Object: COOSYSTEM@1.1:DefaultDeveloperACL


[top]

COOWF@1.1:FilterUsableDiagramsHook

Hook action to filter useable workflow diagrams
ParameterTypeIn/OutOptionalDescription
targetobjectsCOOSYSTEM@1.1:OBJECTLISTin the objects on which the workflow diagrams should be started
usablediagramsCOOSYSTEM@1.1:OBJECTLISTin/out the usable diagrams
considereroomcontextCOOSYSTEM@1.1:BOOLEANintrue if set the room restrictions will be considered when calculating the allowed diagrams

Additional Information

ACL Object: COOSYSTEM@1.1:DefaultDeveloperACL


[top]

COOWF@1.1:FilterUsableObjects

Filters the supplied objects for usable ones in the supplied context
ParameterTypeIn/OutOptionalDescription
contextCOOSYSTEM@1.1:OBJECTin the context
objectsCOOSYSTEM@1.1:OBJECTLISTin/out the objects

Additional Information

ACL Object: COOSYSTEM@1.1:DefaultDeveloperACL


[top]

COOWF@1.1:FixParticipantAffiliation

Hook action to fix affiliation problems.
ParameterTypeIn/OutOptionalDescription
contextCOOSYSTEM@1.1:OBJECTin the context in with the affiliation check was performed
participantsCOOWF@1.1:WorkFlowPartAccessMappingin the participants with affiliation problems
continueeditingCOOSYSTEM@1.1:BOOLEANintrue this option is set when the process is not started directly or the activity is not inserted directly
performedCOOSYSTEM@1.1:BOOLEANretval if set a check was performed and no cancel branch was clicked

Additional Information

ACL Object: COOSYSTEM@1.1:DefaultDeveloperACL


[top]

COOWF@1.1:GetActivityInstanceMenu

Get possible actions on activities

Additional Information

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


[top]

COOWF@1.1:GetAdditionalPrescriptionTemplatesHook

Hook to get additional prescription templates
ParameterTypeIn/OutOptionalDescription
wfobjectsCOOSYSTEM@1.1:OBJECTLISTin workflow objects
templatesCOOSYSTEM@1.1:OBJECTLISTretval in/out list of prescription templates

Additional Information

ACL Object: COOSYSTEM@1.1:DefaultDeveloperACL


[top]

COOWF@1.1:GetAdditionalWorkFlowDiagramsHook

Hook to get additional additional workflow diagrams which are currently not stored in the workflow preferences
ParameterTypeIn/OutOptionalDescription
wfobjectsCOOSYSTEM@1.1:OBJECTLISTin workflow objects
diagramsCOOSYSTEM@1.1:OBJECTLISTretval in/out list of workflow diagrams
requiredraftversionCOOSYSTEM@1.1:BOOLEANintrue if set to true the draft version of the diagrams is needed

Additional Information

ACL Object: COOSYSTEM@1.1:DefaultDeveloperACL


[top]

COOWF@1.1:GetAllWorkListActInsts

Gets all activities of the object which are currently located in a WorkList
ParameterTypeIn/OutOptionalDescription
allactinstsCOOSYSTEM@1.1:OBJECTLISTretval the allactinsts

Additional Information

ACL Object: COOSYSTEM@1.1:DefaultDeveloperACL


[top]

COOWF@1.1:GetAllowedProcessStatisticTargets

ParameterTypeIn/OutOptionalDescription
targetsCOOSYSTEM@1.1:OBJECTLISTretval

Additional Information

ACL Object: COOSYSTEM@1.1:DefaultDeveloperACL
Private: true


[top]

COOWF@1.1:GetCommonPrescribeDefault

Get the common default values for prescriptions on multiple objects
ParameterTypeIn/OutOptionalDescription
objectsCOOSYSTEM@1.1:OBJECTLISTin the objects
commondefaultCOOSYSTEM@1.1:BOOLEANout the commondefault
prescriptionCOOWF@1.1:WorkFlowPrescriptionListout the prescription
prescrparallelCOOSYSTEM@1.1:BOOLEANout the prescrparallel
prescrbackCOOSYSTEM@1.1:OBJECTout the prescrback
prescrusableCOOSYSTEM@1.1:OBJECTLISTouttrue the prescrusable
prescrrestrictedCOOSYSTEM@1.1:BOOLEANouttrue the prescrrestricted
prescrblocksCOOWF@1.1:WorkFlowPrescriptionBlockListouttrue the prescrblocks
prescrblocksonlyCOOSYSTEM@1.1:BOOLEANintrue the prescrblocksonly
prescrbackrestrictedCOOSYSTEM@1.1:BOOLEANouttrue the prescrbackrestricted
prescrtemplatesCOOSYSTEM@1.1:OBJECTLISTouttrue the stored prescription templates
commonprocesspossibleCOOSYSTEM@1.1:BOOLEANouttrue the commonprocesspossible
prescdiagramsCOOSYSTEM@1.1:OBJECTLISTouttrue the usable workflow diagrams
prescrtemplatesonlyCOOSYSTEM@1.1:BOOLEANintrue if set no prescriptiondiagrams will be evaluated
considereroomcontextCOOSYSTEM@1.1:BOOLEANintrue if set the room restrictions will be considered when calculating diagrams

Additional Information

ACL Object: COOSYSTEM@1.1:DefaultDeveloperACL


[top]

COOWF@1.1:GetCommonUsableProcessDefinitions

Retrieve the commonly usable process definitions of all supplied objects
ParameterTypeIn/OutOptionalDescription
objectsCOOSYSTEM@1.1:OBJECTLISTin the objects for which the process definitions should be commonly usable.
commondefaultCOOSYSTEM@1.1:BOOLEANout the commondefault
procdefsCOOSYSTEM@1.1:OBJECTLISTout the retrieved process definitions
commonprocesspossibleCOOSYSTEM@1.1:BOOLEANouttrue the defines if a common process is possible for the supplied objects.

Additional Information

ACL Object: COOSYSTEM@1.1:DefaultDeveloperACL


[top]

COOWF@1.1:GetConditionString

This action is called by the process editor to format the condition in IF conditions or REPEAT loops to a readable form, that is displayed in the graphical process editor.
ParameterTypeIn/OutOptionalDescription
attrdefcontCOOSYSTEM@1.1:OBJECTin The string or content property that contains the formal condition.
condstringCOOSYSTEM@1.1:STRINGretval The condition with references replaced by the language dependent names.
attrdefactionCOOSYSTEM@1.1:OBJECTintrue The property that contains the action or script, that is used to evaluate the condition, if no condtion is found in the property specified in attrdefcont.

Additional Information

ACL Object: COOSYSTEM@1.1:DefaultDeveloperACL


[top]

COOWF@1.1:GetConfiguredProcessStatisticsUsers

Check for which types of users process statistics are enabled
ParameterTypeIn/OutOptionalDescription
usersCOOWF@1.1:ProcStatisticsUsersretval

Additional Information

ACL Object: COOSYSTEM@1.1:DefaultDeveloperACL


[top]

COOWF@1.1:GetConfiguredSender

Retrieve the configured sender for escalation and notification mails
ParameterTypeIn/OutOptionalDescription
senderCOOSYSTEM@1.1:STRINGretval the result

Additional Information

ACL Object: COOSYSTEM@1.1:DefaultDeveloperACL


[top]

COOWF@1.1:GetContextByMultiInstanceType

ParameterTypeIn/OutOptionalDescription
multipletypeCOOWF@1.1:MultiInstanceTypein
insertmultipleCOOSYSTEM@1.1:BOOLEANretval
insertmultiplecontextCOOSYSTEM@1.1:OBJECTout

Additional Information

ACL Object: COOSYSTEM@1.1:DefaultDeveloperACL
Private: true


[top]

COOWF@1.1:GetCurrentActivityInstances

Calculates and returns all activity instances of the object which are currently located in the work list of the current user
ParameterTypeIn/OutOptionalDescription
actinstsCOOSYSTEM@1.1:OBJECTLISTretval the activity instances currently located in the work list
actinststatesCOOWF@1.1:ActivityInstanceStateintrue the activity instances will be filtered by the supplied states. If no states have been supplied on activity instances having states ACTINST_STARTABLE or ACTINST_STARTED will be returned.
usersCOOSYSTEM@1.1:OBJECTLISTintrue the users
anyuserCOOSYSTEM@1.1:BOOLEANintrue the anyuser

Additional Information

Access Types: COOWF@1.1:AccTypeReadWorkFlow
ACL Object: COOSYSTEM@1.1:DefaultDeveloperACL


[top]

COOWF@1.1:GetCurrentUserActivities

Gets all activities contained in the WorkList of the current user
ParameterTypeIn/OutOptionalDescription
actinstsCOOSYSTEM@1.1:OBJECTLISTretval

Additional Information

ACL Object: COOSYSTEM@1.1:DefaultDeveloperACL


[top]

COOWF@1.1:GetDefaultProcessDefinitions

This action is called, when an object is created that has the property COOWF@1.1:workflow assigned. It returns a (possibly empty) list of process definitions, that are used to autmatically initialize process instances that are attached to the just created object.
ParameterTypeIn/OutOptionalDescription
procdefsCOOSYSTEM@1.1:OBJECTLISTretval Process definitions, that are used to initialize new process instances, that are attached to the object.

Additional Information

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:OBJECTLISTretval The list of definition elements.
objclassCOOSYSTEM@1.1:OBJECTintrue The desired class.

Additional Information

ACL Object: COOSYSTEM@1.1:DefaultDeveloperACL


[top]

COOWF@1.1:GetDelegateDefault

This action is called by the user interface to retrieve the default settings, when a user chooses to delegate an activity instance. This is intended as the default parameters, that the user can modify to his needs.
ParameterTypeIn/OutOptionalDescription
participantCOOWF@1.1:WorkFlowParticipantin/out The default workflow participant, to whom the activiy is delegated.
partmansubstCOOWF@1.1:WorkFlowParticipantin/out The substitute in Fabasoft Components, if participant specifies a manual workflow participant.
remarkCOOSYSTEM@1.1:STRINGin/out The additional remark in the activity.
submitdeadlineCOOSYSTEM@1.1:DATETIMEin/out The deadline for submitting the activity.
startdeadlineCOOSYSTEM@1.1:DATETIMEin/out The deadline for starting the activity.
enddeadlineCOOSYSTEM@1.1:DATETIMEin/out The deadline for completing the activity.
nodeadlinecheckCOOSYSTEM@1.1:BOOLEANout

Additional Information

ACL Object: COOSYSTEM@1.1:DefaultDeveloperACL


[top]

COOWF@1.1:GetDelegateMultipleDefault

This action is called by the user interface to retrieve the default settings, when a user chooses to delegate an activity instance to multiple participants. This is intended as the default parameters, that the user can modify to his needs.
ParameterTypeIn/OutOptionalDescription
participantCOOWF@1.1:WorkFlowParticipantin/out The default workflow participant, to whom the activiy is delegated.
partmansubstCOOWF@1.1:WorkFlowParticipantin/out The substitute in Fabasoft Components, if participant specifies a manual workflow participant.
remarkCOOSYSTEM@1.1:STRINGin/out The additional remark in the activity.
submitdeadlineCOOSYSTEM@1.1:DATETIMEin/out The deadline for submitting the activity.
startdeadlineCOOSYSTEM@1.1:DATETIMEin/out The deadline for starting the activity.
enddeadlineCOOSYSTEM@1.1:DATETIMEin/out The deadline for completing the activity.
nodeadlinecheckCOOSYSTEM@1.1:BOOLEANout deadlines are not displayed in the delegation dialog

Additional Information

ACL Object: COOSYSTEM@1.1:DefaultDeveloperACL


[top]

COOWF@1.1:GetDiagramProcessParticipants

Get the participants used in the executable processes of the process diagram
ParameterTypeIn/OutOptionalDescription
skipsubprocessesCOOSYSTEM@1.1:BOOLEANintrue If set to true the subprocesses contained in the process diagram will not be scanned for participants
processparticipantsCOOWF@1.1:WorkFlowCompoundParticipantretval the result
forcereferenceddraftversionCOOSYSTEM@1.1:BOOLEANintrue if to true the draft version of all referenced diagrams is used. If set to false the released version of the referenced processes is used. If the parameter is not defined the current referenced object is used

Additional Information

ACL Object: COOSYSTEM@1.1:DefaultDeveloperACL
Secured: SECURED_READWRITE


[top]

COOWF@1.1:GetDisplayProperties

This action is called, when an activity instance or wait action instance is displayed in a graphical user interface, to determine the list of properties, that should be displayed in the box representing the activity.
ParameterTypeIn/OutOptionalDescription
displaycolumnlistCOODESK@1.1:DisplayColumnListretval The description of the properties, that are to be displayed. If empty, a default set of properties is displayed.
userenvsettingsCOOSYSTEM@1.1:DICTIONARYintrue

Additional Information

ACL Object: COOSYSTEM@1.1:DefaultDeveloperACL


[top]

COOWF@1.1:GetInheritedWorkFlowSettings

Retrieve inherited prescription templates and workflow diagrams
ParameterTypeIn/OutOptionalDescription
prescriptiontemplatesCOOSYSTEM@1.1:OBJECTLISTretval the inherited prescription templates
diagramsCOOSYSTEM@1.1:OBJECTLISTout the inherited workflow diagrams

Additional Information

ACL Object: COOSYSTEM@1.1:DefaultDeveloperACL


[top]

COOWF@1.1:GetInitialResponsible

When starting a new process instance this action is called to calculate the initial responsible of the process. The calculated responsible is stored in the property COOWF@1.1:procinstresponsible. If no valid participant is returned the current user will be used as responsible of the process. Note: The responsible of the process can be changed during the execution if an activity is delegated or the responsible is changed manually.
ParameterTypeIn/OutOptionalDescription
responsibleCOOWF@1.1:WorkFlowParticipantretval the calculated responsible of the process.
respmansubstCOOWF@1.1:WorkFlowParticipantouttrue the calculated responsible of the process for manual activities.
procinstCOOSYSTEM@1.1:OBJECTintrue the newly create process instance
processsourceCOOSYSTEM@1.1:OBJECTintrue the model from which the process flow is taken. (e.g.: a WorkFlowDiagram or ProcessDefinition)

Additional Information

ACL Object: COOSYSTEM@1.1:DefaultDeveloperACL


[top]

COOWF@1.1:GetInsertActivityDef

Calculates and returns an activity definition by using the customization point COOWF@1.1:InsertActivityDef.
ParameterTypeIn/OutOptionalDescription
scopeCOOSYSTEM@1.1:OBJECTin The scope is used as key in combination with the object class to retrieve an activity definition. Each component object can be used as scope.
stateCOOSYSTEM@1.1:DICTIONARYintrue The state is a dictionary to supply additional informations for evaluation of the activity definition.
insertactdefCOOSYSTEM@1.1:OBJECTretval The activity definition is calculated by an expression with the following values in the local scope:
  • activity the currently used activity instance of the current process.
  • process the currently used process instance
  • participant the participant of the current activity instance
  • object the object of the current process
abortfollowersCOOSYSTEM@1.1:BOOLEANout all followers with the same ad hoc key will be aborted

Additional Information

ACL Object: COOSYSTEM@1.1:DefaultDeveloperACL


[top]

COOWF@1.1:GetInstanceElementColor

Retrieve the color used to display the object in the process editor
ParameterTypeIn/OutOptionalDescription
colorcodeCOOSYSTEM@1.1:INTEGERretval the color code

Additional Information

ACL Object: COOSYSTEM@1.1:DefaultDeveloperACL


[top]

COOWF@1.1:GetInstanceElements

This action can be called to retrieve all instance element objects of a process instance that have the specified class and the specified state. If no class is specified, the instance elements in the process instance are returned regardless of their class. If no state is specified, the instance elements in the process instance are returned regardless of their state.
ParameterTypeIn/OutOptionalDescription
instelemsCOOSYSTEM@1.1:OBJECTLISTretval in/out The list of instance elements.
objclassCOOSYSTEM@1.1:OBJECTLISTintrue The desired class.
actinststateCOOWF@1.1:ActivityInstanceStateintrue The desired state.
orderedCOOSYSTEM@1.1:BOOLEANintrue The instance elements are returned in their graphical order. Starting at the top going to the bottom and from left to right
adhockeyCOOSYSTEM@1.1:STRINGintrue the instance elements with the matching ad hockey will be returned

Additional Information

ACL Object: COOSYSTEM@1.1:DefaultDeveloperACL
Secured: SECURED_READWRITE


[top]

COOWF@1.1:GetLastInstanceElements

This action can be called to retrieve the last instance elements in a process instance. These are those elements, that do not have a successor any more. If the last element in a process instance is a CASE switch, IF condition or REPEAT loop, the end element of these elements is returned.
ParameterTypeIn/OutOptionalDescription
instelemsCOOSYSTEM@1.1:OBJECTLISTretval The list of last instance elements.

Additional Information

ACL Object: COOSYSTEM@1.1:DefaultDeveloperACL
Secured: SECURED_READWRITE


[top]

COOWF@1.1:GetLongTermSuspendedActivities

Retrieve all long term suspended activities for the current user
ParameterTypeIn/OutOptionalDescription
activitiesCOOSYSTEM@1.1:OBJECTLISTretval the long term suspended activities

Additional Information

ACL Object: COOSYSTEM@1.1:DefaultDeveloperACL


[top]

COOWF@1.1:GetLowestLoadSharingScoreUsers

Get the users with the lowest load sharing score of a group.
ParameterTypeIn/OutOptionalDescription
usersCOOSYSTEM@1.1:OBJECTLISTretval the users with the lowest load sharing score
_positionCOOSYSTEM@1.1:OBJECTintrue the users are filtered by the supplied position

Additional Information

ACL Object: COOSYSTEM@1.1:DefaultDeveloperACL


[top]

COOWF@1.1:GetManageableWorkFlowPreferenceGroupLocations

Retrieve the groups for which workflow diagrams can be released
ParameterTypeIn/OutOptionalDescription
groupsCOOSYSTEM@1.1:OBJECTLISTretval the target groups

Additional Information

ACL Object: COOSYSTEM@1.1:DefaultDeveloperACL


[top]

COOWF@1.1:GetMenuDefineWFSubstitutes

Additional Information

Prototype: COODESK@1.1:MenuGetActionPrototype
ACL Object: COOSYSTEM@1.1:DefaultDeveloperACL
Private: true


[top]

COOWF@1.1:GetMenuRemoveFromProcessFolder

Dynamic menu action to retrieve the menu remove from process folder

Additional Information

Prototype: COODESK@1.1:MenuGetActionPrototype
ACL Object: COOSYSTEM@1.1:DefaultDeveloperACL
Private: true


[top]

COOWF@1.1:GetMenuShowUsageList

Dynamic menu action to retrieve the usage list menu

Additional Information

Prototype: COODESK@1.1:MenuGetActionPrototype
ACL Object: COOSYSTEM@1.1:DefaultDeveloperACL
Private: true


[top]

COOWF@1.1:GetMetaParticipantProperties

Retrieve the attributes of the participant COOWF@1.1:WorkFlowParticipant which are used when selecting the specified meta participant in the participant control.
ParameterTypeIn/OutOptionalDescription
metpartCOOWF@1.1:WorkFlowMetaParticipantin the meta participant
attributesCOOSYSTEM@1.1:OBJECTLISTretval the attributes which are used to calculate the meta participant. If no attributes are returned all attributes of the participant COOWF@1.1:WorkFlowParticipant are displayed. If attributes are returned all other attributes of the participant COOWF@1.1:WorkFlowParticipant are cleared.

Additional Information

ACL Object: COOSYSTEM@1.1:DefaultDeveloperACL
Private: true


[top]

COOWF@1.1:GetMultiInstanceTypeByContext

ParameterTypeIn/OutOptionalDescription
prescrmetawhoCOOWF@1.1:PrescriptionMetaDataWhoin
multipletypeCOOWF@1.1:MultiInstanceTyperetval

Additional Information

ACL Object: COOSYSTEM@1.1:DefaultDeveloperACL
Private: true


[top]

COOWF@1.1:GetNextActivityInstances

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 COOWF@1.1: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 COOWF@1.1: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.
ParameterTypeIn/OutOptionalDescription
skipconditionsCOOSYSTEM@1.1:BOOLEANintrue if defined the conditions of gateways are not evaluated and all following activities are returned
includecontrolelementsCOOSYSTEM@1.1:BOOLEANintrue if defined the search for the next activity instance is stopped at a control element and the control element is part of the result
nextactinstCOOSYSTEM@1.1:OBJECTLISTretval the following activity instances

Additional Information

ACL Object: COOSYSTEM@1.1:DefaultDeveloperACL
Secured: SECURED_READWRITE


[top]

COOWF@1.1:GetNextInstanceElements

Retrieve all following instance elements of all activity instances in all work lists of the current user
ParameterTypeIn/OutOptionalDescription
nextactinstsCOOSYSTEM@1.1:OBJECTLISTretval the following instance elements
no_conditionCOOSYSTEM@1.1:BOOLEANintrue defines if ConditionStartInstances will be excluded from the result
no_caseCOOSYSTEM@1.1:BOOLEANintrue defines if CaseStartInstances and DivergingGatewayInstances will be excluded from the result
no_repeatCOOSYSTEM@1.1:BOOLEANintrue defines if RepeatStartInstances will be excluded from the result
no_subprocessCOOSYSTEM@1.1:BOOLEANintrue defines if SubProcessInstances will be excluded from the result
no_waitCOOSYSTEM@1.1:BOOLEANintrue defines if WaitActionInstances will be excluded from the result
no_endCOOSYSTEM@1.1:BOOLEANintrue defines if EndEventInstance will be excluded from the result

Additional Information

ACL Object: COOSYSTEM@1.1:DefaultDeveloperACL
Secured: SECURED_READWRITE


[top]

COOWF@1.1:GetNextSuspensionDate

Calculate the next suspension date for the activity based on the values entered in the submission dialog
ParameterTypeIn/OutOptionalDescription
suspensiondatetimeCOOSYSTEM@1.1:DATETIMEretval the calculated suspension date
repetitionperiodCOOWF@1.1:SubmissionRepetitionPeriodin the values entered in the submission dialog

Additional Information

ACL Object: COOSYSTEM@1.1:DefaultDeveloperACL


[top]

COOWF@1.1:GetNotificationSettings

Retrieve the configured notification entries for an activity instance.
Notification entries can be configured on activity definition, process definition level and global by use of an notification definition. After the available notification settings have been calculated the action COOWF@1.1:ExtendNotificationSettings is called to allow to do additional customizing of the notification settings.
ParameterTypeIn/OutOptionalDescription
notificationentriesCOOWF@1.1:NotificationEntryListretval the configured notification entries

Additional Information

ACL Object: COOSYSTEM@1.1:DefaultDeveloperACL


[top]

COOWF@1.1:GetObjectWorkFlowMenu

Dynamic menu action to check if the following menus should be displayed:

Additional Information

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


[top]

COOWF@1.1:GetObjectsConcerned

Retrieves the depending object for changes on the current object
ParameterTypeIn/OutOptionalDescription
contextCOOSYSTEM@1.1:OBJECTin the concerned objects are evaluated depending on the supplied context
objectsconcernedCOOSYSTEM@1.1:OBJECTLISTretval the depending objects

Additional Information

ACL Object: COOSYSTEM@1.1:DefaultDeveloperACL


[top]

COOWF@1.1:GetPartMultipleContextDispInfos

ParameterTypeIn/OutOptionalDescription
attrdefCOOSYSTEM@1.1:OBJECTin
additionalinfosCOOSYSTEM@1.1:DICTIONARYintrue
isvisibleCOOSYSTEM@1.1:BOOLEANretval
ischangeableCOOSYSTEM@1.1:BOOLEANout

Additional Information

ACL Object: COOSYSTEM@1.1:DefaultDeveloperACL
Private: true


[top]

COOWF@1.1:GetParticipantContext

Retrieve the context object to fill the workflow participant
ParameterTypeIn/OutOptionalDescription
objCOOSYSTEM@1.1:OBJECTin for which the participant evaluation is performed
contextCOOSYSTEM@1.1:OBJECTretval the result

Additional Information

ACL Object: COOSYSTEM@1.1:DefaultDeveloperACL


[top]

COOWF@1.1:GetParticipantParentAttribute

This action is called to retrieve the attribute definition to locate the parent object for participant
ParameterTypeIn/OutOptionalDescription
attrdefCOOSYSTEM@1.1:OBJECTretval

Additional Information

ACL Object: COOSYSTEM@1.1:DefaultDeveloperACL


[top]

COOWF@1.1:GetParticipantUsers

Get the user which are used as participants
ParameterTypeIn/OutOptionalDescription
usersCOOSYSTEM@1.1:OBJECTLISTretval the users
ignoregrouppositionCOOSYSTEM@1.1:BOOLEANintrue the ignoregroupposition
activeusersonlyCOOSYSTEM@1.1:BOOLEANintrue the activeusersonly

Additional Information

ACL Object: COOSYSTEM@1.1:DefaultDeveloperACL


[top]

COOWF@1.1:GetPrescribeActivityDefinitions

Get the usable activity definitions for prescriptions
ParameterTypeIn/OutOptionalDescription
contextCOOSYSTEM@1.1:OBJECTin the attribute in which the prescription activity should be inserted
actdefsCOOSYSTEM@1.1:OBJECTLISTout the possible activity definitions
actdefsrestrictedCOOSYSTEM@1.1:BOOLEANout the prescription is restricted to this activity definitions
usagemodeCOOWF@1.1:ActivityUsageModeintrue the possible activity definitions are filtered by usagemode
diagrammodelingCOOSYSTEM@1.1:BOOLEANintrue is only evaluate in combination with usagemode AUM_ONLY_BPMN

Additional Information

ACL Object: COOSYSTEM@1.1:DefaultDeveloperACL


[top]

COOWF@1.1:GetPrescribeDefault

This action is called by the user interface to retrieve the default settings, when a user chooses to prescribe activities. This is intended as the default parameters, that the user can modify to his needs.
ParameterTypeIn/OutOptionalDescription
prescriptionCOOWF@1.1:WorkFlowPrescriptionListout The preconfigured prescription list.
prescrparallelCOOSYSTEM@1.1:BOOLEANout Default for parallel or serial prescriptions.
prescrbackCOOSYSTEM@1.1:OBJECTout Default for an activity back to the originator of the prescription.
prescrusableCOOSYSTEM@1.1:OBJECTLISTouttrue
prescrrestrictedCOOSYSTEM@1.1:BOOLEANouttrue
prescrblocksCOOWF@1.1:WorkFlowPrescriptionBlockListouttrue The list of additional preconfigured blocks of prescriptions.
prescrblocksonlyCOOSYSTEM@1.1:BOOLEANintrue If set to True, all preconfigured prescriptions are returned in the parameter prescrblocks, the parameter prescription is set to empty.
prescrbackrestrictedCOOSYSTEM@1.1:BOOLEANouttrue

Additional Information

ACL Object: COOSYSTEM@1.1:DefaultDeveloperACL


[top]

COOWF@1.1:GetPrescribeTemplate

Gets the parsed and resolved prescription template
ParameterTypeIn/OutOptionalDescription
prescriptionCOOWF@1.1:WorkFlowPrescriptionListout the prescription
prescrparallelCOOSYSTEM@1.1:BOOLEANout the prescrparallel
prescrbackCOOSYSTEM@1.1:OBJECTin/out the prescrback
prescrblocksCOOWF@1.1:WorkFlowPrescriptionBlockListouttrue the prescrblocks
prescrblocksonlyCOOSYSTEM@1.1:BOOLEANintrue the prescrblocksonly
selobjectsCOOSYSTEM@1.1:OBJECTLISTintrue the selobjects
edittemplateCOOSYSTEM@1.1:BOOLEANintrue the edittemplate

Additional Information

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


[top]

COOWF@1.1:GetPrescriptionEditorMode

Retrieve the display mode for the prescription editor
ParameterTypeIn/OutOptionalDescription
isexprtmodeCOOSYSTEM@1.1:BOOLEANretval the prescription editor is started in the expert mode
enforcededitormodeCOOSYSTEM@1.1:BOOLEANout the prescription mode can not be changed

Additional Information

ACL Object: COOSYSTEM@1.1:DefaultDeveloperACL


[top]

COOWF@1.1:GetPrescriptionHeadLine

Get title for prescription editor
ParameterTypeIn/OutOptionalDescription
headlineCOOSYSTEM@1.1:STRINGretval the headline
labelCOOSYSTEM@1.1:STRINGout
prescrlabelCOOSYSTEM@1.1:STRINGout

Additional Information

ACL Object: COOSYSTEM@1.1:DefaultDeveloperACL


[top]

COOWF@1.1:GetProcessParameter

Action to get a process parameter for a specified process. This action fails for users with are no participant of the process or have no access on the object of the process.
ParameterTypeIn/OutOptionalDescription
keyCOOSYSTEM@1.1:STRINGin the identifier for the process parameter
valueretval the parameter value

Additional Information

ACL Object: COOSYSTEM@1.1:DefaultDeveloperACL
Secured: SECURED_READWRITE


[top]

COOWF@1.1:GetProcessParameters

Action read all process parameters for a specified process. This action fails for users with are no participant of the process or have no access on the object of the process.
ParameterTypeIn/OutOptionalDescription
paramsCOOSYSTEM@1.1:DICTIONARYretval process parameters

Additional Information

ACL Object: COOSYSTEM@1.1:DefaultDeveloperACL
Secured: SECURED_READWRITE


[top]

COOWF@1.1:GetProcessStatisticsCache

ParameterTypeIn/OutOptionalDescription
cacheCOOSYSTEM@1.1:OBJECTretval

Additional Information

ACL Object: COOSYSTEM@1.1:DefaultDeveloperACL
Private: true


[top]

COOWF@1.1:GetProcessStatisticsTitle

ParameterTypeIn/OutOptionalDescription
titleCOOSYSTEM@1.1:STRINGretval

Additional Information

ACL Object: COOSYSTEM@1.1:DefaultDeveloperACL
Private: true


[top]

COOWF@1.1:GetReferencedBPMNObject

Locate an object referenced in a BPMN process diagram by the supplied elementid.
ParameterTypeIn/OutOptionalDescription
targetclassCOOSYSTEM@1.1:OBJECTin the suggested class
elementidCOOSYSTEM@1.1:STRINGin the search pattern, valid elementids are COOAddress, external key and reference
objCOOSYSTEM@1.1:OBJECTretval the found object
foundbyreferenceCOOSYSTEM@1.1:BOOLEANout the object was found by the reference of the object
forcereferenceddraftversionCOOSYSTEM@1.1:BOOLEANintrue if to true the draft version of all referenced diagrams is used. If set to false the released version of the referenced processes is used. If the parameter is not defined the current referenced object is used

Additional Information

ACL Object: COOSYSTEM@1.1:DefaultDeveloperACL


[top]

COOWF@1.1:GetReferencedDiagrams

Action to retrieve all diagrams used in subprocesses
ParameterTypeIn/OutOptionalDescription
recursiveCOOSYSTEM@1.1:BOOLEANin the nested diagrams are also included
refdiagramsCOOSYSTEM@1.1:OBJECTLISTretval the result

Additional Information

ACL Object: COOSYSTEM@1.1:DefaultDeveloperACL


[top]

COOWF@1.1:GetReleaseDiagramsHook

Hook action to customize which released diagrams exist
ParameterTypeIn/OutOptionalDescription
diagramsCOOSYSTEM@1.1:OBJECTLISTretval in/out

Additional Information

ACL Object: COOSYSTEM@1.1:DefaultDeveloperACL


[top]

COOWF@1.1:GetReleasedDiagrams

Return all released workflow diagrams for a group
ParameterTypeIn/OutOptionalDescription
diagramsCOOSYSTEM@1.1:OBJECTLISTretval

Additional Information

ACL Object: COOSYSTEM@1.1:DefaultDeveloperACL


[top]

COOWF@1.1:GetReleasedWorkFlowDiagram

This action is used to find the best fitting released workflow diagram for the current user which can be executed on the current object.
ParameterTypeIn/OutOptionalDescription
diagramCOOSYSTEM@1.1:OBJECTin the workflow diagram for which a released version should be retrieved.
releaseddiagramCOOSYSTEM@1.1:OBJECTretval the released diagram
considereroomcontextCOOSYSTEM@1.1:BOOLEANintrue if set the room restrictions will be considered when calculating diagrams

Additional Information

ACL Object: COOSYSTEM@1.1:DefaultDeveloperACL


[top]

COOWF@1.1:GetResolvedProcessStatisticsUsers

Get the users of a group who will get the process statistics widget in their worklist
ParameterTypeIn/OutOptionalDescription
usersCOOSYSTEM@1.1:OBJECTLISTretval the users

Additional Information

ACL Object: COOSYSTEM@1.1:DefaultDeveloperACL


[top]

COOWF@1.1:GetSecurityAttributes

Get the attribute definitions where the security permissions will be stored. The attributes can be defined at the activity definition or on the process definition. If no attributes have been defined fallback attributes are used. See parameters to for the fallback attributes.
ParameterTypeIn/OutOptionalDescription
usersecattrCOOSYSTEM@1.1:OBJECTout the property where the users participating in workflow are stored. If not defined the property COOWF@1.1:workflowusers is used.
groupsecattrCOOSYSTEM@1.1:OBJECTout the property where the groups participating in workflow are stored. If not defined the property COOWF@1.1:workflowgroups is used.
userdonesecattrCOOSYSTEM@1.1:OBJECTout the property where the user had participated in workflow are stored. If not defined the property COOWF@1.1:workflowusersdone is used.
groupdonesecattrCOOSYSTEM@1.1:OBJECTout the property where the groups had participated in workflow are stored. If not defined the property COOWF@1.1:workflowgroupsdone is used.
userrolesecattrCOOSYSTEM@1.1:OBJECTout the property where the users participating in workflow by role are stored. If not defined the property COOWF@1.1:workflowroleusers is used.
userroledonesecattrCOOSYSTEM@1.1:OBJECTout the property where the users have participated in workflow by role are stored. If not defined the property COOWF@1.1:workflowroleusersdone is used.

Additional Information

ACL Object: COOSYSTEM@1.1:DefaultDeveloperACL


[top]

COOWF@1.1:GetSubmissionDefault

Retrieves the default values for submissions of follower activities.
ParameterTypeIn/OutOptionalDescription
submissionsCOOWF@1.1:WorkFlowSubmissionListretval the submissions

Additional Information

ACL Object: COOSYSTEM@1.1:DefaultDeveloperACL


[top]

COOWF@1.1:GetSubstGroupActivities

Retrieves the activities which can be executed cause of group substitution.
ParameterTypeIn/OutOptionalDescription
grsubstactivitiesCOOSYSTEM@1.1:OBJECTLISTout the grsubstactivities
substgroupsCOOSYSTEM@1.1:OBJECTLISTout the substgroups

Additional Information

ACL Object: COOSYSTEM@1.1:DefaultDeveloperACL


[top]

COOWF@1.1:GetSuspendDefault

This action is called by the user interface to retrieve the default settings, when a user chooses to suspend an activity instance. This is intended as the default parameters, that the user can modify to his needs.
ParameterTypeIn/OutOptionalDescription
remarkCOOSYSTEM@1.1:STRINGin/out Default remark.
submitdeadlineCOOSYSTEM@1.1:DATETIMEin/out Default deadline for resubmission of the activity instance.
repetitionperiodCOOWF@1.1:SubmissionRepetitionPeriodin/out

Additional Information

ACL Object: COOSYSTEM@1.1:DefaultDeveloperACL


[top]

COOWF@1.1:GetTerminateDefault

This action is called by the user interface to retrieve the default settings, when a user chooses to terminate an activity instance. This is intended as the default parameters, that the user can modify to his needs.
ParameterTypeIn/OutOptionalDescription
remarkCOOSYSTEM@1.1:STRINGin/out Default remark.
submitdeadlineCOOSYSTEM@1.1:DATETIMEin/out Default deadline for submission of the terminated activity instance.
startdeadlineCOOSYSTEM@1.1:DATETIMEin/out Default deadline for starting.
enddeadlineCOOSYSTEM@1.1:DATETIMEin/out Default deadline for the completion.

Additional Information

ACL Object: COOSYSTEM@1.1:DefaultDeveloperACL


[top]

COOWF@1.1:GetTerminateDenyDefault

Gets the default values for denying activities.
ParameterTypeIn/OutOptionalDescription
remarkCOOSYSTEM@1.1:STRINGin/out the remark
submitdeadlineCOOSYSTEM@1.1:DATETIMEin/out the submitdeadline
startdeadlineCOOSYSTEM@1.1:DATETIMEin/out the startdeadline
enddeadlineCOOSYSTEM@1.1:DATETIMEin/out the enddeadline

Additional Information

ACL Object: COOSYSTEM@1.1:DefaultDeveloperACL


[top]

COOWF@1.1:GetUsableActivityDefinitions

Gets the usable activity definitions of the current object
ParameterTypeIn/OutOptionalDescription
actdefsCOOSYSTEM@1.1:OBJECTLISTretval the activity definitions
excludeactdefsCOOSYSTEM@1.1:OBJECTLISTintrue this definitions will be excluded from the result
prevelementsCOOSYSTEM@1.1:OBJECTLISTintrue the previous instance or definition elements in the process

Additional Information

ACL Object: COOSYSTEM@1.1:DefaultDeveloperACL


[top]

COOWF@1.1:GetUsableObjectsConcerned

Gets the usable depending objects for the current object
ParameterTypeIn/OutOptionalDescription
contextCOOSYSTEM@1.1:OBJECTintrue the conernced objects are evaluated depending on the supplied context
objectsconcernedCOOSYSTEM@1.1:OBJECTLISTretval the depending objects
objectsconcernedrestrictedCOOSYSTEM@1.1:BOOLEANout this value defines if the depending objects are restricted or can be extended or reduce

Additional Information

ACL Object: COOSYSTEM@1.1:DefaultDeveloperACL


[top]

COOWF@1.1:GetUsableOrgElements

This action is called by the workflow participant control on the first object attached to the current process instance (or on the current object, if not used in a process instance) to retrieve the organizational elements, that should be made available for selection in the user interface. This action is intended to be wrapped or overwritten and is not implemented by the software component Workflow itself.
ParameterTypeIn/OutOptionalDescription
contextCOOSYSTEM@1.1:OBJECTin This parameter is intended to know the context, where this action is used, but is currently not set by the caller.
metaparticipantsCOOWF@1.1:WorkFlowMetaParticipantout Returns the list of allowed values for the property COOWF@1.1:wfpmetaparticipant, if not set, all available values are allowed.
usersCOOSYSTEM@1.1:OBJECTLISTout Returns the list of allowed users for the property COOWF@1.1:wfpuser, if not set, any user is allowed.
positionsCOOSYSTEM@1.1:OBJECTLISTout Returns the list of allowed positions for the property COOWF@1.1:wfpposition, if not set, any position is allowed.
groupsCOOSYSTEM@1.1:OBJECTLISTout Returns the list of allowed groups for the property COOWF@1.1:wfpgroup, if not set, any group is allowed.
orgunittypesCOOSYSTEM@1.1:OBJECTLISTout Returns the list of allowed organizational unit types for the property COOWF@1.1:wfporgunittype, if not set, any organizational unit type is allowed.
partdefsCOOSYSTEM@1.1:OBJECTLISTouttrue Returns the list of allowed participant definitions for the property COOWF@1.1:wfspartdefinition, if not set, any organizational unit type is allowed.
partnersCOOSYSTEM@1.1:OBJECTLISTouttrue Returns the list of allowed partners for the property COOWF@1.1:wfppartner, if not set, any organizational unit type is allowed.
attributesCOOSYSTEM@1.1:OBJECTLISTouttrue Returns the list of allowed attributes for the property COOWF@1.1:wfpattribute, if not set, any attributes is allowed.
isfilterCOOSYSTEM@1.1:BOOLEANintrue defines if the action is called by COOWF@1.1:FilterUsableObjects and the elements are filtered against the result of this action in the participant control are returned.
restrictedpartelementsCOOSYSTEM@1.1:OBJECTLISTouttrue Returns the list of attributes of the workflow participant which should be restricted to the supplied values. If a attribute is marked as restricted and no value is defined the attribute will not be displayed in the participant control. Possible values are:

COOWF@1.1:wfpmetaparticipant to disable the meta participant in the participant control

COOWF@1.1:wfpuser to disable the user in the participant control

COOWF@1.1:wfpgroup to disable the group in the participant control

COOWF@1.1:wfpposition to disable the position in the participant control

COOWF@1.1:wfporgunittype to disable the orgunittype in the participant control

COOWF@1.1:wfpattribute to disable the properties in the participant control

COOWF@1.1:wfppartner to disable the partners in the participant controls

COOWF@1.1:wfspartdefinition to disable distribution lists

Additional Information

ACL Object: COOSYSTEM@1.1:DefaultDeveloperACL


[top]

COOWF@1.1:GetUsableProcessDefinitions

This action is called by the user interface, when a new process instance is to be attached to an object or a sub process is to be inserted in a process, to retrieve the process definitions, that are usable for this object.
ParameterTypeIn/OutOptionalDescription
procdefsCOOSYSTEM@1.1:OBJECTLISTretval The usable process definitions.
excludeprocdefsCOOSYSTEM@1.1:OBJECTLISTintrue Process definitions specified in this parameter are never returned in procdefs.
enablesubCOOSYSTEM@1.1:BOOLEANintrue If set to True, process definitions usable only for sub processes are included.
prevelementsCOOSYSTEM@1.1:OBJECTLISTintrue the previous instance or definition elements in the process

Additional Information

ACL Object: COOSYSTEM@1.1:DefaultDeveloperACL


[top]

COOWF@1.1:GetUsableUsersGroups

This action is called by the forms for prescriptions on the current object to retrieve the users and groups, that should be made available for selection in the user interface.
This action is implement by calling COOWF@1.1:GetUsableOrgElements on the approriate object, so if you intend to influence the behaviour, you should overwrite that action to be consistent with the workflow participant control.
ParameterTypeIn/OutOptionalDescription
contextCOOSYSTEM@1.1:OBJECTin This parameter is intended to know the context, where this action is used, but is currently not set by the caller.
usersCOOSYSTEM@1.1:OBJECTLISTout Returns the list of available users.
usersrestrictedCOOSYSTEM@1.1:BOOLEANout If set to True, the user must be selected only among the users returned in users. Otherwise users is only used as initial selection, and other users may be selected.
groupsCOOSYSTEM@1.1:OBJECTLISTout Returns the list of available groups.
groupsrestrictedCOOSYSTEM@1.1:BOOLEANout If set to True, the group must be selected only among the groups returned in groups. Otherwise groups is only used as initial selection, and other groups may be selected.
partdefsCOOSYSTEM@1.1:OBJECTLISTouttrue Returns the list of available participant definitions.
partdefsrestrictedCOOSYSTEM@1.1:BOOLEANouttrue If set to True, the participant definition must be selected only among the participant definitions returned in partdefs. Otherwise partdefs is only used as initial selection, and other participant definition may be selected.
positionsCOOSYSTEM@1.1:OBJECTLISTouttrue Returns the list of available positions.
positionsrestrictedCOOSYSTEM@1.1:BOOLEANouttrue If set to True, the position must be selected only among the positions returned in positions. Otherwise positions is only used as initial selection, and other positions may be selected.
orgunittypesCOOSYSTEM@1.1:OBJECTLISTouttrue Returns the list of available organizational unit types.
orgunittypesrestrictedCOOSYSTEM@1.1:BOOLEANouttrue If set to True, the organizational unit type must be selected only among the organizational unit types returned in orgunittypes. Otherwise orgunittypes is only used as initial selection, and other organizational unit types may be selected.
attributesCOOSYSTEM@1.1:OBJECTLISTouttrue Returns the list of available attributes.
attributesrestrictedCOOSYSTEM@1.1:BOOLEANouttrue If set to True, the attribute must be selected only among the attributes returned in attributes. Otherwise attributes is only used as initial selection, and other attributes may be selected.

Additional Information

ACL Object: COOSYSTEM@1.1:DefaultDeveloperACL


[top]

COOWF@1.1:GetUserSubstitution

Retrieve the user substitution for the user
ParameterTypeIn/OutOptionalDescription
createCOOSYSTEM@1.1:BOOLEANintrue the substitution object will be created if not exist
usersubsCOOSYSTEM@1.1:OBJECTretval the user substitution object

Additional Information

ACL Object: COOSYSTEM@1.1:DefaultDeveloperACL


[top]

COOWF@1.1:GetWorkFlowConfigProperty

Retrieve the value of the supplied property stored in the work flow configuration.
ParameterTypeIn/OutOptionalDescription
attrdefCOOSYSTEM@1.1:OBJECTin the attribute definition which should be read from the configuration
valueretval the configured value

Additional Information

ACL Object: COOSYSTEM@1.1:DefaultDeveloperACL


[top]

COOWF@1.1:GetWorkFlowPreferenceGroupLocations

Retrieve the group locations where workflow prefererences are stored for a user
ParameterTypeIn/OutOptionalDescription
groupsCOOSYSTEM@1.1:OBJECTLISTretval the groupse where workflow preferences are stored;

Additional Information

ACL Object: COOSYSTEM@1.1:DefaultDeveloperACL


[top]

COOWF@1.1:GetWorkFlowPreferenceLocations

Retrieve the locations where work preferences can be stored.
ParameterTypeIn/OutOptionalDescription
usrenvlocationsCOOSYSTEM@1.1:OBJECTLISTretval
grouplocationsCOOSYSTEM@1.1:OBJECTLISTout the groups where workflow preferences can be stored
checkedusrenvsCOOSYSTEM@1.1:OBJECTLISTout
checkedgroupsCOOSYSTEM@1.1:OBJECTLISTout the group objects which have been checked

Additional Information

ACL Object: COOSYSTEM@1.1:DefaultDeveloperACL


[top]

COOWF@1.1:GetWorkFlowSettings

Get the workflow settings configured by an object class
ParameterTypeIn/OutOptionalDescription
defaultprocessCOOSYSTEM@1.1:OBJECTLISTout the processes which are initialized when creating an instance of this class
usableprocessCOOSYSTEM@1.1:OBJECTLISTout the processes which are allowed to be initiated on instances of this class
usableprescrCOOSYSTEM@1.1:OBJECTLISTout the activity definitions which are usable for prescriptions on instances of this class
copydefaultprocessCOOSYSTEM@1.1:BOOLEANouttrue if an instance is copied the default processes will be initialized for the copy or not

Additional Information

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


[top]

COOWF@1.1:GetWorkFlowStatisticsContainer

ParameterTypeIn/OutOptionalDescription
statisticscontainerCOOSYSTEM@1.1:OBJECTretval
createnotexistingCOOSYSTEM@1.1:BOOLEANintrue

Additional Information

ACL Object: COOSYSTEM@1.1:DefaultDeveloperACL
Private: true


[top]

COOWF@1.1:GetWorkItemIndex

Gets the index of the workitem matching the workitem key.
ParameterTypeIn/OutOptionalDescription
wfwkeyCOOSYSTEM@1.1:STRINGin the key of the work item
wfwindexCOOSYSTEM@1.1:INTEGERretval the index of the work item matching the key
wfworigindexCOOSYSTEM@1.1:INTEGERin the index of the key at the last call

Additional Information

ACL Object: COOSYSTEM@1.1:DefaultDeveloperACL


[top]

COOWF@1.1:GetWorkItemKey

Gets the key of the work item matching the supplied index.
ParameterTypeIn/OutOptionalDescription
wfwindexCOOSYSTEM@1.1:INTEGERin the index of the work item
wfwkeyCOOSYSTEM@1.1:STRINGretval the key of the work item matching the index

Additional Information

ACL Object: COOSYSTEM@1.1:DefaultDeveloperACL


[top]

COOWF@1.1:GetWorkItemsMenu

This action is used as dynamic menu get action for the the context menu of an activity instance. This action is called by the Fabasoft Component desk, when the user opens the context menu of an activity instance. The created menu allows the user the call the various work items.

Additional Information

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


[top]

COOWF@1.1:GetWorkList

Retrieves the current WorkList
ParameterTypeIn/OutOptionalDescription
worklistCOOSYSTEM@1.1:OBJECTretval in/out the worklist
sametxCOOSYSTEM@1.1:BOOLEANintrue if the worklist does not exist it will not be created by use of a separate transaction

Additional Information

ACL Object: COOSYSTEM@1.1:DefaultDeveloperACL


[top]

COOWF@1.1:GetWorkListItemCountFromTx

Gets the amount of activities stored in the WorkList
ParameterTypeIn/OutOptionalDescription
attrdefCOOSYSTEM@1.1:OBJECTin the requested property of the WorkList
itemcountCOOSYSTEM@1.1:INTEGERretval the amount of activities stored in the requested list

Additional Information

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


[top]

COOWF@1.1:HandleSuspendedByCancelProcesses

ParameterTypeIn/OutOptionalDescription
settosuspendedCOOSYSTEM@1.1:BOOLEANin

Additional Information

ACL Object: COOSYSTEM@1.1:DefaultDeveloperACL
Private: true


[top]

COOWF@1.1:HasAdditionalParticipantRestrictions

Check if the process has additional restrictions to the participants
ParameterTypeIn/OutOptionalDescription
additionalrestrictionsCOOSYSTEM@1.1:BOOLEANretval the result

Additional Information

ACL Object: COOSYSTEM@1.1:DefaultDeveloperACL


[top]

COOWF@1.1:HasValidParticipant

Check if the participant of the activity instance is valid.
ParameterTypeIn/OutOptionalDescription
checkactivesubstitutionCOOSYSTEM@1.1:BOOLEANintrue if set the participant is checked for active substitutions. The participant will be marked as invalid if the is a substitution defined
checkaccessCOOSYSTEM@1.1:BOOLEANintrue if defined the participant is checked for read access on the object of the process
hasvalidpartCOOSYSTEM@1.1:BOOLEANretval the result
invalidpartreasonCOOSYSTEM@1.1:STRINGouttrue a description if the participant is not valid

Additional Information

ACL Object: COOSYSTEM@1.1:DefaultDeveloperACL
Secured: SECURED_READWRITE


[top]

COOWF@1.1:HasWorkOnSubstTabSet

Check if flag domainworkonsubsttab is set within the workflow configuration
ParameterTypeIn/OutOptionalDescription
workonsubsttabCOOSYSTEM@1.1:BOOLEANretval true if substitute can work on substitution tab

Additional Information

ACL Object: COOSYSTEM@1.1:DefaultDeveloperACL


[top]

COOWF@1.1:HighchartsJSONAllowMultipleTypesWrapper

ParameterTypeIn/OutOptionalDescription
attrdefCOOSYSTEM@1.1:OBJECTin
allowCOOSYSTEM@1.1:BOOLEANretval in/out

Additional Information

ACL Object: COOSYSTEM@1.1:DefaultDeveloperACL
Private: true


[top]

COOWF@1.1:InitializeInstance

This action is called whenever an instance element has to be created from a definition element. This might be when a new process instance is created from a process definition, when a loop has to be repeated, or when a subprocess is expanded during the execution of a process instance.
If a software component has derived new classes for definition and instance elements, it has to implement a method for this action on its new classes for definition elements to create the appropriate classes for instance elements. Otherwise just the default classes for instance elements would be used, if instances are created from the definition.
ParameterTypeIn/OutOptionalDescription
coostCOOSYSTEM@1.1:OBJECTout The Fabasoft Components COO Store, where the new object should be created.
instelemCOOSYSTEM@1.1:OBJECTretval in/out If defined, when the action is called, no new object is created. Only the properties of the object are initialized with the templates from definition element. If not defined, a new object with an appropriate class is created and returned in this parameter.
procinstCOOSYSTEM@1.1:OBJECTin The process instance, that the instance element will be part of.

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:OBJECTout The Fabasoft Components COO Store, where the new object should be created.
procinstCOOSYSTEM@1.1:OBJECTretval in/out 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:OBJECTin 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: SECURED_READWRITE


[top]

COOWF@1.1:InitializeWorkFlow

This action is called and can be called to initialize new process instances from a list of process definitions and to attach these process instances to the object. The first activities of the new process instances are set to "Startable".
ParameterTypeIn/OutOptionalDescription
procdefsCOOSYSTEM@1.1:OBJECTLISTin The list of process definitions, that should be used as template to create process instances. If it is empty, a new process instance is created and initialized with a single activity with the current user as participant. Otherwise for each process definition a separate process instance is created.
addinstancesCOOSYSTEM@1.1:BOOLEANintrue If set to True, the new process instances are added to the list of process instances of the object. Otherwise the existing processes are replaced with the new process instances.
additionalobjectsCOOSYSTEM@1.1:OBJECTLISTintrue
submitdeadlineCOOSYSTEM@1.1:DATETIMEintrue the followers of the first activities are initialized with the supplied deadline for submission
expandsubCOOSYSTEM@1.1:BOOLEANintrue If set to True, all subprocesses contained in the supplied procdefs are expanded
partmappingCOOWF@1.1:WorkFlowParticipantMappingintrue the supplied mapping is used to replace the participants defined in the process definition when the activities are created.
processparamsCOOSYSTEM@1.1:DICTIONARYintrue if defined the process parameters are merged into the process parameters of the process diagram

Additional Information

Access Types: COOWF@1.1:AccTypeChangeWorkFlow
ACL Object: COOSYSTEM@1.1:DefaultDeveloperACL
Secured: SECURED_READWRITE


[top]

COOWF@1.1:InsertActivityInstance

This action can be called to insert a new activity instance after the current activity instance in a process. The activity instance is initialized with the values specified as parameters. If the current activity instance has multiple successors, the new activity instance is inserted before all of them.
ParameterTypeIn/OutOptionalDescription
participantCOOWF@1.1:WorkFlowParticipantin The workflow participant in the inserted activity instance.
partmansubstCOOWF@1.1:WorkFlowParticipantin The substitute in Fabasoft Components, if participant specifies a manual participant.
actinsttitleCOOSYSTEM@1.1:LanguageStringListin The title of the new activity instance.
actinsttypeCOOWF@1.1:ActivityTypein The type of the new activity instance.
copyactivityCOOSYSTEM@1.1:BOOLEANin If set to True, the current activity is copied to create a new activity instance, otherwise it is create from scratch.
actinstCOOSYSTEM@1.1:OBJECTretval The new created or copied activity instance.

Additional Information

ACL Object: COOSYSTEM@1.1:DefaultDeveloperACL


[top]

COOWF@1.1:InsertDefinitionElement

This action can be called to insert a definition element in a process definition. 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 definition of a CASE switch, an IF condition or a REPEAT loop, and the definition element is inserted after, it is inserted after the corresponding end element. On the opposite, if the current object is the end of the definition of a CASE switch, an IF condition or a REPEAT loop, and the definition element is inserted before, it is inserted before the corresponding start element.
ParameterTypeIn/OutOptionalDescription
procdefCOOSYSTEM@1.1:OBJECTin The process definition, that the current object belongs to.
defelemCOOSYSTEM@1.1:OBJECTin The definition element to insert.
beforeCOOSYSTEM@1.1:BOOLEANintrue If set to True, the definition 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 definition 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 definition 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.

Additional Information

ACL Object: COOSYSTEM@1.1:DefaultDeveloperACL


[top]

COOWF@1.1:InsertExternalActivity

This action can be called to insert an external activity instance into a process definition or instance in the specified part.
ParameterTypeIn/OutOptionalDescription
extactinstCOOSYSTEM@1.1:OBJECTin the extactinst
extcompleteCOOSYSTEM@1.1:BOOLEANin the extcomplete

Additional Information

Access Types: COOWF@1.1:AccTypeChangeWorkFlow
ACL Object: COOSYSTEM@1.1:DefaultDeveloperACL


[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:OBJECTin 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:InsertFirstSubProcess

This action can be called to insert a sub process into a process instance as the first element in the specified part. The sub process is expanded before it is inserted.
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
procdefCOOSYSTEM@1.1:OBJECTin The process definition of the sub process.
partCOOSYSTEM@1.1:INTEGERintrue In the case of an IF condition or CASE switch selects the part where the expanded sub process is inserted.

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:OBJECTin 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:OBJECTLISTin The start elements of the new inserted instance elements.
endelemsCOOSYSTEM@1.1:OBJECTLISTin 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:OBJECTin 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:OBJECTin 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:OBJECTin 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:InstanceElementStateChangedHook

Hook action called on the object of the process when the state of the activity instance or wait action instance is changed.
ParameterTypeIn/OutOptionalDescription
instelemCOOSYSTEM@1.1:OBJECTin
processCOOSYSTEM@1.1:OBJECTin the process instance
newstateCOOWF@1.1:ActivityInstanceStatein the state of the instance element
oldstateCOOWF@1.1:ActivityInstanceStatein the old state of the instance element

Additional Information

ACL Object: COOSYSTEM@1.1:DefaultDeveloperACL


[top]

COOWF@1.1:IsActivityCompleted

Check if an activity instance was already completed
ParameterTypeIn/OutOptionalDescription
iscompletedCOOSYSTEM@1.1:BOOLEANretval the result

Additional Information

ACL Object: COOSYSTEM@1.1:DefaultDeveloperACL
Secured: SECURED_READWRITE


[top]

COOWF@1.1:IsEditableWFAttribute

ParameterTypeIn/OutOptionalDescription
attrdefCOOSYSTEM@1.1:OBJECTin
actioncontextCOOSYSTEM@1.1:OBJECTLISTintrue
iseditableCOOSYSTEM@1.1:BOOLEANretval in/out

Additional Information

ACL Object: COOSYSTEM@1.1:DefaultDeveloperACL


[top]

COOWF@1.1:IsInstanceElementEvaluated

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.
ParameterTypeIn/OutOptionalDescription
isevaluatedCOOSYSTEM@1.1:BOOLEANretval
allowstartableCOOSYSTEM@1.1:BOOLEANintrue if set startable activities are not treated as evaluted

Additional Information

ACL Object: COOSYSTEM@1.1:DefaultDeveloperACL


[top]

COOWF@1.1:IsProcessAdministrator

Check if the current user is a process administrator
ParameterTypeIn/OutOptionalDescription
isprocadminCOOSYSTEM@1.1:BOOLEANretval the result
targetgroupCOOSYSTEM@1.1:OBJECTintrue

Additional Information

ACL Object: COOSYSTEM@1.1:DefaultDeveloperACL


[top]

COOWF@1.1:IsProcessOwner

Check if the current user is a process owner
ParameterTypeIn/OutOptionalDescription
isprocessownerCOOSYSTEM@1.1:BOOLEANretval the result
targetgroupCOOSYSTEM@1.1:OBJECTintrue the possible objects are restricted by the supplied group

Additional Information

ACL Object: COOSYSTEM@1.1:DefaultDeveloperACL


[top]

COOWF@1.1:IsReferencedDiagram

Check if the current workflow diagram is used as referenced diagram in another diagram
ParameterTypeIn/OutOptionalDescription
checkreleasedonlyCOOSYSTEM@1.1:BOOLEANin the diagram in only marked as used if the referencing diagram is released
isreferencedCOOSYSTEM@1.1:BOOLEANretval the result
referencingdiagramsCOOSYSTEM@1.1:OBJECTLISTouttrue the diagrams which reference the current diagram

Additional Information

ACL Object: COOSYSTEM@1.1:DefaultDeveloperACL


[top]

COOWF@1.1:IsValidPublishedDiagram

Checks if the current workflow diagram is a released version of an existing workflow diagram which is not already deleted.
ParameterTypeIn/OutOptionalDescription
isvalidCOOSYSTEM@1.1:BOOLEANretval the result

Additional Information

ACL Object: COOSYSTEM@1.1:DefaultDeveloperACL


[top]

COOWF@1.1:IsWFSubstitutionActive

Checks whether the workflow substitution is active.
ParameterTypeIn/OutOptionalDescription
isactiveCOOSYSTEM@1.1:BOOLEANretval true if active
substitutesCOOSYSTEM@1.1:OBJECTLISTout the current substitutes

Additional Information

ACL Object: COOSYSTEM@1.1:DefaultDeveloperACL


[top]

COOWF@1.1:IsWFSubstitutionEnabled

Checks whether the workflow substitution is enabled and definable by the user.
ParameterTypeIn/OutOptionalDescription
isfeatureenabledCOOSYSTEM@1.1:BOOLEANretval true if the workflow feature is enabled
isdefinablebyuserCOOSYSTEM@1.1:BOOLEANout true if user is allowed to change his workflow substitution

Additional Information

ACL Object: COOSYSTEM@1.1:DefaultDeveloperACL


[top]

COOWF@1.1:IsWorkFlowServiceUser

This action is used to decide if the current user is used as service user for background execution of workflow diagrams. For this user the user profile to filter acitivities and process definitions is not evaluated.
ParameterTypeIn/OutOptionalDescription
isserviceuserCOOSYSTEM@1.1:BOOLEANretval the result
servicegroupsCOOSYSTEM@1.1:OBJECTLISTout the service groups of the user

Additional Information

ACL Object: COOSYSTEM@1.1:DefaultDeveloperACL


[top]

COOWF@1.1:LockProcessObjectHook

This hook action can be called to lock the process object.

Additional Information

ACL Object: COOSYSTEM@1.1:DefaultDeveloperACL


[top]

COOWF@1.1:LockWorkFlowObjects

This hook action is called to lock the activities of the process.

Additional Information

ACL Object: COOSYSTEM@1.1:DefaultDeveloperACL


[top]

COOWF@1.1:LogWorkFlowHistory

Hook action when a history modification should be logged
ParameterTypeIn/OutOptionalDescription
contextCOOSYSTEM@1.1:OBJECTin the action context from which the history logging is called
workfowobjectCOOSYSTEM@1.1:OBJECTin this object is the activity instance or process instance which is concerned.
valueintrue if the logging is called from a set action this parameter contains the value parameter the caller
oldvalueintrue if the logging is called from a set action this parameter contains the oldvalue parameter the caller

Additional Information

ACL Object: COOSYSTEM@1.1:DefaultDeveloperACL


[top]

COOWF@1.1:LoggedIn

This action is called when a user performs a login

Additional Information

ACL Object: COOSYSTEM@1.1:DefaultDeveloperACL


[top]

COOWF@1.1:ModifyDelegatePage

Filter elements displayed on the delegate form page

Additional Information

Prototype: COOATTREDIT@1.1:FormPageItemPrototype
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:ModifyPrescriptions

Modify the prescriptions of the activity instance
ParameterTypeIn/OutOptionalDescription
advancedCOOSYSTEM@1.1:BOOLEANin the advanced
prescrblocksonlyCOOSYSTEM@1.1:BOOLEANin the prescrblocksonly
isadvancedCOOSYSTEM@1.1:BOOLEANretval the isadvanced

Additional Information

ACL Object: COOSYSTEM@1.1:DefaultDeveloperACL


[top]

COOWF@1.1:ModifySubmissionsPage

This action is used as display items filter action in the submission form page.

Additional Information

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


[top]

COOWF@1.1:ModifyTerminatePage

This action is used as display items filter action in the termination form page.

Additional Information

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


[top]

COOWF@1.1:MovePrescription

Moves a prescription entry from the source index position to the destination index position. It is possible to convert a subprescription to a normal prescription ande vice versa. If no source index is supplied a new prescription will be created at the destiantion. If no destination index is supplied the prescription at source index will be removed. If no source and no target index is supplied a new prescription will be created at the end.
ParameterTypeIn/OutOptionalDescription
srcindicesCOOSYSTEM@1.1:INTEGERLISTin/out the source index consists of blockid, prescriptionid, subblockid and subprescriptionid the subblock indices can be skipped
dstindicesCOOSYSTEM@1.1:INTEGERLISTin/out the destination index consists of blockid, prescriptionid, subblockid and subprescriptionid the subblock indices can be skipped
modeCOOWF@1.1:SavePresciptionActionTypein defines if the prescription will be enclosed into a block or be inserted parallel.
afterCOOSYSTEM@1.1:BOOLEANin defines if the operation will be performed before or after the destination index.
updatedprescriptionCOOWF@1.1:WorkFlowPrescriptionListintrue the source index will be updated with this value if the mode is set to update

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/out the process state
applicationsCOOSYSTEM@1.1:OBJECTLISTout the applications
applobjectsCOOSYSTEM@1.1:OBJECTLISTout the objects of the application
completeCOOSYSTEM@1.1:BOOLEANout the result if the porcess is complete

Additional Information

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


[top]

COOWF@1.1:NormalizeNestedPrescriptions

Normalize nested prescription of an activity instance. Try to transform nested prescriptions to own prescription blocks to increase readability of complex prescriptions
ParameterTypeIn/OutOptionalDescription
blocksCOOWF@1.1:WorkFlowPrescriptionBlockListin/out the prescription blocks which should be normalized. If no blocks are supplied the blocks are read from the object

Additional Information

ACL Object: COOSYSTEM@1.1:DefaultDeveloperACL


[top]

COOWF@1.1:ObjectAccTypesGet

This action is used as a post wrapper for the action COOSYSTEM@1.1:ObjectAccessTypesGet to modify the list of possible access types in the access control list of an object. The access types introduced by the software component Workflow might not be included in the list returned by the system action, because they might be checked in a way not foreseen by the system.
ParameterTypeIn/OutOptionalDescription
accesstypesCOOSYSTEM@1.1:OBJECTLISTin/out On input the list of access types returned by COOSYSTEM@1.1:ObjectAccessTypesGet. On output extended with the access types, that are additionally needed for the current object by the workflow.
isclassCOOSYSTEM@1.1:BOOLEANintrue defines if the supplied object is an object class

Additional Information

ACL Object: COOSYSTEM@1.1:DefaultDeveloperACL


[top]

COOWF@1.1:OpenStatisticsDashboard

Menu usecase to specific widgets of the workflow statistics

Additional Information

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


[top]

COOWF@1.1:ParseBPMNModel

This action is used to check if the model is a valid bpmn diagram.
ParameterTypeIn/OutOptionalDescription
checkexecutionCOOSYSTEM@1.1:BOOLEANin the model should be checked to be executable
modelintrue the bpmn model which will be checked. If the parameter is not set the model will be read from the object
modeltypeFSCDIAGRAM@1.1001:DiagramTypeintrue the type of the BPMN model e.g process diagram
problemsCOOSYSTEM@1.1:DICTIONARYretval the problems found during the validation
expandsubCOOSYSTEM@1.1:BOOLEANintrue defines if the related diagrams will be resolved to instances
expandprescriptionCOOSYSTEM@1.1:BOOLEANintrue the process of the diagram is resolved to prescription blocks. Note this option is only evaluated for the modeling type WFDMT_PRESCRIPTION
prescriptionblocksCOOWF@1.1:WorkFlowPrescriptionBlockListouttrue the resolved prescription blocks
updatemodelCOOSYSTEM@1.1:BOOLEANintrue the model should be modified to work in other installations.
isexportCOOSYSTEM@1.1:BOOLEANintrue if true COO-Addresses are replaced by external keys otherwise external keys are replaced with COO-Addresses
updatedmodelCOOSYSTEM@1.1:CONTENTouttrue the updated model
updatetranslationsCOOSYSTEM@1.1:BOOLEANintrue the translations of the model are updated and returned in parameter updatedmodel
forcereferenceddraftversionCOOSYSTEM@1.1:BOOLEANintrue if to true the draft version of all referenced diagrams is used. If set to false the released version of the referenced processes is used. If the parameter is not defined the current referenced object is used

Additional Information

ACL Object: COOSYSTEM@1.1:DefaultDeveloperACL


[top]

COOWF@1.1:PatchBPMNDiagramTranslations

ParameterTypeIn/OutOptionalDescription
updatedmodelCOOSYSTEM@1.1:CONTENTretval in/out

Additional Information

ACL Object: COOSYSTEM@1.1:DefaultDeveloperACL


[top]

COOWF@1.1:PrescribeObject

Adds following activities to the process of the current activity. If this action is called on an object, a new process is started.
ParameterTypeIn/OutOptionalDescription
handleCOOSYSTEM@1.1:INTEGERintrue unused deprecated
indexCOOSYSTEM@1.1:INTEGERintrue unused deprecated
prescriptionCOOWF@1.1:WorkFlowPrescriptionListintrue the prescription list contains the following activities and participants
prescrparallelCOOSYSTEM@1.1:BOOLEANintrue defines if following activities defined in parameter prescription will be added parallel
prescrbackCOOSYSTEM@1.1:OBJECTintrue this activity will be added after the inserted activity instances.
remarkCOOSYSTEM@1.1:STRINGintrue the entered remark will be stored to the current activity instance.
remarkdefinedCOOSYSTEM@1.1:BOOLEANintrue determines if a remark is supplied
receivedatCOOSYSTEM@1.1:DATETIMEintrue the time stamp when the current activity was received. Only important for manual activities!
startedatCOOSYSTEM@1.1:DATETIMEintrue the time stamp when the current activity was started Only important for manual activities!
completedatCOOSYSTEM@1.1:DATETIMEintrue the time stamp when the current activity was completed Only important for manual activities!
prescrblocksCOOWF@1.1:WorkFlowPrescriptionBlockListintrue the prescription blocks contains the following activities and participants
notcompleteCOOSYSTEM@1.1:BOOLEANintrue internal: is used for integrity checks if the current activity was already completed
additionalobjectsCOOSYSTEM@1.1:OBJECTLISTintrue when creating a new process this objects will be added to COOWF@1.1:procinstobjects
concernedobjectsCOOSYSTEM@1.1:OBJECTLISTintrue the objects which are dependent for the prescription
processnameCOOSYSTEM@1.1:STRINGintrue the name of the newly created process
processdiagramCOOSYSTEM@1.1:OBJECTintrue the supplied diagram initiates the process on the current object
delayedprocessstartCOOSYSTEM@1.1:BOOLEANintrue the process is not started immediately
adhocprocesskeyCOOSYSTEM@1.1:STRINGintrue the key for the ad hoc process. This parameter is for internal reasons and should not be set.
procinstCOOSYSTEM@1.1:OBJECTretval the process instance where the ad hoc elements were inserted to
partmappingCOOWF@1.1:WorkFlowParticipantMappingintrue the supplied mapping is used to replace the participants defined in the process diagram when the activities are created.
expandsubprocessesCOOSYSTEM@1.1:BOOLEANintrue If set to True, all subprocesses contained in the supplied process diagram are expanded directly when the process is started
processparamsCOOSYSTEM@1.1:DICTIONARYintrue if defined the process parameters are merged into the process parameters of the process diagram

Additional Information

Prototype: COODESK@1.1:MenuActionPrototype
Access Types: COOWF@1.1:AccTypeChangeWorkFlow
ACL Object: COOSYSTEM@1.1:DefaultDeveloperACL
Secured: SECURED_READWRITE


[top]

COOWF@1.1:PrescribeObjectDirect

Action used to prescribe an object from the advanced process editor without any checks of the activity state
ParameterTypeIn/OutOptionalDescription
handleCOOSYSTEM@1.1:INTEGERintrue is no longer used
indexCOOSYSTEM@1.1:INTEGERintrue is no longer used

Additional Information

Prototype: COODESK@1.1:MenuActionPrototype
Access Types: COOWF@1.1:AccTypeChangeWorkFlow
ACL Object: COOSYSTEM@1.1:DefaultDeveloperACL


[top]

COOWF@1.1:PrescribeOnScope

An activity will be added to the current process or a new process will be started. The inserted activity will be calculated by using the customization point COOWF@1.1:InsertActivityDef.
ParameterTypeIn/OutOptionalDescription
scopeCOOSYSTEM@1.1:OBJECTin The scope is used as key in combination with the object class to retrieve an activity definition. Each component object can be used as scope.
stateCOOSYSTEM@1.1:DICTIONARYintrue The state is a dictionary to supply additional informations for evaluation of the activity definition.
participantCOOWF@1.1:WorkFlowParticipantintrue The participant parameter defines to whom the calculated activity belongs. If a list of participants is supplied, the activity will be inserted for each participant parallel to the others.
subjectCOOSYSTEM@1.1:STRINGintrue This parameter defines an optional remark which will be added to the inserted activity.

Additional Information

ACL Object: COOSYSTEM@1.1:DefaultDeveloperACL


[top]

COOWF@1.1:PrescribeSelectedObjects

Selected action for PrescribeObject
ParameterTypeIn/OutOptionalDescription
handleCOOSYSTEM@1.1:INTEGERintrue is no longer used
indexCOOSYSTEM@1.1:INTEGERintrue is no longer used

Additional Information

Call Mode for Actions on Selected Objects: CALLMODE_SELECTEDONLY
Called Action on Selected Objects: COOWF@1.1:PrescribeObject
Prototype: COODESK@1.1:MenuActionPrototype
ACL Object: COOSYSTEM@1.1:DefaultDeveloperACL


[top]

COOWF@1.1:ProcessSettings

Menu usecase to edit the worfklow settings

Additional Information

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


[top]

COOWF@1.1:ProcessStateChangedHook

Hook action called on the object of the process when the state of the process is changed
ParameterTypeIn/OutOptionalDescription
processCOOSYSTEM@1.1:OBJECTin the process instance
newstateCOOWF@1.1:ProcessInstanceStatein the state of the process instance
oldstateCOOWF@1.1:ProcessInstanceStatein the old state of the process instance

Additional Information

ACL Object: COOSYSTEM@1.1:DefaultDeveloperACL


[top]

COOWF@1.1:ProcessStatisticsEnabled

Check if process statistics are enabled for the supplied user
ParameterTypeIn/OutOptionalDescription
enabledCOOSYSTEM@1.1:BOOLEANretval the result
targetgroupCOOSYSTEM@1.1:OBJECTintrue

Additional Information

ACL Object: COOSYSTEM@1.1:DefaultDeveloperACL


[top]

COOWF@1.1:ReadObjectAttributesDirect

Action to direct read the properties of an object
ParameterTypeIn/OutOptionalDescription
handleCOOSYSTEM@1.1:INTEGERintrue is no longer used
indexCOOSYSTEM@1.1:INTEGERintrue is no longer used

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:RefreshProcessList (Refresh Process List)

This action will be called as result of an notification. The process list of the current user will be refreshed on execution of the notification.

Additional Information

ACL Object: COOSYSTEM@1.1:DefaultDeveloperACL


[top]

COOWF@1.1:RefreshProcessStatistics

Additional Information

ACL Object: COOSYSTEM@1.1:DefaultDeveloperACL
Private: true


[top]

COOWF@1.1:RefreshWorkList (Refresh Worklist)

This action will be called as result of an notification. The work list of the current user will be refreshed on execution of the notification.

Additional Information

ACL Object: COOSYSTEM@1.1:DefaultDeveloperACL


[top]

COOWF@1.1:RefreshWorklistDisplayEffect

Refreshes the WorkList of the current user if the display effect of object of a process has been changed

Additional Information

ACL Object: COOSYSTEM@1.1:DefaultDeveloperACL


[top]

COOWF@1.1:RemoveDefinitionElement

This action can be called to remove a definition element from a process definition. The definition element itself is not destroyed, only the pointers of the predecessors and successors of the definition element are modified, so that the element is not longer part of the process definition. 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.
ParameterTypeIn/OutOptionalDescription
procdefCOOSYSTEM@1.1:OBJECTin The process definition, that this definition element is part of.

Additional Information

ACL Object: COOSYSTEM@1.1:DefaultDeveloperACL


[top]

COOWF@1.1:RemoveFromProcessFolder

Remove selected objects from current process folder

Additional Information

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


[top]

COOWF@1.1:RemoveFromProcessFolderSelected

Additional Information

Call Mode for Actions on Selected Objects: CALLMODE_SELECTEDONLY
Called Action on Selected Objects: COOWF@1.1:RemoveFromProcessFolder
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:RemovePrescription

Removes a prescription
ParameterTypeIn/OutOptionalDescription
prescriptionCOOWF@1.1:WorkFlowPrescriptionListin/out the prescription
pblockidxCOOSYSTEM@1.1:INTEGERin/outtrue the index of the prescription block
pidxCOOSYSTEM@1.1:INTEGERin/outtrue the index of the prescription in the prescription block

Additional Information

ACL Object: COOSYSTEM@1.1:DefaultDeveloperACL
Obsolete: true


[top]

COOWF@1.1:ResetObjectHighlighting

Rests the currently used highlighting color
ParameterTypeIn/OutOptionalDescription
exceptobjectsCOOSYSTEM@1.1:OBJECTLISTin the exceptobjects
viewCOOSYSTEM@1.1:OBJECTin the view

Additional Information

ACL Object: COOSYSTEM@1.1:DefaultDeveloperACL


[top]

COOWF@1.1:ResetSecurityOrgElements

Removes the users and groups which are no longer participants of the workflow from the security attributes.
ParameterTypeIn/OutOptionalDescription
resetusersCOOSYSTEM@1.1:BOOLEANin the property where the users participating in workflow are stored.
resetgroupsCOOSYSTEM@1.1:BOOLEANin the property where the groups participating in workflow are stored.
resetusersdoneCOOSYSTEM@1.1:BOOLEANintrue the property where the user had participated in workflow are stored.
resetgroupsdoneCOOSYSTEM@1.1:BOOLEANintrue the property where the groups had participated in workflow are stored.
resetroleusersCOOSYSTEM@1.1:BOOLEANintrue the property where the users participating in workflow by role are stored.
resetroleusersdoneCOOSYSTEM@1.1:BOOLEANintrue the property where the users have participated in workflow by role are stored.

Additional Information

ACL Object: COOSYSTEM@1.1:DefaultDeveloperACL


[top]

COOWF@1.1:ResolveDistributionList

Resolve distribution list to single prescription blocks
ParameterTypeIn/OutOptionalDescription
prescriptionblocksCOOWF@1.1:WorkFlowPrescriptionBlockListin/out the prescription blocks which include distribution lists to resolve
persistCOOSYSTEM@1.1:BOOLEANintrue the resolved prescriptionblocks are stored on the object. In case of no supplied prescriptionblocks the prescriptionblocks are read from the object.

Additional Information

ACL Object: COOSYSTEM@1.1:DefaultDeveloperACL


[top]

COOWF@1.1:ResolveMetaParticipant

This action is called, when the execution of a process instance reaches an activity that refers to an abstract participant as workflow participant. It is used to resolve that abstract participant specified in the enumeration type COOWF@1.1:WorkFlowMetaParticipant to an organizational element. Software components, that extend this enumeration type with additional abstract participants have to specify a wrapper for this action to resolve the added abstract participants.

Additional Information

Prototype: COOWF@1.1:ResolveMetaParticipantPrototype
ACL Object: COOSYSTEM@1.1:DefaultDeveloperACL


[top]

COOWF@1.1:ResolveMultiInstanceActivity

This action is used to resolve a multiple instance activity to a separate instance for each participant
ParameterTypeIn/OutOptionalDescription
newstateCOOWF@1.1:ActivityInstanceStatein
oldstateCOOWF@1.1:ActivityInstanceStatein

Additional Information

ACL Object: COOSYSTEM@1.1:DefaultDeveloperACL


[top]

COOWF@1.1:ResolvePropertyRole

This action is called to resolve the correct participant identified by a property role
ParameterTypeIn/OutOptionalDescription
partCOOWF@1.1:WorkFlowParticipantretval in/out the participant which should be resolved

Additional Information

ACL Object: COOSYSTEM@1.1:DefaultDeveloperACL


[top]

COOWF@1.1:RestoreObjectPostWrapper

ParameterTypeIn/OutOptionalDescription
handleCOOSYSTEM@1.1:INTEGERintrue
indexCOOSYSTEM@1.1:INTEGERintrue
ownerCOOSYSTEM@1.1:OBJECTintrue
aclCOOSYSTEM@1.1:OBJECTintrue
noguiCOOSYSTEM@1.1:BOOLEANintrue

Additional Information

ACL Object: COOSYSTEM@1.1:DefaultDeveloperACL
Private: true


[top]

COOWF@1.1:SavePrescriptionTemplate

Save current prescription as a template
ParameterTypeIn/OutOptionalDescription
templatenameCOOSYSTEM@1.1:STRINGin the name of the created template
templateCOOSYSTEM@1.1:OBJECTretval in/out the created or updated template
skipshareCOOSYSTEM@1.1:BOOLEANintrue do not share template
sharetargetCOOSYSTEM@1.1:OBJECTintrue share the template to this target object
shareviewCOOSYSTEM@1.1:OBJECTintrue share the template to this target view

Additional Information

ACL Object: COOSYSTEM@1.1:DefaultDeveloperACL


[top]

COOWF@1.1:SavePrescriptionTemplateHook

Hook application to be overriden in template management for saving prescription templates
ParameterTypeIn/OutOptionalDescription
vwf_objectCOOSYSTEM@1.1:OBJECTin activity instance
prescr_templatesCOOSYSTEM@1.1:OBJECTLISTin/out list of prescription templates

Additional Information

ACL Object: COOSYSTEM@1.1:DefaultDeveloperACL


[top]

COOWF@1.1:SelectPrescriptionTemplate

Application to select a workflow diagram or a prescription template which should be used to start a new process or add new activities to an existing process
ParameterTypeIn/OutOptionalDescription
initCOOSYSTEM@1.1:BOOLEANin
vwf_objectCOOSYSTEM@1.1:OBJECTin
vwf_selobjectsCOOSYSTEM@1.1:OBJECTLISTin
vwf_prescribedefaultCOOSYSTEM@1.1:OBJECTin
commondefaultCOOSYSTEM@1.1:BOOLEANout
prescriptionCOOWF@1.1:WorkFlowPrescriptionListout
prescrparallelCOOSYSTEM@1.1:BOOLEANout
prescrbackCOOSYSTEM@1.1:OBJECTout
prescrusableCOOSYSTEM@1.1:OBJECTLISTouttrue
prescrrestrictedCOOSYSTEM@1.1:BOOLEANouttrue
prescrblocksCOOWF@1.1:WorkFlowPrescriptionBlockListouttrue
prescrbackrestrictedCOOSYSTEM@1.1:BOOLEANouttrue
commonprocesspossibleCOOSYSTEM@1.1:BOOLEANouttrue
availabletemplatesCOOSYSTEM@1.1:OBJECTLISTouttrue
selecteddiagramCOOSYSTEM@1.1:OBJECTouttrue
selectedtemplateCOOSYSTEM@1.1:OBJECTouttrue

Additional Information

ACL Object: COOSYSTEM@1.1:DefaultDeveloperACL


[top]

COOWF@1.1:SetActive

Activates a suspended activity instance
ParameterTypeIn/OutOptionalDescription
handleCOOSYSTEM@1.1:INTEGERintrue is no longer used
indexCOOSYSTEM@1.1:INTEGERintrue is no longer used
noguiCOOSYSTEM@1.1:BOOLEANintrue the nogui
receivedatCOOSYSTEM@1.1:DATETIMEintrue the receivedat
startedatCOOSYSTEM@1.1:DATETIMEintrue the time stamp when the activity was started

Additional Information

Prototype: COODESK@1.1:MenuActionPrototype
Access Types: COOSYSTEM@1.1:AccTypeChange
ACL Object: COOSYSTEM@1.1:DefaultDeveloperACL


[top]

COOWF@1.1:SetCompleted

Completes an activity instance.
ParameterTypeIn/OutOptionalDescription
handleCOOSYSTEM@1.1:INTEGERintrue is unused
indexCOOSYSTEM@1.1:INTEGERintrue is unused
remarkCOOSYSTEM@1.1:STRINGintrue the remark will be stored on the completed activity
remarkdefinedCOOSYSTEM@1.1:BOOLEANintrue decides if the existing remark is cleared if the parameter remark is empty
receivedatCOOSYSTEM@1.1:DATETIMEintrue the time stamp when the activity instance was received
startedatCOOSYSTEM@1.1:DATETIMEintrue the time stamp when the activity instance was started
completedatCOOSYSTEM@1.1:DATETIMEintrue the time stamp when the activity instance was completed
completemodeCOOSYSTEM@1.1:INTEGERintrue the mode decides how the activity is completed. Supporded values are null, 1, 2 and 3.
  • Value 1: Activity needs a follower
  • Value 2: Activity does not allow a follower
  • Value 3: Activity is completed with state ACTINST_PRESCRIBED.

Additional Information

Prototype: COODESK@1.1:MenuActionPrototype
Access Types: COOSYSTEM@1.1:AccTypeChange
ACL Object: COOSYSTEM@1.1:DefaultDeveloperACL


[top]

COOWF@1.1:SetCompletedSubmission

Complete the activity instance and set a submission date for the follower activity.
ParameterTypeIn/OutOptionalDescription
handleCOOSYSTEM@1.1:INTEGERintrue is no longer used
indexCOOSYSTEM@1.1:INTEGERintrue is no longer used

Additional Information

Prototype: COODESK@1.1:MenuActionPrototype
Access Types: COOSYSTEM@1.1:AccTypeChange
ACL Object: COOSYSTEM@1.1:DefaultDeveloperACL


[top]

COOWF@1.1:SetDelegated

Delegates the respnsibility for the activity instance to the supplied participant.
ParameterTypeIn/OutOptionalDescription
handleCOOSYSTEM@1.1:INTEGERintrue is no longer used
indexCOOSYSTEM@1.1:INTEGERintrue is no longer used
participantCOOWF@1.1:WorkFlowParticipantin the participant
partmansubstCOOWF@1.1:WorkFlowParticipantintrue the partmansubst
remarkCOOSYSTEM@1.1:STRINGintrue the remark
remarkdefinedCOOSYSTEM@1.1:BOOLEANintrue the defines if a remark was entered
receivedatCOOSYSTEM@1.1:DATETIMEintrue the time stamp when the activity was received
startedatCOOSYSTEM@1.1:DATETIMEintrue the time stamp when the activity was started
completedatCOOSYSTEM@1.1:DATETIMEintrue the time stamp when the activity was completed
submitdeadlineCOOSYSTEM@1.1:DATETIMEintrue the deadline when the activity is displayed in the work list
startdeadlineCOOSYSTEM@1.1:DATETIMEintrue the deadline for starting the activity
enddeadlineCOOSYSTEM@1.1:DATETIMEintrue the deadline for completing the activity

Additional Information

Prototype: COODESK@1.1:MenuActionPrototype
Access Types: COOSYSTEM@1.1:AccTypeChange
ACL Object: COOSYSTEM@1.1:DefaultDeveloperACL


[top]

COOWF@1.1:SetDelegatedMultiple

Delegates the activity to multiple participants.
ParameterTypeIn/OutOptionalDescription
handleCOOSYSTEM@1.1:INTEGERintrue is no longer used
indexCOOSYSTEM@1.1:INTEGERintrue is no longer used
participantsCOOWF@1.1:PrescriptionMetaDataWhoin the participants
receivedatCOOSYSTEM@1.1:DATETIMEintrue the time stamp when the activity was received
startedatCOOSYSTEM@1.1:DATETIMEintrue the time stamp when the activity was started
completedatCOOSYSTEM@1.1:DATETIMEintrue the time stamp when the activity was completed
submitdeadlineCOOSYSTEM@1.1:DATETIMEintrue the deadline when the activity is displayed in the work list
startdeadlineCOOSYSTEM@1.1:DATETIMEintrue the deadline for starting the activity
enddeadlineCOOSYSTEM@1.1:DATETIMEintrue the deadline for completing the activity

Additional Information

Prototype: COODESK@1.1:MenuActionPrototype
Access Types: COOSYSTEM@1.1:AccTypeChange
ACL Object: COOSYSTEM@1.1:DefaultDeveloperACL


[top]

COOWF@1.1:SetProcessActive

Activates a suspended process

Additional Information

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


[top]

COOWF@1.1:SetProcessParameter

Action to set a process parameter for a specified process. This action fails for users with are no participant of the process or have no access on the object of the process.
ParameterTypeIn/OutOptionalDescription
keyCOOSYSTEM@1.1:STRINGin the identifier for the process parameter
valueintrue the parameter value
separatetxCOOSYSTEM@1.1:BOOLEANintrue the changes are stored in a separate transaction and directly saved

Additional Information

ACL Object: COOSYSTEM@1.1:DefaultDeveloperACL
Secured: SECURED_READWRITE


[top]

COOWF@1.1:SetProcessSuspended

Suspends a process

Additional Information

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


[top]

COOWF@1.1:SetProcessTerminated

Terminated a process

Additional Information

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


[top]

COOWF@1.1:SetRetracted

Retracts the activity instance.
ParameterTypeIn/OutOptionalDescription
handleCOOSYSTEM@1.1:INTEGERintrue is no longer used
indexCOOSYSTEM@1.1:INTEGERintrue is no longer used
remarkCOOSYSTEM@1.1:STRINGintrue the remark
remarkdefinedCOOSYSTEM@1.1:BOOLEANintrue the remarkdefined

Additional Information

Prototype: COODESK@1.1:MenuActionPrototype
Access Types: COOSYSTEM@1.1:AccTypeChange
ACL Object: COOSYSTEM@1.1:DefaultDeveloperACL


[top]

COOWF@1.1:SetSelectedObjectsActive

Selected action for SetActive
ParameterTypeIn/OutOptionalDescription
handleCOOSYSTEM@1.1:INTEGERintrue is no longer used
indexCOOSYSTEM@1.1:INTEGERintrue is no longer used

Additional Information

Call Mode for Actions on Selected Objects: CALLMODE_SELECTEDONLY
Called Action on Selected Objects: COOWF@1.1:SetActive
Prototype: COODESK@1.1:MenuActionPrototype
ACL Object: COOSYSTEM@1.1:DefaultDeveloperACL


[top]

COOWF@1.1:SetSelectedObjectsCompleted

Selected action for SetCompleted
ParameterTypeIn/OutOptionalDescription
handleCOOSYSTEM@1.1:INTEGERintrue is no longer used
indexCOOSYSTEM@1.1:INTEGERintrue is no longer used

Additional Information

Call Mode for Actions on Selected Objects: CALLMODE_SELECTEDONLY
Called Action on Selected Objects: COOWF@1.1:SetCompleted
Prototype: COODESK@1.1:MenuActionPrototype
ACL Object: COOSYSTEM@1.1:DefaultDeveloperACL


[top]

COOWF@1.1:SetSelectedObjectsCompleted2

Selected action for SetCompleted
ParameterTypeIn/OutOptionalDescription
handleCOOSYSTEM@1.1:INTEGERintrue is no longer used
indexCOOSYSTEM@1.1:INTEGERintrue is no longer used

Additional Information

Call Mode for Actions on Selected Objects: CALLMODE_SELECTEDONLY
Called Action on Selected Objects: COOWF@1.1:SetCompleted
Prototype: COODESK@1.1:MenuActionPrototype
ACL Object: COOSYSTEM@1.1:DefaultDeveloperACL


[top]

COOWF@1.1:SetSelectedObjectsCompletedSubmission

Selected action for SetCompletedSubmission
ParameterTypeIn/OutOptionalDescription
handleCOOSYSTEM@1.1:INTEGERintrue is no longer used
indexCOOSYSTEM@1.1:INTEGERintrue is no longer used

Additional Information

Call Mode for Actions on Selected Objects: CALLMODE_SELECTEDONLY
Called Action on Selected Objects: COOWF@1.1:SetCompletedSubmission
Prototype: COODESK@1.1:MenuActionPrototype
ACL Object: COOSYSTEM@1.1:DefaultDeveloperACL


[top]

COOWF@1.1:SetSelectedObjectsDelegated

Selected action for SetDelegated
ParameterTypeIn/OutOptionalDescription
handleCOOSYSTEM@1.1:INTEGERintrue is no longer used
indexCOOSYSTEM@1.1:INTEGERintrue is no longer used

Additional Information

Call Mode for Actions on Selected Objects: CALLMODE_SELECTEDONLY
Called Action on Selected Objects: COOWF@1.1:SetDelegated
Prototype: COODESK@1.1:MenuActionPrototype
ACL Object: COOSYSTEM@1.1:DefaultDeveloperACL


[top]

COOWF@1.1:SetSelectedObjectsDelegatedMultiple

Selected action for SetDelegatedMultiple
ParameterTypeIn/OutOptionalDescription
handleCOOSYSTEM@1.1:INTEGERintrue is no longer used
indexCOOSYSTEM@1.1:INTEGERintrue is no longer used

Additional Information

Call Mode for Actions on Selected Objects: CALLMODE_SELECTEDONLY
Called Action on Selected Objects: COOWF@1.1:SetDelegatedMultiple
Prototype: COODESK@1.1:MenuActionPrototype
ACL Object: COOSYSTEM@1.1:DefaultDeveloperACL


[top]

COOWF@1.1:SetSelectedObjectsRetracted

Selected action for SetRetracted
ParameterTypeIn/OutOptionalDescription
handleCOOSYSTEM@1.1:INTEGERintrue is no longer used
indexCOOSYSTEM@1.1:INTEGERintrue is no longer used

Additional Information

Call Mode for Actions on Selected Objects: CALLMODE_SELECTEDONLY
Called Action on Selected Objects: COOWF@1.1:SetRetracted
Prototype: COODESK@1.1:MenuActionPrototype
ACL Object: COOSYSTEM@1.1:DefaultDeveloperACL


[top]

COOWF@1.1:SetSelectedObjectsStarted

Selected action for SetStarted
ParameterTypeIn/OutOptionalDescription
handleCOOSYSTEM@1.1:INTEGERintrue is no longer used
indexCOOSYSTEM@1.1:INTEGERintrue is no longer used

Additional Information

Call Mode for Actions on Selected Objects: CALLMODE_SELECTEDONLY
Called Action on Selected Objects: COOWF@1.1:SetStarted
Prototype: COODESK@1.1:MenuActionPrototype
ACL Object: COOSYSTEM@1.1:DefaultDeveloperACL


[top]

COOWF@1.1:SetSelectedObjectsSuspended

Selected action for SetSuspended
ParameterTypeIn/OutOptionalDescription
handleCOOSYSTEM@1.1:INTEGERintrue is no longer used
indexCOOSYSTEM@1.1:INTEGERintrue is no longer used

Additional Information

Call Mode for Actions on Selected Objects: CALLMODE_SELECTEDONLY
Called Action on Selected Objects: COOWF@1.1:SetSuspended
Prototype: COODESK@1.1:MenuActionPrototype
ACL Object: COOSYSTEM@1.1:DefaultDeveloperACL


[top]

COOWF@1.1:SetSelectedObjectsTakenOver

Selected action for SetSelectedObjectsTakenOver
ParameterTypeIn/OutOptionalDescription
handleCOOSYSTEM@1.1:INTEGERintrue is no longer used
indexCOOSYSTEM@1.1:INTEGERintrue is no longer used

Additional Information

Call Mode for Actions on Selected Objects: CALLMODE_SELECTEDONLY
Called Action on Selected Objects: COOWF@1.1:SetTakenOver
Prototype: COODESK@1.1:MenuActionPrototype
ACL Object: COOSYSTEM@1.1:DefaultDeveloperACL


[top]

COOWF@1.1:SetSelectedObjectsTerminated

Selected action for SetTerminated
ParameterTypeIn/OutOptionalDescription
handleCOOSYSTEM@1.1:INTEGERintrue is no longer used
indexCOOSYSTEM@1.1:INTEGERintrue is no longer used

Additional Information

Call Mode for Actions on Selected Objects: CALLMODE_SELECTEDONLY
Called Action on Selected Objects: COOWF@1.1:SetTerminated
Prototype: COODESK@1.1:MenuActionPrototype
ACL Object: COOSYSTEM@1.1:DefaultDeveloperACL


[top]

COOWF@1.1:SetSelectedObjectsTerminatedDenied

Selected action for SetTerminatedDenied
ParameterTypeIn/OutOptionalDescription
handleCOOSYSTEM@1.1:INTEGERintrue is no longer used
indexCOOSYSTEM@1.1:INTEGERintrue is no longer used

Additional Information

Call Mode for Actions on Selected Objects: CALLMODE_SELECTEDONLY
Called Action on Selected Objects: COOWF@1.1:SetTerminatedDenied
Prototype: COODESK@1.1:MenuActionPrototype
ACL Object: COOSYSTEM@1.1:DefaultDeveloperACL


[top]

COOWF@1.1:SetSkipped

Skip an activity instance

Additional Information

Prototype: COODESK@1.1:MenuActionPrototype
Access Types: COOSYSTEM@1.1:AccTypeChange
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 the submit deadline is ignored for the activity instance and in case of the option COOWF@1.1:actinstignorecomplete also for the following activity instance.
nolocktimeoutCOOSYSTEM@1.1:BOOLEANintrue the lock timeout
followerskeepsubmitdeadlineCOOSYSTEM@1.1:BOOLEANintrue this option defines the the option nosubmitdeadline is only considered for the first found activity instance.

Additional Information

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


[top]

COOWF@1.1:SetStarted

Starts the execution of the activity instance.
ParameterTypeIn/OutOptionalDescription
handleCOOSYSTEM@1.1:INTEGERintrue is no longer used
indexCOOSYSTEM@1.1:INTEGERintrue is no longer used
noguiCOOSYSTEM@1.1:BOOLEANintrue no longer used
receivedatCOOSYSTEM@1.1:DATETIMEintrue the time stamp when the activity was received
startedatCOOSYSTEM@1.1:DATETIMEintrue the time stamp when the activity was started
separatetransactionCOOSYSTEM@1.1:BOOLEANintrue the usecase is executed in a separate transaction
lockedCOOSYSTEM@1.1:BOOLEANintrue defines if the current object is already locked
nolocktimeoutCOOSYSTEM@1.1:BOOLEANintrue defines if the default lock timeout should be skipped

Additional Information

Prototype: COODESK@1.1:MenuActionPrototype
Access Types: COOSYSTEM@1.1:AccTypeChange
ACL Object: COOSYSTEM@1.1:DefaultDeveloperACL


[top]

COOWF@1.1:SetSubmission

Defines the submission date of the follower activities
ParameterTypeIn/OutOptionalDescription
submissionsCOOWF@1.1:WorkFlowSubmissionListin the submissions

Additional Information

ACL Object: COOSYSTEM@1.1:DefaultDeveloperACL


[top]

COOWF@1.1:SetSuspended

Suspends the activity instance.
ParameterTypeIn/OutOptionalDescription
handleCOOSYSTEM@1.1:INTEGERintrue is no longer used
indexCOOSYSTEM@1.1:INTEGERintrue is no longer used
submitdeadlineCOOSYSTEM@1.1:DATETIMEintrue the deadline when the activity is displayed in the work list
remarkCOOSYSTEM@1.1:STRINGintrue the remark
remarkdefinedCOOSYSTEM@1.1:BOOLEANintrue the defines if a remark was entered
repetitionperiodCOOWF@1.1:SubmissionRepetitionPeriodintrue the repetitionperiod

Additional Information

Prototype: COODESK@1.1:MenuActionPrototype
Access Types: COOSYSTEM@1.1:AccTypeChange
ACL Object: COOSYSTEM@1.1:DefaultDeveloperACL


[top]

COOWF@1.1:SetTakenOver

Take over the responsibility for execution of the activity instance
ParameterTypeIn/OutOptionalDescription
handleCOOSYSTEM@1.1:INTEGERintrue is no longer used
indexCOOSYSTEM@1.1:INTEGERintrue is no longer used
remarkCOOSYSTEM@1.1:STRINGintrue the remark
remarkdefinedCOOSYSTEM@1.1:BOOLEANintrue the defines if a remark was entered
receivedatCOOSYSTEM@1.1:DATETIMEintrue the time stamp when the activity was received
startedatCOOSYSTEM@1.1:DATETIMEintrue the time stamp when the activity was started
completedatCOOSYSTEM@1.1:DATETIMEintrue the time stamp when the activity was completed

Additional Information

Prototype: COODESK@1.1:MenuActionPrototype
Access Types: COOSYSTEM@1.1:AccTypeChange
ACL Object: COOSYSTEM@1.1:DefaultDeveloperACL


[top]

COOWF@1.1:SetTerminated

Terminate the activity instance.
ParameterTypeIn/OutOptionalDescription
handleCOOSYSTEM@1.1:INTEGERintrue is no longer used
indexCOOSYSTEM@1.1:INTEGERintrue is no longer used
remarkCOOSYSTEM@1.1:STRINGintrue the remark
remarkdefinedCOOSYSTEM@1.1:BOOLEANintrue the defines if a remark was entered
receivedatCOOSYSTEM@1.1:DATETIMEintrue the time stamp when the activity was received
startedatCOOSYSTEM@1.1:DATETIMEintrue the time stamp when the activity was started
completedatCOOSYSTEM@1.1:DATETIMEintrue the time stamp when the activity was completed
submitdeadlineCOOSYSTEM@1.1:DATETIMEintrue the deadline when the activity is displayed in the work list
startdeadlineCOOSYSTEM@1.1:DATETIMEintrue the deadline for starting the activity
enddeadlineCOOSYSTEM@1.1:DATETIMEintrue the deadline for completing the activity

Additional Information

Prototype: COODESK@1.1:MenuActionPrototype
Access Types: COOSYSTEM@1.1:AccTypeChange
ACL Object: COOSYSTEM@1.1:DefaultDeveloperACL


[top]

COOWF@1.1:SetTerminatedDenied

Terminate the activity and send it back to the responsible of the process.
ParameterTypeIn/OutOptionalDescription
handleCOOSYSTEM@1.1:INTEGERintrue is no longer used
indexCOOSYSTEM@1.1:INTEGERintrue is no longer used
remarkCOOSYSTEM@1.1:STRINGintrue the remark
remarkdefinedCOOSYSTEM@1.1:BOOLEANintrue the defines if a remark was entered
receivedatCOOSYSTEM@1.1:DATETIMEintrue the time stamp when the activity was received
startedatCOOSYSTEM@1.1:DATETIMEintrue the time stamp when the activity was started
completedatCOOSYSTEM@1.1:DATETIMEintrue the time stamp when the activity was completed
submitdeadlineCOOSYSTEM@1.1:DATETIMEintrue the deadline when the activity is displayed in the work list
startdeadlineCOOSYSTEM@1.1:DATETIMEintrue the deadline for starting the activity
enddeadlineCOOSYSTEM@1.1:DATETIMEintrue the deadline for completing the activity

Additional Information

Prototype: COODESK@1.1:MenuActionPrototype
Access Types: COOSYSTEM@1.1:AccTypeChange
ACL Object: COOSYSTEM@1.1:DefaultDeveloperACL


[top]

COOWF@1.1:ShowConcernedObjectsSelection

This action is used to the determine if concerned objects can be selected during the prescription process.
ParameterTypeIn/OutOptionalDescription
objectsconcernedCOOSYSTEM@1.1:OBJECTLISTin/out the concerned objects
objectsconcernedrestrictedCOOSYSTEM@1.1:BOOLEANin/out the concerned objects are restricted and can not be modified
showCOOSYSTEM@1.1:BOOLEANouttrue the dialog to select concerned objects will be displayed

Additional Information

ACL Object: COOSYSTEM@1.1:DefaultDeveloperACL


[top]

COOWF@1.1:ShowLongTermSuspended

Usecase to display long term suspended activities

Additional Information

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


[top]

COOWF@1.1:ShowOpenPersonalCollectionWastebasket

ParameterTypeIn/OutOptionalDescription
contextCOOSYSTEM@1.1:OBJECTin
showwastebasketCOOSYSTEM@1.1:BOOLEANretval

Additional Information

ACL Object: COOSYSTEM@1.1:DefaultDeveloperACL
Private: true


[top]

COOWF@1.1:ShowUsageList (Show Related Prozesses)

Show usage list for a document (i.e. all processes where a particular document is referenced)

Additional Information

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


[top]

COOWF@1.1:ShowUsageListSelected

Additional Information

Call Mode for Actions on Selected Objects: CALLMODE_SELECTEDORCONTAINER
Called Action on Selected Objects: COOWF@1.1:ShowUsageList
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:DICTIONARYretval the processstate

Additional Information

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


[top]

COOWF@1.1:StartProcessDiagram

This action is used to start the designed process of a released workflow diagram for the current object. The supplied workflow diagram must be released and executable for the current object.
ParameterTypeIn/OutOptionalDescription
diagramCOOSYSTEM@1.1:OBJECTin the released version of the supplied diagram which fits to the current user will be initialized for the current object
silentCOOSYSTEM@1.1:BOOLEANintrue do not raise errors if the diagram can not be started for the current object
procinstCOOSYSTEM@1.1:OBJECTretval the created process instance
partmappingCOOWF@1.1:WorkFlowParticipantMappingintrue the supplied mapping is used to replace the participants defined in the process diagram when the activities are created.
expandsubCOOSYSTEM@1.1:BOOLEANintrue If set to True, all subprocesses contained in the supplied process diagram are expanded directly when the process is started
processparamsCOOSYSTEM@1.1:DICTIONARYintrue if defined the process parameters are merged into the process parameters of the process diagram
considereroomcontextCOOSYSTEM@1.1:BOOLEANintrue if set the room restrictions will be considered when calculating diagrams

Additional Information

Access Types: COOWF@1.1:AccTypeChangeWorkFlow
ACL Object: COOSYSTEM@1.1:DefaultDeveloperACL
Secured: SECURED_READWRITE


[top]

COOWF@1.1:StartSelectedObjectsWorkFlowProcess

Selected action for StartWorkFlowProcess
ParameterTypeIn/OutOptionalDescription
handleCOOSYSTEM@1.1:INTEGERintrue is no longer used
indexCOOSYSTEM@1.1:INTEGERintrue is no longer used

Additional Information

Call Mode for Actions on Selected Objects: CALLMODE_SELECTEDONLY
Called Action on Selected Objects: COOWF@1.1:StartWorkFlowProcess
Prototype: COODESK@1.1:MenuActionPrototype
ACL Object: COOSYSTEM@1.1:DefaultDeveloperACL


[top]

COOWF@1.1:StartWorkFlow

This action can be called to initialize an new process instance attached to the object, that starts with a single activity. The activity is initialized from the parameters of this action.
ParameterTypeIn/OutOptionalDescription
responsibleCOOWF@1.1:WorkFlowParticipantin The participant in the first activity and also the organizational element, that will be responsible for the new process instance.
respmansubstCOOWF@1.1:WorkFlowParticipantintrue If participant specifies a manual participant, this parameter has to contain the substitute in Fabasoft Components.
actinsttitleCOOSYSTEM@1.1:LanguageStringListintrue The title of the first activity instance.
actinsttypeCOOWF@1.1:ActivityTypeintrue The type of the first activity instance.
addCOOSYSTEM@1.1:BOOLEANintrue If set to True, the new process is added to the list of processes of the object. Otherwise it replaces the current processes.
additionalobjectsCOOSYSTEM@1.1:OBJECTLISTintrue
newprocinstCOOSYSTEM@1.1:OBJECTouttrue
newactinstCOOSYSTEM@1.1:OBJECTouttrue
submitdeadlineCOOSYSTEM@1.1:DATETIMEintrue
actdefCOOSYSTEM@1.1:OBJECTintrue

Additional Information

Access Types: COOWF@1.1:AccTypeChangeWorkFlow
ACL Object: COOSYSTEM@1.1:DefaultDeveloperACL


[top]

COOWF@1.1:StartWorkFlowProcess

Start the process of the object if it has not already been started
ParameterTypeIn/OutOptionalDescription
procinstsCOOSYSTEM@1.1:OBJECTLISTintrue the processes which should be started

Additional Information

Access Types: COOWF@1.1:AccTypeChangeWorkFlow
ACL Object: COOSYSTEM@1.1:DefaultDeveloperACL


[top]

COOWF@1.1:StatisticSettings

Display the settings of a statistics dashboard

Additional Information

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


[top]

COOWF@1.1:StoreReleasedWorkFlowDiagram

This action stores a copy of the diagram the original released diagram will be deleted
ParameterTypeIn/OutOptionalDescription
releaseddiagramCOOSYSTEM@1.1:OBJECTretval the released diagram
releaserefdiagramsCOOSYSTEM@1.1:BOOLEANintrue if set to true all diagrams referenced in sub processes are released too otherwise a released version of the referenced diagram is required to release the current process

Additional Information

ACL Object: COOSYSTEM@1.1:DefaultDeveloperACL


[top]

COOWF@1.1:UpdatePartMultipleContextInfos

ParameterTypeIn/OutOptionalDescription
multipleCOOWF@1.1:MultiInstanceTypein/outtrue

Additional Information

ACL Object: COOSYSTEM@1.1:DefaultDeveloperACL
Private: true


[top]

COOWF@1.1:UpdatePrescriptions

Update the prescription
ParameterTypeIn/OutOptionalDescription
attrdefCOOSYSTEM@1.1:OBJECTin the attribute definition

Additional Information

ACL Object: COOSYSTEM@1.1:DefaultDeveloperACL


[top]

COOWF@1.1:UserIsParticipant

Checks if the user is a valid workflow participant
ParameterTypeIn/OutOptionalDescription
isparticipantCOOSYSTEM@1.1:BOOLEANretval the result
userCOOSYSTEM@1.1:OBJECTintrue the requested user. If not set the current user is used

Additional Information

ACL Object: COOSYSTEM@1.1:DefaultDeveloperACL


[top]

COOWF@1.1:UserIsResponsible

Checks if the user is the responsible of the process
ParameterTypeIn/OutOptionalDescription
isresponsibleCOOSYSTEM@1.1:BOOLEANretval the result
userCOOSYSTEM@1.1:OBJECTintrue the for whom the responsibility should be checked
respcontextCOOWF@1.1:ResponsibilityContextintrue the context of process responsibility. The default value is RESPCTX_OTHER

Additional Information

ACL Object: COOSYSTEM@1.1:DefaultDeveloperACL
Secured: SECURED_READWRITE


[top]

COOWF@1.1:WorkListNavigate

ParameterTypeIn/OutOptionalDescription
worklistCOOSYSTEM@1.1:OBJECTin
viewCOOSYSTEM@1.1:OBJECTin
actinstCOOSYSTEM@1.1:OBJECTin

Additional Information

ACL Object: COOSYSTEM@1.1:DefaultDeveloperACL
Private: true


[top]

COOWF@1.1:WorkflowCreateFolder

Creates a new folder

Additional Information

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


[top]