deRuntime Members
The deRuntime type exposes the following members.
Constructors
| Name | Description | |
|---|---|---|
|
deRuntime(String, String, IErrorProvider) |
deRuntime class constructor
|
|
|
deRuntime(deUserSession) |
Initializes a new instance of the deRuntime class.
|
|
|
deRuntime(String, String, String) |
Initializes a new instance of the deRuntime class.
|
Methods
| Name | Description | |
|---|---|---|
|
|
abortInstance |
Aborts the instance.
|
|
|
archiveInstance |
Archives the instance.
|
|
|
archiveInstanceByUpdateDate |
Archives all instances older than number of days provided
|
|
|
archiveInstanceByUpdateDateAndStatus |
Archives the instance by update date and status.
|
|
|
archiveInstances |
Archives the instances.
|
|
|
archiveInstancesByStatus |
Archives the instances by status.
|
|
|
archiveInstancesByUpdateDate(DateTime, DateTime) |
Archives the instances by update date.
|
|
|
archiveInstancesByUpdateDate(DateTime) |
Archives the instances by update date.
|
|
|
clearEngineAlerts |
Clears all the engine alerts
|
|
|
closeEngineAlert |
Closes the engine alert.
|
|
|
closeNotification |
Closes the notification.
|
|
|
createNotification |
Creates the notification.
|
|
|
createTask |
Creates the task.
|
|
|
generateNextInstanceIndex |
generate the next index for the selected instance name
|
|
|
getAllInstanceList |
Gets all instance list.
|
|
|
getAllOpenTasks |
Gets all open tasks.
|
|
|
getArchivedInstance |
Gets the archived instance.
|
|
|
getArchivedInstances |
Gets the archived instances.
|
|
|
getArchivedInstancesByStatus |
Gets the archived instances by status.
|
|
|
getArchivedInstancesByUpdateDate |
Gets the archived instances by date.
|
|
|
getArchivedInstancesByUser |
Gets the archived instances by user.
|
|
|
getArchiveInstanceUsingName |
returns the archived instance using the instance name
|
|
|
getCurrentUser |
Gets the current user.
(Inherited from deAPIBase.) |
|
|
getEngineAlert |
Gets the engine alert.
|
|
|
getExpiredOpenTasks |
Gets the expired tasks to send email notifications.
|
|
|
getFavoriteInstancesForUser |
Get the Favorite Instances For User
|
|
|
getInstance |
gets a given instance
|
|
|
getInstances(String, String) |
get instances created by an user
|
|
|
getInstances(executionStatus) |
get instances based on instance status
|
|
|
getInstancesByState |
Gets instances by states.
|
|
|
getInstancesByStatus |
Gets the instances by status.
|
|
|
getInstancesData |
getInstancesData
|
|
|
getInstancesWithTasks |
Gets the instances with tasks.
|
|
|
getInstanceUsingName |
returns the instance using the instance name
|
|
|
getLastArchivedInstances |
Gets the archived instances last.
|
|
|
getLastModifiedInstances |
Gets the last modified instances.
|
|
getLicenseStatus |
Gets the license status.
|
|
|
getNotificationData |
Gets the notification data.
|
|
|
getOpenTasks |
get only open tasks for a given user
|
|
|
getProperties |
Gets the properties.
(Inherited from deAPIBase.) |
|
|
getProperty(String) |
get property value
(Inherited from deAPIBase.) |
|
|
getProperty<(Of <<'(T>)>>)(String) |
Gets the property.
(Inherited from deAPIBase.) |
|
|
getTask(String) |
Gets the task.
|
|
|
getTask(String, String) |
Gets the task.
|
|
|
getTaskData |
gets a tasks and its information
|
|
|
getTasks |
Returns all tasks from the system from a given user
|
|
|
getTenant |
Returns the current tenant
(Inherited from deAPIBase.) |
|
|
getTenantID |
Returns tenant id
(Inherited from deAPIBase.) |
|
|
getUserSession |
Gets the user session.
(Inherited from deAPIBase.) |
|
|
getUsersWithOpenTasks |
Gets the users with open tasks.
|
|
|
getUserWithLeastOpenTasks |
Gets the user with least open tasks.
|
|
|
instanceNameExits |
Checks if the instance name exists
|
|
|
processInstanceItems |
Processes the instance items.
|
|
|
reAssignAllOpenTasksToDelegatedUsers | |
|
|
reAssignAllTasks |
ReAssigns all tasks from one user to another
|
|
|
reAssignOpenTasksFromDelegatedUsers |
Res the assign open task from delegated user.
|
|
|
removeAllArchivedInstances |
removes all Archived instances
|
|
|
removeAllProcessedEngineAlerts |
Removes all engine alerts.
|
|
|
removeAllWorkflowInstances |
Removes all workflow instances.
|
|
|
removeArchivedInstance |
Removes the archived instance.
|
|
|
removeArchivedInstancesByStatus |
removes Archived instances By Status
|
|
|
removeEngineAlert(deEngineAlert) |
Removes the engine alert.
|
|
|
removeEngineAlert(String) |
Removes the engine alert.
|
|
|
removeEngineAlertByStatus |
Removes the engine alert by status.
|
|
|
removeEngineAlerts |
Removes the engine alerts.
|
|
|
removeEngineAlertsByPeriod |
Removes the engine alerts by period.
|
|
|
removeEngineAlertsWithNoInstances |
Removes the engine alerts with no instances.
|
|
|
removeFavoriteInstancesForUser |
Removes the favorite instances for user.
|
|
|
removeInstance |
removes an instance
|
|
|
removeInstanceBeforeStartDate |
Removes the instance before start date.
|
|
|
removeInstancesByStatus |
Removes the instance by status.
|
|
|
removeInstancseWithoutDefinitions |
remove instances without any definition
|
|
|
removeNotification |
Removes the notification.
|
|
|
removeTasksWithoutInstance |
removing tasks with no instance
|
|
|
runEngine |
Runs the engine.
|
Properties
| Name | Description | |
|---|---|---|
|
connectionString |
gets the connection string for the database
(Inherited from deAPIBase.) |
|
|
errorMsg |
return last error message
(Inherited from deAPIBase.) |
|
|
executionMode |
get/set the execution mode of the engine
|
|
|
externalUserID |
Gets the external user identifier.
(Inherited from deAPIBase.) |
|
|
generateEvents |
Gets or sets a value indicating whether [generate events].
|
|
|
getWorkflowUserID |
returns the workflow user id
|
|
|
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.) |