Editor & DashboardStates

Outline

This tutorial will describe how you can maintain different dashboardstates referenced by the current dashboard in the Analysis Editor.
The functionality described in this tutorial was introduced to the platform in version 4.1.2 so you need to upgrade to this version to be able to follow this tutorial.

It might also be a good idea to read the guide "What is DashboardState?" before proceeding with this tutorial.

 

Basics

A dashboard can have several Dashboardstates connected and if you start your Analysis Editor in Standalone mode, you can switch between the dashboard states with the dashboardstate droppdownlist in the top-bar in the Analysis Editor. If you start your Analysis Editor in Single Dashboard mode, you have opened your dashboard in edit mode with a tab reference so you cannot switch between dashboardstates but all changes to the dashboardstate inside the Editor in this mode is saved to the Tab-Dashboard dashboardstate.

 

How to switch dashboardstates?

Right next to the Dashboard dropdownlist you have got a new dashboardstate dropdown list. In this list you can switch between all available dashboardstates.

In platform version 4.1.2 the users can set the following dashboarstate types through the user interface:

  • System Dashboardstate - "Fundamental (all tabs)"
    Describes the startup settings (Parameters and filters) for all users rendring this dashboard without a tab reference or if there is no Tab-Dashboard dashboardstate for the referenced tab
  • Tab-Dashboard Dashboardstate - "Fundamental for tab"
    Describes the startup settings (Parameters and filters) for all users rendring this dashboard through clicking the referenced Tab

The Analysis Editor also support editing these future dashboardstate types:

  • User Dashboardstate
    Startup settings for a specific user
  • Group Dashboardstate
    Startup settings for a specific group
  • Orgunit Dashboardstate
    Startup settings for a specific organization

These last three dasboardstate types is not implemented to be set in the user interface but if they are created through a database hack, you can edit them inside the Analysis Editor.

How to save the dashboardstate?

To save changes to a selected dashboardstate in the Editor, the procedure is the same as in runtime:

Open the actiontab to the left and click "Save as startup"

When you click "Save as startup" in the actiontab, the current dashboardstate is saved. Refer to the dashboardstate dropdown list in the top-bar to verify that you are saving the desired dashboardstate.

ATTN: The selected dashboardstate is not saved when you go to Menu -> File -> Save dashboard or hit Ctrl+S!
This action only saves the dashboard definition. You have to explicitly clik "Save as startup" to save the current dashboardstate.

 

How to create a system dashboardstate?

If you create a new dashboard definition or you open a dashboard that do not have any dashboardstates defined, you can create a System dashboardstate by setting your parameters and click "Save as startup" as in the above scenario.

How to create tab-dashboard dashboardstate?

To create a new Tab-Dashboard dashboardstate you have to render you dashboard by clicking the tab you want to create the dashboardstate for and then click "Save as startup" in the actiontab.