- 21 Nov 2024
- 7 Minutes to read
- Print
- DarkLight
- PDF
Viewing Workflows Run History
- Updated on 21 Nov 2024
- 7 Minutes to read
- Print
- DarkLight
- PDF
You can view on the Run History page the results of runs of all Workflows or of a specific Workflow.
To view all runs of all Workflows
- In the upper-right corner of the Workflows page, click Run History. The table on the Run History page shows the details of the runs for all the Workflows defined in the system.
To view the runs of a single Workflow
- In the Workflows table, click a Workflow.
- In the Workflow configuration summary page that opens, in the upper-right corner, click View Runs. The Run History - Workflows tab opens, displaying the runs of the selected workflow. The selected Workflow Name appears in the filter. You can select other Workflows from this dropdown to show their run history as well.
The Run History Page
The Run History page displays a list of runs of all Workflows or of a selected Workflow and allows you to investigate the results of each run.
The Run History page consists of the following main elements:
- Search/Filter bar
- Run History table
- Total (<# of runs performed>) - Increments by 1 each time a Workflow is triggered.
- Actions (Terminate Task)
Run History Table
The Run History table displays a list of Workflow runs, with one row representing each run. The Run History is updated each time a Workflow is triggered by an Event or Action.
Limitation: When a run starts on an asset and the asset is then removed from the scope, the run completes and presents the asset in the Run History page.
The Run History table includes the following fields, by default, for each Workflow, and where relevant, for each element within the Workflow:
Structure - Shows only the icons of the events and actions from the path that the asset went through within the workflow.
Run - The ID number of the run. Begins with WF, e.g., WF Run 70.
Workflow Name – The default or assigned workflow name.
Status - The status of the latest run that originated from this workflow. For example, if an Add Tag to Asset action is currently running in the workflow, the current status of this action is displayed. Available statuses are:
- Awaiting - Workflow is waiting for an event or action. The Workflow changes to this status after a certain amount of time that the run is In Progress and doesn't automatically move to another status.
- Completed - Workflow completed running. Status of the Workflow if the run ended but is not in Delayed, Awaiting, or Timed Out status.
- Delayed - Workflow reached a Delay node and is paused for the configured delay time.
- Failed - All actions failed.
- In Progress - Workflow run is in progress.
- Terminated - Workflow run terminated due to the user manually terminating the Workflow run.
- Timed Out (in red) - An Event, configured with Timeout but without a Timeout condition, has reached its timeout limit. In this case, the Workflow terminates due to the event timeout.
Trigger – The icon and name of the event or action that triggered this workflow.
Triggered On – The asset on which the event or action was triggered.
Last reported activity - The date and time (in UTC time) that the latest node completed running in the Workflow. Updated each time a node is completed.
Start Date – The date and time (in UTC time) that an event or action triggered this Workflow.
End Date – The end date and time (in UTC time) of the entire Workflow run. This field displays a value only when the Workflow run has completed.
Viewing Detailed Run Information and Component Configuration
On the Run History page, you can click any Workflow run (row) to open its Run drawer. The Run drawer has a tab for only those components (Event or Action) in the route that the asset took in the Workflow. Clicking a tab shows detailed information about the Workflow run for this component as well as the configuration of the component. Learn more on how Event fields are displayed in the run drawer, including parsed string fields.
You can click the Go to Workflow icon in the header of the Run drawer to open the detailed configuration of the Workflow.
The following Run Drawer presents the run details and configuration of the Microsoft Teams - Send Message action that triggered the workflow. You can click the other tabs to present the Teams Message Response event or Axonius - Add Tag to Assets Enforcement Action run details and configuration.
- The last event of a run acquires the status of the run. Meaning that if the entire run times out, the last event in that run acquires the status 'tImed out'.
- The run drawer is updated only at the end of a stage. This means that a tab is added to the run drawer only when its status can no longer change.
At the top of the drawer are tabs of the events and actions that ran in the workflow. For each event/action, the following information is shown:
Started, Ended - Start and end date and time of the event/action run.
Type - Whether the workflow component is an Event or Action.
Status -
- Event status can be any of the following:
- Awaiting - Status of the last event of a run that is in Awaiting status.
- Timed Out with gray shading - The last event of a run, which is configured with Timeout and is followed by a Timeout Condition, has reached timeout.
- Completed - Status of the event if the run is not Awaiting or Timed Out.
- Action status can be any of the following:
- Success - The action succeeded.
- Failure - The action failed.
- Event status can be any of the following:
Affected Asset - The asset affected by the run. Clicking the link opens the asset profile page.
If the running of the event/action results in an error, the Run Error is displayed in the drawer.
If the number of incoming events exceeds the maximum allowed, event overflow occurs. In this case, an error is returned stating that the event was dropped because it exceeded the rate limit.
Viewing Run History of an Asset
In the Run Drawer, you can click the Affected Asset link to open the Asset Profile page of that asset, and in the page that opens, click the Enforcement Runs tab to see the history of all enforcement runs (Enforcement Set and Workflow runs) on this asset. To learn more, see Asset Profile Page.
Filtering the Run History Table
You can filter the Run History table by entering or selecting from the following:
- Search - Free-text search on text fields.
- Workflow Name - Filters by Workflow name.
- Event Type - Filters by Events in the Workflow.
- Action Type - Filters by Enforcement Actions in the Workflow.
- Status - Filters by the current status of the run.
- Awaiting - Shows all Workflow runs waiting for an event or action.
- Completed - Shows all Workflow runs in which all events and actions completed successfully.
- Delayed - Shows all Workflow runs that are currently paused (on Delay node).
- Failed - Shows all Workflow runs where all Actions failed.
- In Progress - Shows all Workflows that are still running.
- Terminated - Shows a list of all Workflows whose runs were manually terminated.
- Timed Out - Shows a list of all Workflows whose run terminated due to event timeout.
- From, To - The Workflows that were run in the specified period of time.
- Click From and select the date and optionally the time (right pane) from which to display results. Repeat for To and then click Ok.
- Both From and To dates must be filled in and be earlier than or on the current date.
- Click the arrows to the left/right of the Month/Year header to open the previous/next month's or year's calendar page.
- To filter results only for a specific date, select the same date twice.
You can click the following to perform quick actions on filters:- Select All - Selects all options in a specific filter.
- Clear All - Clears all selections in a specific filter.
- Reset - Clears all filters and displays the entire table.
The total number of Workflow runs that match the search criteria is displayed on the top left side of the Run History table just under the Filter bar. When no search criteria is selected, the total results represent the total number of runs.
For more information about working with Workflows, refer to the following:
Viewing and Configuring Workflows Events Settings
Selecting and Configuring the Workflow Trigger
Selecting and Configuring a Workflow Event
Configuring an Event Condition
Selecting and Configuring a Workflow Action
Configuring an Action Condition
Deleting and Deactivating/Activating Workflows