416.467.9100 | Dundas Data Visualization | Login
Welcome Guest
This is the support page for the legacy Dundas Dashboard application. For assistance with the current Dundas BI application please click here.
Dashboard v5.0

This site makes extensive use of JavaScript.

Please enable JavaScript in your web browser and reload the page before proceeding.

Configuring Annotations

Hide navigation
RSS
Modified on Fri, 13 Apr 2012 05:24 PM Categorized as Annotations, Datasets, KPIs
Click to return to: Documentation | Defining KPIs


Overview

&dw; supports both data annotations and user annotations.

A data annotation is a visual indicator that can be automatically generated for each of your KPI's data points. While viewing a dashboard, use your mouse to hover over a data annotation indicator to see the text of the annotation displayed in a tooltip. The text values are supplied by a column/measure from your KPI's base virtual table/cube.

A data annotation.

A data annotation.


A user annotation is a comment that is manually attached to a data point (or data range) by a user viewing a dashboard. These comments can be used to add context to data or to communicate with other users.

For details on creating user annotations, see Viewing Dashboards - Annotations.

A user annotation.

A user annotation.


Annotations tab

Use the Annotations tab in the KPI Designer to configure data annotations and manage user annotation groups for your KPI.

The Annotations tab in the KPI Designer.

The Annotations tab in the KPI Designer.


Data annotations

On a chart control, data annotations will be displayed with the KPI's measure values.

A chart showing a KPI with a data annotation based on the Product Description column. Hover over a data annotation indicator to see a tooltip which shows the corresponding product description.

A chart showing a KPI with a data annotation based on the Product Description column.
Hover over a data annotation indicator to see a tooltip which shows the corresponding
product description.


If you display a KPI with data annotations on a data grid control, the data annotation fields show up as additional columns. You can configure the appearance and other settings for these additional columns from the Properties list for the data grid control (Dashboard Designer screen).

A data grid showing the Product Description data annotation.

A data grid showing the Product Description data annotation.


Adding a data annotation

Click the Add data annotation fields button in the top-left corner to select columns/measures from your KPI's base virtual table/cube to act as textual sources for data annotations.

Adding a data annotation.

Adding a data annotation.


The list of chosen data annotation sources appears in the upper Data Annotation Fields grid.

Added Product Description as a data annotation field.

Added Product Description as a data annotation field.


Changing the name or description of a data annotation

To change the name (or description) of a data annotation:

  1. In the Data Annotation Fields grid, locate the grid row corresponding to your data annotation.
  2. Select the cell containing the name (or description) that you want to change.
  3. Click inside the cell to begin editing.
  4. Type the new name (or description) in the text box, then press ENTER.

Using a look-up table

Each data annotation source corresponds to a column from the virtual table that your KPI is based upon. If the data in this virtual table column does not provide sufficient detail for annotation purposes, you can choose to replace it with a more meaningful column by using a look-up table. For example, your virtual table may have an ID column but no corresponding name or description column.

To use a look-up table with your data annotation source:

  1. In the Data Annotation Fields grid, locate the grid row corresponding to your data annotation.
  2. Click the button in the Field Look-Up column of the grid. The Data Field Look-Up Wizard is displayed.
  3. Replace the virtual table column with a look-up table column by following the steps as shown in the article, Using a Look-up Table. The name of your data annotation source will be updated automatically in the Data Annotation Fields grid.

Aggregation

An aggregate function takes a set of input values and computes a single output value.

To apply an aggregate function to a data annotation column:

  1. Locate the grid row corresponding to your column.
  2. Select the cell in the Aggregator grid column.
  3. Click inside the cell. A dropdown list control appears.
  4. Click the dropdown list and choose an aggregate function from the resulting menu.

Removing a data annotation

To remove a data annotation from your KPI:

  1. Locate your data annotation source in the Data Annotation Fields grid.
  2. Click the Remove button in the Action grid column.
  3. When prompted to confirm the operation, click Yes. The data annotation is removed from the Data Annotation Fields grid.

Choosing a default data annotation

If you chose multiple data annotation sources, designate one of them as the default data annotation by selecting the appropriate option in the Default column of the Data Annotation Fields grid. If there is only one data annotation, it will be automatically selected as the default.

Changing the appearance of data annotations

Consider a chart that displays a KPI with the following settings:

  • KPI measure: Number of Hits
  • KPI dimension: Product Name
  • KPI data annotation: Product Description.

To change the appearance of the data annotation indicators for this chart:

  1. Go to the Properties grid for your chart in the Dashboard Designer screen.
  2. Click the Series property value for your chart. The Series properties dialog is displayed.
    The Series properties dialog.
  3. Click the Data Annotations property value in the Series properties dialog. The Data Annotations properties dialog is displayed.
    The Data Annotations properties dialog.
  4. Change the following properties for the Product Description data annotation:
    • Marker Fill: Yellow
    • Marker Shape: Ellipse.
  5. Preview your dashboard to see the updated appearance for the data annotation indicators.
    Updated appearance for data annotation indicators.

Tip: To display an image in the data annotation callout, add an image to your project or find an image accessible with a web address, and set Marker Fill to use this image. Set Marker Shape to Rectangle to ensure the entire image is visible.

User annotation groups

When you create a user annotation (while viewing a dashboard), you have the option of choosing its annotation group, which can be thought of as a folder for organizing and limiting the scope or visibility of your user annotations. For example, you may want to set up an annotation group for a sales team to share notes (&ie; annotations) on their sales dashboards.

Multiple annotation groups can be created at the &dw; project-level, or on a per-dataset or per-KPI basis. The User Annotation Groups grid in the Annotations tab of the KPI/Dataset Designer lists all of the annotation groups that are associated with your dataset or KPI, as well as project-level annotation groups.

The User Annotation Groups grid.

The User Annotation Groups grid.


To add, edit, or delete an annotation group that is associated with your dataset or KPI, click Manage Annotation Groups. The Manage Annotation Groups dialog is displayed. This dialog lists project-level annotation groups in the upper grid (read-only) and annotation groups that are associated with your dataset or KPI in the lower grid. Project-level annotation groups cannot be managed from this dialog. To modify project-level annotation groups you must use the Administration Sidebar and edit the desired project.

Note: Any changes that you make to annotation groups using this dialog are permanent and do not require you to check in or check out the associated dataset or KPI.

The Manage Annotation Groups dialog.

The Manage Annotation Groups dialog.


Adding an annotation group

To add a new annotation group that is associated with your dataset or KPI:

  1. In the Manage Annotation Groups dialog, click Add Annotation Group. The Create Annotation Group dialog is displayed.
  2. In the General tab:
    • Enter a name for the annotation group in the Name box.
    • Enter a description for the annotation group in the Description box.
    • Click Apply.
      The Create Annotation Group dialog.
  3. Click the Security tab:
    • Add users or object security groups to the Groups or user names list as required.
    • For each user or object security group, set the Read/Write/Delete permissions. These are permissions on the actual annotations contained within the annotation group.
      The Security tab.
  4. Click OK.

The Create Annotation Group dialog closes and a new entry is added to the lower grid in the Manage Annotation Groups dialog.

A newly added annotation group.

A newly added annotation group.


Editing an annotation group

To edit an existing annotation group that is associated with your dataset or KPI:

  1. In the Manage Annotation Groups dialog, click the Edit annotation group button in the Action grid column that corresponds to the annotation group you want to modify. The Edit annotation group dialog is displayed.
  2. Follow the same steps as when creating a new annotation group.

Deleting an annotation group

To delete an existing annotation group that is associated with your dataset or KPI:

  1. In the Manage Annotation Groups dialog, click the Delete annotation group button in the Action grid column that corresponds to the annotation group you want to delete.
  2. When prompted to confirm the operation, click Delete.

Warning: This operation will delete all user annotations contained within the annotation group. The operation is permanent and cannot be undone.

Related topics


Click to return to: Documentation | Defining KPIs

About Dundas | Contact Us Follow us on Twitter! | Privacy Statement | Report Site Issues

Copyright © 2009-2014 Dundas Data Visualization, Inc.