AX1362

Axiom.ProcessEvents

The Axiom.ProcessEvents system table contains information about the events performed for a process, such as activating a process, activating a step, and completing a 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.

EventID

The database ID of the process event.

EventType

The type of event. For example: ActivateProcess, ActivateStep, AbortProcess, CompleteStep, Comment.

StepNumber

The step number the event relates to. Returns blank if the event is not associated with a step. Sub-steps are shown using dot notation—for example, 3.2 for the second sub-step of step three.

DimensionValue

The dimension value the event relates to. Only applies to steps that are performed over a dimension, such as plan file processes. Returns blank otherwise.

NOTE: This column is a string column, even if the dimension values are numbers.

DimensionDescription

The description of the dimension value. Only applies if the event has a dimension value; returns blank otherwise.

IsSubProcessStepEvent

Whether the event is for a subprocess (True/False).

PrincipalName

The user who triggered the event.

CommentText

The comment associated with the event. If a user enters a comment when they complete a step, it is returned here. This field also returns auto-generated comments from Scheduler Process Steps. Returns blank if no comment is associated with the event.

EventDateTime

The date and time the event occurred.

Remarks

This table returns the process events for the currently active instance of the specified process definition. If the process is not currently active, no events are returned. If you want to return the events from a historical instance, 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.ProcessEvents cannot be modified using Save Type 4.