Annotations

Annotations directly identify interesting data over a specific time range within a run or asset. There are two types of annotations: Data Review annotations and Phase annotations.

Data Review annotations are useful for reviewing data. They're associated with a channel(s) on a given run or asset and can also be assigned a status—Open, Flagged, or Resolved.

Phase annotations are useful for denoting a sequence or event. They differ because they cannot be assigned a status and do not have to be directly linked to a set of channels. They also show separately at the top of the time-series plot with persistent labels.

The annotations sidebar displays all annotations in a run or the current time range if a run is not selected. You can filter annotations by type, name, tags, status, or whether they have comments. Filtering by tags allows advanced features like case-matching and regular expressions.

Grey annotations are Phase annotations. Yellow annotations are open Data Review annotations*.* Red annotations are flagged Data Review annotations. Green annotations are resolved Data Review annotations.

By default, resolved annotations will not appear on the plot. You can view all annotations by clicking on the Toggle annotations switch. You can also toggle the visibility of individual channels by clicking the eye icon. Selecting annotations will open the bulk edit toolbar at the bottom of the plot.

Creating an Annotation

Click the plus icon a the top of the sidebar to create a new annotation. You can also click & drag across the chart in Annotate mode to create an annotation.

Here, you can set an annotation's name, type, and description, add tags, and assign the annotation to a user in your organization. Users will receive a notification when the annotation is assigned to them.

You can select existing tags or create new tags. The tag search also provides advanced features like case matching and regular expressions.

To select a time range for the annotation, either enter start and end date times in the inputs or drag to select a range on the plot.

Viewing an Annotation

Click on an annotation in the annotation list or in the plot to view the annotation.

Cycle through all annotations by clicking the left or right arrows at the top.

Four corners icon: center the annotation in the plot.
Link icon: create a share link for the annotation and copy it to your clipboard.
Trash can icon: delete the annotation.
Edit icon: edit the annotation.

Change the annotation status by clicking one of the three statuses beneath the name.

Clicking Plot Linked Channels will plot the channels plotted when the annotation was created.

Adding Comments

You can add comments to the annotation, which will appear in the annotation log alongside events like creation and changes to the annotation status. The assignee will receive a notification when a comment is added.

Using Mentions

Use @ mentions in annotations to notify other users that something requires their attention.

While writing a comment, enter the @ symbol and begin typing a user's alias. A typeahead menu will pop up with a list of potential alias matches.

Use the Up or Down arrow keys to navigate the list with your keyboard. Press the tab key or click the mouse to select a user from the list.

When you're finished, click the Post button or use the Cmd / Ctrl + Enter keys to publish the comment. Once submitted, the user mentioned will receive a notification that they've been tagged in an annotation.

Editing an Annotation

Click on the edit icon when viewing an annotation to edit it.

Here, you can update the annotation's name and description, add and remove tags, and assign the annotation to a user in your organization. Users will receive a notification when the annotation is assigned to them.