Related Topics
The Workflow object is the legacy process model used in early versions of Process Director. BP Logix recommends the use of the Process Timeline object, and not the Workflow object. The Workflow object remains in the product for backwards compatibility, but doesn't receive any new functionality updates, other than required bug fixes. No new features have been added to this object since Process Director v4.5. All new process-based functionality is solely added to the Process Timeline.
This object represents a user in a Workflow Step.
When developing Form scripts (in the various callback methods such as BP_Event) or Workflow scripts, you are automatically given an instance of the “current” Workflow User with the CurrentWorkflowStepUser variable.
Properties
PROPERTY NAME | DATA TYPE | DESCRIPTION |
|---|---|---|
WFID | String | The ID of the Workflow definition |
STID | String | The ID of the Workflow Step |
SUID | String | The ID of the Workflow Step user |
TLID | String | The optional task list ID |
WFINSTID | String | The ID of the Workflow instance |
STINSTID | String | The ID of the step instance |
SUINSTID | String | The ID of the step user instance |
User | User Object | The user object |
Status | Integer | The status of this user in this Workflow Step. Please see the table definition of tblProjActivityUserInst for status codes. |
Comment | String | If the user completed this task, the optional comments |
Start | DateTime | The time that the user started in this step |
End | DateTime | The time that the user completed this step |
TermReason | Integer | The termination reason for this user in this step. Please see the Classes topic for a list of termination reasons and their associated integer code. |
BranchName | String | The branch the user selected to complete this step |
SubTaskName | String | The optional name of the sub task assigned to this Task User |
Methods
GetWorkflowStepUserBySUINSTID (Static Method)This API will get a Workflow Step definition object from the specified ID.
Parameters
BP: The bp environment.
SUINSTID: The ID of the Workflow Step user to retrieve.
Returns
WorkflowStepUser: Will return null if Workflow Step isn't found.
Example
// Normally not used directly
var oWorkflowStepUser = WorkflowStepUser.GetWorkflowStepUserBySUINSTID(bp, "SUINSTID");
RestartThis API will restart a Workflow Step for a specified user. There are two overloads for calling this function:
WorkflowStep.Restart(string UID)
WorkflowStep.Restart(string UID, string Comments)
Parameters
UID: The UID of the user to restart in the Workflow Step.
Comments: Optional parameter containing the Routing Slip comments to add to the Workflow Step.
Returns
None
Example
var oWorkflowStepInstance = WorkflowStep.GetWorkflowStepBySTINSTID(bp, "STINSTID");
oWorkflowStepInstance.Restart();
Documentation Feedback and Questions
If you notice some way that this document can be improved, we're happy to hear your suggestions. Similarly, if you can't find an answer you're looking for, ask it via feedback. Simply click on the button below to provide us with your feedback or ask a question. Please remember, though, that not every issue can be addressed through documentation. So, if you have a specific technical issue with Process Director, please open a support ticket.
