Actions of COOWF@1.1

Return Type	Signature
void	AddPrescription( ref WorkFlowPrescriptionList[] prescription, SavePresciptionActionType action, ref optional integer pblockidx, ref optional integer pidx, optional WorkFlowPrescriptionBlockList[] prescriptionblocks)
string	AddSearchRestrictionsForReferencedBPMNObject( ObjectClass targetclass, out retval string queryrestriction)
boolean	AllowChangeProcessState( out retval boolean statechangeable)
void	AmendSubstitutePermissions( optional boolean locked)
object[]	AnalyzeBPMNZip( Content zipcont, optional ObjectClass targetclass, optional string elementname, out retval object[] existingdiagrams, out object[] additionaldiagrams)
void	ArchiveProcess()
void	AttachToProcess( ref dictionary processstate, object obj)
any	AttrActInstCopy( AttributeDefinition attrdef, object sourceobj, out retval any value)
void	AttrActInstInstanceGet( AttributeDefinition attrdef, ref any value, out optional boolean volatile, out optional boolean volatiletx)
void	AttrActInstInstanceGetVersion( AttributeDefinition attrdef, integer versnr, ref any value, out optional boolean volatile, out optional boolean volatiletx)
void	AttrActInstObjectGet( AttributeDefinition attrdef, ref any value, out optional boolean volatile, out optional boolean volatiletx)
void	AttrActInstObjectGetVersion( AttributeDefinition attrdef, integer versnr, ref any value, out optional boolean volatile, out optional boolean volatiletx)
void	AttrActInstObjectSet( AttributeDefinition attrdef, ref optional any value, any oldvalue)
void	AttrActInstObjectsGet( AttributeDefinition attrdef, ref any value, out optional boolean volatile, out optional boolean volatiletx)
void	AttrActInstObjectsGetVersion( AttributeDefinition attrdef, integer versnr, ref any value, out optional boolean volatile, out optional boolean volatiletx)
void	AttrActInstSet( AttributeDefinition attrdef, ref optional any value, any oldvalue)
void	AttrActInstStateSet( AttributeDefinition attrdef, ref optional any value, any oldvalue)
void	AttrActInstStatisticGet( AttributeDefinition attrdef, ref any value, out optional boolean volatile, out optional boolean volatiletx)
void	AttrActInstSubstUserGet( AttributeDefinition attrdef, ref any value, out optional boolean volatile, out optional boolean volatiletx)
void	AttrActInstSubstUserGetVersion( AttributeDefinition attrdef, integer versnr, ref any value, out optional boolean volatile, out optional boolean volatiletx)
string	AttrActivityWithPartGetDisp( AttributeDefinition attrdef, out retval string string, optional any value, optional Language language, optional AttributeDefinition[] attrdeflist, optional integer flags, optional integer index)
void	AttrBackLinkDefaultSet( AttributeDefinition attrdef, ref optional any value, any oldvalue)
void	AttrDefCaseNextDestructor( AttributeDefinition attrdef, any value)
void	AttrDefGatewayNextDestructor( AttributeDefinition attrdef, any value)
void	AttrDefRefObjClassesGet( AttributeDefinition attrdef, ref any value, out optional boolean volatile, out optional boolean volatiletx)
string	AttrGetActinstworkDisp( AttributeDefinition attrdef, out retval string string, optional any value, optional Language language, optional AttributeDefinition[] attrdeflist, optional integer flags, optional integer index)
string	AttrGetCompoundParticipantDisp( AttributeDefinition attrdef, out retval string string, optional any value, optional Language language, optional AttributeDefinition[] attrdeflist, optional integer flags, optional integer index)
string	AttrGetParticipantDisp( AttributeDefinition attrdef, out retval string string, optional any value, optional Language language, optional AttributeDefinition[] attrdeflist, optional integer flags, optional integer index)
void	AttrInstCaseNextDestructor( AttributeDefinition attrdef, any value)
void	AttrInstConditionGet( AttributeDefinition attrdef, ref any value, out optional boolean volatile, out optional boolean volatiletx)
void	AttrInstConditionGetVersion( AttributeDefinition attrdef, integer versnr, ref any value, out optional boolean volatile, out optional boolean volatiletx)
any	AttrInstDefinitionCopy( AttributeDefinition attrdef, object sourceobj, out retval any value)
void	AttrInstElemSet( AttributeDefinition attrdef, ref optional any value, any oldvalue)
void	AttrInstGatewayNextDestructor( AttributeDefinition attrdef, any value)
void	AttrLoadSharingScoreGet( AttributeDefinition attrdef, ref any value, out optional boolean volatile, out optional boolean volatiletx)
void	AttrObjectDestructor( AttributeDefinition attrdef, any value)
void	AttrObjectListDestructor( AttributeDefinition attrdef, any value)
void	AttrPrescriptionBlockConstructor( object attrdef, out any value, any[] oldvalues)
void	AttrPrescriptionLineConstructor( object attrdef, out any value, any[] oldvalues)
void	AttrProcDefParticipantsGet( AttributeDefinition attrdef, ref any value, out optional boolean volatile, out optional boolean volatiletx)
void	AttrProcDefRefObjClassesGet( AttributeDefinition attrdef, ref any value, out optional boolean volatile, out optional boolean volatiletx)
void	AttrProcessListExpItemsGet( AttributeDefinition attrdef, ref any value, out optional boolean volatile, out optional boolean volatiletx)
void	AttrProcessListExpItemsSet( AttributeDefinition attrdef, ref optional any value, any oldvalue)
void	AttrProcessListItemsGet( AttributeDefinition attrdef, ref any value, out optional boolean volatile, out optional boolean volatiletx)
void	AttrProcessListItemsSet( AttributeDefinition attrdef, ref optional any value, any oldvalue)
void	AttrProcessParticipantSet( AttributeDefinition attrdef, ref optional any value, any oldvalue)
any	AttrProcInstCopy( AttributeDefinition attrdef, object sourceobj, out retval any value)
void	AttrProcInstSet( AttributeDefinition attrdef, ref optional any value, any oldvalue)
void	AttrProcInstStatisticGet( AttributeDefinition attrdef, ref any value, out optional boolean volatile, out optional boolean volatiletx)
void	AttrProcInstUsersGet( AttributeDefinition attrdef, ref any value, out optional boolean volatile, out optional boolean volatiletx)
void	AttrProcInstWorkGet( AttributeDefinition attrdef, ref any value, out optional boolean volatile, out optional boolean volatiletx)
void	AttrSetPendingList( AttributeDefinition attrdef, ref optional any value, any oldvalue)
void	AttrUseForClassGet( AttributeDefinition attrdef, ref any value, out optional boolean volatile, out optional boolean volatiletx)
void	AttrUsrEnvWfEventsGet( AttributeDefinition attrdef, ref any value, out optional boolean volatile, out optional boolean volatiletx)
void	AttrUsrEnvWfEventsSet( AttributeDefinition attrdef, ref any value, out optional boolean volatile, out optional boolean volatiletx)
void	AttrUsrEnvWfPushEventsGet( AttributeDefinition attrdef, ref any value, out optional boolean volatile, out optional boolean volatiletx)
void	AttrUsrEnvWfPushEventsSet( AttributeDefinition attrdef, ref any value, out optional boolean volatile, out optional boolean volatiletx)
any	AttrWorkFlowConstructor( AttributeDefinition attrdef, out retval any value)
any	AttrWorkFlowCopy( AttributeDefinition attrdef, object sourceobj, out retval any value)
void	AttrWorkFlowDeadLinesGet( AttributeDefinition attrdef, ref any value, out optional boolean volatile, out optional boolean volatiletx)
object[]	AttrWorkFlowDefinitionObjectFilter( ref retval object[] objects, optional AttributeDefinition attrdef)
void	AttrWorkFlowDelVersion( AttributeDefinition attrdef, integer versnr, any value)
void	AttrWorkFlowFixVersion( AttributeDefinition attrdef, integer oldversnr, integer newversnr, any value, optional boolean autofixed)
void	AttrWorkFlowSet( AttributeDefinition attrdef, ref optional any value, any oldvalue)
void	AttrWorkListItemsGet( AttributeDefinition attrdef, ref any value, out optional boolean volatile, out optional boolean volatiletx)
void	AttrWorkListItemsSet( AttributeDefinition attrdef, ref optional any value, any oldvalue)
object[]	AttrWorkListUIFilter( ref retval object[] objects, AttributeDefinition attrdef)
boolean	AutomaticallyInsertFollowerActivity( InstanceElement activity, boolean hastobelastactivity, out retval boolean automaticallyinsert)
PartControlParams	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)
void	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)
void	CalculateProcessStatistics( boolean separatetx, optional ProcessInstance[] processes, optional boolean useprogress, optional boolean background)
void	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)
void	CallWorkItem( optional integer unused1, optional integer unused2, integer menudynkey)
boolean	CanBeUsedForSubProcessesOnly( out retval boolean subprocessesonly)
boolean	CanChangeProcessState( ProcessInstance procinst, ref retval boolean statechangeable)
boolean	CanDeleteWorkFlow( out retval boolean candelete, optional ProcessInstance[] procinsts)
boolean	CanManageWorkFlowDiagrams( object context, optional boolean silent, out retval boolean canmanage)
void	ChangeAppWorkFlowState( App app, ref boolean licensed, ref boolean active, boolean oldstate)
void	ChangeResponsible( WorkFlowParticipant responsible, optional WorkFlowParticipant respmansubst)
void	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)
boolean	CheckActive( out retval boolean active, optional boolean checkapplicense, optional object context)
object[]	CheckAdditionalParticipantRestrictions( ref retval object[] participants)
void	CheckAllowedActions( ref object[] actions)
void	CheckAllowedElements( ref object[] objclasses)
boolean	CheckAutoComplete( out retval boolean autocomplete)
void	CheckBackgroundWork()
boolean	CheckCopy( out retval boolean copyable)
void	CheckDatesForm( object action, out optional object attrdef, out optional string askquestion, optional boolean needplaintexterrors)
void	CheckDelegateForm( object action, out optional object attrdef, out optional string askquestion, out optional boolean affiliationusable, optional boolean needplaintexterrors, out dictionary workflowsubstitutioninfos, out WorkFlowPartAccessMapping[] invaffiliationparts)
void	CheckDelegateMultipleForm( object action, out optional object attrdef, out optional string askquestion, out optional boolean affiliationusable, optional boolean needplaintexterrors, out dictionary workflowsubstitutioninfos, out WorkFlowPartAccessMapping[] invaffiliationparts)
void	CheckDestination( optional boolean ignoremetaparticipant, optional boolean strict, optional boolean resolvemetaparticipant)
string	CheckExpiredActivities( out retval string escalationerrors)
void	CheckForm( object action, out optional object attrdef, out optional string askquestion, out WorkFlowPartAccessMapping[] invaffiliatonparts, optional boolean needplaintexterrors)
boolean	CheckInsertTemplate( integer pblockidx, integer pidx, out retval boolean allowed)
void	CheckLongTermActivities()
void	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)
boolean	CheckParticipantAffiliation( WorkFlowParticipant participant, object actinst, out retval boolean usableparticipant, optional boolean skipdisplaywithaccessparts, optional AccessType[] requiredaccesstypes)
void	CheckParticipantRules( WorkFlowParticipant part, optional object processelement, optional ActivityType acttype)
void	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)
boolean	CheckReferencedDiagramExecutionRestriction( out retval boolean allowed, out optional WorkFlowDiagram[] restrictionconflicts)
boolean	CheckReleaseReferencedDiagrams( out retval boolean hasrefdiagrams, out boolean isreleasepossible, out WorkFlowDiagram[] notreleaseablediagrams, out WorkFlowDiagram[] requireddiagrams)
WorkFlowOrgSecurity	CheckRemoveOrgElements( out retval WorkFlowOrgSecurity orgsecurity)
boolean	CheckRetracted( out retval boolean allowed)
void	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)
boolean	CheckStart( out retval boolean startable)
void	CheckSubmissionRepetitionPeriod( SubmissionRepetitionPeriod repetitionperiod, out string checkresult, out boolean error, out string askquestion)
boolean	CheckTakenOver( out retval boolean allowed)
void	CheckWorkDay( datetime checkdate, optional boolean checkpast)
boolean	CheckWorkFlowAppLicense( optional boolean disableerrorapps, optional boolean silentmode, out retval boolean haslicense)
void	CheckWorkList()
void	ChooseProcessDefinition( optional integer handle, optional integer index)
void	ClearProcessParameters( optional boolean separatetx)
object[]	CollectCommonStartedInstances( object[] sourceobjects, ref optional integer dynkey, optional AttributeObjectDef view, out retval object[] targetobjects)
void	ComputeDeadLine( object attrdef)
boolean	ConfirmStart( integer parenthandle, object context, out retval boolean yes)
integer	ConvertDateToWorkDays( datetime startdate, datetime enddate, out retval integer workdays)
datetime	ConvertWorkDaysToDate( datetime startdate, integer workdays, out retval datetime enddate)
object	CopyWorkFlowObject( object refobject, out retval object resultobject)
object	CreateProcessInstance( out retval object procinst, optional string procinstcommonid)
void	CreateProcessOutput( optional integer unused1, optional integer unused2)
void	CreateProcessParticipant( optional integer unused1, optional integer unused2)
ProcessStatisticsCache	CreateProcessStatisticsCache( object processdefinition, out retval ProcessStatisticsCache cache)
void	CreateWorkFlowDiagram( optional integer unused1, optional integer unused2)
object	CreateWorkFlowObject( object refobject, out retval object obj, optional boolean separatetx)
void	DefineWFSubstitutes( optional integer unused1, optional integer unused2)
WorkFlowParticipant	DelegateActivityHook( ref retval WorkFlowParticipant participant, ref optional WorkFlowParticipant partmansubst, ActivityInstance activity, ProcessInstance process)
PrescriptionMetaDataWho[]	DelegateActivityMultipleHook( ref retval PrescriptionMetaDataWho[] participants, ActivityInstance activity, ProcessInstance process)
void	DeleteSelectedObjectsWorkFlow( optional integer handle, optional integer index)
void	DeleteWasteBasketObjects( optional integer unused1, optional integer unused2)
void	DeleteWasteBasketObjectsSelected( optional integer unused1, optional integer unused2)
void	DeleteWorkFlow( optional object[] procinsts)
void	DeleteWorkFlowDiagram( optional integer unused1, optional integer unused2)
void	DeleteWorkFlowDiagramSelected( optional integer unused1, optional integer unused2)
void	DeleteWorkFlowObject( optional boolean separatetx)
void	DeskLoggedIn()
boolean	DisplayActionsInWorkflowTaskPane( out retval boolean displayactions)
void	DisplayBPMNCustomizedExpressions( optional integer unused1, optional integer unused2)
string[]	DisplayParticipantWithLabels( WorkFlowParticipant part, boolean uselabelplaceholder, optional boolean dontshowprefix, AttributeDefinition[] domainprophiddenprefixes, out retval string[] formattedpart)
boolean	DoShowWorkListItem( object attrdef, out retval boolean show)
void	EditObjectAttributesDirect( optional integer handle, optional integer index)
void	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)
integer	EscalateObject( EscalationEntryList[] escalations, ExpiryCheck deadlinetype, datetime deadline, WorkFlowPriority priority, ref datetime escalatedat, out retval integer nrsuccess, out integer nrfailure, out string[] errormsgs)
integer	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)
integer	EvaluateCase( out retval integer caseresult, out optional string[] activatedpaths)
boolean	EvaluateCondition( out retval boolean condresult)
boolean	EvaluatePrecondition( integer wfwidx, out retval boolean notexecuteable, out boolean hidden, optional boolean silent)
void	ExecuteBackgroundWork()
void	ExpandPrescribeParticipants( ref optional WorkFlowPrescriptionList[] prescription, ref optional WorkFlowPrescriptionBlockList[] prescrblocks, optional boolean resolvetouser)
NotificationEntryList[]	ExtendNotificationSettings( ProcessInstance procinst, object[] processobjects, WorkFlowParticipant participant, ref retval NotificationEntryList[] notificationentries)
PushNotificationEntryList[]	ExtendPushNotificationSettings( ProcessInstance procinst, object[] processobjects, WorkFlowParticipant participant, ref retval PushNotificationEntryList[] pushnotificationentries)
WorkFlowPrescriptionList[]	ExtractSubPrescription( WorkFlowSubPrescriptionList[] source, out retval WorkFlowPrescriptionList[] extractedprescription)
DiagramObject[]	FilterPossibleReferencedDiagrams( ref retval DiagramObject[] possiblediagrams, optional boolean considereroomcontext)
void	FilterUsableDefinitions( object context, ref object[] objects)
void	FilterUsableDiagramsHook( object[] targetobjects, ref WorkFlowDiagram[] usablediagrams, optional boolean considereroomcontext)
void	FilterUsableObjects( object context, ref object[] objects)
boolean	FixParticipantAffiliation( Action context, WorkFlowPartAccessMapping[] participants, optional boolean continueediting, out retval boolean performed)
InfoList[]	FormatWFNotificationSettingsToInfolist( boolean read, WorkFlowEventType[] mailevents, WorkFlowEventType[] pushevents, optional boolean disablemailedit, optional boolean disablepushedit, out retval InfoList[] dispnotifications)
ArchivedProcessStatistic	GenerateArchivedProcessStatistic( out retval ArchivedProcessStatistic statistics)
void	GetActivityInstanceMenu( optional integer unused1, optional integer unused2, ref MenuStructList[] menuentries, optional object menu, optional object[] selobjects, out optional boolean addchildren)
PrescriptionTemplate[]	GetAdditionalPrescriptionTemplatesHook( object[] wfobjects, ref retval PrescriptionTemplate[] templates)
WorkFlowDiagram[]	GetAdditionalWorkFlowDiagramsHook( object[] wfobjects, ref retval WorkFlowDiagram[] diagrams, optional boolean requiredraftversion)
object[]	GetAllWorkListActInsts( out retval object[] allactinsts)
void	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)
void	GetCommonUsableProcessDefinitions( object[] objects, out boolean commondefault, out object[] procdefs, out optional boolean commonprocesspossible)
string	GetConditionString( object attrdefcont, out retval string condstring, optional object attrdefaction)
ProcStatisticsUsers[]	GetConfiguredProcessStatisticsUsers( out retval ProcStatisticsUsers[] users)
string	GetConfiguredSender( out retval string sender)
object[]	GetCurrentActivityInstances( out retval object[] actinsts, optional ActivityInstanceState[] actinststates, optional object[] users, optional boolean anyuser)
object[]	GetCurrentUserActivities( out retval object[] actinsts)
WorkFlowEventType[]	GetDefaultNotificationTypes( boolean pushnotifications, boolean skipconfig, out retval WorkFlowEventType[] notificationtypes)
object[]	GetDefaultProcessDefinitions( out retval object[] procdefs)
object[]	GetDefinitionElements( out retval object[] defelems, optional object objclass)
void	GetDelegateDefault( ref WorkFlowParticipant participant, ref WorkFlowParticipant partmansubst, ref string remark, ref datetime submitdeadline, ref datetime startdeadline, ref datetime enddeadline, out boolean nodeadlinecheck)
void	GetDelegateMultipleDefault( ref WorkFlowParticipant participant, ref WorkFlowParticipant partmansubst, ref string remark, ref datetime submitdeadline, ref datetime startdeadline, ref datetime enddeadline, out boolean nodeadlinecheck)
string	GetDiagramIdFromWorkFlowObject( optional boolean usenamefallback, out retval string id)
WorkFlowCompoundParticipant[]	GetDiagramProcessParticipants( optional boolean skipsubprocesses, out retval WorkFlowCompoundParticipant[] processparticipants, optional boolean forcereferenceddraftversion)
DisplayColumnList[]	GetDisplayProperties( out retval DisplayColumnList[] displaycolumnlist, optional dictionary userenvsettings)
object[]	GetInheritedWorkFlowSettings( out retval object[] prescriptiontemplates, out WorkFlowDiagram[] diagrams)
WorkFlowParticipant	GetInitialResponsible( out retval WorkFlowParticipant responsible, out optional WorkFlowParticipant respmansubst, optional ProcessInstance procinst, optional object processsource)
object	GetInsertActivityDef( object scope, optional dictionary state, out retval object insertactdef, out boolean abortfollowers)
integer	GetInstanceElementColor( out retval integer colorcode)
object[]	GetInstanceElements( ref retval object[] instelems, optional object[] objclass, optional ActivityInstanceState[] actinststate, optional boolean ordered, optional string adhockey, optional string multiinstancekey)
object[]	GetLastInstanceElements( out retval object[] instelems)
ActivityInstance[]	GetLongTermSuspendedActivities( out retval ActivityInstance[] activities)
object[]	GetLowestLoadSharingScoreUsers( out retval object[] users, optional object _position)
Group[]	GetManageableWorkFlowPreferenceGroupLocations( out retval Group[] groups)
InstanceElement[]	GetNextActivityInstances( optional boolean skipconditions, optional boolean includecontrolelements, out retval InstanceElement[] nextactinst)
object[]	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)
datetime	GetNextSuspensionDate( out retval datetime suspensiondatetime, SubmissionRepetitionPeriod repetitionperiod)
NotificationEntryList[]	GetNotificationSettings( out retval NotificationEntryList[] notificationentries)
EventTriggerList[]	GetNotificationSettingsFromUser( optional boolean usefallback, out UserEnvironment userenv, out retval EventTriggerList[] notificationsettings, out EventTriggerList[] pushnotificationsettings)
object[]	GetObjectsConcerned( object context, out retval object[] objectsconcerned)
void	GetObjectWorkFlowMenu( optional integer unused1, optional integer unused2, ref MenuStructList[] menuentries, optional object menu, optional object[] selobjects, out optional boolean addchildren)
object	GetParticipantContext( object obj, out retval object context)
AttributeObjectDef	GetParticipantContextAttribute( out retval AttributeObjectDef attrdef)
ObjectClass[]	GetParticipantContextClass( out retval ObjectClass[] classes)
User[]	GetParticipantListUsersGroups( optional WorkFlowParticipant part, out retval User[] users, out Group[] groups, out User[] roleusers)
AttributeObjectDef	GetParticipantParentAttribute( out retval AttributeObjectDef attrdef)
object[]	GetParticipantUsers( out retval object[] users, optional boolean ignoregroupposition, optional boolean activeusersonly)
void	GetPrescribeActivityDefinitions( object context, out object[] actdefs, out boolean actdefsrestricted, optional ActivityUsageMode usagemode, optional boolean diagrammodeling)
void	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)
void	GetPrescribeTemplate( out WorkFlowPrescriptionList[] prescription, out boolean prescrparallel, ref object prescrback, out optional WorkFlowPrescriptionBlockList[] prescrblocks, optional boolean prescrblocksonly, optional object[] selobjects, optional boolean edittemplate)
boolean	GetPrescriptionEditorMode( out retval boolean isexprtmode, out boolean enforcededitormode)
string	GetPrescriptionHeadLine( out retval string headline, out string label, out string prescrlabel, optional boolean processmultiplecommon)
any	GetProcessParameter( string key, out retval any value)
dictionary	GetProcessParameters( out retval dictionary params)
PushNotificationEntryList[]	GetPushNotificationSettings( out retval PushNotificationEntryList[] pushnotificationentries)
object	GetReferencedBPMNObject( ObjectClass targetclass, string elementid, out retval object obj, out boolean foundbyreference, optional boolean forcereferenceddraftversion, optional boolean searchfornames)
WorkFlowDiagram[]	GetReferencedDiagrams( boolean recursive, out retval WorkFlowDiagram[] refdiagrams)
WorkFlowDiagram[]	GetReleasedDiagrams( out retval WorkFlowDiagram[] diagrams)
WorkFlowDiagram[]	GetReleaseDiagramsHook( ref retval WorkFlowDiagram[] diagrams)
WorkFlowDiagram	GetReleasedWorkFlowDiagram( WorkFlowDiagram diagram, out retval WorkFlowDiagram releaseddiagram, optional boolean considereroomcontext)
User[]	GetResolvedProcessStatisticsUsers( out retval User[] users)
void	GetSecurityAttributes( out AttributeObjectDef usersecattr, out AttributeObjectDef groupsecattr, out AttributeObjectDef userdonesecattr, out AttributeObjectDef groupdonesecattr, out AttributeObjectDef userrolesecattr, out AttributeObjectDef userroledonesecattr, out AttributeObjectDef usersubstsecattr, out AttributeObjectDef usersubstdonesecattr)
WorkFlowSubmissionList[]	GetSubmissionDefault( out retval WorkFlowSubmissionList[] submissions)
void	GetSubstGroupActivities( out object[] grsubstactivities, out object[] substgroups)
void	GetSuspendDefault( ref string remark, ref datetime submitdeadline, ref SubmissionRepetitionPeriod repetitionperiod)
void	GetTerminateDefault( ref string remark, ref datetime submitdeadline, ref datetime startdeadline, ref datetime enddeadline)
void	GetTerminateDenyDefault( ref string remark, ref datetime submitdeadline, ref datetime startdeadline, ref datetime enddeadline)
object[]	GetUsableActivityDefinitions( out retval object[] actdefs, optional object[] excludeactdefs, optional object[] prevelements)
object[]	GetUsableObjectsConcerned( optional object context, out retval object[] objectsconcerned, out boolean objectsconcernedrestricted)
void	GetUsableOrgElements( object context, out WorkFlowMetaParticipant[] metaparticipants, out object[] users, out object[] positions, out object[] groups, out object[] orgunittypes, out optional object[] partdefs, out optional object[] partners, out optional object[] attributes, optional boolean isfilter, out optional AttributeDefinition[] restrictedpartelements)
object[]	GetUsableProcessDefinitions( out retval object[] procdefs, optional object[] excludeprocdefs, optional boolean enablesub, optional object[] prevelements)
void	GetUsableUsersGroups( object context, out User[] users, out boolean usersrestricted, out Group[] groups, out boolean groupsrestricted, out optional object[] partdefs, out optional boolean partdefsrestricted, out optional Position[] positions, out optional boolean positionsrestricted, out optional OrgUnitType[] orgunittypes, out optional boolean orgunittypesrestricted, out optional AttributeObjectDef[] attributes, out optional boolean attributesrestricted)
UserSubstitution	GetUserSubstitution( optional boolean create, out retval UserSubstitution usersubs)
string	GetWFEventSettingOnClickCommand( string evttypename, string settingscategory, integer eventtypekey, string type, boolean isactive, out retval string command)
any[]	GetWorkFlowConfigProperty( AttributeDefinition attrdef, out retval any[] value)
Group[]	GetWorkFlowPreferenceGroupLocations( out retval Group[] groups)
UserEnvironment[]	GetWorkFlowPreferenceLocations( out retval UserEnvironment[] usrenvlocations, out Group[] grouplocations, out UserEnvironment[] checkedusrenvs, out Group[] checkedgroups)
void	GetWorkFlowSettings( out object[] defaultprocess, out object[] usableprocess, out object[] usableprescr, out optional boolean copydefaultprocess)
string	GetWorkFlowUsecaseHeadLine( Action usecasecontext, boolean processmultiplecommon, out retval string headline, out string label, out string additionallabel)
integer	GetWorkItemIndex( string wfwkey, out retval integer wfwindex, integer wfworigindex)
string	GetWorkItemKey( integer wfwindex, out retval string wfwkey, optional boolean silent)
void	GetWorkItemsMenu( optional integer unused1, optional integer unused2, ref MenuStructList[] menuentries, optional object menu, optional object[] selobjects, out optional boolean addchildren)
object	GetWorkList( ref retval object worklist, optional boolean sametx, optional boolean nocreate)
integer	GetWorkListItemCountFromTx( object attrdef, out retval integer itemcount)
object[]	GetWorkListItemsFlat( object attrdef, out retval object[] worklistitems)
boolean	HasAdditionalParticipantRestrictions( out retval boolean additionalrestrictions)
boolean	HasValidParticipant( optional boolean checkactivesubstitution, optional boolean checkaccess, out retval boolean hasvalidpart, out optional string invalidpartreason)
boolean	HasWorkOnSubstTabSet( out retval boolean workonsubsttab)
object[]	ImportBPMNZip( Content zipcont, optional ObjectClass targetclass, optional object[] elementstoskip, optional string elementkey, out retval object[] updateddiagrams, out WorkFlowDiagram[] createddiagrams)
object	InitializeInstance( out object coost, ref retval object instelem, object procinst)
object	InitializeProcessInstance( out object coost, ref retval object procinst, object refobject, optional string procinstcommonid)
void	InitializeWorkFlow( object[] procdefs, optional boolean addinstances, optional object[] additionalobjects, optional datetime submitdeadline, optional boolean expandsub, optional WorkFlowParticipantMapping[] partmapping, optional dictionary processparams, optional string procinstcommonid)
object	InsertActivityInstance( WorkFlowParticipant participant, WorkFlowParticipant partmansubst, LanguageStringList[] actinsttitle, ActivityType actinsttype, boolean copyactivity, out retval object actinst)
void	InsertDefinitionElement( object procdef, object defelem, optional boolean before, optional object[] siblings)
void	InsertExternalActivity( object extactinst, boolean extcomplete)
void	InsertFirstElement( object elem, optional integer part)
void	InsertFirstSubProcess( object procdef, optional integer part)
void	InsertInstanceElement( object instelem, optional boolean before, optional object[] siblings, optional boolean checksequence)
void	InsertInstanceElements( object[] startelems, object[] endelems, optional boolean before, optional object[] siblings, optional boolean checksequence)
void	InsertParallelElement( object instelem, optional object endparelem, optional object procdef, optional boolean above, optional boolean newparallelsequence, optional object[] nextparaobjs)
void	InsertParallelSubProcess( object procdef, optional object endparelem, optional boolean above, optional boolean newparallelsequence, optional object[] nextparaobjs)
void	InsertSubProcess( object procdef, optional boolean before, optional object[] siblings)
void	InstanceElementStateChangedHook( InstanceElement instelem, ProcessInstance process, ActivityInstanceState newstate, ActivityInstanceState oldstate)
boolean	IsActivityCompleted( out retval boolean iscompleted)
boolean	IsBPMNExpression( string expr, out retval boolean isexpression, out optional boolean isquery)
boolean	IsEditableWFAttribute( AttributeDefinition attrdef, optional Action[] actioncontext, ref retval boolean iseditable)
boolean	IsInstanceElementEvaluated( out retval boolean isevaluated, optional boolean allowstartable)
boolean	IsProcessAdministrator( out retval boolean isprocadmin, optional Group targetgroup)
boolean	IsProcessOwner( out retval boolean isprocessowner, optional Group targetgroup)
boolean	IsReferencedDiagram( boolean checkreleasedonly, out retval boolean isreferenced, out optional WorkFlowDiagram[] referencingdiagrams)
boolean	IsSubstituteForParticipant( ActivityInstance actinst, WorkFlowParticipant part, out retval boolean issubstitute, out User substitutionfor)
boolean	IsValidPublishedDiagram( out retval boolean isvalid)
boolean	IsWFSubstitutionActive( out retval boolean isactive, out User[] substitutes)
boolean	IsWFSubstitutionEnabled( out retval boolean isfeatureenabled, out boolean isdefinablebyuser)
boolean	IsWorkFlowServiceUser( out retval boolean isserviceuser, out Group[] servicegroups)
BPMNCustomizedExpression[]	LoadBPMNCustomizedExpressions( out retval BPMNCustomizedExpression[] expressions)
void	LockProcessObjectHook()
void	LockWorkFlowObjects()
void	LoggedIn()
void	LogWorkFlowHistory( Action context, object workfowobject, optional any[] value, optional any[] oldvalue)
void	ModifyPage( object form, object page, UIVerb uiverb, object action, ref PageItemList[] formpageitems, object objclass, ref string formpagelabel, ref object formpageicon, dictionary localscope)
boolean	ModifyPrescriptions( boolean advanced, boolean prescrblocksonly, out retval boolean isadvanced)
void	MovePrescription( ref integer[] srcindices, ref integer[] dstindices, SavePresciptionActionType mode, boolean after, optional WorkFlowPrescriptionList[] updatedprescription)
void	NextProcessWorkItem( ref dictionary processstate, out object[] applications, out object[] applobjects, out boolean complete)
void	NormalizeNestedPrescriptions( ref WorkFlowPrescriptionBlockList[] blocks)
void	ObjectAccTypesGet( ref object[] accesstypes, optional boolean isclass)
void	OpenStatisticsDashboard( optional integer unused1, optional integer unused2)
dictionary	ParseBPMNModel( boolean checkexecution, optional any model, optional DiagramType modeltype, out retval dictionary problems, optional boolean expandsub, optional boolean expandprescription, out optional WorkFlowPrescriptionBlockList[] prescriptionblocks, optional boolean updatemodel, optional boolean isexport, out optional content updatedmodel, optional boolean updatetranslations, optional boolean forcereferenceddraftversion, ref optional object[] usedreferenceddiagrams, ref optional dictionary referenceddigramsmodel, optional boolean includesubprocpreview, optional boolean issilentmode)
content	PatchBPMNDiagramTranslations( ref retval content updatedmodel)
ProcessInstance	PrescribeObject( optional integer handle, optional integer index, ref optional WorkFlowPrescriptionList[] prescription, optional boolean prescrparallel, optional object prescrback, optional string remark, optional boolean remarkdefined, optional datetime receivedat, optional datetime startedat, optional datetime completedat, ref optional WorkFlowPrescriptionBlockList[] prescrblocks, optional boolean notcomplete, optional object[] additionalobjects, optional object[] concernedobjects, optional string processname, optional WorkFlowDiagram processdiagram, optional boolean delayedprocessstart, optional string adhocprocesskey, out retval ProcessInstance procinst, optional WorkFlowParticipantMapping[] partmapping, optional boolean expandsubprocesses, optional dictionary processparams, optional string procinstcommonid)
void	PrescribeObjectDirect( optional integer handle, optional integer index)
void	PrescribeOnScope( object scope, optional dictionary state, optional WorkFlowParticipant[] participant, optional string subject)
void	PrescribeSelectedObjects( optional integer handle, optional integer index)
void	ProcessSettings( optional integer unused1, optional integer unused2)
void	ProcessStateChangedHook( ProcessInstance process, ProcessInstanceState newstate, ProcessInstanceState oldstate)
boolean	ProcessStatisticsEnabled( out retval boolean enabled, optional Group targetgroup)
void	ReadObjectAttributesDirect( optional integer handle, optional integer index)
void	ReadProcessObjectAttributes( 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 any internal9, optional any internal10, optional any internal11, optional any internal12, optional integer handleparent, optional string itempath)
void	RefreshProcessList()
void	RefreshWorkList()
void	RefreshWorklistDisplayEffect()
void	RemoveDefinitionElement( object procdef)
void	RemoveFromProcessFolder( optional integer unused1, optional integer unused2)
void	RemoveFromProcessFolderSelected( optional integer unused1, optional integer unused2)
void	RemoveInstanceElement()
void	RemovePrescription( ref WorkFlowPrescriptionList[] prescription, ref optional integer pblockidx, ref optional integer pidx)
void	ResetObjectHighlighting( object[] exceptobjects, object view)
void	ResetSecurityOrgElements( boolean resetusers, boolean resetgroups, optional boolean resetusersdone, optional boolean resetgroupsdone, optional boolean resetroleusers, optional boolean resetroleusersdone, optional boolean resetserstsubst, optional boolean resetuserssubstdone)
void	ResolveDistributionList( ref WorkFlowPrescriptionBlockList[] prescriptionblocks, optional boolean persist)
WorkFlowParticipant	ResolveMetaParticipant( ref retval WorkFlowParticipant participant, out optional WorkFlowParticipant[] additionalparticipants, optional ProcessParticipant[] sourceprocparts)
void	ResolveMultiInstanceActivity( ActivityInstanceState newstate, ActivityInstanceState oldstate)
WorkFlowParticipant	ResolvePropertyRole( ref retval WorkFlowParticipant part)
PrescriptionTemplate	SavePrescriptionTemplate( string templatename, ref retval PrescriptionTemplate template, optional boolean skipshare, optional object sharetarget, optional object shareview)
void	SavePrescriptionTemplateHook( object vwf_object, ref object[] prescr_templates)
void	SelectPrescriptionTemplate( boolean init, object vwf_object, object[] vwf_selobjects, object vwf_prescribedefault, out boolean commondefault, out WorkFlowPrescriptionList[] prescription, out boolean prescrparallel, out object prescrback, out optional object[] prescrusable, out optional boolean prescrrestricted, out optional WorkFlowPrescriptionBlockList[] prescrblocks, out optional boolean prescrbackrestricted, out optional boolean commonprocesspossible, out optional PrescriptionTemplate[] availabletemplates, out optional WorkFlowDiagram selecteddiagram, out optional PrescriptionTemplate selectedtemplate, optional dictionary settings)
void	SetActive( optional integer handle, optional integer index, optional boolean nogui, optional datetime receivedat, optional datetime startedat)
void	SetCompleted( optional integer handle, optional integer index, optional string remark, optional boolean remarkdefined, optional datetime receivedat, optional datetime startedat, optional datetime completedat, optional integer completemode)
void	SetCompletedSubmission( optional integer handle, optional integer index)
void	SetDelegated( optional integer handle, optional integer index, WorkFlowParticipant participant, optional WorkFlowParticipant partmansubst, optional string remark, optional boolean remarkdefined, optional datetime receivedat, optional datetime startedat, optional datetime completedat, optional datetime submitdeadline, optional datetime startdeadline, optional datetime enddeadline)
void	SetDelegatedMultiple( optional integer handle, optional integer index, PrescriptionMetaDataWho[] participants, optional datetime receivedat, optional datetime startedat, optional datetime completedat, optional datetime submitdeadline, optional datetime startdeadline, optional datetime enddeadline)
void	SetProcessActive()
void	SetProcessParameter( string key, optional any value, optional boolean separatetx)
void	SetProcessSuspended()
void	SetProcessTerminated()
void	SetRetracted( optional integer handle, optional integer index, optional string remark, optional boolean remarkdefined)
void	SetSelectedObjectsActive( optional integer handle, optional integer index)
void	SetSelectedObjectsCompleted( optional integer handle, optional integer index)
void	SetSelectedObjectsCompleted2( optional integer handle, optional integer index)
void	SetSelectedObjectsCompletedSubmission( optional integer handle, optional integer index)
void	SetSelectedObjectsDelegated( optional integer handle, optional integer index)
void	SetSelectedObjectsDelegatedMultiple( optional integer handle, optional integer index)
void	SetSelectedObjectsRetracted( optional integer handle, optional integer index)
void	SetSelectedObjectsStarted( optional integer handle, optional integer index)
void	SetSelectedObjectsSuspended( optional integer handle, optional integer index)
void	SetSelectedObjectsTakenOver( optional integer handle, optional integer index)
void	SetSelectedObjectsTerminated( optional integer handle, optional integer index)
void	SetSelectedObjectsTerminatedDenied( optional integer handle, optional integer index)
void	SetSkipped( optional integer unused1, optional integer unused2)
void	SetStartable( optional boolean nosubmitdeadline, optional boolean nolocktimeout, optional boolean followerskeepsubmitdeadline)
void	SetStarted( optional integer handle, optional integer index, optional boolean nogui, optional datetime receivedat, optional datetime startedat, optional boolean separatetransaction, optional boolean locked, optional boolean nolocktimeout)
void	SetSubmission( WorkFlowSubmissionList[] submissions)
void	SetSuspended( optional integer handle, optional integer index, optional datetime submitdeadline, optional string remark, optional boolean remarkdefined, optional SubmissionRepetitionPeriod repetitionperiod)
void	SetTakenOver( optional integer handle, optional integer index, optional string remark, optional boolean remarkdefined, optional datetime receivedat, optional datetime startedat, optional datetime completedat)
void	SetTerminated( optional integer handle, optional integer index, optional string remark, optional boolean remarkdefined, optional datetime receivedat, optional datetime startedat, optional datetime completedat, optional datetime submitdeadline, optional datetime startdeadline, optional datetime enddeadline)
void	SetTerminatedDenied( optional integer handle, optional integer index, optional string remark, optional boolean remarkdefined, optional datetime receivedat, optional datetime startedat, optional datetime completedat, optional datetime submitdeadline, optional datetime startdeadline, optional datetime enddeadline)
void	ShowCommonStartedProcessOverview( optional integer unused1, optional integer unused2)
void	ShowCommonStartedProcessOverviewSelected( optional integer unused1, optional integer unused2)
void	ShowConcernedObjectsSelection( ref object[] objectsconcerned, ref boolean objectsconcernedrestricted, out optional boolean show)
void	ShowLongTermSuspended( optional integer unused1, optional integer unused2)
void	ShowUsageList( optional integer unused1, optional integer unused2)
void	ShowUsageListSelected( optional integer unused1, optional integer unused2)
dictionary	StartProcessDefinition( out retval dictionary processstate, optional string procinstcommonid)
ProcessInstance	StartProcessDiagram( WorkFlowDiagram diagram, optional boolean silent, out retval ProcessInstance procinst, optional WorkFlowParticipantMapping[] partmapping, optional boolean expandsub, optional dictionary processparams, optional boolean considereroomcontext, optional string procinstcommonid)
void	StartSelectedObjectsWorkFlowProcess( optional integer handle, optional integer index)
void	StartWorkFlow( WorkFlowParticipant responsible, optional WorkFlowParticipant respmansubst, optional LanguageStringList[] actinsttitle, optional ActivityType actinsttype, optional boolean add, optional object[] additionalobjects, out optional object newprocinst, out optional object newactinst, optional datetime submitdeadline, optional object actdef)
void	StartWorkFlowProcess( optional object[] procinsts)
void	StatisticSettings( optional integer unused1, optional integer unused2)
WorkFlowDiagram	StoreReleasedWorkFlowDiagram( out retval WorkFlowDiagram releaseddiagram, optional boolean releaserefdiagrams)
void	UpdatePrescriptions( object attrdef)
boolean	UseCommonStartedActivities( out retval boolean usecommonstarted)
boolean	UserIsParticipant( out retval boolean isparticipant, optional object user, optional WorkFlowParticipant checkpart)
boolean	UserIsResponsible( out retval boolean isresponsible, optional object user, optional ResponsibilityContext respcontext)
boolean	ValidateUIParticipant( AttributeDefinition attribute, WorkFlowParticipant value, optional Action context, out retval boolean isvalidparticipant)
void	WorkflowCreateFolder( optional integer unused1, optional integer unused2)

COOWF@1.1:AddPrescription

Adds a prescription

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

ACL Object: DefaultDeveloperACL
Software Component: COOWF@1.1

COOWF@1.1:AddSearchRestrictionsForReferencedBPMNObject

This action is called in GetReferencedBPMNObject to define additional query restrictions

string COOWF@1.1:AddSearchRestrictionsForReferencedBPMNObject(
ObjectClass targetclass,
out retval string queryrestriction)

Name	Description
targetclass
queryrestriction	this parameter defines an additional search restriction

Additional Information

ACL Object: DefaultDeveloperACL
Software Component: COOWF@1.1

COOWF@1.1:AllowChangeProcessState

Check if the current user is allowed to change the state of the process

boolean COOWF@1.1:AllowChangeProcessState(
out retval boolean statechangeable)

Name	Description
statechangeable

Additional Information

ACL Object: DefaultDeveloperACL
Software Component: COOWF@1.1

COOWF@1.1:AmendSubstitutePermissions

Correct the permissions of substitutes when executing activities.

void COOWF@1.1:AmendSubstitutePermissions(
optional boolean locked)

Name	Description
locked	defines if the current object is already locked

Additional Information

ACL Object: DefaultDeveloperACL
Software Component: COOWF@1.1

COOWF@1.1:AnalyzeBPMNZip

Analyze the compressed BPMN Model for contained diagrams

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

ACL Object: DefaultDeveloperACL
Software Component: COOWF@1.1

COOWF@1.1:ArchiveProcess

The instance elements like activities and control elements of the process are deleted. Only the process instance is kept with some meta data about the process statistic.

void COOWF@1.1:ArchiveProcess()

Additional Information

ACL Object: DefaultDeveloperACL
Software Component: COOWF@1.1

COOWF@1.1:AttachToProcess

Attaches an object to the process definition

void COOWF@1.1:AttachToProcess(
ref dictionary processstate,
object obj)

Name	Description
processstate	the processstate
obj	the obj

Additional Information

ACL Object: DefaultDeveloperACL
Software Component: COOWF@1.1

COOWF@1.1:AttrActInstCopy

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

any COOWF@1.1:AttrActInstCopy(
  AttributeDefinition attrdef,
  object sourceobj,
  out retval any value)

Name	Description
attrdef
sourceobj
value

Additional Information

Prototype: AttrCopyPrototype
ACL Object: DefaultDeveloperACL
Software Component: COOWF@1.1

COOWF@1.1:AttrActInstInstanceGet

This action is used as property get action for the property 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

Prototype: AttrGetPrototype
ACL Object: DefaultDeveloperACL
Software Component: COOWF@1.1

COOWF@1.1:AttrActInstInstanceGetVersion

This action is used as property get version action for the property 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

Prototype: AttrGetVersionPrototype
ACL Object: DefaultDeveloperACL
Software Component: COOWF@1.1

COOWF@1.1:AttrActInstObjectGet

This action is used as property get action for the property 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

Prototype: AttrGetPrototype
ACL Object: DefaultDeveloperACL
Software Component: COOWF@1.1

COOWF@1.1:AttrActInstObjectGetVersion

This action is used as property get version action for the property 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

Prototype: AttrGetVersionPrototype
ACL Object: DefaultDeveloperACL
Software Component: COOWF@1.1

COOWF@1.1:AttrActInstObjectSet

This action is used as property set action for the property 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

Prototype: AttrSetPrototype
ACL Object: DefaultDeveloperACL
Software Component: COOWF@1.1

COOWF@1.1:AttrActInstObjectsGet

This action is used as property get action for the property 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

Prototype: AttrGetPrototype
ACL Object: DefaultDeveloperACL
Software Component: COOWF@1.1

COOWF@1.1:AttrActInstObjectsGetVersion

This action is used as property get version action for the property 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

Prototype: AttrGetVersionPrototype
ACL Object: DefaultDeveloperACL
Software Component: COOWF@1.1

COOWF@1.1:AttrActInstSet

This action is used for must properties of 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

Prototype: AttrSetPrototype
ACL Object: DefaultDeveloperACL
Software Component: COOWF@1.1

COOWF@1.1:AttrActInstStateSet

This action is used as property set action for the property 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

Prototype: AttrSetPrototype
ACL Object: DefaultDeveloperACL
Software Component: COOWF@1.1

COOWF@1.1:AttrActInstStatisticGet

This action is used as property get action for the property 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

Prototype: AttrGetPrototype
ACL Object: DefaultDeveloperACL
Software Component: COOWF@1.1

COOWF@1.1:AttrActInstSubstUserGet

This action is used as property get action for the property 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

Prototype: AttrGetPrototype
ACL Object: DefaultDeveloperACL
Software Component: COOWF@1.1

COOWF@1.1:AttrActInstSubstUserGetVersion

This action is used as property get version action for the property 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

Prototype: AttrGetVersionPrototype
ACL Object: DefaultDeveloperACL
Software Component: COOWF@1.1

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

Prototype: AttrGetDispPrototype
ACL Object: DefaultDeveloperACL
Software Component: COOWF@1.1

COOWF@1.1:AttrBackLinkDefaultSet

This action is used as property set action for the property 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

Prototype: AttrSetPrototype
ACL Object: DefaultDeveloperACL
Software Component: COOWF@1.1

COOWF@1.1:AttrDefCaseNextDestructor

This action is used as property destructor action for the property 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

Prototype: AttrDestructorPrototype
ACL Object: DefaultDeveloperACL
Software Component: COOWF@1.1

COOWF@1.1:AttrDefGatewayNextDestructor

This action is used as property destructor action for the property 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

Prototype: AttrDestructorPrototype
ACL Object: DefaultDeveloperACL
Software Component: COOWF@1.1

COOWF@1.1:AttrDefRefObjClassesGet

This action is used as property get action for the property 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

Prototype: AttrGetPrototype
ACL Object: DefaultDeveloperACL
Software Component: COOWF@1.1

COOWF@1.1:AttrGetActinstworkDisp

This action is used as get display string action for all properties, that use the type for workflow worklist 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

Prototype: AttrGetDispPrototype
ACL Object: DefaultDeveloperACL
Software Component: COOWF@1.1

COOWF@1.1:AttrGetCompoundParticipantDisp

This action is used as get display string action for all properties, that use the type for workflow compound participants 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

Prototype: AttrGetDispPrototype
ACL Object: DefaultDeveloperACL
Software Component: COOWF@1.1

COOWF@1.1:AttrGetParticipantDisp

This action is used as get display string action for all properties, that use the type for workflow participants 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

Prototype: AttrGetDispPrototype
ACL Object: DefaultDeveloperACL
Software Component: COOWF@1.1

COOWF@1.1:AttrInstCaseNextDestructor

This action is used as property destructor action for the property 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

Prototype: AttrDestructorPrototype
ACL Object: DefaultDeveloperACL
Software Component: COOWF@1.1

COOWF@1.1:AttrInstConditionGet

This action is used as property get action for the property 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

Prototype: AttrGetPrototype
ACL Object: DefaultDeveloperACL
Software Component: COOWF@1.1

COOWF@1.1:AttrInstConditionGetVersion

This action is used as property get version action for the property 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

Prototype: AttrGetVersionPrototype
ACL Object: DefaultDeveloperACL
Software Component: COOWF@1.1

COOWF@1.1:AttrInstDefinitionCopy

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

any COOWF@1.1:AttrInstDefinitionCopy(
  AttributeDefinition attrdef,
  object sourceobj,
  out retval any value)

Name	Description
attrdef
sourceobj
value

Additional Information

Prototype: AttrCopyPrototype
ACL Object: DefaultDeveloperACL
Software Component: COOWF@1.1

COOWF@1.1:AttrInstElemSet

This action is used for must properties of the classes derived from 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

Prototype: AttrSetPrototype
ACL Object: DefaultDeveloperACL
Software Component: COOWF@1.1

COOWF@1.1:AttrInstGatewayNextDestructor

This action is used as property destructor action for the property 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

Prototype: AttrDestructorPrototype
ACL Object: DefaultDeveloperACL
Software Component: COOWF@1.1

COOWF@1.1:AttrLoadSharingScoreGet

This action is used as property get action for the property 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

Prototype: AttrGetPrototype
ACL Object: DefaultDeveloperACL
Software Component: COOWF@1.1

COOWF@1.1:AttrObjectDestructor

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

void COOWF@1.1:AttrObjectDestructor(
AttributeDefinition attrdef,
any value)

Name	Description
attrdef
value

Additional Information

Prototype: AttrDestructorPrototype
ACL Object: DefaultDeveloperACL
Software Component: COOWF@1.1

COOWF@1.1:AttrObjectListDestructor

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

void COOWF@1.1:AttrObjectListDestructor(
AttributeDefinition attrdef,
any value)

Name	Description
attrdef
value

Additional Information

Prototype: AttrDestructorPrototype
ACL Object: DefaultDeveloperACL
Software Component: COOWF@1.1

COOWF@1.1:AttrPrescriptionBlockConstructor

Create a new block in the prescription

void COOWF@1.1:AttrPrescriptionBlockConstructor(
  object attrdef,
  out any value,
  any[] oldvalues)

Name	Description
attrdef
value
oldvalues

Additional Information

Prototype: AttrLineConstructorPrototype
ACL Object: DefaultDeveloperACL
Software Component: COOWF@1.1

COOWF@1.1:AttrPrescriptionLineConstructor

Create a new line in the prescription

void COOWF@1.1:AttrPrescriptionLineConstructor(
  object attrdef,
  out any value,
  any[] oldvalues)

Name	Description
attrdef
value
oldvalues

Additional Information

Prototype: AttrLineConstructorPrototype
ACL Object: DefaultDeveloperACL
Software Component: COOWF@1.1

COOWF@1.1:AttrProcDefParticipantsGet

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

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

Prototype: AttrGetPrototype
ACL Object: DefaultDeveloperACL
Software Component: COOWF@1.1

COOWF@1.1:AttrProcDefRefObjClassesGet

This action is used as property get action for the property 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

Prototype: AttrGetPrototype
ACL Object: DefaultDeveloperACL
Software Component: COOWF@1.1

COOWF@1.1:AttrProcessListExpItemsGet

This action is used as property get action for the properties of a 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

Prototype: AttrGetPrototype
ACL Object: DefaultDeveloperACL
Software Component: COOWF@1.1

COOWF@1.1:AttrProcessListExpItemsSet

This action is used as property set action for the properties of a 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

Prototype: AttrSetPrototype
ACL Object: DefaultDeveloperACL
Software Component: COOWF@1.1

COOWF@1.1:AttrProcessListItemsGet

This action is used as property get action for the property 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

Prototype: AttrGetPrototype
ACL Object: DefaultDeveloperACL
Software Component: COOWF@1.1

COOWF@1.1:AttrProcessListItemsSet

This action is used as property set action for the property 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

Prototype: AttrSetPrototype
ACL Object: DefaultDeveloperACL
Software Component: COOWF@1.1

COOWF@1.1:AttrProcessParticipantSet

This action is intended to delegate activities of the current object using the abstract participant WFMP_OBJPROPERTY or WFMP_OBJPROPROLE to a new participant.

Only activities which are displayed in the worklist and the property of the participant is matching the parameter attrdef are touched.
The delegation is performed by calling the action SetDelegated().

If the current object is a file all objects which refer to this file by use of objfile will be searched and their activities matching the abstract participant WFMP_PARENTPROPERTY or WFMP_PARENTPROPROLE are also delegated to the new participant.
If the current object is a teamroom all objects which refer to this teamroom by use of objteamroom will be searched and their activities matching the abstract participant WFMP_CONTEXTPROPERTY or WFMP_CONTEXTPROPROLE are also delegated to the new participant.

void COOWF@1.1:AttrProcessParticipantSet(
  AttributeDefinition attrdef,
  ref optional any value,
  any oldvalue)

Name	Description
attrdef
value
oldvalue

Additional Information

Prototype: AttrSetPrototype
ACL Object: DefaultDeveloperACL
Software Component: COOWF@1.1

COOWF@1.1:AttrProcInstCopy

any COOWF@1.1:AttrProcInstCopy(
  AttributeDefinition attrdef,
  object sourceobj,
  out retval any value)

Name	Description
attrdef
sourceobj
value

Additional Information

Prototype: AttrCopyPrototype
ACL Object: DefaultDeveloperACL
Software Component: COOWF@1.1

COOWF@1.1:AttrProcInstSet

This action is used as property set action for most properties of 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

Prototype: AttrSetPrototype
ACL Object: DefaultDeveloperACL
Software Component: COOWF@1.1

COOWF@1.1:AttrProcInstStatisticGet

This action is used as property get action for the property 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

Prototype: AttrGetPrototype
ACL Object: DefaultDeveloperACL
Software Component: COOWF@1.1

COOWF@1.1:AttrProcInstUsersGet

This action is used as property get action for the property 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

Prototype: AttrGetPrototype
ACL Object: DefaultDeveloperACL
Software Component: COOWF@1.1

COOWF@1.1:AttrProcInstWorkGet

This action is used as property get action for the property 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

Prototype: AttrGetPrototype
ACL Object: DefaultDeveloperACL
Software Component: COOWF@1.1

COOWF@1.1:AttrSetPendingList

This action is used as wrapper for the property set action of the property 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

Prototype: AttrSetPrototype
ACL Object: DefaultDeveloperACL
Software Component: COOWF@1.1

COOWF@1.1:AttrUseForClassGet

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

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

Prototype: AttrGetPrototype
ACL Object: DefaultDeveloperACL
Software Component: COOWF@1.1

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

Prototype: AttrGetPrototype
ACL Object: DefaultDeveloperACL
Software Component: COOWF@1.1

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

Prototype: AttrGetPrototype
ACL Object: DefaultDeveloperACL
Software Component: COOWF@1.1

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

Prototype: AttrGetPrototype
ACL Object: DefaultDeveloperACL
Software Component: COOWF@1.1

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

Prototype: AttrGetPrototype
ACL Object: DefaultDeveloperACL
Software Component: COOWF@1.1

COOWF@1.1:AttrWorkFlowConstructor

This action is used as property constructor action for the property 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

Prototype: AttrConstructorPrototype
ACL Object: DefaultDeveloperACL
Software Component: COOWF@1.1

COOWF@1.1:AttrWorkFlowCopy

This action is used as property copy action for the property 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

Prototype: AttrCopyPrototype
ACL Object: DefaultDeveloperACL
Software Component: COOWF@1.1

COOWF@1.1:AttrWorkFlowDeadLinesGet

This action is used as property get action for the property 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

Prototype: AttrGetPrototype
ACL Object: DefaultDeveloperACL
Software Component: COOWF@1.1

COOWF@1.1:AttrWorkFlowDefinitionObjectFilter

Filter allowed definition objects for workflow elements. E.g.: NotificationDefinition, COOWF@1.1:EsclalationDefinition...

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

ACL Object: DefaultDeveloperACL
Software Component: COOWF@1.1

COOWF@1.1:AttrWorkFlowDelVersion

This action is used as property delete version action for the property 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

Prototype: AttrDelVersionPrototype
ACL Object: DefaultDeveloperACL
Software Component: COOWF@1.1

COOWF@1.1:AttrWorkFlowFixVersion

This action is used as property fix version action for the property 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

Prototype: AttrFixVersionPrototype
ACL Object: DefaultDeveloperACL
Software Component: COOWF@1.1

COOWF@1.1:AttrWorkFlowSet

This action is used as property set action for the property 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

Prototype: AttrSetPrototype
ACL Object: DefaultDeveloperACL
Software Component: COOWF@1.1

COOWF@1.1:AttrWorkListItemsGet

This action is used as property get action for the various lists of activities in 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

Prototype: AttrGetPrototype
ACL Object: DefaultDeveloperACL
Software Component: COOWF@1.1

COOWF@1.1:AttrWorkListItemsSet

This action is used as property set action for the various lists of activities in 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

Prototype: AttrSetPrototype
ACL Object: DefaultDeveloperACL
Software Component: COOWF@1.1

COOWF@1.1:AttrWorkListUIFilter

object[] COOWF@1.1:AttrWorkListUIFilter(
ref retval object[] objects,
AttributeDefinition attrdef)

Name	Description
objects
attrdef

Additional Information

Prototype: AttrUIFilterPrototype
ACL Object: DefaultDeveloperACL
Software Component: COOWF@1.1

COOWF@1.1:AutomaticallyInsertFollowerActivity

Check if an activity should be automatically inserted after the current activity. This action is intended to be used in customization point InsertActivityDef.

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

ACL Object: DefaultDeveloperACL
Software Component: COOWF@1.1

COOWF@1.1:BuildPartipantControlParams

Build the control parameters structure by the single values

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

ACL Object: DefaultDeveloperACL
Software Component: COOWF@1.1

COOWF@1.1:BuildPartipantControlParamValues

Build the control parameter single values by the control parameter structure

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

ACL Object: DefaultDeveloperACL
Software Component: COOWF@1.1

COOWF@1.1:CalculateProcessStatistics

Calculate the process statistics for a group

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

ACL Object: DefaultDeveloperACL
Software Component: COOWF@1.1

COOWF@1.1:CallObjectWorkItem

Calls the work item with the supplied index.

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

Prototype: MenuActionPrototype
ACL Object: DefaultDeveloperACL
Software Component: COOWF@1.1

COOWF@1.1:CallWorkItem

Calls an workitem from the menu

void COOWF@1.1:CallWorkItem(
  optional integer unused1,
  optional integer unused2,
  integer menudynkey)

Name	Description
unused1
unused2
menudynkey

Additional Information

Prototype: MenuDynActionPrototype
ACL Object: DefaultDeveloperACL
Software Component: COOWF@1.1

COOWF@1.1:CanBeUsedForSubProcessesOnly

Checks if the current workflow diagram is only usable as sub process

boolean COOWF@1.1:CanBeUsedForSubProcessesOnly(
out retval boolean subprocessesonly)

Name	Description
subprocessesonly	the result

Additional Information

ACL Object: DefaultDeveloperACL
Software Component: COOWF@1.1

COOWF@1.1:CanChangeProcessState

Perform additional checks on the process object if the process state can be changed

boolean COOWF@1.1:CanChangeProcessState(
ProcessInstance procinst,
ref retval boolean statechangeable)

Name	Description
procinst	the process instance
statechangeable	the result

Additional Information

ACL Object: DefaultDeveloperACL
Software Component: COOWF@1.1

COOWF@1.1:CanDeleteWorkFlow

This action is called during 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

ACL Object: DefaultDeveloperACL
Software Component: COOWF@1.1

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

ACL Object: DefaultDeveloperACL
Software Component: COOWF@1.1

COOWF@1.1:ChangeAppWorkFlowState

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

void COOWF@1.1:ChangeAppWorkFlowState(
  App app,
  ref boolean licensed,
  ref boolean active,
  boolean oldstate)

Name	Description
app
licensed
active
oldstate

Additional Information

Prototype: AppStateChangeActionPrototype
ACL Object: DefaultDeveloperACL
Software Component: COOWF@1.1

COOWF@1.1:ChangeResponsible

This action can be called to change the organizational element, that is responsible for the process instance. Except during delegation, the responsible for a process can only be changed by a person, that is responsible for the process or by a substitute of that person.

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

ACL Object: DefaultDeveloperACL
Software Component: COOWF@1.1

COOWF@1.1:CheckAction

This action is called to check, if and how one of the following workflow actions is usable in a Web environment: OpenObject, SelectTreeObject, EditObjectAttributes, SetStarted, SetSuspended, SetCompleted, SetDelegated, SetTerminated, PrescribeObject and CallObjectWorkItem.
This action returns, what questions must be asked, what date values have to be specified by the user, what applications have to be executed on behalf of executing work items.

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

ACL Object: DefaultDeveloperACL
Software Component: COOWF@1.1

COOWF@1.1:CheckActive

This action checks if the current group or user is active. In case of users the action checks if the user has licensed the app AppWorkFlow. If the license is not valid the action returns with an error

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

ACL Object: DefaultDeveloperACL
Software Component: COOWF@1.1

COOWF@1.1:CheckAdditionalParticipantRestrictions

If the process has additional participant restrictions the participants will be filtered by this action

object[] COOWF@1.1:CheckAdditionalParticipantRestrictions(
ref retval object[] participants)

Name	Description
participants

Additional Information

ACL Object: DefaultDeveloperACL
Software Component: COOWF@1.1

COOWF@1.1:CheckAllowedActions

Checks which workflow actions are allowed for the current object

void COOWF@1.1:CheckAllowedActions(
ref object[] actions)

Name	Description
actions	the actions

Additional Information

ACL Object: DefaultDeveloperACL
Software Component: COOWF@1.1

COOWF@1.1:CheckAllowedElements

This action is called by the process editor to check, which types of elements are allowed to be created by the user on the fly in a process instance. It is intended to by overwritten or wrapped by software components, that want to restrict the ability of the end user to manipulate process instances.

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

ACL Object: DefaultDeveloperACL
Software Component: COOWF@1.1

COOWF@1.1:CheckAutoComplete

Checks if the process can be completed automatically

boolean COOWF@1.1:CheckAutoComplete(
out retval boolean autocomplete)

Name	Description
autocomplete	the result value

Additional Information

ACL Object: DefaultDeveloperACL
Software Component: COOWF@1.1

COOWF@1.1:CheckBackgroundWork

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

void COOWF@1.1:CheckBackgroundWork()

Additional Information

ACL Object: DefaultDeveloperACL
Software Component: COOWF@1.1

COOWF@1.1:CheckCopy

This action is called on every process instance attached to an object, when that object is copied. It is used to check, if that process instance should be copied also, and the copied process instance should be attached to the copy of the object.

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

ACL Object: DefaultDeveloperACL
Software Component: COOWF@1.1

COOWF@1.1:CheckDatesForm

This action is used to check the user input if the supplied dates are holidays.

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

Prototype: AttrCheckPrototype
ACL Object: DefaultDeveloperACL
Software Component: COOWF@1.1

COOWF@1.1:CheckDelegateForm

This action is used to check the user input when modifying the responsible of an activity.

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

Prototype: AttrCheckPrototype
ACL Object: DefaultDeveloperACL
Software Component: COOWF@1.1

COOWF@1.1:CheckDelegateMultipleForm

This action is used to check the user input when modifying the responsible of an activity.

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

Prototype: AttrCheckPrototype
ACL Object: DefaultDeveloperACL
Software Component: COOWF@1.1

COOWF@1.1:CheckDestination

This action is called on an activity instance, when it is about to get startable, to check, if the workflow participant described in the activity is available, and to check, if background execution is enabled, when it is a background activity. The action is expected to return an appropriate error, if there is a problem with the participant.

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

ACL Object: DefaultDeveloperACL
Software Component: COOWF@1.1

COOWF@1.1:CheckExpiredActivities

This action can be used in a task for the AT service to check periodically for expired activities. A task for that action is not created automatically as for the action 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

ACL Object: DefaultDeveloperACL
Software Component: COOWF@1.1

COOWF@1.1:CheckForm

This action is used to check the user input when modifying definitions and instances of processes and activities, if it is valid and complete. It is called by the property editor, after the input is saved and before the form is closed and the input is committed, to verify the user input. It is expected to return an appropriate error, if problems are found.

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

Prototype: AttrCheckPrototype
ACL Object: DefaultDeveloperACL
Software Component: COOWF@1.1

COOWF@1.1:CheckInsertTemplate

Check a prescription template can be inserted at the current position

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

ACL Object: DefaultDeveloperACL
Software Component: COOWF@1.1

COOWF@1.1:CheckLongTermActivities

This action can be used in a task for the AT service to check periodically for expiring submissions of long term suspended activities. A task for that action is not created automatically as for the action 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

ACL Object: DefaultDeveloperACL
Software Component: COOWF@1.1

COOWF@1.1:CheckParticipant

Check if the supplied participant is a valid workflow participant

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

ACL Object: DefaultDeveloperACL
Software Component: COOWF@1.1

COOWF@1.1:CheckParticipantAffiliation

This action is used as hook to perform additional checks if supplied the participant is valid for the current process. The action is currently called when the integrity of the participant is checked.

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

ACL Object: DefaultDeveloperACL
Software Component: COOWF@1.1

COOWF@1.1:CheckParticipantRules

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

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

The action is called in several actions where participant input validation is performed.
Caller Actions:

COOWF@1.1:CheckActivityDefinition
COOWF@1.1:CheckActivityInstance
CheckBPMNProcessParticipants
CheckDelegateForm
CheckParticipant
CheckPrescriptionsForm
COOWF@1.1:CheckProcessDefinition
COOWF@1.1:CheckProcessInstance
CheckSimplePrescriptionsForm
SetStartable

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

ACL Object: DefaultDeveloperACL
Software Component: COOWF@1.1

COOWF@1.1:CheckPrescriptionsForm

This action is used to check the user input when doing prescriptions to other users, if it is valid and complete. It is called by the property editor, after the input is saved and before the form is closed and the input is committed, to verify the user input. It is expected to return an appropriate error, if problems are found.

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

Prototype: AttrCheckPrototype
ACL Object: DefaultDeveloperACL
Software Component: COOWF@1.1

COOWF@1.1:CheckReferencedDiagramExecutionRestriction

Check if the execution restrictions of the current diagram can be used in context of the referencing diagrams

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

ACL Object: DefaultDeveloperACL
Software Component: COOWF@1.1

COOWF@1.1:CheckReleaseReferencedDiagrams

Check if the current workflow diagram has referenced workflow diagrams and if it is required to release the referenced diagrams to release the current diagram

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

ACL Object: DefaultDeveloperACL
Software Component: COOWF@1.1

COOWF@1.1:CheckRemoveOrgElements

Retrieve the configuration setting if the users and groups with permissions on the activity are removed after completion.

WorkFlowOrgSecurity COOWF@1.1:CheckRemoveOrgElements(
out retval WorkFlowOrgSecurity orgsecurity)

Name	Description
orgsecurity	the configuration how the permissions are handled after completion

Additional Information

ACL Object: DefaultDeveloperACL
Software Component: COOWF@1.1

COOWF@1.1:CheckRetracted

Checks if an activity instance can be retracted

boolean COOWF@1.1:CheckRetracted(
out retval boolean allowed)

Name	Description
allowed	the retraction of the activity instances is allowed

Additional Information

ACL Object: DefaultDeveloperACL
Software Component: COOWF@1.1

COOWF@1.1:CheckSimplePrescriptionsForm

Check the entered values in the simple prescription editor

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

Prototype: AttrCheckPrototype
ACL Object: DefaultDeveloperACL
Software Component: COOWF@1.1

COOWF@1.1:CheckStart

Checks if the process instance will be started automatically.

boolean COOWF@1.1:CheckStart(
out retval boolean startable)

Name	Description
startable	the result value

Additional Information

ACL Object: DefaultDeveloperACL
Software Component: COOWF@1.1

COOWF@1.1:CheckSubmissionRepetitionPeriod

Check the submission period

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

ACL Object: DefaultDeveloperACL
Software Component: COOWF@1.1

COOWF@1.1:CheckTakenOver

Checks if the activity instance can be taken over.

boolean COOWF@1.1:CheckTakenOver(
out retval boolean allowed)

Name	Description
allowed	the allowed

Additional Information

ACL Object: DefaultDeveloperACL
Software Component: COOWF@1.1

COOWF@1.1:CheckWorkDay

Checks if the supplied date is a vaild work day

void COOWF@1.1:CheckWorkDay(
datetime checkdate,
optional boolean checkpast)

Name	Description
checkdate	the checkdate
checkpast	the checkpast

Additional Information

ACL Object: DefaultDeveloperACL
Software Component: COOWF@1.1

COOWF@1.1:CheckWorkFlowAppLicense

Check if the app workflow is licensed for the current user

boolean COOWF@1.1:CheckWorkFlowAppLicense(
  optional boolean disableerrorapps,
  optional boolean silentmode,
  out retval boolean haslicense)

Name	Description
disableerrorapps
silentmode
haslicense

Additional Information

ACL Object: DefaultDeveloperACL
Software Component: COOWF@1.1

COOWF@1.1:CheckWorkList

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

void COOWF@1.1:CheckWorkList()

Additional Information

ACL Object: DefaultDeveloperACL
Software Component: COOWF@1.1

COOWF@1.1:ChooseProcessDefinition

Selected action for InitializeWorkFlow

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

Prototype: MenuActionPrototype
ACL Object: DefaultDeveloperACL
Software Component: COOWF@1.1

COOWF@1.1:ClearProcessParameters

Action clear process parameters for a specified process. This action fails for users with are no participant of the process or have no access on the object of the process.

void COOWF@1.1:ClearProcessParameters(
optional boolean separatetx)

Name	Description
separatetx	the changes are stored in a separate transaction and directly saved

Additional Information

ACL Object: DefaultDeveloperACL
Software Component: COOWF@1.1

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

ACL Object: DefaultDeveloperACL
Software Component: COOWF@1.1

COOWF@1.1:ComputeDeadLine

This action is called during the execution of a process instance, when an activity reaches the state ACTINST_STARTABLE, to compute the various deadlines for submission, start and completion of the activity. This action can be wrapped or overwritten to apply different rules for computing deadlines. The computed deadline is stored in the specified property.

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

ACL Object: DefaultDeveloperACL
Software Component: COOWF@1.1

COOWF@1.1:ConfirmStart

This action is called during the execution of a process instance in several situations, to confirm if an activity instance, that is not yet started, but that needs to be started to continue, should be set to the state ACTINST_STARTED now. The action can decide depending on the context, if it should be started in any case, or it can ask the user, if the activity should be started.

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

ACL Object: DefaultDeveloperACL
Software Component: COOWF@1.1

COOWF@1.1:ConvertDateToWorkDays

Converts the distance between two dates into workdays.

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

ACL Object: DefaultDeveloperACL
Software Component: COOWF@1.1

COOWF@1.1:ConvertWorkDaysToDate

Converts the start date and the defined amount of workdays to the end date.

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

ACL Object: DefaultDeveloperACL
Software Component: COOWF@1.1

COOWF@1.1:CopyWorkFlowObject

This action should be called, if an object used in process instances is copied. It uses the defined affinity for workflow objects of the current domain (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

ACL Object: DefaultDeveloperACL
Software Component: COOWF@1.1

COOWF@1.1:CreateProcessInstance

Creates a process instance for the current object

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

ACL Object: DefaultDeveloperACL
Software Component: COOWF@1.1

COOWF@1.1:CreateProcessOutput

Creates a new process output

void COOWF@1.1:CreateProcessOutput(
optional integer unused1,
optional integer unused2)

Name	Description
unused1
unused2

Additional Information

Prototype: MenuActionPrototype
ACL Object: DefaultDeveloperACL
Software Component: COOWF@1.1

COOWF@1.1:CreateProcessParticipant

Creates a new process participant

void COOWF@1.1:CreateProcessParticipant(
optional integer unused1,
optional integer unused2)

Name	Description
unused1
unused2

Additional Information

Prototype: MenuActionPrototype
ACL Object: DefaultDeveloperACL
Software Component: COOWF@1.1

COOWF@1.1:CreateProcessStatisticsCache

Create a process statistics cache for a group

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

ACL Object: DefaultDeveloperACL
Software Component: COOWF@1.1

COOWF@1.1:CreateWorkFlowDiagram

Creates a new process diagram

void COOWF@1.1:CreateWorkFlowDiagram(
optional integer unused1,
optional integer unused2)

Name	Description
unused1
unused2

Additional Information

Prototype: MenuActionPrototype
ACL Object: DefaultDeveloperACL
Software Component: COOWF@1.1

COOWF@1.1:CreateWorkFlowObject

This action should be called, if an object used in process instances is created. It uses the defined affinity for workflow objects of the current domain (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

ACL Object: DefaultDeveloperACL
Software Component: COOWF@1.1

COOWF@1.1:DefineWFSubstitutes

Use case to the define the current users substitutions

void COOWF@1.1:DefineWFSubstitutes(
optional integer unused1,
optional integer unused2)

Name	Description
unused1
unused2

Additional Information

Prototype: MenuActionPrototype
ACL Object: DefaultDeveloperACL
Software Component: COOWF@1.1

COOWF@1.1:DelegateActivityHook

Hook action called on the object of the process during COOWF@1.1:SetDelegate before the participant of the activity is changed

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

ACL Object: DefaultDeveloperACL
Software Component: COOWF@1.1

COOWF@1.1:DelegateActivityMultipleHook

Hook action called on the object of the process during COOWF@1.1:SetDelegateMultiple before the participant of the activity is changed

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

ACL Object: DefaultDeveloperACL
Software Component: COOWF@1.1

COOWF@1.1:DeleteSelectedObjectsWorkFlow

Selected action for DeleteWorkFlow

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

Prototype: MenuActionPrototype
ACL Object: DefaultDeveloperACL
Software Component: COOWF@1.1

COOWF@1.1:DeleteWasteBasketObjects

Delete objects in a process folder wastebasket

void COOWF@1.1:DeleteWasteBasketObjects(
optional integer unused1,
optional integer unused2)

Name	Description
unused1
unused2

Additional Information

Prototype: MenuActionPrototype
ACL Object: DefaultDeveloperACL
Software Component: COOWF@1.1

COOWF@1.1:DeleteWasteBasketObjectsSelected

void COOWF@1.1:DeleteWasteBasketObjectsSelected(
optional integer unused1,
optional integer unused2)

Name	Description
unused1
unused2

Additional Information

Prototype: MenuActionPrototype
ACL Object: DefaultDeveloperACL
Software Component: COOWF@1.1

COOWF@1.1:DeleteWorkFlow

This action can be called to delete the specified process instances attached to the object. If no process is specified, all process instances attached to the object are destroyed.
In general, process instances can only be destroyed, if they are executed completely, or if the object they are attached to is destroyed also.

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

ACL Object: DefaultDeveloperACL
Software Component: COOWF@1.1

COOWF@1.1:DeleteWorkFlowDiagram

Delete the work flow diagram including its released versions.

void COOWF@1.1:DeleteWorkFlowDiagram(
optional integer unused1,
optional integer unused2)

Name	Description
unused1
unused2

Additional Information

Prototype: MenuActionPrototype
ACL Object: DefaultDeveloperACL
Software Component: COOWF@1.1

COOWF@1.1:DeleteWorkFlowDiagramSelected

void COOWF@1.1:DeleteWorkFlowDiagramSelected(
optional integer unused1,
optional integer unused2)

Name	Description
unused1
unused2

Additional Information

Prototype: MenuActionPrototype
ACL Object: DefaultDeveloperACL
Software Component: COOWF@1.1

COOWF@1.1:DeleteWorkFlowObject

This action should be called, to delete instance elements in process instances. The deleted elements will be stored in property 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

ACL Object: DefaultDeveloperACL
Software Component: COOWF@1.1

COOWF@1.1:DeskLoggedIn

This action is used as a post wrapper for the action 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

ACL Object: DefaultDeveloperACL
Software Component: COOWF@1.1

COOWF@1.1:DisplayActionsInWorkflowTaskPane

This action is defined as hook action to display the context menu actions in the task pane of an activity instance

boolean COOWF@1.1:DisplayActionsInWorkflowTaskPane(
out retval boolean displayactions)

Name	Description
displayactions	the context menu actions should be diplayed

Additional Information

ACL Object: DefaultDeveloperACL
Software Component: COOWF@1.1

COOWF@1.1:DisplayBPMNCustomizedExpressions

Usecase to display the expressions which are customized in the BPMN process diagram.

void COOWF@1.1:DisplayBPMNCustomizedExpressions(
optional integer unused1,
optional integer unused2)

Name	Description
unused1
unused2

Additional Information

Prototype: MenuActionPrototype
ACL Object: DefaultDeveloperACL
Software Component: COOWF@1.1

COOWF@1.1:DisplayParticipantWithLabels

Action used to format a participant for the workflow editor control

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

ACL Object: DefaultDeveloperACL
Software Component: COOWF@1.1

COOWF@1.1:DoShowWorkListItem

Define if a WorkList item showed be shown

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

ACL Object: DefaultDeveloperACL
Software Component: COOWF@1.1

COOWF@1.1:EditObjectAttributesDirect

Action to edit direct the properties of an object

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

Prototype: MenuActionPrototype
ACL Object: DefaultDeveloperACL
Software Component: COOWF@1.1

COOWF@1.1:EditProcessObjectAttributes

Action to edit the attributes of an object of the process

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

Prototype: MenuActionPrototype
ACL Object: DefaultDeveloperACL
Software Component: COOWF@1.1

COOWF@1.1:EscalateObject

Escalates the objects regarding to the defined escalation specification

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

ACL Object: DefaultDeveloperACL
Software Component: COOWF@1.1

COOWF@1.1:EscalateToRecipients

Send an escalation message to a recipient

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

ACL Object: DefaultDeveloperACL
Software Component: COOWF@1.1

COOWF@1.1:EvaluateCase

This action is called on the start of a CASE switch, when the execution of a process instance reaches that point, to decide which path of the case switch has to be entered.

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

ACL Object: DefaultDeveloperACL
Software Component: COOWF@1.1

COOWF@1.1:EvaluateCondition

This action is called on the start of an IF condition or the end of a REPEAT loop, when the execution of a process instance reaches that point, to decide which path has to be entered. In the case of an IF condition it decides, if the THEN or the ELSE part is entered. In the case of a REPEAT loop it decides, if the loop will be repeated.

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

ACL Object: DefaultDeveloperACL
Software Component: COOWF@1.1

COOWF@1.1:EvaluatePrecondition

Helper action to evaluate the precondition expressions of an activity instance

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

ACL Object: DefaultDeveloperACL
Software Component: COOWF@1.1

COOWF@1.1:ExecuteBackgroundWork

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

void COOWF@1.1:ExecuteBackgroundWork()

Additional Information

ACL Object: DefaultDeveloperACL
Software Component: COOWF@1.1

COOWF@1.1:ExpandPrescribeParticipants

Expands the participants of a workflow prescription. E.g.: Distribution lists are resolved.

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

ACL Object: DefaultDeveloperACL
Software Component: COOWF@1.1

COOWF@1.1:ExtendNotificationSettings

Hook action called during GetNotificationSettings to allow additional customizing of the notification settings.
All available notification settings are passed into this action an can be modified.

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

ACL Object: DefaultDeveloperACL
Software Component: COOWF@1.1

COOWF@1.1:ExtendPushNotificationSettings

Hook action called during GetPushNotificationSettings to allow additional customizing of the push notification settings.
All available push notification settings are passed into this action an can be modified.

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

ACL Object: DefaultDeveloperACL
Software Component: COOWF@1.1

COOWF@1.1:ExtractSubPrescription

Converts a subprescription to a prescription

WorkFlowPrescriptionList[] COOWF@1.1:ExtractSubPrescription(
WorkFlowSubPrescriptionList[] source,
out retval WorkFlowPrescriptionList[] extractedprescription)

Name	Description
source
extractedprescription

Additional Information

ACL Object: DefaultDeveloperACL
Software Component: COOWF@1.1

COOWF@1.1:FilterPossibleReferencedDiagrams

Filter the possible diagrams

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

ACL Object: DefaultDeveloperACL
Software Component: COOWF@1.1

COOWF@1.1:FilterUsableDefinitions

Filters the supplied definition objects for usable ones in the supplied context

void COOWF@1.1:FilterUsableDefinitions(
object context,
ref object[] objects)

Name	Description
context	the context
objects	the objects

Additional Information

ACL Object: DefaultDeveloperACL
Software Component: COOWF@1.1

COOWF@1.1:FilterUsableDiagramsHook

Hook action to filter useable workflow diagrams

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

ACL Object: DefaultDeveloperACL
Software Component: COOWF@1.1

COOWF@1.1:FilterUsableObjects

Filters the supplied objects for usable ones in the supplied context

void COOWF@1.1:FilterUsableObjects(
object context,
ref object[] objects)

Name	Description
context	the context
objects	the objects

Additional Information

ACL Object: DefaultDeveloperACL
Software Component: COOWF@1.1

COOWF@1.1:FixParticipantAffiliation

Hook action to fix affiliation problems.

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

ACL Object: DefaultDeveloperACL
Software Component: COOWF@1.1

COOWF@1.1:FormatWFNotificationSettingsToInfolist

Action to render the workflow notification settings

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

ACL Object: DefaultDeveloperACL
Software Component: COOWF@1.1

COOWF@1.1:GenerateArchivedProcessStatistic

This action can be used to generate a process statistic before archiving the process instance.

ArchivedProcessStatistic COOWF@1.1:GenerateArchivedProcessStatistic(
out retval ArchivedProcessStatistic statistics)

Name	Description
statistics

Additional Information

ACL Object: DefaultDeveloperACL
Software Component: COOWF@1.1

COOWF@1.1:GetActivityInstanceMenu

Get possible actions on activities

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

Prototype: MenuGetActionPrototype
ACL Object: DefaultDeveloperACL
Software Component: COOWF@1.1

COOWF@1.1:GetAdditionalPrescriptionTemplatesHook

Hook to get additional prescription templates

PrescriptionTemplate[] COOWF@1.1:GetAdditionalPrescriptionTemplatesHook(
object[] wfobjects,
ref retval PrescriptionTemplate[] templates)

Name	Description
wfobjects	workflow objects
templates	list of prescription templates

Additional Information

ACL Object: DefaultDeveloperACL
Software Component: COOWF@1.1

COOWF@1.1:GetAdditionalWorkFlowDiagramsHook

Hook to get additional additional workflow diagrams which are currently not stored in the workflow preferences

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

ACL Object: DefaultDeveloperACL
Software Component: COOWF@1.1

COOWF@1.1:GetAllWorkListActInsts

Gets all activities of the object which are currently located in a WorkList

object[] COOWF@1.1:GetAllWorkListActInsts(
out retval object[] allactinsts)

Name	Description
allactinsts	the allactinsts

Additional Information

ACL Object: DefaultDeveloperACL
Software Component: COOWF@1.1

COOWF@1.1:GetCommonPrescribeDefault

Get the common default values for prescriptions on multiple objects

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

ACL Object: DefaultDeveloperACL
Software Component: COOWF@1.1

COOWF@1.1:GetCommonUsableProcessDefinitions

Retrieve the commonly usable process definitions of all supplied objects

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

ACL Object: DefaultDeveloperACL
Software Component: COOWF@1.1

COOWF@1.1:GetConditionString

This action is called by the process editor to format the condition in IF conditions or REPEAT loops to a readable form, that is displayed in the graphical process editor.

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

ACL Object: DefaultDeveloperACL
Software Component: COOWF@1.1

COOWF@1.1:GetConfiguredProcessStatisticsUsers

Check for which types of users process statistics are enabled

ProcStatisticsUsers[] COOWF@1.1:GetConfiguredProcessStatisticsUsers(
out retval ProcStatisticsUsers[] users)

Name	Description
users

Additional Information

ACL Object: DefaultDeveloperACL
Software Component: COOWF@1.1

COOWF@1.1:GetConfiguredSender

Retrieve the configured sender for escalation and notification mails

string COOWF@1.1:GetConfiguredSender(
out retval string sender)

Name	Description
sender	the result

Additional Information

ACL Object: DefaultDeveloperACL
Software Component: COOWF@1.1

COOWF@1.1:GetCurrentActivityInstances

Calculates and returns all activity instances of the object which are currently located in the work list of the current user

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

ACL Object: DefaultDeveloperACL
Software Component: COOWF@1.1

COOWF@1.1:GetCurrentUserActivities

Gets all activities contained in the WorkList of the current user

object[] COOWF@1.1:GetCurrentUserActivities(
out retval object[] actinsts)

Name	Description
actinsts

Additional Information

ACL Object: DefaultDeveloperACL
Software Component: COOWF@1.1

COOWF@1.1:GetDefaultNotificationTypes

Get the default notification types for workflow notifications. This notification types are used will be initialized in user environments

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

ACL Object: DefaultDeveloperACL
Software Component: COOWF@1.1

COOWF@1.1:GetDefaultProcessDefinitions

This action is called, when an object is created that has the property 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

ACL Object: DefaultDeveloperACL
Software Component: COOWF@1.1

COOWF@1.1:GetDefinitionElements

This action can be called to retrieve all definition element objects of a process definition that have the specified class. If no class is specified, all definition elements in the process definition are returned.

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

ACL Object: DefaultDeveloperACL
Software Component: COOWF@1.1

COOWF@1.1:GetDelegateDefault

This action is called by the user interface to retrieve the default settings, when a user chooses to delegate an activity instance. This is intended as the default parameters, that the user can modify to his needs.

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

ACL Object: DefaultDeveloperACL
Software Component: COOWF@1.1

COOWF@1.1:GetDelegateMultipleDefault

This action is called by the user interface to retrieve the default settings, when a user chooses to delegate an activity instance to multiple participants. This is intended as the default parameters, that the user can modify to his needs.

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

ACL Object: DefaultDeveloperACL
Software Component: COOWF@1.1

COOWF@1.1:GetDiagramIdFromWorkFlowObject

Retrieve an id do identify the object when used in a workflow diagram. For component objects the reference is used by default. For all other objects the external key is used if defined or the object address.

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

ACL Object: DefaultDeveloperACL
Software Component: COOWF@1.1

COOWF@1.1:GetDiagramProcessParticipants

Get the participants used in the executable processes of the process diagram

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

ACL Object: DefaultDeveloperACL
Software Component: COOWF@1.1

COOWF@1.1:GetDisplayProperties

This action is called, when an activity instance or wait action instance is displayed in a graphical user interface, to determine the list of properties, that should be displayed in the box representing the activity.

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

ACL Object: DefaultDeveloperACL
Software Component: COOWF@1.1

COOWF@1.1:GetInheritedWorkFlowSettings

Retrieve inherited prescription templates and workflow diagrams

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

ACL Object: DefaultDeveloperACL
Software Component: COOWF@1.1

COOWF@1.1:GetInitialResponsible

When starting a new process instance this action is called to calculate the initial responsible of the process. The calculated responsible is stored in the property 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

ACL Object: DefaultDeveloperACL
Software Component: COOWF@1.1

COOWF@1.1:GetInsertActivityDef

Calculates and returns an activity definition by using the customization point 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: `activity` the currently used activity instance of the current process. `process` the currently used process instance `participant` the participant of the current activity instance `object` the object of the current process
abortfollowers	all followers with the same ad hoc key will be aborted

Additional Information

ACL Object: DefaultDeveloperACL
Software Component: COOWF@1.1

COOWF@1.1:GetInstanceElementColor

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

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

Name	Description
colorcode	the color code

Additional Information

ACL Object: DefaultDeveloperACL
Software Component: COOWF@1.1

COOWF@1.1:GetInstanceElements

This action can be called to retrieve all instance element objects of a process instance that have the specified class and the specified state. If no class is specified, the instance elements in the process instance are returned regardless of their class. If no state is specified, the instance elements in the process instance are returned regardless of their state.

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

ACL Object: DefaultDeveloperACL
Software Component: COOWF@1.1

COOWF@1.1:GetLastInstanceElements

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

object[] COOWF@1.1:GetLastInstanceElements(
out retval object[] instelems)

Name	Description
instelems	The list of last instance elements.

Additional Information

ACL Object: DefaultDeveloperACL
Software Component: COOWF@1.1

COOWF@1.1:GetLongTermSuspendedActivities

Retrieve all long term suspended activities for the current user

ActivityInstance[] COOWF@1.1:GetLongTermSuspendedActivities(
out retval ActivityInstance[] activities)

Name	Description
activities	the long term suspended activities

Additional Information

ACL Object: DefaultDeveloperACL
Software Component: COOWF@1.1

COOWF@1.1:GetLowestLoadSharingScoreUsers

Get the users with the lowest load sharing score of a group.

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

ACL Object: DefaultDeveloperACL
Software Component: COOWF@1.1

COOWF@1.1:GetManageableWorkFlowPreferenceGroupLocations

Retrieve the groups for which workflow diagrams can be released

Group[] COOWF@1.1:GetManageableWorkFlowPreferenceGroupLocations(
out retval Group[] groups)

Name	Description
groups	the target groups

Additional Information

ACL Object: DefaultDeveloperACL
Software Component: COOWF@1.1

COOWF@1.1:GetNextActivityInstances

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

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

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

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

Name	Description
skipconditions	if defined the conditions of gateways are not evaluated and all following activities are returned
includecontrolelements	if defined the search for the next activity instance is stopped at a control element and the control element is part of the result
nextactinst	the following activity instances

Additional Information

ACL Object: DefaultDeveloperACL
Software Component: COOWF@1.1

COOWF@1.1:GetNextInstanceElements

Retrieve all following instance elements of all activity instances in all work lists of the current user

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

ACL Object: DefaultDeveloperACL
Software Component: COOWF@1.1

COOWF@1.1:GetNextSuspensionDate

Calculate the next suspension date for the activity based on the values entered in the submission dialog

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

ACL Object: DefaultDeveloperACL
Software Component: COOWF@1.1

COOWF@1.1:GetNotificationSettings

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

NotificationEntryList[] COOWF@1.1:GetNotificationSettings(
out retval NotificationEntryList[] notificationentries)

Name	Description
notificationentries	the configured notification entries

Additional Information

ACL Object: DefaultDeveloperACL
Software Component: COOWF@1.1

COOWF@1.1:GetNotificationSettingsFromUser

Calculates the workflow notification settings for a specific user

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

ACL Object: DefaultDeveloperACL
Software Component: COOWF@1.1

COOWF@1.1:GetObjectsConcerned

Retrieves the depending object for changes on the current object

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

ACL Object: DefaultDeveloperACL
Software Component: COOWF@1.1

COOWF@1.1:GetObjectWorkFlowMenu

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

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

Prototype: MenuGetActionPrototype
ACL Object: DefaultDeveloperACL
Software Component: COOWF@1.1

COOWF@1.1:GetParticipantContext

Retrieve the context object to fill the workflow participant

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

ACL Object: DefaultDeveloperACL
Software Component: COOWF@1.1

COOWF@1.1:GetParticipantContextAttribute

This action is called to retrieve the attribute definition to locate the context object for participant

AttributeObjectDef COOWF@1.1:GetParticipantContextAttribute(
out retval AttributeObjectDef attrdef)

Name	Description
attrdef	the result

Additional Information

ACL Object: DefaultDeveloperACL
Software Component: COOWF@1.1

COOWF@1.1:GetParticipantContextClass

This action is called to retrieve the object classes to which the context participant can be restricted

ObjectClass[] COOWF@1.1:GetParticipantContextClass(
out retval ObjectClass[] classes)

Name	Description
classes	the result

Additional Information

ACL Object: DefaultDeveloperACL
Software Component: COOWF@1.1

COOWF@1.1:GetParticipantListUsersGroups

Resolve the list participant to users an groups

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

ACL Object: DefaultDeveloperACL
Software Component: COOWF@1.1

COOWF@1.1:GetParticipantParentAttribute

This action is called to retrieve the attribute definition to locate the parent object for participant

AttributeObjectDef COOWF@1.1:GetParticipantParentAttribute(
out retval AttributeObjectDef attrdef)

Name	Description
attrdef	the result

Additional Information

ACL Object: DefaultDeveloperACL
Software Component: COOWF@1.1

COOWF@1.1:GetParticipantUsers

Get the user which are used as participants

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

ACL Object: DefaultDeveloperACL
Software Component: COOWF@1.1

COOWF@1.1:GetPrescribeActivityDefinitions

Get the usable activity definitions for prescriptions

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

ACL Object: DefaultDeveloperACL
Software Component: COOWF@1.1

COOWF@1.1:GetPrescribeDefault

This action is called by the user interface to retrieve the default settings, when a user chooses to prescribe activities. This is intended as the default parameters, that the user can modify to his needs.

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

ACL Object: DefaultDeveloperACL
Software Component: COOWF@1.1

COOWF@1.1:GetPrescribeTemplate

Gets the parsed and resolved prescription template

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

ACL Object: DefaultDeveloperACL
Software Component: COOWF@1.1

COOWF@1.1:GetPrescriptionEditorMode

Retrieve the display mode for the prescription editor

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

ACL Object: DefaultDeveloperACL
Software Component: COOWF@1.1

COOWF@1.1:GetPrescriptionHeadLine

Get title for prescription editor

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

ACL Object: DefaultDeveloperACL
Software Component: COOWF@1.1

COOWF@1.1:GetProcessParameter

Action to get a process parameter for a specified process. This action fails for users with are no participant of the process or have no access on the object of the process.

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

ACL Object: DefaultDeveloperACL
Software Component: COOWF@1.1

COOWF@1.1:GetProcessParameters

Action read all process parameters for a specified process. This action fails for users with are no participant of the process or have no access on the object of the process.

dictionary COOWF@1.1:GetProcessParameters(
out retval dictionary params)

Name	Description
params	process parameters

Additional Information

ACL Object: DefaultDeveloperACL
Software Component: COOWF@1.1

COOWF@1.1:GetPushNotificationSettings

Retrieve the configured push notification entries for an activity instance.
Push notification entries can be configured on activity definition, process definition level and global by use of an notification definition. After the available push notification settings have been calculated the action ExtendPushNotificationSettings is called to allow to do additional customizing of the notification settings.

PushNotificationEntryList[] COOWF@1.1:GetPushNotificationSettings(
out retval PushNotificationEntryList[] pushnotificationentries)