Return Type |
Signature |
AddPrescription( |
|
AddSearchRestrictionsForReferencedBPMNObject( |
|
AllowChangeProcessState( |
|
AmendSubstitutePermissions( |
|
AnalyzeBPMNZip( |
|
AttachToProcess( |
|
AttrActInstCopy( |
|
AttrActInstInstanceGet( |
|
AttrActInstInstanceGetVersion( |
|
AttrActInstObjectGet( |
|
AttrActInstObjectGetVersion( |
|
AttrActInstObjectSet( |
|
AttrActInstObjectsGet( |
|
AttrActInstObjectsGetVersion( |
|
AttrActInstSet( |
|
AttrActInstStateSet( |
|
AttrActInstStatisticGet( |
|
AttrActInstSubstUserGet( |
|
AttrActInstSubstUserGetVersion( |
|
AttrActivityWithPartGetDisp( |
|
AttrBackLinkDefaultSet( |
|
AttrDefCaseNextDestructor( |
|
AttrDefGatewayNextDestructor( |
|
AttrDefRefObjClassesGet( |
|
AttrGetActinstworkDisp( |
|
AttrGetCompoundParticipantDisp( |
|
AttrGetParticipantDisp( |
|
AttrInstCaseNextDestructor( |
|
AttrInstConditionGet( |
|
AttrInstConditionGetVersion( |
|
AttrInstDefinitionCopy( |
|
AttrInstElemSet( |
|
AttrInstGatewayNextDestructor( |
|
AttrLoadSharingScoreGet( |
|
AttrObjectDestructor( |
|
AttrObjectListDestructor( |
|
AttrPrescriptionBlockConstructor( |
|
AttrPrescriptionLineConstructor( |
|
AttrProcDefParticipantsGet( |
|
AttrProcDefRefObjClassesGet( |
|
AttrProcessListExpItemsGet( |
|
AttrProcessListExpItemsSet( |
|
AttrProcessListItemsGet( |
|
AttrProcessListItemsSet( |
|
AttrProcessParticipantSet( |
|
AttrProcInstCopy( |
|
AttrProcInstSet( |
|
AttrProcInstStatisticGet( |
|
AttrProcInstUsersGet( |
|
AttrProcInstWorkGet( |
|
AttrSetPendingList( |
|
AttrUseForClassGet( |
|
AttrUsrEnvWfEventsGet( |
|
AttrUsrEnvWfEventsSet( |
|
AttrUsrEnvWfPushEventsGet( |
|
AttrUsrEnvWfPushEventsSet( |
|
AttrWorkFlowConstructor( |
|
AttrWorkFlowCopy( |
|
AttrWorkFlowDeadLinesGet( |
|
AttrWorkFlowDefinitionObjectFilter( |
|
AttrWorkFlowDelVersion( |
|
AttrWorkFlowFixVersion( |
|
AttrWorkFlowSet( |
|
AttrWorkListItemsGet( |
|
AttrWorkListItemsSet( |
|
AttrWorkListUIFilter( |
|
AutomaticallyInsertFollowerActivity( |
|
BuildPartipantControlParams( |
|
BuildPartipantControlParamValues( |
|
CalculateProcessStatistics( |
|
CallObjectWorkItem( |
|
CallWorkItem( |
|
CanBeUsedForSubProcessesOnly( |
|
CanChangeProcessState( |
|
CanDeleteWorkFlow( |
|
CanManageWorkFlowDiagrams( |
|
ChangeAppWorkFlowState( |
|
ChangeResponsible( |
|
CheckAction( |
|
CheckActive( |
|
CheckAdditionalParticipantRestrictions( |
|
CheckAllowedActions( |
|
CheckAllowedElements( |
|
CheckAutoComplete( |
|
CheckDatesForm( |
|
CheckDelegateForm( |
|
CheckDelegateMultipleForm( |
|
CheckDestination( |
|
CheckExpiredActivities( |
|
CheckForm( |
|
CheckInsertTemplate( |
|
CheckParticipant( |
|
CheckParticipantAffiliation( |
|
CheckParticipantRules( |
|
CheckPrescriptionsForm( |
|
CheckReferencedDiagramExecutionRestriction( |
|
CheckReleaseReferencedDiagrams( |
|
CheckRemoveOrgElements( |
|
CheckRetracted( |
|
CheckSimplePrescriptionsForm( |
|
CheckStart( |
|
CheckSubmissionRepetitionPeriod( |
|
CheckTakenOver( |
|
CheckWorkDay( |
|
CheckWorkFlowAppLicense( |
|
ChooseProcessDefinition( |
|
ClearProcessParameters( |
|
CollectCommonStartedInstances( |
|
ComputeDeadLine( |
|
ConfirmStart( |
|
ConvertDateToWorkDays( |
|
ConvertWorkDaysToDate( |
|
CopyWorkFlowObject( |
|
CreateProcessInstance( |
|
CreateProcessOutput( |
|
CreateProcessParticipant( |
|
CreateProcessStatisticsCache( |
|
CreateWorkFlowDiagram( |
|
CreateWorkFlowObject( |
|
DefineWFSubstitutes( |
|
DelegateActivityHook( |
|
DelegateActivityMultipleHook( |
|
DeleteSelectedObjectsWorkFlow( |
|
DeleteWasteBasketObjects( |
|
DeleteWasteBasketObjectsSelected( |
|
DeleteWorkFlow( |
|
DeleteWorkFlowDiagram( |
|
DeleteWorkFlowDiagramSelected( |
|
DeleteWorkFlowObject( |
|
DisplayActionsInWorkflowTaskPane( |
|
DisplayBPMNCustomizedExpressions( |
|
DisplayParticipantWithLabels( |
|
DoShowWorkListItem( |
|
EditObjectAttributesDirect( |
|
EditProcessObjectAttributes( |
|
EscalateObject( |
|
EscalateToRecipients( |
|
EvaluateCase( |
|
EvaluateCondition( |
|
EvaluatePrecondition( |
|
ExpandPrescribeParticipants( |
|
ExtendNotificationSettings( |
|
ExtendPushNotificationSettings( |
|
ExtractSubPrescription( |
|
FilterPossibleReferencedDiagrams( |
|
FilterUsableDefinitions( |
|
FilterUsableDiagramsHook( |
|
FilterUsableObjects( |
|
FixParticipantAffiliation( |
|
FormatWFNotificationSettingsToInfolist( |
|
GenerateArchivedProcessStatistic( |
|
GetActivityInstanceMenu( |
|
GetAdditionalPrescriptionTemplatesHook( |
|
GetAdditionalWorkFlowDiagramsHook( |
|
GetAllWorkListActInsts( |
|
GetCommonPrescribeDefault( |
|
GetCommonUsableProcessDefinitions( |
|
GetConditionString( |
|
GetConfiguredProcessStatisticsUsers( |
|
GetConfiguredSender( |
|
GetCurrentActivityInstances( |
|
GetCurrentUserActivities( |
|
GetDefaultNotificationTypes( |
|
GetDefaultProcessDefinitions( |
|
GetDefinitionElements( |
|
GetDelegateDefault( |
|
GetDelegateMultipleDefault( |
|
GetDiagramIdFromWorkFlowObject( |
|
GetDiagramProcessParticipants( |
|
GetDisplayProperties( |
|
GetInheritedWorkFlowSettings( |
|
GetInitialResponsible( |
|
GetInsertActivityDef( |
|
GetInstanceElementColor( |
|
GetInstanceElements( |
|
GetLastInstanceElements( |
|
GetLongTermSuspendedActivities( |
|
GetLowestLoadSharingScoreUsers( |
|
GetManageableWorkFlowPreferenceGroupLocations( |
|
GetNextActivityInstances( |
|
GetNextInstanceElements( |
|
GetNextSuspensionDate( |
|
GetNotificationSettings( |
|
GetNotificationSettingsFromUser( |
|
GetObjectsConcerned( |
|
GetObjectWorkFlowMenu( |
|
GetParticipantContext( |
|
GetParticipantContextAttribute( |
|
GetParticipantContextClass( |
|
GetParticipantListUsersGroups( |
|
GetParticipantParentAttribute( |
|
GetParticipantUsers( |
|
GetPrescribeActivityDefinitions( |
|
GetPrescribeDefault( |
|
GetPrescribeTemplate( |
|
GetPrescriptionEditorMode( |
|
GetPrescriptionHeadLine( |
|
GetProcessParameter( |
|
GetProcessParameters( |
|
GetPushNotificationSettings( |
|
GetReferencedBPMNObject( |
|
GetReferencedDiagrams( |
|
GetReleasedDiagrams( |
|
GetReleaseDiagramsHook( |
|
GetReleasedWorkFlowDiagram( |
|
GetResolvedProcessStatisticsUsers( |
|
GetSecurityAttributes( |
|
GetSubmissionDefault( |
|
GetSubstGroupActivities( |
|
GetSuspendDefault( |
|
GetTerminateDefault( |
|
GetTerminateDenyDefault( |
|
GetUsableActivityDefinitions( |
|
GetUsableObjectsConcerned( |
|
GetUsableOrgElements( |
|
GetUsableProcessDefinitions( |
|
GetUsableUsersGroups( |
|
GetUserSubstitution( |
|
GetWFEventSettingOnClickCommand( |
|
GetWorkFlowConfigProperty( |
|
GetWorkFlowPreferenceGroupLocations( |
|
GetWorkFlowPreferenceLocations( |
|
GetWorkFlowSettings( |
|
GetWorkFlowUsecaseHeadLine( |
|
GetWorkItemIndex( |
|
GetWorkItemKey( |
|
GetWorkItemsMenu( |
|
GetWorkList( |
|
GetWorkListItemCountFromTx( |
|
GetWorkListItemsFlat( |
|
HasAdditionalParticipantRestrictions( |
|
HasValidParticipant( |
|
HasWorkOnSubstTabSet( |
|
ImportBPMNZip( |
|
InitializeInstance( |
|
InitializeProcessInstance( |
|
InitializeWorkFlow( |
|
InsertActivityInstance( |
|
InsertDefinitionElement( |
|
InsertExternalActivity( |
|
InsertFirstElement( |
|
InsertFirstSubProcess( |
|
InsertInstanceElement( |
|
InsertInstanceElements( |
|
InsertParallelElement( |
|
InsertParallelSubProcess( |
|
InsertSubProcess( |
|
InstanceElementStateChangedHook( |
|
IsActivityCompleted( |
|
IsBPMNExpression( |
|
IsEditableWFAttribute( |
|
IsInstanceElementEvaluated( |
|
IsProcessAdministrator( |
|
IsProcessOwner( |
|
IsReferencedDiagram( |
|
IsSubstituteForParticipant( |
|
IsValidPublishedDiagram( |
|
IsWFSubstitutionActive( |
|
IsWFSubstitutionEnabled( |
|
IsWorkFlowServiceUser( |
|
LoadBPMNCustomizedExpressions( |
|
LoggedIn() |
|
LogWorkFlowHistory( |
|
ModifyPage( |
|
ModifyPrescriptions( |
|
MovePrescription( |
|
NextProcessWorkItem( |
|
NormalizeNestedPrescriptions( |
|
ObjectAccTypesGet( |
|
OpenStatisticsDashboard( |
|
ParseBPMNModel( |
|
PatchBPMNDiagramTranslations( |
|
PrescribeObject( |
|
PrescribeObjectDirect( |
|
PrescribeOnScope( |
|
PrescribeSelectedObjects( |
|
ProcessSettings( |
|
ProcessStateChangedHook( |
|
ProcessStatisticsEnabled( |
|
ReadObjectAttributesDirect( |
|
ReadProcessObjectAttributes( |
|
RemoveDefinitionElement( |
|
RemoveFromProcessFolder( |
|
RemoveFromProcessFolderSelected( |
|
RemovePrescription( |
|
ResetObjectHighlighting( |
|
ResetSecurityOrgElements( |
|
ResolveDistributionList( |
|
ResolveMetaParticipant( |
|
ResolveMultiInstanceActivity( |
|
ResolvePropertyRole( |
|
SavePrescriptionTemplate( |
|
SavePrescriptionTemplateHook( |
|
SelectPrescriptionTemplate( |
|
SetActive( |
|
SetCompleted( |
|
SetCompletedSubmission( |
|
SetDelegated( |
|
SetDelegatedMultiple( |
|
SetProcessParameter( |
|
SetRetracted( |
|
SetSelectedObjectsActive( |
|
SetSelectedObjectsCompleted( |
|
SetSelectedObjectsCompleted2( |
|
SetSelectedObjectsCompletedSubmission( |
|
SetSelectedObjectsDelegated( |
|
SetSelectedObjectsDelegatedMultiple( |
|
SetSelectedObjectsRetracted( |
|
SetSelectedObjectsStarted( |
|
SetSelectedObjectsSuspended( |
|
SetSelectedObjectsTakenOver( |
|
SetSelectedObjectsTerminated( |
|
SetSelectedObjectsTerminatedDenied( |
|
SetSkipped( |
|
SetStartable( |
|
SetStarted( |
|
SetSubmission( |
|
SetSuspended( |
|
SetTakenOver( |
|
SetTerminated( |
|
SetTerminatedDenied( |
|
ShowCommonStartedProcessOverview( |
|
ShowCommonStartedProcessOverviewSelected( |
|
ShowConcernedObjectsSelection( |
|
ShowLongTermSuspended( |
|
ShowUsageList( |
|
ShowUsageListSelected( |
|
StartProcessDefinition( |
|
StartProcessDiagram( |
|
StartSelectedObjectsWorkFlowProcess( |
|
StartWorkFlow( |
|
StartWorkFlowProcess( |
|
StatisticSettings( |
|
StoreReleasedWorkFlowDiagram( |
|
UpdatePrescriptions( |
|
UseCommonStartedActivities( |
|
UserIsParticipant( |
|
UserIsResponsible( |
|
ValidateUIParticipant( |
|
WorkflowCreateFolder( |
void
COOWF@1.1:AddPrescription(
ref WorkFlowPrescriptionList[]
prescription,
SavePresciptionActionType
action,
ref optional integer
pblockidx,
ref optional integer
pidx,
optional WorkFlowPrescriptionBlockList[]
prescriptionblocks)
Name |
Description |
prescription |
the prescription which should be added or modified
|
action |
the option how the prescription should be modified
|
pblockidx |
the index of the prescription block
|
pidx |
the index of the prescription in the prescription block
|
prescriptionblocks |
the prescription block which should be added or modified
|
Additional Information
COOWF@1.1:AddSearchRestrictionsForReferencedBPMNObject
string
COOWF@1.1:AddSearchRestrictionsForReferencedBPMNObject(
ObjectClass
targetclass,
out retval string
queryrestriction)
Name |
Description |
targetclass |
|
queryrestriction |
this parameter defines an additional search restriction
|
Additional Information
COOWF@1.1:AllowChangeProcessState
boolean
COOWF@1.1:AllowChangeProcessState(
out retval boolean
statechangeable)
Name |
Description |
statechangeable |
Additional Information
COOWF@1.1:AmendSubstitutePermissions
void
COOWF@1.1:AmendSubstitutePermissions(
optional boolean
locked)
Name |
Description |
locked |
defines if the current object is already locked
|
Additional Information
object[]
COOWF@1.1:AnalyzeBPMNZip(
Content
zipcont,
optional ObjectClass
targetclass,
optional string
elementname,
out retval object[]
existingdiagrams,
out object[]
additionaldiagrams)
Name |
Description |
zipcont |
the compressed content
|
targetclass |
defines which object class the new created diagrams will get. The default is WorkFlowDiagram
|
elementname |
the name of the current element which is used if the content is no zip content
|
existingdiagrams |
already existing diagrams base on the content
|
additionaldiagrams |
diagrams which will be newly created
|
Additional Information
void COOWF@1.1:ArchiveProcess()
Additional Information
void
COOWF@1.1:AttachToProcess(
ref dictionary
processstate,
object
obj)
Name |
Description |
processstate |
the processstate
|
obj |
the obj
|
Additional Information
any
COOWF@1.1:AttrActInstCopy(
AttributeDefinition
attrdef,
object
sourceobj,
out retval any
value)
Name |
Description |
attrdef |
|
sourceobj |
|
value |
Additional Information
COOWF@1.1:AttrActInstInstanceGet
actinstinstance
. It is called by the kernel, when the value of
that property is read.
void
COOWF@1.1:AttrActInstInstanceGet(
AttributeDefinition
attrdef,
ref any
value,
out optional boolean
volatile,
out optional boolean
volatiletx)
Name |
Description |
attrdef |
|
value |
|
volatile |
|
volatiletx |
Additional Information
COOWF@1.1:AttrActInstInstanceGetVersion
actinstinstance
. It is called by the kernel, when the value of
that property is read for a version.
void
COOWF@1.1:AttrActInstInstanceGetVersion(
AttributeDefinition
attrdef,
integer
versnr,
ref any
value,
out optional boolean
volatile,
out optional boolean
volatiletx)
Name |
Description |
attrdef |
|
versnr |
|
value |
|
volatile |
|
volatiletx |
Additional Information
COOWF@1.1:AttrActInstObjectGet
actinstobject
. It is called by the kernel, when the value of
that property is read.
void
COOWF@1.1:AttrActInstObjectGet(
AttributeDefinition
attrdef,
ref any
value,
out optional boolean
volatile,
out optional boolean
volatiletx)
Name |
Description |
attrdef |
|
value |
|
volatile |
|
volatiletx |
Additional Information
COOWF@1.1:AttrActInstObjectGetVersion
actinstobject
. It is called by the kernel, when the value of
that property is read for a version.
void
COOWF@1.1:AttrActInstObjectGetVersion(
AttributeDefinition
attrdef,
integer
versnr,
ref any
value,
out optional boolean
volatile,
out optional boolean
volatiletx)
Name |
Description |
attrdef |
|
versnr |
|
value |
|
volatile |
|
volatiletx |
Additional Information
COOWF@1.1:AttrActInstObjectSet
actinstobject
. It is called by the kernel, before that property
is saved.
void
COOWF@1.1:AttrActInstObjectSet(
AttributeDefinition
attrdef,
ref optional any
value,
any
oldvalue)
Name |
Description |
attrdef |
|
value |
|
oldvalue |
Additional Information
COOWF@1.1:AttrActInstObjectsGet
actinstobjects
. It is called by the kernel, when the value of
that property is read.
void
COOWF@1.1:AttrActInstObjectsGet(
AttributeDefinition
attrdef,
ref any
value,
out optional boolean
volatile,
out optional boolean
volatiletx)
Name |
Description |
attrdef |
|
value |
|
volatile |
|
volatiletx |
Additional Information
COOWF@1.1:AttrActInstObjectsGetVersion
actinstobjects
. It is called by the kernel, when the value of
that property is read for a version.
void
COOWF@1.1:AttrActInstObjectsGetVersion(
AttributeDefinition
attrdef,
integer
versnr,
ref any
value,
out optional boolean
volatile,
out optional boolean
volatiletx)
Name |
Description |
attrdef |
|
versnr |
|
value |
|
volatile |
|
volatiletx |
Additional Information
ActivityInstance
and
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.
void
COOWF@1.1:AttrActInstSet(
AttributeDefinition
attrdef,
ref optional any
value,
any
oldvalue)
Name |
Description |
attrdef |
|
value |
|
oldvalue |
Additional Information
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.
void
COOWF@1.1:AttrActInstStateSet(
AttributeDefinition
attrdef,
ref optional any
value,
any
oldvalue)
Name |
Description |
attrdef |
|
value |
|
oldvalue |
Additional Information
COOWF@1.1:AttrActInstStatisticGet
actinststatistic
. It is called by the kernel, when the value of
that property is read.
void
COOWF@1.1:AttrActInstStatisticGet(
AttributeDefinition
attrdef,
ref any
value,
out optional boolean
volatile,
out optional boolean
volatiletx)
Name |
Description |
attrdef |
|
value |
|
volatile |
|
volatiletx |
Additional Information
COOWF@1.1:AttrActInstSubstUserGet
actinstsubstuser
. It is called by the kernel, when the value of
that property is read.
void
COOWF@1.1:AttrActInstSubstUserGet(
AttributeDefinition
attrdef,
ref any
value,
out optional boolean
volatile,
out optional boolean
volatiletx)
Name |
Description |
attrdef |
|
value |
|
volatile |
|
volatiletx |
Additional Information
COOWF@1.1:AttrActInstSubstUserGetVersion
actinstsubstuser
. It is called by the kernel, when the value of
that property is read for a version.
void
COOWF@1.1:AttrActInstSubstUserGetVersion(
AttributeDefinition
attrdef,
integer
versnr,
ref any
value,
out optional boolean
volatile,
out optional boolean
volatiletx)
Name |
Description |
attrdef |
|
versnr |
|
value |
|
volatile |
|
volatiletx |
Additional Information
COOWF@1.1:AttrActivityWithPartGetDisp
string
COOWF@1.1:AttrActivityWithPartGetDisp(
AttributeDefinition
attrdef,
out retval string
string,
optional any
value,
optional Language
language,
optional AttributeDefinition[]
attrdeflist,
optional integer
flags,
optional integer
index)
Name |
Description |
attrdef |
|
string |
|
value |
|
language |
|
attrdeflist |
|
flags |
|
index |
Additional Information
COOWF@1.1:AttrBackLinkDefaultSet
domainbacklinkdefault
of a current domain object. It is called
by the kernel, before the value of that property is saved.
void
COOWF@1.1:AttrBackLinkDefaultSet(
AttributeDefinition
attrdef,
ref optional any
value,
any
oldvalue)
Name |
Description |
attrdef |
|
value |
|
oldvalue |
Additional Information
COOWF@1.1:AttrDefCaseNextDestructor
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.
void
COOWF@1.1:AttrDefCaseNextDestructor(
AttributeDefinition
attrdef,
any
value)
Name |
Description |
attrdef |
|
value |
Additional Information
COOWF@1.1:AttrDefGatewayNextDestructor
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.
void
COOWF@1.1:AttrDefGatewayNextDestructor(
AttributeDefinition
attrdef,
any
value)
Name |
Description |
attrdef |
|
value |
Additional Information
COOWF@1.1:AttrDefRefObjClassesGet
defrefobjclasses
. It is called by the kernel, when the value of
that property is read.
void
COOWF@1.1:AttrDefRefObjClassesGet(
AttributeDefinition
attrdef,
ref any
value,
out optional boolean
volatile,
out optional boolean
volatiletx)
Name |
Description |
attrdef |
|
value |
|
volatile |
|
volatiletx |
Additional Information
COOWF@1.1:AttrGetActinstworkDisp
WorkFlowWorkList
. It is
called by the kernel or other components, when the string representation of such
a property is required.
string
COOWF@1.1:AttrGetActinstworkDisp(
AttributeDefinition
attrdef,
out retval string
string,
optional any
value,
optional Language
language,
optional AttributeDefinition[]
attrdeflist,
optional integer
flags,
optional integer
index)
Name |
Description |
attrdef |
|
string |
|
value |
|
language |
|
attrdeflist |
|
flags |
|
index |
Additional Information
COOWF@1.1:AttrGetCompoundParticipantDisp
WorkFlowCompoundParticipant
. It is
called by the kernel or other components, when the string representation of such
a property is required.
string
COOWF@1.1:AttrGetCompoundParticipantDisp(
AttributeDefinition
attrdef,
out retval string
string,
optional any
value,
optional Language
language,
optional AttributeDefinition[]
attrdeflist,
optional integer
flags,
optional integer
index)
Name |
Description |
attrdef |
|
string |
|
value |
|
language |
|
attrdeflist |
|
flags |
|
index |
Additional Information
COOWF@1.1:AttrGetParticipantDisp
WorkFlowParticipant
. It is
called by the kernel or other components, when the string representation of such
a property is required.
string
COOWF@1.1:AttrGetParticipantDisp(
AttributeDefinition
attrdef,
out retval string
string,
optional any
value,
optional Language
language,
optional AttributeDefinition[]
attrdeflist,
optional integer
flags,
optional integer
index)
Name |
Description |
attrdef |
|
string |
|
value |
|
language |
|
attrdeflist |
|
flags |
|
index |
Additional Information
COOWF@1.1:AttrInstCaseNextDestructor
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.
void
COOWF@1.1:AttrInstCaseNextDestructor(
AttributeDefinition
attrdef,
any
value)
Name |
Description |
attrdef |
|
value |
Additional Information
COOWF@1.1:AttrInstConditionGet
instcondstr
. It is called by the kernel, when that property is
read. This action is used as migration path for the property
instcondition
, which is not used any more.
void
COOWF@1.1:AttrInstConditionGet(
AttributeDefinition
attrdef,
ref any
value,
out optional boolean
volatile,
out optional boolean
volatiletx)
Name |
Description |
attrdef |
|
value |
|
volatile |
|
volatiletx |
Additional Information
COOWF@1.1:AttrInstConditionGetVersion
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
instcondition
, which is not used any more.
void
COOWF@1.1:AttrInstConditionGetVersion(
AttributeDefinition
attrdef,
integer
versnr,
ref any
value,
out optional boolean
volatile,
out optional boolean
volatiletx)
Name |
Description |
attrdef |
|
versnr |
|
value |
|
volatile |
|
volatiletx |
Additional Information
COOWF@1.1:AttrInstDefinitionCopy
any
COOWF@1.1:AttrInstDefinitionCopy(
AttributeDefinition
attrdef,
object
sourceobj,
out retval any
value)
Name |
Description |
attrdef |
|
sourceobj |
|
value |
Additional Information
InstanceElement
, except ActivityInstance
and
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.
void
COOWF@1.1:AttrInstElemSet(
AttributeDefinition
attrdef,
ref optional any
value,
any
oldvalue)
Name |
Description |
attrdef |
|
value |
|
oldvalue |
Additional Information
COOWF@1.1:AttrInstGatewayNextDestructor
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.
void
COOWF@1.1:AttrInstGatewayNextDestructor(
AttributeDefinition
attrdef,
any
value)
Name |
Description |
attrdef |
|
value |
Additional Information
COOWF@1.1:AttrLoadSharingScoreGet
userloadsharingscore
. It is called by the kernel, when the value of
that property is read.
void
COOWF@1.1:AttrLoadSharingScoreGet(
AttributeDefinition
attrdef,
ref any
value,
out optional boolean
volatile,
out optional boolean
volatiletx)
Name |
Description |
attrdef |
|
value |
|
volatile |
|
volatiletx |
Additional Information
COOWF@1.1:AttrObjectDestructor
void
COOWF@1.1:AttrObjectDestructor(
AttributeDefinition
attrdef,
any
value)
Name |
Description |
attrdef |
|
value |
Additional Information
COOWF@1.1:AttrObjectListDestructor
void
COOWF@1.1:AttrObjectListDestructor(
AttributeDefinition
attrdef,
any
value)
Name |
Description |
attrdef |
|
value |
Additional Information
COOWF@1.1:AttrPrescriptionBlockConstructor
void
COOWF@1.1:AttrPrescriptionBlockConstructor(
object
attrdef,
out any
value,
any[]
oldvalues)
Name |
Description |
attrdef |
|
value |
|
oldvalues |
Additional Information
COOWF@1.1:AttrPrescriptionLineConstructor
void
COOWF@1.1:AttrPrescriptionLineConstructor(
object
attrdef,
out any
value,
any[]
oldvalues)
Name |
Description |
attrdef |
|
value |
|
oldvalues |
Additional Information
COOWF@1.1:AttrProcDefParticipantsGet
void
COOWF@1.1:AttrProcDefParticipantsGet(
AttributeDefinition
attrdef,
ref any
value,
out optional boolean
volatile,
out optional boolean
volatiletx)
Name |
Description |
attrdef |
|
value |
|
volatile |
|
volatiletx |
Additional Information
COOWF@1.1:AttrProcDefRefObjClassesGet
procdefrefobjclasses
. It is called by the kernel, when the value
of that property is read.
void
COOWF@1.1:AttrProcDefRefObjClassesGet(
AttributeDefinition
attrdef,
ref any
value,
out optional boolean
volatile,
out optional boolean
volatiletx)
Name |
Description |
attrdef |
|
value |
|
volatile |
|
volatiletx |
Additional Information
COOWF@1.1:AttrProcessListExpItemsGet
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.
void
COOWF@1.1:AttrProcessListExpItemsGet(
AttributeDefinition
attrdef,
ref any
value,
out optional boolean
volatile,
out optional boolean
volatiletx)
Name |
Description |
attrdef |
|
value |
|
volatile |
|
volatiletx |
Additional Information
COOWF@1.1:AttrProcessListExpItemsSet
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.
void
COOWF@1.1:AttrProcessListExpItemsSet(
AttributeDefinition
attrdef,
ref optional any
value,
any
oldvalue)
Name |
Description |
attrdef |
|
value |
|
oldvalue |
Additional Information
COOWF@1.1:AttrProcessListItemsGet
proclistitems
. It is called by the kernel, when the value of
that property is read.
void
COOWF@1.1:AttrProcessListItemsGet(
AttributeDefinition
attrdef,
ref any
value,
out optional boolean
volatile,
out optional boolean
volatiletx)
Name |
Description |
attrdef |
|
value |
|
volatile |
|
volatiletx |
Additional Information
COOWF@1.1:AttrProcessListItemsSet
proclistitems
. It is called by the kernel, before that property
is saved.
void
COOWF@1.1:AttrProcessListItemsSet(
AttributeDefinition
attrdef,
ref optional any
value,
any
oldvalue)
Name |
Description |
attrdef |
|
value |
|
oldvalue |
Additional Information
COOWF@1.1:AttrProcessParticipantSet
void
COOWF@1.1:AttrProcessParticipantSet(
AttributeDefinition
attrdef,
ref optional any
value,
any
oldvalue)
Name |
Description |
attrdef |
|
value |
|
oldvalue |
Additional Information
any
COOWF@1.1:AttrProcInstCopy(
AttributeDefinition
attrdef,
object
sourceobj,
out retval any
value)
Name |
Description |
attrdef |
|
sourceobj |
|
value |
Additional Information
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.
void
COOWF@1.1:AttrProcInstSet(
AttributeDefinition
attrdef,
ref optional any
value,
any
oldvalue)
Name |
Description |
attrdef |
|
value |
|
oldvalue |
Additional Information
COOWF@1.1:AttrProcInstStatisticGet
procinststatistic
. It is called by the kernel, when the value
of that property is read.
void
COOWF@1.1:AttrProcInstStatisticGet(
AttributeDefinition
attrdef,
ref any
value,
out optional boolean
volatile,
out optional boolean
volatiletx)
Name |
Description |
attrdef |
|
value |
|
volatile |
|
volatiletx |
Additional Information
COOWF@1.1:AttrProcInstUsersGet
procinstusers
. It is called by the kernel, when the value of
that property is read.
void
COOWF@1.1:AttrProcInstUsersGet(
AttributeDefinition
attrdef,
ref any
value,
out optional boolean
volatile,
out optional boolean
volatiletx)
Name |
Description |
attrdef |
|
value |
|
volatile |
|
volatiletx |
Additional Information
procinstwork
. It is called by the kernel, when the value of
that property is read.
void
COOWF@1.1:AttrProcInstWorkGet(
AttributeDefinition
attrdef,
ref any
value,
out optional boolean
volatile,
out optional boolean
volatiletx)
Name |
Description |
attrdef |
|
value |
|
volatile |
|
volatiletx |
Additional Information
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.
void
COOWF@1.1:AttrSetPendingList(
AttributeDefinition
attrdef,
ref optional any
value,
any
oldvalue)
Name |
Description |
attrdef |
|
value |
|
oldvalue |
Additional Information
COOWF@1.1:wfdforclass
. It is called by the kernel, when the value of
that property is read.
void
COOWF@1.1:AttrUseForClassGet(
AttributeDefinition
attrdef,
ref any
value,
out optional boolean
volatile,
out optional boolean
volatiletx)
Name |
Description |
attrdef |
|
value |
|
volatile |
|
volatiletx |
Additional Information
COOWF@1.1:AttrUsrEnvWfEventsGet
void
COOWF@1.1:AttrUsrEnvWfEventsGet(
AttributeDefinition
attrdef,
ref any
value,
out optional boolean
volatile,
out optional boolean
volatiletx)
Name |
Description |
attrdef |
|
value |
|
volatile |
|
volatiletx |
Additional Information
COOWF@1.1:AttrUsrEnvWfEventsSet
void
COOWF@1.1:AttrUsrEnvWfEventsSet(
AttributeDefinition
attrdef,
ref any
value,
out optional boolean
volatile,
out optional boolean
volatiletx)
Name |
Description |
attrdef |
|
value |
|
volatile |
|
volatiletx |
Additional Information
COOWF@1.1:AttrUsrEnvWfPushEventsGet
void
COOWF@1.1:AttrUsrEnvWfPushEventsGet(
AttributeDefinition
attrdef,
ref any
value,
out optional boolean
volatile,
out optional boolean
volatiletx)
Name |
Description |
attrdef |
|
value |
|
volatile |
|
volatiletx |
Additional Information
COOWF@1.1:AttrUsrEnvWfPushEventsSet
void
COOWF@1.1:AttrUsrEnvWfPushEventsSet(
AttributeDefinition
attrdef,
ref any
value,
out optional boolean
volatile,
out optional boolean
volatiletx)
Name |
Description |
attrdef |
|
value |
|
volatile |
|
volatiletx |
Additional Information
COOWF@1.1:AttrWorkFlowConstructor
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.
any
COOWF@1.1:AttrWorkFlowConstructor(
AttributeDefinition
attrdef,
out retval any
value)
Name |
Description |
attrdef |
|
value |
Additional Information
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.
any
COOWF@1.1:AttrWorkFlowCopy(
AttributeDefinition
attrdef,
object
sourceobj,
out retval any
value)
Name |
Description |
attrdef |
|
sourceobj |
|
value |
Additional Information
COOWF@1.1:AttrWorkFlowDeadLinesGet
workflowdeadlines
. It is called by the kernel, when the value of
that property is read.
void
COOWF@1.1:AttrWorkFlowDeadLinesGet(
AttributeDefinition
attrdef,
ref any
value,
out optional boolean
volatile,
out optional boolean
volatiletx)
Name |
Description |
attrdef |
|
value |
|
volatile |
|
volatiletx |
Additional Information
COOWF@1.1:AttrWorkFlowDefinitionObjectFilter
object[]
COOWF@1.1:AttrWorkFlowDefinitionObjectFilter(
ref retval object[]
objects,
optional AttributeDefinition
attrdef)
Name |
Description |
objects |
the definition objects to be filtered
|
attrdef |
attribute definition
|
Additional Information
COOWF@1.1:AttrWorkFlowDelVersion
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.
void
COOWF@1.1:AttrWorkFlowDelVersion(
AttributeDefinition
attrdef,
integer
versnr,
any
value)
Name |
Description |
attrdef |
|
versnr |
|
value |
Additional Information
COOWF@1.1:AttrWorkFlowFixVersion
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.
void
COOWF@1.1:AttrWorkFlowFixVersion(
AttributeDefinition
attrdef,
integer
oldversnr,
integer
newversnr,
any
value,
optional boolean
autofixed)
Name |
Description |
attrdef |
|
oldversnr |
|
newversnr |
|
value |
|
autofixed |
Additional Information
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.
void
COOWF@1.1:AttrWorkFlowSet(
AttributeDefinition
attrdef,
ref optional any
value,
any
oldvalue)
Name |
Description |
attrdef |
|
value |
|
oldvalue |
Additional Information
COOWF@1.1:AttrWorkListItemsGet
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.
void
COOWF@1.1:AttrWorkListItemsGet(
AttributeDefinition
attrdef,
ref any
value,
out optional boolean
volatile,
out optional boolean
volatiletx)
Name |
Description |
attrdef |
|
value |
|
volatile |
|
volatiletx |
Additional Information
COOWF@1.1:AttrWorkListItemsSet
WorkList
, that represent the different types of "To Do"
lists. It is called by the kernel, before such a property is saved.
void
COOWF@1.1:AttrWorkListItemsSet(
AttributeDefinition
attrdef,
ref optional any
value,
any
oldvalue)
Name |
Description |
attrdef |
|
value |
|
oldvalue |
Additional Information
COOWF@1.1:AttrWorkListUIFilter
object[]
COOWF@1.1:AttrWorkListUIFilter(
ref retval object[]
objects,
AttributeDefinition
attrdef)
Name |
Description |
objects |
|
attrdef |
Additional Information
COOWF@1.1:AutomaticallyInsertFollowerActivity
boolean
COOWF@1.1:AutomaticallyInsertFollowerActivity(
InstanceElement
activity,
boolean
hastobelastactivity,
out retval boolean
automaticallyinsert)
Name |
Description |
activity |
the instance element
|
hastobelastactivity |
the activity has to be the last instance element in the sequence to insert a follower activity
|
automaticallyinsert |
the result
|
Additional Information
COOWF@1.1:BuildPartipantControlParams
PartControlParams
COOWF@1.1:BuildPartipantControlParams(
optional boolean
full,
optional boolean
keephiddenvalues,
optional string
grouproot,
optional string
grouplist,
optional string
userroot,
optional string
userlist,
optional string
show,
optional string
hide,
optional string
disabledmetaparticipants,
optional boolean
simplepartonly,
optional string
simplepartattributes,
optional string
partproproleattributes,
optional boolean
initroles,
optional string
order,
optional Action
validationaction,
out retval PartControlParams
controlparams)
Name |
Description |
full |
all attributes of the participant control should be used
|
keephiddenvalues |
values of invisible properties will not be cleared
|
grouproot |
the COO-Address of an expression object to calculate the tree root for the group attribute
|
grouplist |
the COO-Address of an expression object to calculate the tree lists of the group attribute
|
userroot |
the COO-Address of an expression object to calculate the tree root for the user attribute
|
userlist |
the COO-Address of an expression object to calculate the tree lists of the user attribute
|
show |
defines a list of attributes which should be displayed in the participant control
|
hide |
defines a list of attributes which should be be hidden in the participant control
|
disabledmetaparticipants |
defines a list meta participant values which should be be hidden in the participant control
|
simplepartonly |
defines if the simple mode of the participant control is required or a user can change the mode.
|
simplepartattributes |
defines the attributes which will be display when the participant control uses the simple mode.
|
partproproleattributes |
defines the attributes of the participant aggregate which are used in evaluation of the meta participant WFMP_OBJPROPROLE.
|
initroles |
defines if the role of a user which is selected in the participant control are initialized to the group and position attributes
|
order |
defines the order of the attributes of the participant aggregate.
|
validationaction |
defines the validation action which is executed by the validation expression of the participant control.
|
controlparams |
the control parameters as structure
|
Additional Information
COOWF@1.1:BuildPartipantControlParamValues
void
COOWF@1.1:BuildPartipantControlParamValues(
PartControlParams
controlparams,
out boolean
full,
out boolean
keephiddenvalues,
out string
grouproot,
out string
grouplist,
out string
userroot,
out string
userlist,
out string
show,
out string
hide,
out string
disabledmetaparticipants,
out boolean
simplepartonly,
out string
simplepartattributes,
out string
partproproleattributes,
out boolean
initroles,
out string
order,
out Action
validationaction)
Name |
Description |
controlparams |
the control parameters as structure
|
full |
all attributes of the participant control should be used
|
keephiddenvalues |
values of invisible properties will not be cleared
|
grouproot |
the COO-Address of an expression object to calculate the tree root for the group attribute
|
grouplist |
the COO-Address of an expression object to calculate the tree lists of the group attribute
|
userroot |
the COO-Address of an expression object to calculate the tree root for the user attribute
|
userlist |
the COO-Address of an expression object to calculate the tree lists of the user attribute
|
show |
defines a list of attributes which should be displayed in the participant control
|
hide |
defines a list of attributes which should be be hidden in the participant control
|
disabledmetaparticipants |
defines a list meta participant values which should be be hidden in the participant control
|
simplepartonly |
defines if the simple mode of the participant control is required or a user can change the mode.
|
simplepartattributes |
defines the attributes which will be display when the participant control uses the simple mode.
|
partproproleattributes |
defines the attributes of the participant aggregate which are used in evaluation of the meta participant WFMP_OBJPROPROLE.
|
initroles |
defines if the role of a user which is selected in the participant control are initialized to the group and position attributes
|
order |
defines the order of the attributes of the participant aggregate.
|
validationaction |
defines the validation action which is executed by the validation expression of the participant control.
|
Additional Information
COOWF@1.1:CalculateProcessStatistics
void
COOWF@1.1:CalculateProcessStatistics(
boolean
separatetx,
optional ProcessInstance[]
processes,
optional boolean
useprogress,
optional boolean
background)
Name |
Description |
separatetx |
use a separate transaction to calculate the cache
|
processes |
the processes for which the statistics should be calculated.
If not processes were supplied the processes are calculated
|
useprogress |
|
background |
Additional Information
void
COOWF@1.1:CallObjectWorkItem(
optional integer
handle,
optional integer
index,
integer
wfwindex,
out boolean
refresh,
optional string
remark,
optional boolean
remarkdefined,
optional datetime
receivedat,
optional datetime
startedat,
optional datetime
completedat,
optional datetime
workstartedat,
optional boolean
handled)
Name |
Description |
handle |
is no longer used
|
index |
is no longer used
|
wfwindex |
the index of the work item
|
refresh |
the refresh
|
remark |
the entered remark will be stored to the current
activity instance.
|
remarkdefined |
determines if a remark is supplied
|
receivedat |
the time stamp when the current activity was received.
Only important for manual activities!
|
startedat |
the time stamp when the activity was started
|
completedat |
the time stamp when the activity was completed
|
workstartedat |
the time stamp when the work item was executed
|
handled |
if set the default implementation like executing the work item is not done
|
Additional Information
void
COOWF@1.1:CallWorkItem(
optional integer
unused1,
optional integer
unused2,
integer
menudynkey)
Name |
Description |
unused1 |
|
unused2 |
|
menudynkey |
Additional Information
COOWF@1.1:CanBeUsedForSubProcessesOnly
boolean
COOWF@1.1:CanBeUsedForSubProcessesOnly(
out retval boolean
subprocessesonly)
Name |
Description |
subprocessesonly |
the result
|
Additional Information
COOWF@1.1:CanChangeProcessState
boolean
COOWF@1.1:CanChangeProcessState(
ProcessInstance
procinst,
ref retval boolean
statechangeable)
Name |
Description |
procinst |
the process instance
|
statechangeable |
the result
|
Additional Information
DeleteWorkFlow
to check if the current user is allowed to
delete a process instance.
boolean
COOWF@1.1:CanDeleteWorkFlow(
out retval boolean
candelete,
optional ProcessInstance[]
procinsts)
Name |
Description |
candelete |
the result
|
procinsts |
the process instances which should be deleted
|
Additional Information
COOWF@1.1:CanManageWorkFlowDiagrams
boolean
COOWF@1.1:CanManageWorkFlowDiagrams(
object
context,
optional boolean
silent,
out retval boolean
canmanage)
Name |
Description |
context |
|
silent |
|
canmanage |
Additional Information
COOWF@1.1:ChangeAppWorkFlowState
void
COOWF@1.1:ChangeAppWorkFlowState(
App
app,
ref boolean
licensed,
ref boolean
active,
boolean
oldstate)
Name |
Description |
app |
|
licensed |
|
active |
|
oldstate |
Additional Information
void
COOWF@1.1:ChangeResponsible(
WorkFlowParticipant
responsible,
optional WorkFlowParticipant
respmansubst)
Name |
Description |
responsible |
The organizational element, that will be responsible.
|
respmansubst |
If
responsible specifies an organizational element outside of the system, the organizational element in the system that has to do the work. |
Additional Information
OpenObject
,
SelectTreeObject
,
EditObjectAttributes
, SetStarted
,
SetSuspended
, SetCompleted
,
SetDelegated
, SetTerminated
,
PrescribeObject
and
CallObjectWorkItem
.
void
COOWF@1.1:CheckAction(
object
action,
ref integer
index,
out boolean
ignoreall,
out boolean
asktostart,
out boolean
setstarted,
out boolean
verifydates,
out datetime
defreceivedat,
out datetime
defstartedat,
out datetime
defcompletedat,
out optional string
askquestion,
out optional object[]
applications,
out optional object[]
applobjects,
out optional datetime
workstartedat,
optional object[]
selobjects,
out optional boolean
setsubstitute,
optional boolean
skippermlockcheck)
Name |
Description |
action |
One of the actions listed above.
|
index |
The index of the work item to check, if the action is
CallObjectWorkItem . If not specified, the next not yet executed work item is searched, and the index is returned. |
ignoreall |
If set to
True , the caller should ignore everything other and should not execute, what he intended to do. |
asktostart |
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. |
setstarted |
If set to
True , the activity instance has to be started in any case before continuing. |
verifydates |
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. |
defreceivedat |
The default value for "Received on/at".
|
defstartedat |
The default value for "Started on/at".
|
defcompletedat |
The default value for "Completed on/at".
|
askquestion |
If defined, ask the user this question.
|
applications |
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 CallObjectWorkItem . |
applobjects |
The corresponding objects for the list in
applications . Only valid, if the action is CallObjectWorkItem . |
workstartedat |
The value of this parameter has to be passed to the following call of
CallObjectWorkItem . The applications returned in applications have to be executed before that call. |
selobjects |
The selected objects
|
setsubstitute |
The the current user is a substitute and the workitem can be executed as substitute
|
skippermlockcheck |
The check for permanent locks should be skipped
|
Additional Information
boolean
COOWF@1.1:CheckActive(
out retval boolean
active,
optional boolean
checkapplicense,
optional object
context)
Name |
Description |
active |
The parameter return if the object is active. If the license check is performed and retrieves error the parameter
active will remain empty. |
checkapplicense |
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.
|
context |
Additional Information
COOWF@1.1:CheckAdditionalParticipantRestrictions
object[]
COOWF@1.1:CheckAdditionalParticipantRestrictions(
ref retval object[]
participants)
Name |
Description |
participants |
Additional Information
void
COOWF@1.1:CheckAllowedActions(
ref object[]
actions)
Name |
Description |
actions |
the actions
|
Additional Information
COOWF@1.1:CheckAllowedElements
void
COOWF@1.1:CheckAllowedElements(
ref object[]
objclasses)
Name |
Description |
objclasses |
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
boolean
COOWF@1.1:CheckAutoComplete(
out retval boolean
autocomplete)
Name |
Description |
autocomplete |
the result value
|
Additional Information
void COOWF@1.1:CheckBackgroundWork()
Additional Information
boolean
COOWF@1.1:CheckCopy(
out retval boolean
copyable)
Name |
Description |
copyable |
If set to
True , the process instance is copied and attached to the copy of the object. |
Additional Information
void
COOWF@1.1:CheckDatesForm(
object
action,
out optional object
attrdef,
out optional string
askquestion,
optional boolean
needplaintexterrors)
Name |
Description |
action |
|
attrdef |
|
askquestion |
|
needplaintexterrors |
Additional Information
void
COOWF@1.1:CheckDelegateForm(
object
action,
out optional object
attrdef,
out optional string
askquestion,
out optional boolean
affiliationusable,
optional boolean
needplaintexterrors,
out dictionary
workflowsubstitutioninfos,
out WorkFlowPartAccessMapping[]
invaffiliationparts)
Name |
Description |
action |
|
attrdef |
|
askquestion |
|
affiliationusable |
|
needplaintexterrors |
|
workflowsubstitutioninfos |
|
invaffiliationparts |
Additional Information
COOWF@1.1:CheckDelegateMultipleForm
void
COOWF@1.1:CheckDelegateMultipleForm(
object
action,
out optional object
attrdef,
out optional string
askquestion,
out optional boolean
affiliationusable,
optional boolean
needplaintexterrors,
out dictionary
workflowsubstitutioninfos,
out WorkFlowPartAccessMapping[]
invaffiliationparts)
Name |
Description |
action |
|
attrdef |
|
askquestion |
|
affiliationusable |
|
needplaintexterrors |
|
workflowsubstitutioninfos |
|
invaffiliationparts |
Additional Information
void
COOWF@1.1:CheckDestination(
optional boolean
ignoremetaparticipant,
optional boolean
strict,
optional boolean
resolvemetaparticipant)
Name |
Description |
ignoremetaparticipant |
meta participants will not raise an error
when domainenforcepartcheck is set
|
strict |
is used to override the setting actinstignoreinvpart of the activity
|
resolvemetaparticipant |
the metaparticipant is resolved before the checks are performed
|
Additional Information
COOWF@1.1:CheckExpiredActivities
CheckBackgroundWork
, it has to
be done by a system administrator. You can copy the task created for the action
CheckBackgroundWork
and change the action to do that.
string
COOWF@1.1:CheckExpiredActivities(
out retval string
escalationerrors)
Name |
Description |
escalationerrors |
errors ocurred during escalations
|
Additional Information
void
COOWF@1.1:CheckForm(
object
action,
out optional object
attrdef,
out optional string
askquestion,
out WorkFlowPartAccessMapping[]
invaffiliatonparts,
optional boolean
needplaintexterrors)
Name |
Description |
action |
|
attrdef |
|
askquestion |
|
invaffiliatonparts |
|
needplaintexterrors |
Additional Information
boolean
COOWF@1.1:CheckInsertTemplate(
integer
pblockidx,
integer
pidx,
out retval boolean
allowed)
Name |
Description |
pblockidx |
the index of the precription block
|
pidx |
the index of the prescription in the prescription block
|
allowed |
the result
|
Additional Information
COOWF@1.1:CheckLongTermActivities
CheckBackgroundWork
, it has to be done by a system administrator.
You can copy the task created for the action CheckBackgroundWork
and change the action to do that.void COOWF@1.1:CheckLongTermActivities()
Additional Information
void
COOWF@1.1:CheckParticipant(
WorkFlowParticipant
participant,
optional WorkFlowParticipant
partmansubst,
optional boolean
metaallowed,
out optional string
askquestion,
optional ActivityType
acttype,
out optional string
errortext,
optional boolean
enforcepartcheck,
optional boolean
remembercheckedparticipants,
optional boolean
checkactivesubstitution,
out optional boolean
affiliationusable,
optional boolean
needplaintexterrors,
optional boolean
separatesubstitutioncheck,
out dictionary
workflowsubstitutioninfos,
optional boolean
skipdisplaywithaccessparts,
optional AccessType[]
requiredaccesstypes)
Name |
Description |
participant |
the participant which should be checked
|
partmansubst |
the manual participant which should be checked
|
metaallowed |
the parameter defines if meta participants are allowed
|
askquestion |
the question which is displayed to the uses to decide if
he wants to use the participant which the displayed warnings (plain text)
|
acttype |
the activity type of the activity instance
|
errortext |
the question which is displayed to the uses to decide if
he wants to use the participant which the displayed warnings (html)
|
enforcepartcheck |
the warnings are treated as errors
|
remembercheckedparticipants |
already checked participants are skipped
|
checkactivesubstitution |
the substitution check can be enabled or disabled
|
affiliationusable |
the participant is allowed by affilation checks
|
needplaintexterrors |
the errortext and askquestion will be returned as plain text
|
separatesubstitutioncheck |
the errors concerning participant abscense are not contained
in the errortext the parameters of the substitution are returned in the dictionary workflowsubstitutioninfos
|
workflowsubstitutioninfos |
the infos about the substitution
|
skipdisplaywithaccessparts |
if defined only one member of the group of the participant needs access to the object
|
requiredaccesstypes |
is used for checking the affiliation access. If not set the access types configured on the activity
instance or activity definition is used
|
Additional Information
COOWF@1.1:CheckParticipantAffiliation
boolean
COOWF@1.1:CheckParticipantAffiliation(
WorkFlowParticipant
participant,
object
actinst,
out retval boolean
usableparticipant,
optional boolean
skipdisplaywithaccessparts,
optional AccessType[]
requiredaccesstypes)
Name |
Description |
participant |
The participant which should be checked.
|
actinst |
The current activity of the current process.
|
usableparticipant |
The participant can be used and the action does not need
to throw an error message
|
skipdisplaywithaccessparts |
the current activity should be displayed only for participants with access permissions
|
requiredaccesstypes |
the access types which should be checked to execute the activity
|
Additional Information
COOWF@1.1:CheckParticipantRules
void
COOWF@1.1:CheckParticipantRules(
WorkFlowParticipant
part,
optional object
processelement,
optional ActivityType
acttype)
Name |
Description |
part |
the participant which should be checked
|
processelement |
the process element for which the participant check is performed.
(e.g.: ActivityInstance, ProcessInstance, ActivityDefinition, ProcessDefinition, WorkFlowDiagram)
|
acttype |
the type of the activity
|
Additional Information
COOWF@1.1:CheckPrescriptionsForm
void
COOWF@1.1:CheckPrescriptionsForm(
object
action,
out optional object
attrdef,
out optional string
askquestion,
out WorkFlowPartAccessMapping[]
invaffiliatonparts,
optional boolean
needplaintexterrors,
optional WorkFlowPrescriptionList[]
prescriptions,
optional WorkFlowPrescriptionBlockList[]
prescriptionblocks,
out dictionary
workflowsubstitutioninfos)
Name |
Description |
action |
|
attrdef |
|
askquestion |
|
invaffiliatonparts |
|
needplaintexterrors |
|
prescriptions |
|
prescriptionblocks |
|
workflowsubstitutioninfos |
Additional Information
COOWF@1.1:CheckReferencedDiagramExecutionRestriction
boolean
COOWF@1.1:CheckReferencedDiagramExecutionRestriction(
out retval boolean
allowed,
out optional WorkFlowDiagram[]
restrictionconflicts)
Name |
Description |
allowed |
the current restrictions are allowed in context of the superior processes
|
restrictionconflicts |
the superior processes where execution restrictions exist
|
Additional Information
COOWF@1.1:CheckReleaseReferencedDiagrams
boolean
COOWF@1.1:CheckReleaseReferencedDiagrams(
out retval boolean
hasrefdiagrams,
out boolean
isreleasepossible,
out WorkFlowDiagram[]
notreleaseablediagrams,
out WorkFlowDiagram[]
requireddiagrams)
Name |
Description |
hasrefdiagrams |
the current workflow diagram has referenced diagrams which have a newer draft
version than the released version
|
isreleasepossible |
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.
|
notreleaseablediagrams |
this diagrams can not be released by the current user
|
requireddiagrams |
this diagrams are required to be released to release the diagram
|
Additional Information
COOWF@1.1:CheckRemoveOrgElements
WorkFlowOrgSecurity
COOWF@1.1:CheckRemoveOrgElements(
out retval WorkFlowOrgSecurity
orgsecurity)
Name |
Description |
orgsecurity |
the configuration how the permissions are handled after completion
|
Additional Information
boolean
COOWF@1.1:CheckRetracted(
out retval boolean
allowed)
Name |
Description |
allowed |
the retraction of the activity instances is allowed
|
Additional Information
COOWF@1.1:CheckSimplePrescriptionsForm
void
COOWF@1.1:CheckSimplePrescriptionsForm(
object
action,
out optional object
attrdef,
out optional string
askquestion,
out WorkFlowPartAccessMapping[]
invaffiliatonparts,
optional boolean
needplaintexterrors,
optional WorkFlowPrescriptionList[]
prescription,
optional WorkFlowPrescriptionBlockList[]
prescriptionblocks,
out dictionary
workflowsubstitutioninfos)
Name |
Description |
action |
|
attrdef |
|
askquestion |
|
invaffiliatonparts |
|
needplaintexterrors |
|
prescription |
|
prescriptionblocks |
|
workflowsubstitutioninfos |
Additional Information
boolean
COOWF@1.1:CheckStart(
out retval boolean
startable)
Name |
Description |
startable |
the result value
|
Additional Information
COOWF@1.1:CheckSubmissionRepetitionPeriod
void
COOWF@1.1:CheckSubmissionRepetitionPeriod(
SubmissionRepetitionPeriod
repetitionperiod,
out string
checkresult,
out boolean
error,
out string
askquestion)
Name |
Description |
repetitionperiod |
the repetitionperiod
|
checkresult |
the checkresult
|
error |
the error
|
askquestion |
the question displayed in the user interface
|
Additional Information
boolean
COOWF@1.1:CheckTakenOver(
out retval boolean
allowed)
Name |
Description |
allowed |
the allowed
|
Additional Information
void
COOWF@1.1:CheckWorkDay(
datetime
checkdate,
optional boolean
checkpast)
Name |
Description |
checkdate |
the checkdate
|
checkpast |
the checkpast
|
Additional Information
COOWF@1.1:CheckWorkFlowAppLicense
boolean
COOWF@1.1:CheckWorkFlowAppLicense(
optional boolean
disableerrorapps,
optional boolean
silentmode,
out retval boolean
haslicense)
Name |
Description |
disableerrorapps |
|
silentmode |
|
haslicense |
Additional Information
void COOWF@1.1:CheckWorkList()
Additional Information
COOWF@1.1:ChooseProcessDefinition
void
COOWF@1.1:ChooseProcessDefinition(
optional integer
handle,
optional integer
index)
Name |
Description |
handle |
is no longer used
|
index |
is no longer used
|
Additional Information
COOWF@1.1:ClearProcessParameters
void
COOWF@1.1:ClearProcessParameters(
optional boolean
separatetx)
Name |
Description |
separatetx |
the changes are stored in a separate transaction and
directly saved
|
Additional Information
COOWF@1.1:CollectCommonStartedInstances
object[]
COOWF@1.1:CollectCommonStartedInstances(
object[]
sourceobjects,
ref optional integer
dynkey,
optional AttributeObjectDef
view,
out retval object[]
targetobjects)
Name |
Description |
sourceobjects |
|
dynkey |
|
view |
|
targetobjects |
Additional Information
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.
void
COOWF@1.1:ComputeDeadLine(
object
attrdef)
Name |
Description |
attrdef |
The deadline property that has to be computed. Must be one of
actinstsubmitdeadline , actinststartdeadline or actinstenddeadline . |
Additional Information
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.
boolean
COOWF@1.1:ConfirmStart(
integer
parenthandle,
object
context,
out retval boolean
yes)
Name |
Description |
parenthandle |
The handle of the parent window that can be used as parents for dialogs in the user interface.
|
context |
The action object of the context, where this action is called.
|
yes |
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
COOWF@1.1:ConvertDateToWorkDays
integer
COOWF@1.1:ConvertDateToWorkDays(
datetime
startdate,
datetime
enddate,
out retval integer
workdays)
Name |
Description |
startdate |
the start date
|
enddate |
the end date
|
workdays |
the distance between the start and end date in workdays
|
Additional Information
COOWF@1.1:ConvertWorkDaysToDate
datetime
COOWF@1.1:ConvertWorkDaysToDate(
datetime
startdate,
integer
workdays,
out retval datetime
enddate)
Name |
Description |
startdate |
the start date
|
workdays |
the workdays
|
enddate |
the end date
|
Additional Information
domainworkflowaffinity
) to modify the placement of the copied
object as desired.
object
COOWF@1.1:CopyWorkFlowObject(
object
refobject,
out retval object
resultobject)
Name |
Description |
refobject |
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.
|
resultobject |
The copied object.
|
Additional Information
COOWF@1.1:CreateProcessInstance
object
COOWF@1.1:CreateProcessInstance(
out retval object
procinst,
optional string
procinstcommonid)
Name |
Description |
procinst |
the created process instance
|
procinstcommonid |
if defined the identification is stored in property procinstcommonid for newly created processes.
This identification is used to allow to combine commonly started process instances
|
Additional Information
void
COOWF@1.1:CreateProcessOutput(
optional integer
unused1,
optional integer
unused2)
Name |
Description |
unused1 |
|
unused2 |
Additional Information
COOWF@1.1:CreateProcessParticipant
void
COOWF@1.1:CreateProcessParticipant(
optional integer
unused1,
optional integer
unused2)
Name |
Description |
unused1 |
|
unused2 |
Additional Information
COOWF@1.1:CreateProcessStatisticsCache
ProcessStatisticsCache
COOWF@1.1:CreateProcessStatisticsCache(
object
processdefinition,
out retval ProcessStatisticsCache
cache)
Name |
Description |
processdefinition |
the process definition or BPMN diagram object
|
cache |
the created cache object
|
Additional Information
COOWF@1.1:CreateWorkFlowDiagram
void
COOWF@1.1:CreateWorkFlowDiagram(
optional integer
unused1,
optional integer
unused2)
Name |
Description |
unused1 |
|
unused2 |
Additional Information
COOWF@1.1:CreateWorkFlowObject
domainworkflowaffinity
) to modify the placement of the created
object as desired.
object
COOWF@1.1:CreateWorkFlowObject(
object
refobject,
out retval object
obj,
optional boolean
separatetx)
Name |
Description |
refobject |
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.
|
obj |
|
separatetx |
the create operation will be performed in a separate transaction
and automatically commited
|
Additional Information
void
COOWF@1.1:DefineWFSubstitutes(
optional integer
unused1,
optional integer
unused2)
Name |
Description |
unused1 |
|
unused2 |
Additional Information
COOWF@1.1:DelegateActivityHook
WorkFlowParticipant
COOWF@1.1:DelegateActivityHook(
ref retval WorkFlowParticipant
participant,
ref optional WorkFlowParticipant
partmansubst,
ActivityInstance
activity,
ProcessInstance
process)
Name |
Description |
participant |
the participant
|
partmansubst |
the substitute of a manual participant
|
activity |
the activity which should be delegated
|
process |
the process instance the activity is assigned to.
|
Additional Information
COOWF@1.1:DelegateActivityMultipleHook
PrescriptionMetaDataWho[]
COOWF@1.1:DelegateActivityMultipleHook(
ref retval PrescriptionMetaDataWho[]
participants,
ActivityInstance
activity,
ProcessInstance
process)
Name |
Description |
participants |
the participants who should get the activity of the current user additionally
|
activity |
the activity which should be delegated to multiple participants
|
process |
the process instance the activity is assigned to.
|
Additional Information
COOWF@1.1:DeleteSelectedObjectsWorkFlow
void
COOWF@1.1:DeleteSelectedObjectsWorkFlow(
optional integer
handle,
optional integer
index)
Name |
Description |
handle |
is no longer used
|
index |
is no longer used
|
Additional Information
COOWF@1.1:DeleteWasteBasketObjects
void
COOWF@1.1:DeleteWasteBasketObjects(
optional integer
unused1,
optional integer
unused2)
Name |
Description |
unused1 |
|
unused2 |
Additional Information
COOWF@1.1:DeleteWasteBasketObjectsSelected
void
COOWF@1.1:DeleteWasteBasketObjectsSelected(
optional integer
unused1,
optional integer
unused2)
Name |
Description |
unused1 |
|
unused2 |
Additional Information
void
COOWF@1.1:DeleteWorkFlow(
optional object[]
procinsts)
Name |
Description |
procinsts |
Process instances that should be deleted. If empty, all process instances attached to the object are deleted.
|
Additional Information
COOWF@1.1:DeleteWorkFlowDiagram
void
COOWF@1.1:DeleteWorkFlowDiagram(
optional integer
unused1,
optional integer
unused2)
Name |
Description |
unused1 |
|
unused2 |
Additional Information
COOWF@1.1:DeleteWorkFlowDiagramSelected
void
COOWF@1.1:DeleteWorkFlowDiagramSelected(
optional integer
unused1,
optional integer
unused2)
Name |
Description |
unused1 |
|
unused2 |
Additional Information
COOWF@1.1:DeleteWorkFlowObject
procinstdeleted
of the process instance.
void
COOWF@1.1:DeleteWorkFlowObject(
optional boolean
separatetx)
Name |
Description |
separatetx |
the delete operation will be performed in a separate transaction
and automatically commited
|
Additional Information
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, after the user has successfully logged in.void COOWF@1.1:DeskLoggedIn()
Additional Information
COOWF@1.1:DisplayActionsInWorkflowTaskPane
boolean
COOWF@1.1:DisplayActionsInWorkflowTaskPane(
out retval boolean
displayactions)
Name |
Description |
displayactions |
the context menu actions should be diplayed
|
Additional Information
COOWF@1.1:DisplayBPMNCustomizedExpressions
void
COOWF@1.1:DisplayBPMNCustomizedExpressions(
optional integer
unused1,
optional integer
unused2)
Name |
Description |
unused1 |
|
unused2 |
Additional Information
COOWF@1.1:DisplayParticipantWithLabels
string[]
COOWF@1.1:DisplayParticipantWithLabels(
WorkFlowParticipant
part,
boolean
uselabelplaceholder,
optional boolean
dontshowprefix,
AttributeDefinition[]
domainprophiddenprefixes,
out retval string[]
formattedpart)
Name |
Description |
part |
the participant
|
uselabelplaceholder |
if defined the placeholder <%label%> is inserted before each label
|
dontshowprefix |
if defined the attribute names of the properties specified in param domainprophiddenprefixes
are not displayed for the participant
|
domainprophiddenprefixes |
|
formattedpart |
the result
|
Additional Information
boolean
COOWF@1.1:DoShowWorkListItem(
object
attrdef,
out retval boolean
show)
Name |
Description |
attrdef |
the requested property of the WorkList
|
show |
return flag
|
Additional Information
COOWF@1.1:EditObjectAttributesDirect
void
COOWF@1.1:EditObjectAttributesDirect(
optional integer
handle,
optional integer
index)
Name |
Description |
handle |
is no longer used
|
index |
is no longer used
|
Additional Information
COOWF@1.1:EditProcessObjectAttributes
void
COOWF@1.1:EditProcessObjectAttributes(
optional integer
handle,
optional integer
index,
optional object
objectclass,
optional object
focusattr,
optional boolean
domodal,
optional string
oleitem,
optional object[]
attrs,
optional object
formsobj,
optional object
checkaction,
optional boolean
locked,
optional any
internal11,
optional any
internal12,
optional integer
handleparent,
optional string
itempath)
Name |
Description |
handle |
the handle
|
index |
the index
|
objectclass |
the objectclass
|
focusattr |
the focusattr
|
domodal |
the domodal
|
oleitem |
the oleitem
|
attrs |
the attrs
|
formsobj |
the formsobj
|
checkaction |
the checkaction
|
locked |
the locked
|
internal11 |
the internal11
|
internal12 |
the internal12
|
handleparent |
the handleparent
|
itempath |
the itempath
|
Additional Information
integer
COOWF@1.1:EscalateObject(
EscalationEntryList[]
escalations,
ExpiryCheck
deadlinetype,
datetime
deadline,
WorkFlowPriority
priority,
ref datetime
escalatedat,
out retval integer
nrsuccess,
out integer
nrfailure,
out string[]
errormsgs)
Name |
Description |
escalations |
the defined escalation
|
deadlinetype |
the expired deadline
|
deadline |
the deadline which triggered the escalation
|
priority |
the priority of the escalated process
|
escalatedat |
the escalation date
|
nrsuccess |
the amount of successful escalation
|
nrfailure |
the amount of failures during the escalation
|
errormsgs |
the occurred errors during the escalation process
|
Additional Information
COOWF@1.1:EscalateToRecipients
integer
COOWF@1.1:EscalateToRecipients(
EscalationRecipient[]
escalrecipients,
ExpiryCheck
deadlinetype,
EscalationType
escalationtype,
datetime
deadline,
LanguageStringList[]
text,
out retval integer
nrsuccess,
out integer
nrfailure,
out string[]
errormsgs,
optional XSLTransformation
textxsl,
optional string[]
subjectexpr,
optional boolean
subjectaddsuiteprefix,
optional Importance
mailimportance)
Name |
Description |
escalrecipients |
the recipients of the escalation
|
deadlinetype |
the expired deadline
|
escalationtype |
defines if the escalation is
done before or after expiration obj the deadline
|
deadline |
the deadline which triggered the escalation
|
text |
the text of the escalation message
|
nrsuccess |
the amount of successful escalation
|
nrfailure |
the amount of failures during the escalation
|
errormsgs |
the occurred errors during the escalation process
|
textxsl |
the xsl transformation to format the body of the escalation mail
|
subjectexpr |
an expression to define the subject of the mail
|
subjectaddsuiteprefix |
define if the suite name should be included in the subject of the mail
|
mailimportance |
the importance of the sent escalation mail
|
Additional Information
integer
COOWF@1.1:EvaluateCase(
out retval integer
caseresult,
out optional string[]
activatedpaths)
Name |
Description |
caseresult |
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.
|
activatedpaths |
The activated outgoing flows of the diverging gateway instance
|
Additional Information
boolean
COOWF@1.1:EvaluateCondition(
out retval boolean
condresult)
Name |
Description |
condresult |
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
COOWF@1.1:EvaluatePrecondition
boolean
COOWF@1.1:EvaluatePrecondition(
integer
wfwidx,
out retval boolean
notexecuteable,
out boolean
hidden,
optional boolean
silent)
Name |
Description |
wfwidx |
the index of the work item for which the conditions should be evaluated
|
notexecuteable |
if true the work item is not executable
|
hidden |
if true the work item is hidden
|
silent |
Additional Information
COOWF@1.1:ExecuteBackgroundWork
ScheduleTask
or
ScheduleLocal
with this action as the action, that will
execute these tasks.void COOWF@1.1:ExecuteBackgroundWork()
Additional Information
COOWF@1.1:ExpandPrescribeParticipants
void
COOWF@1.1:ExpandPrescribeParticipants(
ref optional WorkFlowPrescriptionList[]
prescription,
ref optional WorkFlowPrescriptionBlockList[]
prescrblocks,
optional boolean
resolvetouser)
Name |
Description |
prescription |
the prescription
|
prescrblocks |
the prescription blocks
|
resolvetouser |
defines of the participants should be resolved to users
|
Additional Information
COOWF@1.1:ExtendNotificationSettings
NotificationEntryList[]
COOWF@1.1:ExtendNotificationSettings(
ProcessInstance
procinst,
object[]
processobjects,
WorkFlowParticipant
participant,
ref retval NotificationEntryList[]
notificationentries)
Name |
Description |
procinst |
the process of the instance element
|
processobjects |
the objects of the process
|
participant |
the participant of the instance element
|
notificationentries |
the notification settings
|
Additional Information
COOWF@1.1:ExtendPushNotificationSettings
PushNotificationEntryList[]
COOWF@1.1:ExtendPushNotificationSettings(
ProcessInstance
procinst,
object[]
processobjects,
WorkFlowParticipant
participant,
ref retval PushNotificationEntryList[]
pushnotificationentries)
Name |
Description |
procinst |
the process of the instance element
|
processobjects |
the objects of the process
|
participant |
the participant of the instance element
|
pushnotificationentries |
the push notification settings
|
Additional Information
COOWF@1.1:ExtractSubPrescription
WorkFlowPrescriptionList[]
COOWF@1.1:ExtractSubPrescription(
WorkFlowSubPrescriptionList[]
source,
out retval WorkFlowPrescriptionList[]
extractedprescription)
Name |
Description |
source |
|
extractedprescription |
Additional Information
COOWF@1.1:FilterPossibleReferencedDiagrams
DiagramObject[]
COOWF@1.1:FilterPossibleReferencedDiagrams(
ref retval DiagramObject[]
possiblediagrams,
optional boolean
considereroomcontext)
Name |
Description |
possiblediagrams |
the diagrams which will be filterd
|
considereroomcontext |
if set the room restrictions will be considered when calculating diagrams
|
Additional Information
COOWF@1.1:FilterUsableDefinitions
void
COOWF@1.1:FilterUsableDefinitions(
object
context,
ref object[]
objects)
Name |
Description |
context |
the context
|
objects |
the objects
|
Additional Information
COOWF@1.1:FilterUsableDiagramsHook
void
COOWF@1.1:FilterUsableDiagramsHook(
object[]
targetobjects,
ref WorkFlowDiagram[]
usablediagrams,
optional boolean
considereroomcontext)
Name |
Description |
targetobjects |
the objects on which the workflow diagrams should be started
|
usablediagrams |
the usable diagrams
|
considereroomcontext |
if set the room restrictions will be considered when calculating the allowed diagrams
|
Additional Information
void
COOWF@1.1:FilterUsableObjects(
object
context,
ref object[]
objects)
Name |
Description |
context |
the context
|
objects |
the objects
|
Additional Information
COOWF@1.1:FixParticipantAffiliation
boolean
COOWF@1.1:FixParticipantAffiliation(
Action
context,
WorkFlowPartAccessMapping[]
participants,
optional boolean
continueediting,
out retval boolean
performed)
Name |
Description |
context |
the context in with the affiliation check was performed
|
participants |
the participants with affiliation problems
|
continueediting |
this option is set when the process is not started directly or the activity is
not inserted directly
|
performed |
if set a check was performed and no cancel branch was clicked
|
Additional Information
COOWF@1.1:FormatWFNotificationSettingsToInfolist
InfoList[]
COOWF@1.1:FormatWFNotificationSettingsToInfolist(
boolean
read,
WorkFlowEventType[]
mailevents,
WorkFlowEventType[]
pushevents,
optional boolean
disablemailedit,
optional boolean
disablepushedit,
out retval InfoList[]
dispnotifications)
Name |
Description |
read |
the control should be displayed read only
|
mailevents |
the mail event types which should be displayed as checked
|
pushevents |
the push event types which should be displayed as checked
|
disablemailedit |
if set to true the settings for mail notifications are not editable
|
disablepushedit |
if set to true the settings for push notifications are not editable
|
dispnotifications |
the result
|
Additional Information
COOWF@1.1:GenerateArchivedProcessStatistic
ArchivedProcessStatistic
COOWF@1.1:GenerateArchivedProcessStatistic(
out retval ArchivedProcessStatistic
statistics)
Name |
Description |
statistics |
Additional Information
COOWF@1.1:GetActivityInstanceMenu
void
COOWF@1.1:GetActivityInstanceMenu(
optional integer
unused1,
optional integer
unused2,
ref MenuStructList[]
menuentries,
optional object
menu,
optional object[]
selobjects,
out optional boolean
addchildren)
Name |
Description |
unused1 |
|
unused2 |
|
menuentries |
|
menu |
|
selobjects |
|
addchildren |
Additional Information
COOWF@1.1:GetAdditionalPrescriptionTemplatesHook
PrescriptionTemplate[]
COOWF@1.1:GetAdditionalPrescriptionTemplatesHook(
object[]
wfobjects,
ref retval PrescriptionTemplate[]
templates)
Name |
Description |
wfobjects |
workflow objects
|
templates |
list of prescription templates
|
Additional Information
COOWF@1.1:GetAdditionalWorkFlowDiagramsHook
WorkFlowDiagram[]
COOWF@1.1:GetAdditionalWorkFlowDiagramsHook(
object[]
wfobjects,
ref retval WorkFlowDiagram[]
diagrams,
optional boolean
requiredraftversion)
Name |
Description |
wfobjects |
workflow objects
|
diagrams |
list of workflow diagrams
|
requiredraftversion |
if set to true the draft version of the diagrams is needed
|
Additional Information
COOWF@1.1:GetAllWorkListActInsts
object[]
COOWF@1.1:GetAllWorkListActInsts(
out retval object[]
allactinsts)
Name |
Description |
allactinsts |
the allactinsts
|
Additional Information
COOWF@1.1:GetCommonPrescribeDefault
void
COOWF@1.1:GetCommonPrescribeDefault(
object[]
objects,
out boolean
commondefault,
out WorkFlowPrescriptionList[]
prescription,
out boolean
prescrparallel,
out object
prescrback,
out optional object[]
prescrusable,
out optional boolean
prescrrestricted,
out optional WorkFlowPrescriptionBlockList[]
prescrblocks,
optional boolean
prescrblocksonly,
out optional boolean
prescrbackrestricted,
out optional object[]
prescrtemplates,
out optional boolean
commonprocesspossible,
out optional WorkFlowDiagram[]
prescdiagrams,
optional boolean
prescrtemplatesonly,
optional boolean
considereroomcontext)
Name |
Description |
objects |
the objects
|
commondefault |
the commondefault
|
prescription |
the prescription
|
prescrparallel |
the prescrparallel
|
prescrback |
the prescrback
|
prescrusable |
the prescrusable
|
prescrrestricted |
the prescrrestricted
|
prescrblocks |
the prescrblocks
|
prescrblocksonly |
the prescrblocksonly
|
prescrbackrestricted |
the prescrbackrestricted
|
prescrtemplates |
the stored prescription templates
|
commonprocesspossible |
the commonprocesspossible
|
prescdiagrams |
the usable workflow diagrams
|
prescrtemplatesonly |
if set no prescriptiondiagrams will be evaluated
|
considereroomcontext |
if set the room restrictions will be considered when calculating diagrams
|
Additional Information
COOWF@1.1:GetCommonUsableProcessDefinitions
void
COOWF@1.1:GetCommonUsableProcessDefinitions(
object[]
objects,
out boolean
commondefault,
out object[]
procdefs,
out optional boolean
commonprocesspossible)
Name |
Description |
objects |
the objects for which the process definitions should be commonly usable.
|
commondefault |
the commondefault
|
procdefs |
the retrieved process definitions
|
commonprocesspossible |
the defines if a common process is possible for the supplied objects.
|
Additional Information
string
COOWF@1.1:GetConditionString(
object
attrdefcont,
out retval string
condstring,
optional object
attrdefaction)
Name |
Description |
attrdefcont |
The string or content property that contains the formal condition.
|
condstring |
The condition with references replaced by the language dependent names.
|
attrdefaction |
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
COOWF@1.1:GetConfiguredProcessStatisticsUsers
ProcStatisticsUsers[]
COOWF@1.1:GetConfiguredProcessStatisticsUsers(
out retval ProcStatisticsUsers[]
users)
Name |
Description |
users |
Additional Information
string
COOWF@1.1:GetConfiguredSender(
out retval string
sender)
Name |
Description |
sender |
the result
|
Additional Information
COOWF@1.1:GetCurrentActivityInstances
object[]
COOWF@1.1:GetCurrentActivityInstances(
out retval object[]
actinsts,
optional ActivityInstanceState[]
actinststates,
optional object[]
users,
optional boolean
anyuser)
Name |
Description |
actinsts |
the activity instances currently located in the work list
|
actinststates |
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. |
users |
the users
|
anyuser |
the anyuser
|
Additional Information
COOWF@1.1:GetCurrentUserActivities
object[]
COOWF@1.1:GetCurrentUserActivities(
out retval object[]
actinsts)
Name |
Description |
actinsts |
Additional Information
COOWF@1.1:GetDefaultNotificationTypes
WorkFlowEventType[]
COOWF@1.1:GetDefaultNotificationTypes(
boolean
pushnotifications,
boolean
skipconfig,
out retval WorkFlowEventType[]
notificationtypes)
Name |
Description |
pushnotifications |
the default settings for push notifications are returned
|
skipconfig |
the default values are returned without checking the workflow configuration settings.
|
notificationtypes |
the result
|
Additional Information
COOWF@1.1:GetDefaultProcessDefinitions
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.
object[]
COOWF@1.1:GetDefaultProcessDefinitions(
out retval object[]
procdefs)
Name |
Description |
procdefs |
Process definitions, that are used to initialize new process instances, that are attached to the object.
|
Additional Information
COOWF@1.1:GetDefinitionElements
object[]
COOWF@1.1:GetDefinitionElements(
out retval object[]
defelems,
optional object
objclass)
Name |
Description |
defelems |
The list of definition elements.
|
objclass |
The desired class.
|
Additional Information
void
COOWF@1.1:GetDelegateDefault(
ref WorkFlowParticipant
participant,
ref WorkFlowParticipant
partmansubst,
ref string
remark,
ref datetime
submitdeadline,
ref datetime
startdeadline,
ref datetime
enddeadline,
out boolean
nodeadlinecheck)
Name |
Description |
participant |
The default workflow participant, to whom the activiy is delegated.
|
partmansubst |
The substitute, if
participant specifies a manual workflow participant. |
remark |
The additional remark in the activity.
|
submitdeadline |
The deadline for submitting the activity.
|
startdeadline |
The deadline for starting the activity.
|
enddeadline |
The deadline for completing the activity.
|
nodeadlinecheck |
Additional Information
COOWF@1.1:GetDelegateMultipleDefault
void
COOWF@1.1:GetDelegateMultipleDefault(
ref WorkFlowParticipant
participant,
ref WorkFlowParticipant
partmansubst,
ref string
remark,
ref datetime
submitdeadline,
ref datetime
startdeadline,
ref datetime
enddeadline,
out boolean
nodeadlinecheck)
Name |
Description |
participant |
The default workflow participant, to whom the activiy is delegated.
|
partmansubst |
The substitute, if
participant specifies a manual workflow participant. |
remark |
The additional remark in the activity.
|
submitdeadline |
The deadline for submitting the activity.
|
startdeadline |
The deadline for starting the activity.
|
enddeadline |
The deadline for completing the activity.
|
nodeadlinecheck |
deadlines are not displayed in the delegation dialog
|
Additional Information
COOWF@1.1:GetDiagramIdFromWorkFlowObject
string
COOWF@1.1:GetDiagramIdFromWorkFlowObject(
optional boolean
usenamefallback,
out retval string
id)
Name |
Description |
usenamefallback |
if set to true the object name is used instead of the object address
|
id |
the result
|
Additional Information
COOWF@1.1:GetDiagramProcessParticipants
WorkFlowCompoundParticipant[]
COOWF@1.1:GetDiagramProcessParticipants(
optional boolean
skipsubprocesses,
out retval WorkFlowCompoundParticipant[]
processparticipants,
optional boolean
forcereferenceddraftversion)
Name |
Description |
skipsubprocesses |
If set to true the subprocesses contained
in the process diagram will not be scanned for participants
|
processparticipants |
the result
|
forcereferenceddraftversion |
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
COOWF@1.1:GetDisplayProperties
DisplayColumnList[]
COOWF@1.1:GetDisplayProperties(
out retval DisplayColumnList[]
displaycolumnlist,
optional dictionary
userenvsettings)
Name |
Description |
displaycolumnlist |
The description of the properties, that are to be displayed. If empty, a default set of properties is displayed.
|
userenvsettings |
Additional Information
COOWF@1.1:GetInheritedWorkFlowSettings
object[]
COOWF@1.1:GetInheritedWorkFlowSettings(
out retval object[]
prescriptiontemplates,
out WorkFlowDiagram[]
diagrams)
Name |
Description |
prescriptiontemplates |
the inherited prescription templates
|
diagrams |
the inherited workflow diagrams
|
Additional Information
COOWF@1.1:GetInitialResponsible
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.
WorkFlowParticipant
COOWF@1.1:GetInitialResponsible(
out retval WorkFlowParticipant
responsible,
out optional WorkFlowParticipant
respmansubst,
optional ProcessInstance
procinst,
optional object
processsource)
Name |
Description |
responsible |
the calculated responsible of the process.
|
respmansubst |
the calculated responsible of the process for manual activities.
|
procinst |
the newly create process instance
|
processsource |
the model from which the process flow is taken.
(e.g.: a WorkFlowDiagram or ProcessDefinition)
|
Additional Information
COOWF@1.1:GetInsertActivityDef
InsertActivityDef
.
object
COOWF@1.1:GetInsertActivityDef(
object
scope,
optional dictionary
state,
out retval object
insertactdef,
out boolean
abortfollowers)
Name |
Description |
scope |
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. |
state |
The
state is a dictionary to supply additional informations for evaluation of the activity definition. |
insertactdef |
The activity definition is calculated by an expression with the following values in the local scope:
|
abortfollowers |
all followers with the same ad hoc key will be aborted
|
Additional Information
COOWF@1.1:GetInstanceElementColor
integer
COOWF@1.1:GetInstanceElementColor(
out retval integer
colorcode)
Name |
Description |
colorcode |
the color code
|
Additional Information
object[]
COOWF@1.1:GetInstanceElements(
ref retval object[]
instelems,
optional object[]
objclass,
optional ActivityInstanceState[]
actinststate,
optional boolean
ordered,
optional string
adhockey,
optional string
multiinstancekey)
Name |
Description |
instelems |
The list of instance elements.
|
objclass |
The desired class.
|
actinststate |
The desired state.
|
ordered |
The instance elements are returned in their graphical order. Starting
at the top going to the bottom and from left to right
|
adhockey |
the instance elements with the matching ad hockey will be returned
|
multiinstancekey |
the instance elements with the matching multi instance key will be returned
|
Additional Information
COOWF@1.1:GetLastInstanceElements
object[]
COOWF@1.1:GetLastInstanceElements(
out retval object[]
instelems)
Name |
Description |
instelems |
The list of last instance elements.
|
Additional Information
COOWF@1.1:GetLongTermSuspendedActivities
ActivityInstance[]
COOWF@1.1:GetLongTermSuspendedActivities(
out retval ActivityInstance[]
activities)
Name |
Description |
activities |
the long term suspended activities
|
Additional Information
COOWF@1.1:GetLowestLoadSharingScoreUsers
object[]
COOWF@1.1:GetLowestLoadSharingScoreUsers(
out retval object[]
users,
optional object
_position)
Name |
Description |
users |
the users with the lowest load sharing score
|
_position |
the users are filtered by the supplied position
|
Additional Information
COOWF@1.1:GetManageableWorkFlowPreferenceGroupLocations
Group[]
COOWF@1.1:GetManageableWorkFlowPreferenceGroupLocations(
out retval Group[]
groups)
Name |
Description |
groups |
the target groups
|
Additional Information
COOWF@1.1:GetNextActivityInstances
InstanceElement[]
COOWF@1.1:GetNextActivityInstances(
optional boolean
skipconditions,
optional boolean
includecontrolelements,
out retval InstanceElement[]
nextactinst)
Name |
Description |
skipconditions |
if defined the conditions of gateways are not evaluated and all following activities are returned
|
includecontrolelements |
if defined the search for the next activity instance is stopped
at a control element and the control element is part of the result
|
nextactinst |
the following activity instances
|
Additional Information
COOWF@1.1:GetNextInstanceElements
object[]
COOWF@1.1:GetNextInstanceElements(
out retval object[]
nextactinsts,
optional boolean
no_condition,
optional boolean
no_case,
optional boolean
no_repeat,
optional boolean
no_subprocess,
optional boolean
no_wait,
optional boolean
no_end)
Name |
Description |
nextactinsts |
the following instance elements
|
no_condition |
defines if ConditionStartInstances will be excluded from the result
|
no_case |
defines if CaseStartInstances and DivergingGatewayInstances will be excluded from the result
|
no_repeat |
defines if RepeatStartInstances will be excluded from the result
|
no_subprocess |
defines if SubProcessInstances will be excluded from the result
|
no_wait |
defines if WaitActionInstances will be excluded from the result
|
no_end |
defines if EndEventInstance will be excluded from the result
|
Additional Information
COOWF@1.1:GetNextSuspensionDate
datetime
COOWF@1.1:GetNextSuspensionDate(
out retval datetime
suspensiondatetime,
SubmissionRepetitionPeriod
repetitionperiod)
Name |
Description |
suspensiondatetime |
the calculated suspension date
|
repetitionperiod |
the values entered in the submission dialog
|
Additional Information
COOWF@1.1:GetNotificationSettings
NotificationEntryList[]
COOWF@1.1:GetNotificationSettings(
out retval NotificationEntryList[]
notificationentries)
Name |
Description |
notificationentries |
the configured notification entries
|
Additional Information
COOWF@1.1:GetNotificationSettingsFromUser
EventTriggerList[]
COOWF@1.1:GetNotificationSettingsFromUser(
optional boolean
usefallback,
out UserEnvironment
userenv,
out retval EventTriggerList[]
notificationsettings,
out EventTriggerList[]
pushnotificationsettings)
Name |
Description |
usefallback |
consider the group settings if no UserEnvironment is available
|
userenv |
the considered UserEnvironment
|
notificationsettings |
the defined notification settings
|
pushnotificationsettings |
the defined notification settings for push notifications
|
Additional Information
object[]
COOWF@1.1:GetObjectsConcerned(
object
context,
out retval object[]
objectsconcerned)
Name |
Description |
context |
the concerned objects are evaluated depending on the supplied context
|
objectsconcerned |
the depending objects
|
Additional Information
COOWF@1.1:GetObjectWorkFlowMenu
void
COOWF@1.1:GetObjectWorkFlowMenu(
optional integer
unused1,
optional integer
unused2,
ref MenuStructList[]
menuentries,
optional object
menu,
optional object[]
selobjects,
out optional boolean
addchildren)
Name |
Description |
unused1 |
|
unused2 |
|
menuentries |
|
menu |
|
selobjects |
|
addchildren |
Additional Information
COOWF@1.1:GetParticipantContext
object
COOWF@1.1:GetParticipantContext(
object
obj,
out retval object
context)
Name |
Description |
obj |
for which the participant evaluation is performed
|
context |
the result
|
Additional Information
COOWF@1.1:GetParticipantContextAttribute
AttributeObjectDef
COOWF@1.1:GetParticipantContextAttribute(
out retval AttributeObjectDef
attrdef)
Name |
Description |
attrdef |
the result
|
Additional Information
COOWF@1.1:GetParticipantContextClass
ObjectClass[]
COOWF@1.1:GetParticipantContextClass(
out retval ObjectClass[]
classes)
Name |
Description |
classes |
the result
|
Additional Information
COOWF@1.1:GetParticipantListUsersGroups
User[]
COOWF@1.1:GetParticipantListUsersGroups(
optional WorkFlowParticipant
part,
out retval User[]
users,
out Group[]
groups,
out User[]
roleusers)
Name |
Description |
part |
the participant which should be resolved. If the parameter is not set the attributes actinstparticipant or procinstresponsible is used as fallback.
|
users |
the resolved users
|
groups |
the resolved groups
|
roleusers |
the resolved users by group and positions
|
Additional Information
COOWF@1.1:GetParticipantParentAttribute
AttributeObjectDef
COOWF@1.1:GetParticipantParentAttribute(
out retval AttributeObjectDef
attrdef)
Name |
Description |
attrdef |
the result
|
Additional Information
object[]
COOWF@1.1:GetParticipantUsers(
out retval object[]
users,
optional boolean
ignoregroupposition,
optional boolean
activeusersonly)
Name |
Description |
users |
the users
|
ignoregroupposition |
the ignoregroupposition
|
activeusersonly |
the activeusersonly
|
Additional Information
COOWF@1.1:GetPrescribeActivityDefinitions
void
COOWF@1.1:GetPrescribeActivityDefinitions(
object
context,
out object[]
actdefs,
out boolean
actdefsrestricted,
optional ActivityUsageMode
usagemode,
optional boolean
diagrammodeling)
Name |
Description |
context |
the attribute in which the prescription activity should be inserted
|
actdefs |
the possible activity definitions
|
actdefsrestricted |
the prescription is restricted to this activity definitions
|
usagemode |
the possible activity definitions are filtered by usagemode
|
diagrammodeling |
is only evaluate in combination with usagemode AUM_ONLY_BPMN
|
Additional Information
void
COOWF@1.1:GetPrescribeDefault(
out WorkFlowPrescriptionList[]
prescription,
out boolean
prescrparallel,
out object
prescrback,
out optional object[]
prescrusable,
out optional boolean
prescrrestricted,
out optional WorkFlowPrescriptionBlockList[]
prescrblocks,
optional boolean
prescrblocksonly,
out optional boolean
prescrbackrestricted)
Name |
Description |
prescription |
The preconfigured prescription list.
|
prescrparallel |
Default for parallel or serial prescriptions.
|
prescrback |
Default for an activity back to the originator of the prescription.
|
prescrusable |
|
prescrrestricted |
|
prescrblocks |
The list of additional preconfigured blocks of prescriptions.
|
prescrblocksonly |
If set to
True , all preconfigured prescriptions are returned in the parameter prescrblocks , the parameter prescription is set to empty. |
prescrbackrestricted |
Additional Information
COOWF@1.1:GetPrescribeTemplate
void
COOWF@1.1:GetPrescribeTemplate(
out WorkFlowPrescriptionList[]
prescription,
out boolean
prescrparallel,
ref object
prescrback,
out optional WorkFlowPrescriptionBlockList[]
prescrblocks,
optional boolean
prescrblocksonly,
optional object[]
selobjects,
optional boolean
edittemplate)
Name |
Description |
prescription |
the prescription
|
prescrparallel |
the prescrparallel
|
prescrback |
the prescrback
|
prescrblocks |
the prescrblocks
|
prescrblocksonly |
the prescrblocksonly
|
selobjects |
the selobjects
|
edittemplate |
the edittemplate
|
Additional Information
COOWF@1.1:GetPrescriptionEditorMode
boolean
COOWF@1.1:GetPrescriptionEditorMode(
out retval boolean
isexprtmode,
out boolean
enforcededitormode)
Name |
Description |
isexprtmode |
the prescription editor is started in the expert mode
|
enforcededitormode |
the prescription mode can not be changed
|
Additional Information
COOWF@1.1:GetPrescriptionHeadLine
string
COOWF@1.1:GetPrescriptionHeadLine(
out retval string
headline,
out string
label,
out string
prescrlabel,
optional boolean
processmultiplecommon)
Name |
Description |
headline |
the headline
|
label |
|
prescrlabel |
|
processmultiplecommon |
Additional Information
any
COOWF@1.1:GetProcessParameter(
string
key,
out retval any
value)
Name |
Description |
key |
the identifier for the process parameter
|
value |
the parameter value
|
Additional Information
COOWF@1.1:GetProcessParameters
dictionary
COOWF@1.1:GetProcessParameters(
out retval dictionary
params)
Name |
Description |
params |
process parameters
|
Additional Information
COOWF@1.1:GetPushNotificationSettings
PushNotificationEntryList[]
COOWF@1.1:GetPushNotificationSettings(
out retval PushNotificationEntryList[]
pushnotificationentries)