This documentation supports releases of BMC Helix Dashboards up to December 31, 2021. To view the latest version, select the version from the Product version menu.

Using annotations to mark anomalies

As a tenant administrator or an editor, you can configure annotations in your dashboard. You can use annotations as points to mark on panels. Usually, annotations are used to flag anomalies in your environment data.


To add an annotation

You can add an annotation in one of the following ways:

  • From a panel — You can add a single annotation from a panel to mark a point on the panel. You cannot see these annotations on the Dashboard settings > Annotations page.
  • From the dashboard settings — You can add an annotation query from the dashboard settings. Annotation queries display annotations on the dashboard based on the filters that you specify in the dashboard settings.

Adding from a panel:

  1. Click anywhere on the panel and click Add Annotation.
  2. Add the required information and save your changes.
  3. In the left navigation pane, click Save dashboard.

Adding from the dashboard settings:

  1. On a dashboard, click the Dashboard settings icon in the upper right corner.
  2. On the left navigation bar, click Annotations > Add Annotation Query.
  3. Do the following:
    1. Enter a name and select a data source for the annotation.
    2. Ensure that the annotation is enabled and select a color for the annotation.

      Tip: Enabling or disabling an annotation

      The Enable toggle key helps if you have multiple annotations and you want to show only one on the dashboard. You can enable the annotation that you want to show and disable other annotations.

    3. Add queries to the annotation. Select one of the filtering options.
      • Filter by Tags —  Specify at least one tag for this filter to work. 
      • Filter by Dashboard
  4. Click Add.
  5. On the left navigation pane, click Save dashboard.


To edit an annotation

You can edit an annotation in one of the following ways:

  • From the panel —  You can edit only those annotations that you have added from the panel.
  • From the dashboard settings —  You can edit only those annotations that you have added from the dashboard settings.

Editing from a panel:

  1. On the panel where the annotation is added, hover over the annotation point and click the edit icon .
  2. Make your changes and click Save.

Editing from the dashboard settings:

  1. On a dashboard, click the Dashboard settings icon in the upper right corner.
  2. On the left navigation bar, click Annotations.
  3. On the Annotations page, click an annotation.
  4. Make your changes and click Update.
  5. In the left navigation pane, click Save dashboard.


To delete an annotation

You can delete an annotation in one of the following ways:

  • From the panel — You can delete only those annotations that you have added from the panel.
  • From the dashboard settings — You can delete only those annotations that you have added from the dashboard settings.

Deleting from a panel:

  1. On the panel where the annotation is added, hover over the annotation point and click the edit icon .
  2. Click Delete.

Deleting from the dashboard settings:

  1. On a dashboard, click the Dashboard settings icon in the upper right corner.
  2. On the left navigation bar, click Annotations.
  3. Click the delete icon  against the annotation that you want to delete.
  4. On the left navigation pane, click Save dashboard.



Was this page helpful? Yes No Submitting... Thank you

Comments