AX1401
Axiom.ProcessTasks
The Axiom.ProcessTasks system table contains information about the active tasks for a process, such as the task name, owner, and due date. When a step is made active in a process, one or more tasks are generated for the owner(s) of that step.
Query requirements
When querying this table, you must apply a data filter to limit the results by ProcessDefinitionID. If the query does not include this filter, an error will occur. For example:
ProcessDefinitionID=5988
This filters the query to return the events for ProcessDefinitionID 5988. To find out the ID for a process, you can use the GetProcessInfo function.
Available columns
The following columns can be queried:
Column | Description |
---|---|
ProcessDefinitionID |
The database ID of the process definition. The query must be filtered by a specific process definition ID. |
TaskID |
The database ID of the task. |
PrincipalName |
The owner of the task. |
DimensionValue |
The dimension value that the task relates to. Only applies to plan file processes; returns blank otherwise. |
DimensionDescription |
The description of the dimension value. Only applies to plan file processes; returns blank otherwise. |
StartDate |
The date the task was generated. |
DueDate |
The due date of the task. |
FriendlyDueDate |
The due date of the task, represented in language relative to today. For example, if the task is due today, the friendly due date returns "Due today." |
StepNumber |
The step number associated with the task. Sub-steps are shown using dot notation—for example, 3.2 for the second sub-step of step three. |
StepName |
The step name associated with the task. |
CurrentUserIsOwner |
Whether the current user is the owner of the task (True/False). This column can be used to filter the query for administrators and process owners, so that the query returns only the tasks that they own. |
IsApprovalStep |
Whether the current step is an approval step (True/False). This indicates tasks that support approval and rejection versus simply completing the task. |
Remarks
This table returns the currently active task or tasks for the active instance of the specified process definition. Note the following:
-
If the current user is an administrator or the process owner, then all active tasks are returned. If instead you want to filter the query to show only the tasks that are owned by the administrator or process owner, use the CurrentUserIsOwner column. For all other users (including group owners), only tasks that belong to the current user are returned. Group owners do not see all tasks for their assigned group.
-
If the process is not currently active, no tasks are returned.
-
If an active step has multiple assigned owners, then the table returns one row per task / owner combination. For plan file processes, the table returns one row per plan code / task / owner combination.
Save Type 4 support
The Axiom.ProcessTasks table itself cannot be modified using Save Type 4. However, active tasks for plan file processes can be completed and moved using Save Type 4 to the Axiom.ProcessAction table. You can use the Axiom.ProcessTasks table to bring in a list of the current tasks, and then perform a save-to-database to the Axiom.ProcessAction table to perform actions against those tasks.