deWorkflowInstance Members
The deWorkflowInstance type exposes the following members.
Methods
| Name | Description | |
|---|---|---|
|
addErrorMessageToExecutionIteration |
Adds the error message to execution iteration.
|
|
|
addInvolvedUsers |
Adds the involved users.
|
|
|
addMessageToExecutionIteration |
adds a message to an execution iteration
|
|
|
addToFavorites |
Adds to favorites.
|
|
|
addToHistory |
Adds to history.
|
|
|
changeStatus |
update the status of the instance
|
|
|
closeAllOpenTasks()()()() |
Closes all open tasks.
|
|
|
closeAllOpenTasks(String, String, String) |
closes all open tasks for the instance, step and iteration
|
|
|
completeStep |
Completes the step.
|
|
|
computeInstanceProjectionActivityCache |
Computes the instance projection activity cache.
|
|
|
continueParentWorkflow |
Continues the execution of the parent workflow
|
|
|
continueRouteStep |
continues the route step once the tasks are completed
|
|
|
createEngineAlert |
Creates the engine alert.
|
|
|
createNotification |
Creates the notification.
|
|
|
definitionHasChanged |
Determines if the definition has changed
|
|
|
execute(Hashtable, Hashtable, Boolean, instancePriority, Boolean, String) |
executes the instance and remembers the variable values
|
|
|
execute(Hashtable, Hashtable, instancePriority, Boolean, String) |
Executes the specified o variable default values.
|
|
|
execute(Boolean, String) |
execute the instance
|
|
|
execute(Hashtable, Hashtable, Boolean, String) |
Executes the specified o variable default values.
|
|
|
execute(Hashtable, Hashtable, Nullable<(Of <<'(DateTime>)>>), Boolean, String) |
Executes the specified o variable default values.
|
|
|
execute(Hashtable, Hashtable, Nullable<(Of <<'(DateTime>)>>), instancePriority, Boolean, String) |
Executes the specified o variable default values.
|
|
|
execute(Hashtable, Hashtable, Hashtable, Boolean, Boolean, Nullable<(Of <<'(DateTime>)>>), instancePriority, Boolean, Boolean, String) |
Executes the specified o variable default values.
|
|
|
execute(Hashtable, Hashtable, Boolean, Boolean, Nullable<(Of <<'(DateTime>)>>), instancePriority, Boolean, Boolean, String, Hashtable) |
Executes the instance.
|
|
|
export |
Exports the instance
|
|
|
exportAllTaskAttachments |
To get a zip for all task attachments
|
|
|
exportStepPropertiesToXML |
Exports the step properties to XML.
|
|
|
exportToSQL |
Export the instance to SQL.
|
|
|
exportWithSubWorkflows |
Exports the with sub workflows.
|
|
|
generateModelExecutionTaskGraphic(String%, String%, Boolean) |
generate a execution view with only tasks steps
|
|
|
generateModelExecutionTaskGraphic(String%, String%, Boolean, Font, Color, Font, Color) |
generate a execution view with only tasks steps
|
|
|
generateModelExecutionViewGraphic(String%, String%, Font, List<(Of <<'(String>)>>)) |
generate execution view of the instance
|
|
|
generateModelExecutionViewGraphic(String%, String%, Int32, Int32) |
Generates the model execution view graphic.
|
|
|
generateModelExecutionViewGraphic(String%, String%, Boolean, Font, Color, Font, Color, List<(Of <<'(String>)>>)) |
generate execution view of the instance
|
|
|
generateModelGraphic(Boolean, String%, String%, Font, Color, Font, Color, Color, Color, Color, Color, Color, Boolean, Nullable<(Of <<'(Color>)>>)) |
renders the execution
|
|
|
generateModelGraphic(Boolean, String%, String%, Font, Color, Font, Color, Color, Color, Color, Color, Color, Boolean, Dictionary<(Of <<'(Int32, Point>)>>)%, List<(Of <<'(String>)>>)%, Nullable<(Of <<'(Color>)>>)) |
Generates the model graphic.
|
|
|
generateModelGraphic(Boolean, String%, String%, Font, Color, Font, Color, Nullable<(Of <<'(Color>)>>)) |
generate execution view of the instance
|
|
|
generateModelGraphic(Boolean, String%, String%, Font, Color, Font, Color, Boolean) |
generate execution view of the instance
|
|
|
generateModelGraphic(Boolean, String%, String%, Font, Color, Font, Color, Color, Color, Color, Color, Color) |
generate execution view of the instance
|
|
|
generateModelGraphic(Boolean, String%, Font) |
generate a model graphic
|
|
|
generateModelGraphicCriticalPath |
Generates the model graphic critical path.
|
|
|
GenerateReport |
generates a report for the current instance
|
|
|
getActivitiesForActualData |
Gets the activities for actual data.
|
|
|
getBusinessObjectData |
returns the columns from the xLinks table
|
|
|
getBusinessObjects |
Gets the business objects.
|
|
|
getChildWorkflowTree |
Gets the child workflow tree.
|
|
|
getCurrentUser |
Gets the current user.
(Inherited from deAPIBase.) |
|
|
getDefinition |
Gets the definition.
|
|
|
getEngineAlert |
Gets the engine alert.
|
|
|
getEngineAlertData()()()() |
Gets the engine alert data.
|
|
|
getEngineAlertData(String, String) |
Gets the engine alert data.
|
|
|
getEngineAlerts |
Gets the engine alerts.
|
|
|
getExecutionErrors |
Gets the execution errors.
|
|
|
getExecutionIterations |
returns the execution iterations of each step as a sorted list
|
|
|
getFormVariableDesignSchemas |
Gets the form variable design schemas.
|
|
|
getFormVariableRuntimeSchemas |
Gets the form variable runtime schemas.
|
|
|
getGeneratedEvents |
Gets the generated events for the instance
|
|
|
getGlobals |
Gets the globals.
|
|
|
getHistory |
get history
|
|
|
getHistoryDetails |
Gets the history details.
|
|
|
getInvolvedUsers |
Gets the involved users.
|
|
|
getLevel |
Gets the level on the heirachy.
|
|
|
getListOfForms |
Gets the list of forms involved within the workflow instance
|
|
|
getListOfTags |
Gets the list of tags.
|
|
|
getLogMessages |
Returns log messages from each executed step
|
|
|
getMasterVariables |
Gets the master variables.
|
|
|
getMessageWaitingIterations |
Gets the message waiting iterations.
|
|
|
getOpenTaskData |
Gets the open tasks for the instance
|
|
|
getOpenTasks |
Gets the open tasks.
|
|
|
getParentInstance |
Gets the parent instance.
|
|
|
getParentInstances |
Get parent workflow instances
|
|
|
getPlannedCriticalPathFigures |
Gets the planned critical path figures.
|
|
|
getProperties |
returns the properties for the instance
|
|
|
getProperty(String) |
get property value
(Inherited from deAPIBase.) |
|
|
getProperty<(Of <<'(T>)>>)(String) |
Gets the property.
(Inherited from deAPIBase.) |
|
|
getRequiredGlobals |
Gets the required globals.
|
|
|
getRequiredVariables |
Gets required variables.
|
|
|
getRootInstance |
Gets the top most workflow
|
|
|
getStartAfterReset |
gets the starting step after a reset point
|
|
|
getStartDatTime |
Gets the start dat time.
|
|
|
getStartEngineAlert |
Gets the start engine alert.
|
|
|
getStartStepVariablesAndValues |
Gets the start step variables and values.
|
|
|
getStartVariablesAndGlobals |
Gets the start variables and globals.
|
|
|
getStartVariablesGlobalsAndFormVariables |
Gets the start variables globals and form variables.
|
|
|
getStates |
Gets the states.
|
|
|
getStatus |
Gets the status.
|
|
|
getStep |
returns a step based on the step id
|
|
|
getStepExecuteElapsedTime |
Gets the step execute elapsed time.
|
|
|
getStepExecutionInformaton |
gets information for a given step and iteration
|
|
|
getStepExecutions |
Gets the step executions.
|
|
|
getSteps |
returns a collection of steps
|
|
|
getSubWorkflowInstanceCount |
Gets the sub workflow instance count.
|
|
|
getSubWorkflowInstanceData |
Gets the sub workflow instance data.
|
|
|
getSubWorkflowInstances |
Gets the sub workflow instances.
|
|
|
getSubWorkflowUIModels |
Gets the sub workflow UI models.
|
|
|
getTaskAssignedTo |
Gets the task assigned to.
|
|
|
getTaskProjections |
Gets the task projections.
|
|
|
getTaskProjectionsWithConfiguration |
Gets the task projections with configuration.
|
|
|
getTaskReminders |
Gets the task reminders.
|
|
|
getTasks()()()() |
returns the list of tasks for the instance
|
|
|
getTasks(String, Int32) |
Gets the tasks.
|
|
|
getTasks(String) |
Gets the tasks.
|
|
|
getTenant |
Returns the current tenant
(Inherited from deAPIBase.) |
|
|
getTenantID |
Returns tenant id
(Inherited from deAPIBase.) |
|
|
getTimeLeftPercent |
Gets the time left percent.
|
|
|
getUIModel |
return the UI model object
|
|
|
getUniquePropertyValues |
Gets the unique property values.
|
|
|
getUsers |
Gets the users.
|
|
|
getUserSession |
Gets the user session.
(Inherited from deAPIBase.) |
|
|
getWaitMessages |
Gets the wait messages.
|
|
|
getWaitSteps |
Gets the wait steps.
|
|
|
hasChanged |
Determines whether the specified o dt has changed.
|
|
|
hasNotStartedOrExecutingEngineAlerts |
Determines whether instance has [not started or executing engine alerts].
|
|
|
instanceHasSubWorkflows |
returns if the instance has sub-workflow instances
|
|
|
isChildWorkflow |
Determines whether [is child workflow].
|
|
|
isDesignEmpty |
Determines whether [is design valid].
|
|
|
isParentWorkflow |
Determines whether [is parent workflow].
|
|
|
isTestMode |
Determines whether [is test mode].
|
|
|
jumpToStep |
Jumps to step.
|
|
|
markQueueItemsAssigned |
Marks the queue items assigned.
|
|
|
reAssignAllOpenTasks |
Res the assign all open tasks.
|
|
|
removeFromFavorites |
Removes from favorites.
|
|
|
removeNotifications |
Removes the notifications.
|
|
|
removeStates |
Removes the states by item identifier.
|
|
|
removeSubWorkflowInstances |
removes all subworkflow instances
|
|
|
resendOpenTaskNotifications()()()() |
Resends the open task notifications.
|
|
|
resendOpenTaskNotifications(Boolean, String, array<String>[]()[][]) |
Resends the open task notifications.
|
|
|
reset |
resets the instance
|
|
|
resetAllNotProcessedStepsFromDefinition |
Resets all not processed steps from definition.
|
|
|
resetBackToFigure(String, String, Boolean) |
resets the instance back to selected step and iteration
|
|
|
resetBackToFigure(String, Boolean) |
resets the instance back to step based on the execution id
|
|
|
resetBackToFirstFigureIteration |
resets the instance back to a selected step's first iteration
|
|
|
resetBackToLastFigureIteration |
resets the instance back to a selected steps last iteration
|
|
|
resetStepPropertiesFromDefinition |
Resets the step properties from definition.
|
|
|
sendMessageToWaitSteps |
Sends the message to wait steps.
|
|
|
setState |
Set state for instance
|
|
|
toXML |
returns the xml version of the instance
|
|
|
updateGlobals |
Updates the globals.
|
|
|
updateInstanceXML(String, executionStatus) |
updates the instance xml
|
|
|
updateInstanceXML(clsUIModel) |
Updates the instance XML.
|
|
|
updateInstanceXML(String) |
updates the XML for the instance
|
|
|
updateMasterVariables |
Updates the master variables.
|
|
|
updateProperties |
updates the instance properties
|
|
|
updateWaitingSteps |
Updates the waiting steps.
|
Properties
| Name | Description | |
|---|---|---|
|
connectionString |
gets the connection string for the database
(Inherited from deAPIBase.) |
|
|
errorMsg |
return last error message
(Inherited from deAPIBase.) |
|
|
executionPriority |
Gets or sets the instance priority.
|
|
|
externalUserID |
Gets the external user identifier.
(Inherited from deAPIBase.) |
|
|
generateEvents |
Gets or sets a value indicating whether [generate events].
|
|
|
instanceID |
return the ID of the instance
|
|
|
instanceName |
Gets the name of the instance.
|
|
|
isMasterTenant |
return if the session is for the master tenant
(Inherited from deAPIBase.) |
|
|
isMultiTenant |
returns if the API is being used on multi-tenant mode
(Inherited from deAPIBase.) |
|
|
oErrorProvider |
Gets the o error provider.
(Inherited from deAPIBase.) |
|
|
tenantMasterConnectionString |
gets the tenant master database connection string
(Inherited from deAPIBase.) |
|
|
workflowUserID |
returns the user id
(Inherited from deAPIBase.) |