Class COOWF@1.1:WaitActionInstance

Class Hierarchy

Object > InstanceElement > WaitActionInstance

Objects of this class are used for an activity in a process instance that represents a wait action instead of a list of work items. This action can be a Action or an ActiveX script. It can be used to delay the workflow process e.g. until a certain state in an external resource is reached. Wait actions are always executed in the background, therefore this functionality requires the installation of an AT service.
E.g. you can use a wait action definition for asynchronous calls of an external application server. The first execution of the action starts as asynchronous query in the application server, the further calls wait for the query result. The wait action is called until the result of the application server is finished. The amount of time after which the execution of the action is repeated can be specified.
You can also use a wait action definition to execute activities that wait for the availability of certain external application server resources. A customer should be registered in a billing system. The workflow continues only when the registration in the billing system has been done. The wait action instance is just called again, if the registration failed (e.g. because the system is not available).

Additional Information

Programmatic Use
Symbol: SymbolActivity
Default Main Menu: MenuRootFolder
Default Background Menu: MenuRootWinContext
Default Context Menu: MenuRootWaitActionContext
Default Context Menu (Container Independent): MenuRootDirectContext
Action for Moving Objects: DragIntoMove
Action for Linking Objects: DragIntoLink
Action for Copying Objects: DragIntoCopy
ACL Object: DefaultGlobalACL
Software Component: COOWF@1.1

Properties

Type	Property	Name
InstanceElement[]	actinstcommonactivities	My Activities in Progress
string	actinstcommonid	Identifier for Activities in Related Processes
InstanceElement[]	actinstcommonrunning	All Activities in Progress
InstanceElement[]	actinstcommonsiblings	Activities Started Together
date	actinstcompletedat	Completed on/at
WorkFlowConditionalWaitAction	actinstconditionalwaitaction	Condition
boolean	actinstdispcommon	Display as Activity Started Together
date	actinstenddeadline	To Complete at the Latest by
date	actinstescalatedat	Escalated on/at
EscalationDefinition	actinstescalation	Escalation
InstanceElement[]	actinstinstance	Activity Itself
ActivityInstanceState	actinstlaststate	Last State of Activity
MultiInstanceType	actinstmultiple	Multi-Instance
InstanceElement[]	actinstnext	Successor Activities
integer	actinstnrcall	Number of Calls
Object[]	actinstobject	Applies to
Object	actinstpartdefinition	Distribution List
WorkFlowParticipant	actinstparticipant	Workflow Participant
InstanceElement[]	actinstprev	Predecessor Activities
Object	actinstprocdefinition	Process Definition
date	actinstreceivedat	Received on/at
ResourceDefinition	actinstresource	Resource Used
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
User	actinststatechangedby	Last State Change by
ActivityStatistic	actinststatistic	Activity Instance Statistic
LanguageStringList[]	actinsttitle	Title
WorkFlowWaitAction	actinstwaitaction	Wait Action
date	actinstwaitactionextcheckat	Next Condition Evaluation on/at
WaitActionEventType	actinstwaitactiontype	Wait Action Type

Actions

Return Type	Signature
void	AddRecentlyUsed( object context, optional object[] additionalobjects)
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	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)
string	AttrSignaturesGetDisp( AttributeDefinition attrdef, out retval string string, optional any value, optional Language language, optional AttributeDefinition[] attrdeflist, optional integer flags, optional integer index)
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)
void	CheckDestination( optional boolean ignoremetaparticipant, optional boolean strict, optional boolean resolvemetaparticipant)
WorkFlowOrgSecurity	CheckRemoveOrgElements( out retval WorkFlowOrgSecurity orgsecurity)
void	ComputeDeadLine( object attrdef)
void	ExecuteBackgroundWork()
Breadcrumb[]	GetBreadCrumbPreWrapper( out retval Breadcrumb[] breadcrumb, ref optional AttributeDefinition view, ref optional object context)
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)
NotificationEntryList[]	GetNotificationSettings( out retval NotificationEntryList[] notificationentries)
object[]	GetParticipantUsers( out retval object[] users, optional boolean ignoregroupposition, optional boolean activeusersonly)
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)
void	ModifyPage( object form, object page, UIVerb uiverb, object action, ref PageItemList[] formpageitems, object objclass, ref string formpagelabel, ref object formpageicon, dictionary localscope)
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	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	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)
boolean	UseRestrictedAccessForm( out retval boolean userestricedform)
boolean	UserIsParticipant( out retval boolean isparticipant, optional object user, optional WorkFlowParticipant checkpart)