AX1382
Axiom.ProcessSteps
The Axiom.ProcessSteps system table contains information about the steps in a process, such as the step number and step type.
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 steps 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. |
|
ProcessStepID |
The database ID of the step. The process step ID is a large number and may display in scientific notation when queried into Excel. |
|
StepName |
The name of the step. |
|
StepNumber |
The number of the step in the overall process. Sub-steps are shown using dot notation—for example, 3.2 for the second sub-step of step three. NOTE: The step numbers are returned as strings, which may affect the sort order. If you want to sort the query so that steps are shown in order, use the StepOrder column instead. |
|
StepOrder |
An ordinal number specifying the order of each step. This column can be used to sort the query by step order, instead of using the string column StepNumber. |
|
StepDescription |
The description of the step. |
|
StepType |
The type of step. For example: Approval, Report, or Import. |
|
HasChildren |
Indicates whether the step has sub-steps (True/False). |
|
AssociatedItemName |
The name of the file or other item that is associated with the step. |
|
AssignmentType |
The type of owner assignment. For example: User, Role, Workbook. |
|
Assignment |
The configured owner assignment. For example, if the type is User, the assignment is the user name. If the type is Workbook, the assignment is the file name. |
|
WorkbookAssignmentSheet |
The sheet in the workbook that contains owner assignments. Only applies if the assignment type is Workbook. Returns blank otherwise (unless the step was configured for a workbook at one time and then was changed; in this case the sheet will remain in the table). |
|
DueDate |
The configured due date of the step. If a date is specified, returns the date. If a relative due date is used, returns text such as "5 days after process starts". |
|
StepLevel |
The level of the step in the process. Returns 1 for top-level steps, 2 for sub-steps of top-level steps, etc. |
Remarks
-
This table returns the steps as they are currently defined in the process definition. The table can be used in conjunction with the GetProcessInfo function to report on an active process.
-
If you want to return the steps from a historical instance of the process, then you must provide the process definition ID from that historical instance. For more information, see Reporting on process information.
Save Type 4 support
Axiom.ProcessSteps cannot be modified using Save Type 4.
