How to Create a Visual KPI Bookmark in DataStudio

This section explains how to create a VisualKPI Bookmark using DataStudio. Visual KPI Bookmarks can be created under KPI Profile objects in the Server Model of DataStudio. Bookmarks created and configured in DataStudio are displayed on the Visual KPI web interface. More information on Visual KPI Bookmarks can be found here.

To create a Visual KPI Bookmark in DataStudio, you should first have created a Visual KPI Profile. If you have not already done this, please follow the instructions here.

Create KPI Bookmark

  1. Right click on a Profile Object in the Server Model and select Admin  New  Bookmark from the context menu to open the create object wizard.

    Create New KPI Bookmark

  2. Give the KPI Bookmark object a name, then click Create

    Create New KPI Bookmark

  3. To configure the KPI Bookmark Object custom properties need to be be added to the object. In this simple example we will configure the bookmark to be a generic link to a specified URL. The custom properties that need to be added are shown below along with a brief description of their function.

    Table 1. KPI Bookmark Properties
    Property Name Property Value Notes

    bookmarkType

    Generic Link

    Determines the type of bookmark it is

    url

    www.inmation.com

    URL

    icon

    tf-rocket22

    Specifies the icon shown for the bookmark. The tf- prefix is added to the front of the icon name. Available icons can be viewed under the KPI Status settings in Visual KPI Designer. See the Transpara documentation for more details.

    name

    DataStudio Bookmark

    Bookmark name displayed on web interface.

  4. After adding the custom properties, the configured Object Properties panel should look like the screenshot below:

    Configured Bookmark Custom Properties

  5. Click Apply to save the settings then once the KPI ID field has been populated, go to the Visual KPI web interface to see the KPI Bookmark under the respective Profile.

    KPI Bookmark - Web Interface

  6. Clicking on the bookmark will open the web page of the configured URL

    Generic Link

Create KPI Bookmark to Dashboard

It is also possible to create a bookmark to another Visual KPI Dashboard using the "Dashboard Link" bookmarkType. Instead of providing a URL as a custom property, we use the KPI ID for a Visual KPI Dashboard object.

The following Custom Properties and values need to be added to the KPI Bookmark object once it has been created underneath a Visual KPI Profile object.

Table 2. KPI Bookmark to Dashboard Properties
Property Name Property Value Notes

bookmarkType

Dashboard Link

Determines the bookmark type. Here we want a dashboard Link

objectMetaID

<KPI ID for Visual KPI Dashboard object>

The objectMetaID is the KPI ID for the linked Dashboard object. This is assigned to the object by the Visual KPI Remote Context server. This can be found by going to the object properties panel for the Visual KPI Dashboard object (In the Server Model) and copying the KPI ID.

icon

tf-fire22

Specifies the icon shown for the bookmark. The tf- prefix is added to the front of the icon name. Available icons can be viewed under the KPI Status settings in Visual KPI Designer. See the Transpara documentation for more details.

name

Dashboard Bookmark

Bookmark name displayed on web interface.

The object properties panel should look like the following screenshot:

Dashboard Link Bookmark - Custom Properties

And in the Visual KPI web browser:

Dashboard Link Bookmark - Visual KPI Web Browser