Reports
Reports is one of our purpose-built data review workflow features. At a high level, a Report is a collection of rules that are evaluated over a given run, and any annotations that those rules generate from the evaluation.
Reports can be generated in a number of ways:
-
By default: all rules evaluated on a live-streamed run will roll up into a “default” Report for that run.
-
Via Report Templates: Predefined collections of rules can be configured into a Report Template. (ex: All thermal-related rules can be put into a “thermal Report Template”)
- Report templates create a Report as data streams in, as specified by the rules within the Report Template
- Users can also create a Report from a Report Template over historic data at any time
-
Via rule evaluation: Within the Explore page, one or more rules can be evaluated at once, resulting in a Report
How Reports Works
At a foundational level, Reports are a streamlined way to disposition related annotations for a run. The core workflow enables user to go through the Report rule by rule, and review each annotation. The UI allows for both individual and bulk annotation dispositioning.
Actions that can be taken on annotations include:
-
Changing the state (Open, Passed, Failed)
-
Assigning the annotation to someone in your organization
-
Commenting on the annotation
- Comments also support file uploads
-
Viewing the annotation in the Explore page
-
Viewing the rule version that created the annotation
Reports Components
Left Sidebar
The Sidebar is where you can view Report and Run Metadata, filter down the Rules that are in view, and navigating between Rules, and view all annotations that each rule generated. The Sidebar also provides a high-level-overview of the health of your Report with the current Passed
/ Open
/ Failed
Rule ratios.
Read more about this here: Reports Sidebar
Rule Instance
The Rule instance is the section of the Reports page that contains the information about the current Rule in view. This includes the Rule's metadata, the Chart with the associated channels' data, and the log data from any log channel.
Read more about this here: https://siftstack.atlassian.net/wiki/spaces/211255498/pages/383123488/
Annotations Sidebar
The Annotation Sidebar is where annotation dispositioning occurs. Annotation state, assignment, and comments, and file uploads can occur here. These actions can be taken on 1 or more annotations. Selecting an annotation also shows the rule version that created it, making it easy to view or update the rule.
Read more about this here: https://siftstack.atlassian.net/wiki/spaces/SCS/pages/627376157/Annotations+Sidebar?atl_f=PAGETREE
Reports Chart
The Reports Chart is a Chart that is purpose-built for data review and dispositioning Annotations. It allows the user to select whether to view multi-channel data as a set of individual strip charts or combined into one chart, similar to the explore view.
Read more about this here: Reports Chart
Reports Log Viewer
If a Rule has log channels, those logs can be viewed in the new and improved Log Viewer within Reports.
Read more about this here: https://siftstack.atlassian.net/wiki/spaces/211255498/pages/383156288/
Navigating between Rules
Navigating between Rules can be done via the Sidebar, the top navigation bar, or hotkeys.
Read more about this here: Navigating between Rules