2022 April Release

Class COOWF@1.1:ActivityInstance Permanent link for this heading

Class Hierarchy

Object > InstanceElement > ActivityInstance

This object class is used to describe an activity (a logical step) in a process instance. It defines who has to do what when. An activity instance can be created on the fly in a process instance or it can be created based on an activity definition as template. If an activity instance is created from an activity definition the relative deadlines are replaced with absolute dates (based on calendar days).

Additional Information

Properties Permanent link for this heading

Type

Property

Name

integer

actdefendworkdays

Days to the Latest Possible Completion

integer

actdefstartworkdays

Days to the Latest Possible Start

integer

actdefsubmitworkdays

Days Until Visibility in Worklist

AccessType[]

actinstaccess

Required Access Types

boolean

actinstactivatedmanually

Activated Manually

ActivityInstance

actinstbackactivityfor

Back-Activity for

boolean

actinstbackground

Execute in Background

string[]

actinstbackgroundexpression

Expression for Skript Activities

User

actinstbfinishedby

Finished by

integer

actinstcolor

Color of Activity in Processexplorer

InstanceElement[]

actinstcommonactivities

My Activities in Progress

string

actinstcommonid

Identifier for Activities in Related Processes

Object[]

actinstcommonobjects

Applies to

CommonProcsChart[]

actinstcommonprocschart

Overview of Related Processes

CommonRunningChart[]

actinstcommonrrunningchart

Overview of Activities in Progress

InstanceElement[]

actinstcommonrunning

All Activities in Progress

InstanceElement[]

actinstcommonsiblings

Activities Started Together

date

actinstcompletedat

Completed on/at

PrescriptionMetaDataWho[]

actinstdelegatemultipleparticipants

Assign Activity to the Following Workflow Participants

boolean

actinstdispcommon

Display as Activity Started Together

boolean

actinstdisplayonlywithaccess

Display Activity Only if the Participant Has Access to Affected Object

string

actinstenclosure

Enclosures

date

actinstenddeadline

To Complete at the Latest by

date

actinstescalatedat

Escalated on/at

EscalationDefinition

actinstescalation

Escalation

ActivityExecutionType

actinstexecutiontype

Execution Type

boolean

actinstexternalsync

Activity Is an External Synchronization Point

boolean

actinstignorecomplete

Ignore Completion

boolean

actinstignoreinvpart

Skip Invalid Participant

InstanceElement[]

actinstinstance

Activity Itself

boolean

actinstkeepstarted

Started Activity Remains in All Worklists

ActivityInstanceState

actinstlaststate

Last State of Activity

string

actinstmultiinstancekey

Multi Instance Key

MultiInstanceType

actinstmultiple

Multi-Instance

InstanceElement[]

actinstnext

Successor Activities

boolean

actinstnopersonalsubst

Disable Personal Substitution

boolean

actinstnosubst

Disable Substitution

ActivityNotificationParams[]

actinstnotificationparams

Parameters for Asynchronous Notifications

Object[]

actinstobject

Applies to

Object[]

actinstobjects

Objects Concerned

string[]

actinstoldremarks

Preceded Remarks

Object

actinstpartdefinition

Distribution List

WorkFlowParticipant

actinstparticipant

Workflow Participant

WorkFlowParticipant

actinstpartmansubst

Manual Entry by

User

actinstpartuser

As Substitute of

User[]

actinstpartwithoutaccess

Participants Without Access Rights

ActivityDefinition

actinstprescrback

Activity Back

WorkFlowPrescriptionBlockList[]

actinstprescrblocks

Additional Prescriptions

WorkFlowPrescriptionList[]

actinstprescription

Prescriptions

PrescriptionMetaDataWhat

actinstprescrmetawhat

What

PrescriptionMetaDataWhen

actinstprescrmetawhen

Deadlines

PrescriptionMetaDataWhenWorkDays

actinstprescrmetawhenworkdays

Deadlines

PrescriptionMetaDataWho

actinstprescrmetawho

Who

Object[]

actinstprescrobjects

Objects Concerned by Prescription

boolean

actinstprescrparallel

Parallel

InstanceElement[]

actinstprev

Predecessor Activities

WorkFlowPriority

actinstpriority

Workflow Priority

Object

actinstprocdefinition

Process Definition

date

actinstreceivedat

Received on/at

string

actinstremark

Hint

ResourceDefinition

actinstresource

Resource Used

boolean

actinstretractable

Is Retractable

date

actinstscheduledat

Scheduled for Execution

SignatureList[]

actinstsignatures

Signatures

date

actinststartdeadline

To Start at the Latest by

date

actinststartedat

Started on/at

ActivityInstanceState

actinststate

State of Activity

WorkFlowStateActionList[]

actinststateactions

State Change Actions

User

actinststatechangedby

Last State Change by

ActivityStatistic

actinststatistic

Activity Instance Statistic

WorkFlowSubmissionList[]

actinstsubmission

Submission Dates

date

actinstsubmitdeadline

Visible in Worklist From

date

actinstsubmittedat

Ready to Receive on/at

Group[]

actinstsubstgroups

Substitutions (Groups)

User

actinstsubstuser

As Substitute of

User[]

actinstsubstusers

Substitutions (Users)

User[]

actinstsubstwithoutaccess

Substitutes Without Access Rights

ActivityDefinition

actinstterminatedactdef

Following Activity after Rejection

LanguageStringList[]

actinsttitle

Title

ActivityType

actinsttype

Activity Type

WorkFlowWorkList[]

actinstwork

Work Items

Action

actinstworklistfilter

Action to Filter Activities in Worklist

ActivityDefReference

assocactdefref

Associated Activity Definition Reference

SubmissionRepetitionPeriod

submissionrepetitionperiod

Submission on/in

WorkFlowParticipant

wfsparticipant

Participant

WorkFlowParticipant

wfspartmansubst

Manual Entry by

Actions Permanent link for this heading

Return Type

Signature

void

AddPrescription(
  ref WorkFlowPrescriptionList[] prescription,
  SavePresciptionActionType action,
  ref optional integer pblockidx,
  ref optional integer pidx,
  optional WorkFlowPrescriptionBlockList[] prescriptionblocks)

void

AddRecentlyUsed(
  object context,
  optional object[] additionalobjects)

void

AmendSubstitutePermissions(
  optional boolean locked)

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)

void

AttrObjDisplayEffectGet(
  AttributeDefinition attrdef,
  ref any value,
  out optional boolean volatile,
  out optional boolean volatiletx)

void

AttrObjDisplayEffectGetVersion(
  AttributeDefinition attrdef,
  integer versnr,
  ref any value,
  out optional boolean volatile,
  out optional boolean volatiletx)

void

AttrObjFontEffectGet(
  AttributeDefinition attrdef,
  ref any value,
  out optional boolean volatile,
  out optional boolean volatiletx)

void

AttrObjFontEffectGetVersion(
  AttributeDefinition attrdef,
  integer versnr,
  ref any value,
  out optional boolean volatile,
  out optional boolean volatiletx)

void

AttrPrescriptionBlockConstructor(
  object attrdef,
  out any value,
  any[] oldvalues)

void

AttrPrescriptionLineConstructor(
  object attrdef,
  out any value,
  any[] oldvalues)

string

AttrSignaturesGetDisp(
  AttributeDefinition attrdef,
  out retval string string,
  optional any value,
  optional Language language,
  optional AttributeDefinition[] attrdeflist,
  optional integer flags,
  optional integer index)

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

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)

object[]

CheckAdditionalParticipantRestrictions(
  ref retval object[] participants)

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)

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

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)

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)

void

CheckSubmissionRepetitionPeriod(
  SubmissionRepetitionPeriod repetitionperiod,
  out string checkresult,
  out boolean error,
  out string askquestion)

boolean

CheckTakenOver(
  out retval boolean allowed)

void

ComputeDeadLine(
  object attrdef)

boolean

ConfirmStart(
  integer parenthandle,
  object context,
  out retval boolean yes)

boolean

EvaluatePrecondition(
  integer wfwidx,
  out retval boolean notexecuteable,
  out boolean hidden,
  optional boolean silent)

void

ExecuteBackgroundWork()

WorkFlowPrescriptionList[]

ExtractSubPrescription(
  WorkFlowSubPrescriptionList[] source,
  out retval WorkFlowPrescriptionList[] extractedprescription)

void

GetActiveMailPortalPart(
  out object portalpart)

object

GetAdditionalTaskTarget(
  out retval object target,
  optional boolean checktaskpane,
  optional AdditionalTaskDisplayMode displaymode)

string

GetAdditionalTaskTargetMenuCaption(
  out retval string caption,
  out optional Symbol symbol,
  out optional boolean nosubmenus)

string

GetBreadcrumbObjectName(
  out retval string name,
  optional object contextobject)

Breadcrumb[]

GetBreadCrumbPreWrapper(
  out retval Breadcrumb[] breadcrumb,
  ref optional AttributeDefinition view,
  ref optional object context)

string

GetConfiguredSender(
  out retval string sender)

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)

DisplayColumnList[]

GetDisplayProperties(
  out retval DisplayColumnList[] displaycolumnlist,
  optional dictionary userenvsettings)

void

GetEnterObjectStatus(
  out boolean venv_closeenterobject,
  object venv_parent,
  object venv_object,
  object venv_view,
  out boolean venv_navigatetonext)

string[]

GetHeader(
  out retval string[] header)

string

GetHighchartsJSON(
  AttributeDefinition attrdef,
  any value,
  out retval string json)

object

GetHolidayTableObject(
  out retval object holidaytable)

datetime

GetNextSuspensionDate(
  out retval datetime suspensiondatetime,
  SubmissionRepetitionPeriod repetitionperiod)

NotificationEntryList[]

GetNotificationSettings(
  out retval NotificationEntryList[] notificationentries)

void

GetObjectInfo(
  out optional object targetobject,
  out optional string[] description,
  out optional string imagepath,
  out optional CardStyle imagestyle,
  optional object view)

object[]

GetParticipantUsers(
  out retval object[] users,
  optional boolean ignoregroupposition,
  optional boolean activeusersonly)

object

GetPDFOverviewSource(
  out retval object pdfoverviewsource)

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)

string

GetPrescriptionHeadLine(
  out retval string headline,
  out string label,
  out string prescrlabel,
  optional boolean processmultiplecommon)

PushNotificationEntryList[]

GetPushNotificationSettings(
  out retval PushNotificationEntryList[] pushnotificationentries)

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)

string

GetSendBackgroundFrom(
  out retval string from,
  boolean usedefaultsender,
  optional Language userlang)

WorkFlowSubmissionList[]

GetSubmissionDefault(
  out retval WorkFlowSubmissionList[] submissions)

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)

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)

boolean

HasAdditionalParticipantRestrictions(
  out retval boolean additionalrestrictions)

object

InsertActivityInstance(
  WorkFlowParticipant participant,
  WorkFlowParticipant partmansubst,
  LanguageStringList[] actinsttitle,
  ActivityType actinsttype,
  boolean copyactivity,
  out retval object actinst)

boolean

IsEditable(
  out retval boolean iseditable)

boolean

IsPDFOverviewObject(
  out retval boolean isoverview)

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

NormalizeNestedPrescriptions(
  ref WorkFlowPrescriptionBlockList[] blocks)

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

RemovePrescription(
  ref WorkFlowPrescriptionList[] prescription,
  ref optional integer pblockidx,
  ref optional integer pidx)

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)

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

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

SetRetracted(
  optional integer handle,
  optional integer index,
  optional string remark,
  optional boolean remarkdefined)

void

SetSkipped(
  optional integer unused1,
  optional integer unused2)

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

ShowConcernedObjectsSelection(
  ref object[] objectsconcerned,
  ref boolean objectsconcernedrestricted,
  out optional boolean show)

void

UpdatePrescriptions(
  object attrdef)

boolean

UseRestrictedAccessForm(
  out retval boolean userestricedform)

boolean

UserIsParticipant(
  out retval boolean isparticipant,
  optional object user,
  optional WorkFlowParticipant checkpart)

boolean

WFIsWorkItemCalledByWebservice(
  out retval boolean calledbywebservice)