Related Topics
This object represents a user in a Process Task.
Properties
|
PROPERTY NAME |
DATA TYPE |
DESCRIPTION |
|---|---|---|
|
Comment |
String |
The optional comments if the user completed this Task |
|
End |
DateTime |
The time that the user completed this Task |
|
ProcessInstance |
Process Instance Object |
The Process Instance object for the Process containing this Task User |
|
ProcessTaskInstance |
Process Task Instance Object |
The Process Task Instance object for the Task containing this Task User |
|
PROCID |
String |
The ID of the Process Definition |
|
Start |
DateTime |
The time that the user started in this Task |
|
Status |
Integer |
The status of this user in this Process Task. Please see the table definition of tblProjActivityUserInst for status codes. |
|
SubTaskName |
String |
The optional name of the sub task assigned to this Task User |
|
TASKID |
String |
The ID of the Process Task |
|
TASKINSTID |
String |
The ID of the Task Instance |
|
TASKUID |
String |
The ID of the Process Task User |
|
TASKUINSTID |
String |
The ID of the Task User Instance |
|
TermReason |
Integer |
The termination reason for this user in this Task. Please see the Classes topic for a list of termination reasons and their associated integer code. |
|
TLID |
String |
The optional task list ID |
|
User |
User Object |
The user object |
Methods
CancelUser
This API will cancel the task for the particular user which this object represents. This is an overloaded method with the following possible declarations:
public bool CancelUser()
public bool CancelUser(string Comments)
public bool CancelUser(string Comments, string UIDAdmin)
Parameters
Comments: (optional) Comments to add to the completion action.
UIDAdmin: (optional) The UID of the (administrative) User who authorized the Task’s cancellation.
Returns
Boolean: True if the operation succeeds.
Example
// Cancel the User's Task, adding a comment
CurrentProjectActivityUser.CancelUser("Programmatically canceling user");
CompleteUser
This API will complete the task for the particular user which this object represents. This is an overloaded method with the following possible declarations:
public bool CompleteUser()
public bool CompleteUser(string Selection)
public bool CompleteUser(string Selection, string Comments)
Parameters
Selection: (optional) The branch to take on completion.
Comments: (optional) Comments to add to the completion action.
Returns
Boolean: True if the operation succeeds.
Example
// Complete the User's Task, taking the "Approve" branch
CurrentProjectActivityUser.CompleteUser("Approve");
ConvertSysVarsInString
This API will convert a SysVar string in the context of the ProcessTaskUser. This is an overloaded method with the following possible declarations:
public virtual string ConvertSysVarsInString(string pString)
public virtual string ConvertSysVarsInString(string pString,
bp.SysVarEncode pDefaultEncode)
Parameters
String: The SysVar string to convert.
pDefaultEncode: A BP SysVarEncode object that defines the encoding.
Returns
String: The expansion of the SysVar string
Example
// Create the string to append the current object name to the
// string "Name: "
var strNew =
CurrentProjectActivityUser.ConvertSysVarsInString("Name: {OBJ_NAME}");
GetProcessTaskUserByTASKUID
This API will return a ProcessTaskUser for a Given TaskUserID.
Parameters
BP: The BP Logix environment.
pTASKUID: The string TaskUserID for the user.
Returns
ProcessTaskUser: The ProcessTaskUser object or null if the operation fails.
Example
var oUser = ProcessTaskUser.GetProcessTaskUserByTASKUID(bp, "TASKUID");
GetProcessTaskUserByTASKUINSTID
This API will return a ProcessTaskUser for a Given TaskUserInstanceID.
Parameters
BP: The BP Logix environment.
pTASKUINSTID: The string TaskUserInstanceID for the user.
Returns
ProcessTaskUser: The ProcessTaskUser object or null if the operation fails.
Example
var oUser =
ProcessTaskUser.GetProcessTaskUserByTASKUINSTID(bp, "TASKUINSTID");
ResendEmailForUserTask
This API will resend the task email to a specific user.
Parameters
UIDAdmin: Optional string parameter of the user you want to associate with the resend in the audit logs.
Comments: The optional string comments for a completed task.
Returns
ProcessTaskUser: The ProcessTaskUser object or null if the operation fails.
Example
var oUser =
ProcessTaskUser.GetProcessTaskUserByTASKUINSTID(bp,
"TASKUINSTID");
oUSer.ResendEmailForUserTask("UIDAdmin", "Comments");
TaskUsersInTask (Static Method)
This API will return a collection of all Process Task User objects from the specified Task ID.
Parameters
BP: The bp environment.
TASKINSTID: The ID of the Process Task instance with the Process Task Users to retrieve.
Returns
IEnumerable<ProcessTaskUser>: The list of Process Task User objects for the particular Task.
Example
// Normally not used directly
var TaskUsers = ProcessTaskUser.TaskUsersInTask(bp, "TASKINSTID");
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.
