Therefore Programming Interface 3.0

Zoom Window Out
Larger Text | Smaller Text
Hide Page Header
Show Expanding Text
Printable Version
Save Permalink URL

TheWFInstance

TheWFInstance represents an instance of an Therefore™ workflow process. It maintains task sequences, transitions and document links. It can be claimed an unclaimed by a user and controls task completion and delegation.

Namespace: Therefore.API

Name	Description
AskForPwd	Determines if the user has to enter his password in order to complete the current task.
AssignedTo	Gets the user name of the user the instance is currently assigned to.
ChecklistItemCount	Gets the number of TheWFChecklistItem objects in the workflow instance.
Claimed	Gets the claimed status of the instance.
CurrTaskName	Gets the name of the current workflow task for the instance.
CurrTaskNo	Gets the number of the current workflow task for the instance.
CurrTaskType	Gets the TheWFTaskType of the current task.
DelegationDisabled	Determines if delegating the current task is allowed or not.
ErrorInfo	Gets the additional error text if an error occurred in an automatic task.
ErrorString	Gets the error string describing the error if an error occurred in an automatic task.
ErrorTimestamp	Gets the timestamp when the error occurred.
HistoryEntryCount	Gets the number of TheWFHistoryEntry objects in the workflow instance.
InitiatorNo	Gets the user number of the user who started the workflow instance.
InstanceNo	Gets the unique instance number of the workflow instance.
IsAssignedToUser	Determines if the user is in the list of potential claimants for the instance.
IsChangeCtgry	Determines if the current task is a category change task.
IsProcessOwner	Determines if the current user has process owner rights for the workflow instance.
LinkedDocCount	Gets the number of linked TheWFDocument objects in the workflow instance.
NextTaskCount	Gets the number of next tasks in the workflow instance.
ProcessDueDate	Gets the date when the current workflow instance should be finished routing / processing.
ProcessName	Gets the name of the workflow process the instance belongs to.
ProcessNo	Gets the number of the workflow process the instance belongs to.
ProcessStartDate	Gets the date when the current workflow instance was started.
TaskDueDate	Gets the date when the current task instance should be finished.
TaskStartDate	Gets the date when the current task instance was started.
Text	Gets the long additional text information for the current workflow instance.
TokenNo	The unique number for the current workflow token.
TransitionCount	Gets the number of TheWFTransition objects in the workflow instance.
UseChecklist	Determines if the user instructions are displayed as a checklist.
VersionNo	Gets the version number of the workflow process the instance belongs to.

Note

All properties are read-only.

Name	Description
ClaimInstance	Claims the workflow instance.
DelegateTo	Delegates the workflow instance to the specified user.
DeleteInstance	Deletes the workflow instance.
FinishCurrentTask	Finishes the current task, routes the workflow instance to nNextTaskNo and assigns it to user nNextUserNo with the type nNextUserType.
GetChecklistItemAt	Returns the TheWFChecklistItem with the specified index.
GetCurrentLCID	Gets the currently used LCID.
GetHistoryEntryAt	Returns the TheWFHistoryEntry with the specified index.
GetLinkedDocAt	Returns the linked TheWFDocument with the specified index.
GetNextTaskAt	Returns the next task with the specified index.
GetNextTaskNo	Gets the task number of the next task after the specified one.
GetTransitionAt	Returns the TheWFTransition with the specified index.
LinkDocToInstance	Links the Therefore™ document to the workflow instance.
Load	Loads a workflow instance from the Therefore™ server.
LoadRerouteTaskList	Loads the reroute tasklist from Therefore™ server. Only available if current user is the process owner of the current workflow process.
LoadWorkflowHistory	Loads the workflow history from Therefore™ server.
RemoveDocFromInstance	Removes the document link to an Therefore™ document from the workflow instance.
SaveInstance	Commits changes made to the current workflow instance to the server.
SetChecklistItem	Sets the checked status for the specified checklist item.
SetCurrentLCID	Sets the currently used LCID.
SetText	Sets the free text information for the workflow instance.
ShowDialog	Loads a workflow instance from the Therefore™ server and displays it in the default Therefore™ workflow instance dialog.
ShowHistoryDialog	Loads the history of a workflow instance from the Therefore™ Server and displays it in the default Therefore™ workflow instance history dialog.
UnClaimInstance	Unclaimes the current workflow instance if claimed by the current user.