Page History

...

Overview

...

1. Annotation Flag highlighting the date, or start of date range, on the time series x axis, with a descriptive roll over that is editable from the report page.
   Note: if the Annotation is set to Private the flag will be coloured red.
2. Highlighting on a time series chart when the annotation has been applied to a date range rather than a single date.
3. A descriptive roll over on the table displayed on the date, or start of the date range, that is editable from the report page.

Enabling Annotations

...

1. You must get an administrator to enable annotation permissions for our role. There are *C*reate, *R*ead, *U*pdate, and *D*elete options available.
   1. The administrator should go to Administration > Role Management and edit your role
   2. They will need to ensure the Annotations role is enabled
      
2. The report you wish to view annotations on must be correctly enabled
   1. While the report is in draft mode, open the Display menu
   2. Ensure that Display on Charts and/or Display on Tables is set to Yes
      
   3. Activate the report

Creating Annotations

...

1. Ensure your report is Active (not in Draft mode)
2. In the Annotate menu, click on the Add Annotation button
   
3. The Annotation window will open, providing you with the following options:
   

Date

Nominate the date, or date range that your annotation should be displayed for. If a date range is selected, you will also be able to choose a colour for chart highlighting.

Filter

The optional Filter setting allows you to associate the Annotation with a filter value. This results in the Annotation only being available if the report viewed contains the filter, and the specified value is available.

...

Note: if you apply a Filter link to your Annotation, the Visibility options will be reduced to Report and View. This is because the filter is linked to a view field and as such cannot be applied to reports based on other views.

Visibility

Here you should select the level of your Annotation. This will restrict what content it can appear on. There are three levels available:

...

Note: If the Annotation is linked to a filter, the Global (Organisation) level will not be available, as the filter is linked to a view field and as such cannot be applied to reports based on other views.

Tag

Specify a tag to categorise your Annotation. This can be left blank, but it's suggested that tags are used where possible in order to make it easier for the users to view content relevant to them.

A new tag can be added by typing the description of the tag in the text box at the bottom of the list and clicking Add.

Title

Enter the Subject of your Annotation

Description

This is where you should enter the details of your Annotation, and format as desired.

Security

Annotations are set to Public by default. In order to restrict visibility of the annotation, complete the following:

...

Note: Annotations will always be secured by Client Org (if implemented), so even if set to Public, only users and groups within the Org it was created in will have access. If your Annotation is Private the flag on a chart will be red, rather than grey.

Viewing Annotations

...

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
   
3. The Filters used in the Report match those used in the Annotation (if specified)
4. The Annotation is Untagged OR matches a tag specified in the Report Save Menu
   

Annotation Display Options

There are options available in the Annotation Menu of an active report, that allow the user to restrict the Annotations seen on the report.

...

The user can then specify which Annotations they wish to view by the tags that have been applied to them (or untagged as the case may be).

Global Annotations

...