Report Annotation

Overview

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.

Enabling annotations

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.

Annotation permissions

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.

Report annotation settings

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.

1. From the report page, click the Annotation tool on the toolbar to open Annotation Settings window
2. Click on the Display section
3. Toggle on the Chart Display and Table Display toggles to enable annotations for this report
   

Creating annotations

Follow the steps below to create an annotation.

1. From the report page, click the Annotation tool on the toolbar to open Annotation Settings window
2. Click on the Add Annotation button
   
   The Annotation dialog box will display, providing you with the following options
   
   
3. Nominate the date, or date range for your annotation and click the Submit button
   If a date range is selected, choose a highlight color for the chart annotation
   
    
4. Click the Select Visibility dropdown and click This Report
   
5. Enter a title and description, and click the OK button
   
   
   The report page will be displayed with the annotation flag visible at the selected date
   
   
   

   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.
   

Annotation settings

Date

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.

Filter

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:

1. Add the required filter to your report, ensuring that it is a cached user prompt filter
2. Click the Select Filter dropdown in the Annotation window, and choose your filter from the first dropdown list
3. Select the desired value from the second dropdown list in the Annotation window and click the Submit button
   
   

Visibility

You can select a visibility level for an annotation to restrict the content it can appear on. There are three levels available.

Title & description

The following fields allow you to enter a subject title and description for an annotation.

Security

Annotations are set to public by default. To restrict visibility of the annotation, complete the following steps:

1. Click on + Add people to make private
2. Search for the appropriate users or groups by typing in the search field
   
   
   
3. Click on the users/groups you wish to add
   The creator of the annotation will always have view permissions, and will be added by the system automatically
   
4. Once all other fields are complete, click the OK button to create the annotation
   The private annotation flag will appear orange on the chart visualization

Viewing annotations

By default, a report will display an annotation if the following criteria are met:

1. The report and/or time series chart contains the matching date or range specified in the annotation
2. Annotations display is enabled during report creation
   

Global annotations

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. 

Anyone with Yellowfin administrator rights can enable Global Annotations for Client Orgs. Follow the steps below.

1. On the left-side navigation pane, click on Administration, then Configuration
2. Click on the Authentication  tool along the top of the screen, then click on the Client Organizations section to display the following options
   
   
   
3. Under the Client Organisation Functionality, toggle on Global Annotations
   
   
   
4. Click the Save button to save the settings