Yellowfin allows you to annotate time series charts by highlighting and commenting on key points of interest, providing further detail for the report reader. Annotations are only available on reports with manually-selected time series chart visualizations.
Annotations are displayed in multiple places on a report, as seen in the example below.
Number | Feature | Description |
---|---|---|
1 | Annotation flag | Shows the details of an annotation via a tooltip on the chart visualization. If an annotation is private, it appears orange on the chart visualization. |
2 | Highlighted area | Shows that the annotation is applied to a date range as opposed to a single date. |
3 | Multiple annotations flag | Shows how many annotations are applied to a given point. |
4 | Annotation flag | Shows the details of an annotation via a tooltip on the report table. |
To use annotations in Yellowfin, an administrator must enable annotation permissions for a user's role, and annotations must be enabled correctly for a given report.
Administrators must enable annotations for a user's role via the Admin Console. There are *C*reate, *R*ead, *U*pdate, and *D*elete role permission options available.
Only administrators can change role permissions. For more information on how to create and edit roles, visit Roles. |
To display annotations on a given report, the report annotation settings must be enabled via the annotations toolbar on the draft or published report page.
Follow the steps below to create an annotation.
When using multi-chart reports, annotations may not display immediately. Click Preview from the report page toolbar to preview the live report along with your annotations. |
Nominate the date or date range for your annotation. If a date range is selected, you can choose a highlight color for the chart annotation.
The optional filter setting allows you to associate an annotation with a filter value. This means an annotation is only available if the report contains the selected filter, and the specified value is available.
To link your annotation to a filter value, complete the following steps:
If you apply a filter link to your annotation, the visibility options will be reduced to This Report and Multi-Report -View, as the filter is linked to a view field and cannot be applied to reports based on other views. |
You can select a visibility level for an annotation to restrict the content it can appear on. There are three levels available.
Option | Level | Description |
---|---|---|
This Report | Report level | If selected, annotations are attached to a single report. Any date that falls on the specified date, or within the range, will be annotated. |
Multi-Report - View | View level | If selected, annotations will be applied to all reports at the view level with the same data. |
Multi-Report - Global | Organization level | If selected, anyone who belongs to the same organisation as the annotation creator will be able to see these annotations on any reports with the matching date data. |
The following fields allow you to enter a subject title and description for an annotation.
Annotations are set to public by default. To restrict visibility of the annotation, complete the following steps:
Annotations will always be secured by Client Org (if configured). If a public annotation is created within a given org, only users and groups within that org will see it. |
By default, a report will display an annotation if the following criteria are met:
When using the Client Orgs feature in Yellowfin, administrators of the Primary Org can enable Global Annotations. When enabled, all annotations created at the Primary Org (default level) will be passed through and visible in all Client Orgs.
Users logged in at the Client Org level will not be able to edit or delete the Global Annotations. However, they will be able to display or hide them through the same display settings as their own client annotations. |
Anyone with Yellowfin administrator rights can enable Global Annotations for Client Orgs. Follow the steps below.
When Global Annotations are enabled, the annotations at the Primary Org level will be set to public. |