deWorkflowDefinition Members
The deWorkflowDefinition type exposes the following members.
Methods
| Name | Description | |
|---|---|---|
|
abortAllInstancesByStatus |
Abort all instances by status
|
|
|
addCommentsToItem |
addCommentsToItem
|
|
|
addToFavorites |
Adds to favorites.
|
|
|
addToHistory |
Adds to history.
|
|
|
archiveAllInstancesByStatus |
Archive all instances by status
|
|
|
archiveInstances |
Archives the instances.
|
|
|
changeOwner |
Changes the owner.
|
|
|
compareSnapshots |
compares the two snapshots and return the differences between the two
|
|
|
compareVariables |
compareVariables
|
|
|
computeDefinitionProjectionActivityCache |
Computes the definition projection activity cache2.
|
|
|
convertDefinitionXmlToMxgraphXml |
Converts the current UI Model definition XML into mxGraph compatiable XML.
|
|
|
copyDefinition |
Copies a given definition
|
|
|
copyDefinitionWithSubWorkflows |
Copies the definition with sub workflows.
|
|
|
createdByUser |
Createds the by user.
|
|
|
createInstance(String, String) |
create an instance passing the instance name and instance id
|
|
|
createInstance(String) |
create an instance from the definition
|
|
|
createSnapshot |
creates a snapshot of the definition
|
|
|
export |
Exports the definition
|
|
|
exportSnapshots |
Export form snapshots
|
|
|
exportStepPropertiesToXML |
Exports the step properties to XML.
|
|
|
exportToSQL |
Export the definition to SQL
|
|
|
exportWithSubWorkflows |
Exports the with sub workflows.
|
|
|
generateModelGraphic(String%, String%, Font, Color, Font, Color, Color, Color, Color, Color, Color, Boolean) |
generates a model graphic, lets you pass in parameters for colors, font
|
|
|
generateModelGraphic(String%, Font, Color, Font, Color) |
Generates an image of the design
|
|
|
generateModelGraphic(String%, Font) |
generate a graphic image of the workflow definition
|
|
|
generateModelGraphic(Bitmap%, Point%, Boolean, Font) |
Generates the model graphic.
|
|
|
generateModelGraphicCriticalPath |
Generates the model graphic critical path.
|
|
|
generateReport |
generates a report for the current definition
|
|
|
getActivities |
Gets the activities.
|
|
|
getComments |
get Comments for the definition
|
|
|
getCriticalPathFigures |
Gets the critical path figures.
|
|
|
getCurrentUser |
Gets the current user.
(Inherited from deAPIBase.) |
|
|
getDefinitionLockedByUser |
Gets the definition locked by user.
|
|
|
getDesign |
Gets the design.
|
|
|
getDetailData |
Gets the detail data.
|
|
|
getExportPackage |
Gets the export package.
|
|
|
getExportPackageItems |
Gets the export package items.
|
|
|
getFormVariableDesignSchemas |
Gets the form variable design schemas.
|
|
|
getGeneratedEvents |
Gets the generated events for the definition
|
|
|
getHistory |
get history
|
|
|
getHistoryDetails |
Gets the history details.
|
|
|
getInstanceCount |
Gets the instance count.
|
|
|
getInstances |
Gets the instances.
|
|
|
getInstancesByState |
Gets the state of the instances by.
|
|
|
getLatestSnapshot |
Gets the latest snapshot.
|
|
|
getListOfSnapshots |
returns a list of snapshots for the current definition
|
|
|
getListOfTags |
Gets the list of tags.
|
|
|
getNextAutoSnapshotIndex |
Gets the index of the next automatic snapshot.
|
|
|
getOpenTasks |
Gets the open tasks.
|
|
|
getParallelSteps |
Gets the parallel steps.
|
|
|
getProperties |
Gets the selected properties for the definition
|
|
|
getProperty(String) |
get property value
(Inherited from deAPIBase.) |
|
|
getProperty<(Of <<'(T>)>>)(String) |
Gets the property.
(Inherited from deAPIBase.) |
|
|
getRelatedObjects |
Gets the related objects.
|
|
|
getRelationChangesFromTarget |
Gets the relation changes from target.
|
|
|
getSnapshot |
gets a snapshot
|
|
|
getSnapshotCount |
Gets the snapshot count.
|
|
|
getSnapshots |
returns a list of snapshot objects
|
|
|
getStartFormVariables |
Gets the start form variables.
|
|
|
getStartGlobals |
Gets the start globals.
|
|
|
getStartVariables |
returns a collection of variables
|
|
|
getSubWorkflowDefinitions |
Gets the sub workflow definitions.
|
|
|
getSubWorkflowDefinitionsAtLevel |
Gets the sub workflow definitions at level.
|
|
|
getSubWorkflowInstanceCount |
Gets the sub workflow instance count.
|
|
|
getSubWorkflowInstances |
Gets the Sub-workflow instances.
|
|
|
getTaskAssignedTo |
Gets the task assigned to.
|
|
|
getTaskProjections |
Gets the task projections.
|
|
|
getTaskProjectionsWithConfiguration |
Gets the task projections with configuration.
|
|
|
getTaskReminders |
Gets the task reminder configuration data for the task.
task step id
|
|
|
getTenant |
Returns the current tenant
(Inherited from deAPIBase.) |
|
|
getTenantID |
Returns tenant id
(Inherited from deAPIBase.) |
|
|
getUIModel |
returns the UI model for the selected definition
|
|
|
getUniquePropertyValues |
Gets the unique property values.
|
|
|
getUserSession |
Gets the user session.
(Inherited from deAPIBase.) |
|
|
getUserWithLeastOpenTasks |
Gets the user with least open tasks.
|
|
|
hasSnapshot |
checks if a snapshot already exists for the definition
|
|
|
hasSnapshots |
Determines whether this instance has snapshots.
|
|
|
hasSubWorkflows |
Determines whether [has sub workflows].
|
|
|
hasWorkflowInstances |
Determines whether [has workflow instances].
|
|
|
import |
Imports the definition xml
|
|
|
importStepPropertiesFromXML |
Imports the step properties.
|
|
|
isDefinitionValid |
Determines whether [is definition valid].
|
|
|
isDesignEmpty |
Determines whether [is design valid].
|
|
|
lockDefinitionForDesign |
Locks the definition for design.
|
|
|
reAssignTasks |
Res the assign tasks.
|
|
|
removeAllComments |
Removes all comments.
|
|
|
removeAllInstances |
removes all instances for the current definition
|
|
|
removeAllInstancesByStatus |
Remove all instances by type
|
|
|
removeAllSnapshots |
remove all snapshots for the definition
|
|
|
removeAutoBackupSnapshots |
Removes the automatic backup snapshots.
|
|
|
removeDetailData |
Removes the detail data.
|
|
|
removeFromFavorites |
Removes from favorites.
|
|
|
removeResourceItem |
Removes the resource item.
|
|
|
removeSnapshot |
removes a given snapshot from the definition
|
|
|
renderSnapshotCompare |
generates the two images with the changes
|
|
|
toBPMN |
Converts to BPMN Format
|
|
|
toXML |
returns the xml version of the definition
|
|
|
unlockDefinitionFromDesign |
Unlocks the definition from design.
|
|
|
updatedByUser |
Updateds the by user.
|
|
|
updateDefinition(clsUIModel, definitionSaveType) |
Updates the definition.
|
|
|
updateDefinition(String, definitionSaveType) |
updates the definition
|
|
|
updateDetailData |
Updates the detail data.
|
|
|
updateProperties |
updates the properties of the definition
|
|
|
updateWaitingInstanceDesign |
Updates the waiting instance design.
|
|
|
updateWaitingInstancesDesign |
Updates the waiting instances design.
|
|
|
validateDefinition |
Validates the definition.
|
Properties
| Name | Description | |
|---|---|---|
|
connectionString |
gets the connection string for the database
(Inherited from deAPIBase.) |
|
|
defID |
returns definition ID
|
|
|
definitionName |
Gets the name of the definition.
|
|
|
defXML |
Gets the definition XML.
|
|
|
errorMsg |
return last error message
(Inherited from deAPIBase.) |
|
|
externalUserID |
Gets the external user identifier.
(Inherited from deAPIBase.) |
|
|
generateEvents |
Gets or sets a value indicating whether [generate events].
|
|
|
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.) |