Creating DeepSee Dashboards
Creating and Modifying Dashboards
[Back] [Next]
   
Server:docs2
Instance:LATEST
User:UnknownUser
 
-
Go to:
Search:    

This chapter describes how to create and edit dashboards. It discusses the following topics:

For information on customizing covers for dashboards, see the DeepSee End User Guide.
Introduction to the Autosave Feature
DeepSee provides an optional autosave feature, which can automatically save the state of the User Portal for each user, for each dashboard. If the autosave feature is enabled for the User Portal:
For information on this option, see Specifying Basic Settings in the DeepSee Implementation Guide. Note that there is a separate autosave feature for the Analyzer.
Creating a Dashboard
To create a dashboard, use the following overall process:
  1. Log in to the User Portal in the desired namespace, as described earlier.
  2. Or click the Add button , which is above the list of dashboards, as follows:
    Then click Add Dashboard.
    Or click the < button at the left side of the User Portal, click Add, and then click Add Dashboard.
    In any case, the system then displays a dialog box that prompts you for basic information about the new dashboard.
  3. For Folder, optionally type a folder name or select an existing folder.
  4. For Dashboard Name, type the name of the dashboard.
    Note that this name is used (along with Folder) as the logical name of the dashboard; DeepSee displays this logical name when you use the Save As option, for example.
  5. Optionally provide values for the other options as given in the next section.
  6. Click OK.
    The system creates, saves, and displays the dashboard, which is initially empty.
  7. To configure the dashboard, use a combination of the following tools:
Modifying Dashboard Settings
To modify settings of a dashboard or of the widgets in a dashboard:
  1. Display the dashboard as described in Accessing DeepSee Dashboards,” earlier in this book.
  2. Click the > button to the left of the dashboard. (If this button is not visible, either the dashboard is not editable or you do not have permission to edit it.) The following shows an example:
    DeepSee then expands the Dashboard Editor as follows:
    To hide the Dashboard Editor, click the < button.
  3. Specify any of the following options as needed:
    For details on the other parts of the Dashboard Editor, see the following chapters:
    In some cases, the changes are saved automatically.
    In other cases, DeepSee does not save the changes automatically. In these cases, it displays an indicator like the following as a reminder:
    In such cases, save the dashboard as described in Saving a Dashboard.”
Adding a Widget to a Dashboard
To add a widget to a dashboard, use the following general procedure:
  1. Display the dashboard as described in Displaying DeepSee Dashboards,” earlier in this book.
  2. If you make unrelated changes to the dashboard, and if you want to keep those changes, save them.
    When you add a widget, the Dashboard Designer saves the dashboard with the newly added widget but discards other unsaved changes.
  3. Do one of the following:
    DeepSee then displays a wizard where you select a widget and specify basic information for it.
  4. Navigate to a widget type and (if applicable) subtype.
  5. (For most types of widgets) Optionally specify of the following items:
    Or specify a data source later, as described in Specifying the Data Source for a Widget.”
  6. Optionally specify a name for Widget Name.
  7. Click OK to add the widget to your dashboard.
  8. Optionally configure the widget. For information on specific types of widgets, see the following chapters:
  9. Optionally add controls to the widget. See the chapter Adding Widget Controls.”
Overview of Widget Types
This section provides an overview of widget types.
Widget Types and Subtypes
After you add widgets, you can reconfigure them in any way other than modifying their type. Note that you can modify the subtype, if applicable. DeepSee provides the following widget types and subtypes:
Comparison of Widget Types
For reference, the following table compares the key features of widgets, across the different widget types:
Widget Type Possible Data Sources Print Option? Export to Excel Option? Mini Analyzer Option? Drilldown Option?
pivot table widget pivot table, KPI, worksheet, or Ensemble business metric Yes Yes Yes* Yes*
meter pivot table, KPI, worksheet, or Ensemble business metric Yes No Yes* No
scorecard pivot table, KPI, worksheet, or Ensemble business metric Yes No Yes* No
calendar none No No No No
map pivot table, KPI, worksheet, Ensemble business metric, or no data source No No Yes* No
worksheet widgets worksheet Yes No No No
*This option is available only if the data source is a pivot table.
For a portlet, all these details depend upon the implementation.
Reconfiguring a Widget
When you reconfigure this widget, you can change any detail except for the widget type. To select and reconfigure a widget on a given dashboard:
  1. Display the dashboard as described in Displaying DeepSee Dashboards,” earlier in this book.
  2. Display the Dashboard Editor.
  3. Click Widgets.
    DeepSee then displays a list of the widgets in the dashboard.
  4. Click the name of the widget in this list. This action selects the widget.
    The system then displays a list of settings that you can modify. In most cases, the list includes submenus. The following shows a partial example:
  5. Optionally specify the following settings, which all widgets have:
    The other submenus list additional items, depending on the kind of widget you select. For information, see the following chapters:
Toolbar Settings
Use this submenu to configure the toolbar for the widget. Specify the following options:
Sidebar Settings
Use this submenu to configure optional sidebar text for the widget, which is displayed in a rectangle on the right side of the widget, as in the following example:
Specify the following options:
Specifying the Data Source for a Widget
To specify the data source for a widget:
  1. Access the Dashboard Editor and select the widget as described in Reconfiguring a Widget.”
  2. DeepSee then displays the Type and Data submenu.
  3. Specify one of the following options:
    Note that the Widget Type option enables you to choose a different widget subtype; it does not let you choose a type. See Widget Types and Subtypes,” earlier in this chapter.
The following subsections provide details.
Names of Data Sources
When you specify the data source for a widget, you refer to that data source by name. This logic simplifies the process of deploying dashboards and pivot tables to end users. But it also means that if you rename items, you must update any dashboards that use those elements.
When you open a dashboard, if the system cannot find a data source that it uses, the system displays as much of the dashboard as possible. For example:
Kinds of Data Sources
With exceptions noted below, a dashboard widget can display data from any of the following data sources:
Data source Where created For information, see
Pivot tables Analyzer Using the DeepSee Analyzer
Detail listings
KPIs (key performance indicators) Studio DeepSee Implementation Guide
Worksheets Worksheet Builder Defining DeepSee Models
Ensemble business metrics (available only in Ensemble) Studio Developing Ensemble Productions
Exceptions:
The kind of data source does not affect the appearance of the widget; for example, the user cannot tell if a given chart is displaying data from a pivot table, a KPI, a worksheet, or a business metric.
Note that some kinds of widgets do not use data sources.
Linked Widgets
When you specify the Link to option for a widget, you configure that widget as a dependent widget that is linked to another widget (an independent widget). The following rules govern linked widgets:
Saving a Widget to the Widget Catalog
You can copy a widget (including all its configuration details) to the widget catalog. To do so:
  1. Display the dashboard that contains the widget. See Displaying DeepSee Dashboards,” earlier in this book.
  2. Display the Dashboard Editor.
  3. Access the Dashboard Editor and select the widget as described in Reconfiguring a Widget.”
  4. The system displays a dialog box in which you specify details for the widget in the catalog.
  5. Specify Folder, Widget Name, and other options. For information, see Adding a Widget to a Dashboard,” earlier in this chapter.
  6. Click OK.
    If you have already saved a widget with this name, in the given folder, the system prompts you to confirm that you want to overwrite the previously saved widget.
  7. Click OK.
    No change is made to the dashboard itself.
The saved copy does not include any local overrides. That is, if you have customized the pivot table by using the Mini Analyzer, those customizations are not included in the widget catalog.
Removing a Widget from a Dashboard
To remove a widget from a dashboard:
  1. Display the Dashboard Editor.
  2. If you make unrelated changes to the dashboard, and if you want to keep those changes, save them.
    When you remove a widget, the Dashboard Designer automatically saves the dashboard, now without the removed widget. In this step, the Dashboard Designer discards other changes that you made and did not save.
  3. Click Widgets.
  4. Click the X button next to the widget name. The change is saved automatically.
Clearing the Autosave State of a Dashboard
If the autosave feature for the User Portal is enabled, then when you display a dashboard, the User Portal displays that dashboard with any unsaved changes that you might have made. To remove these unsaved changes, click Menu > Clear Autosave State. Then the User Portal displays the dashboard as defined in its saved definition.
Or save the dashboard, thus saving the changes and changing the definition. See the next topic.
Saving a Dashboard
To save the dashboard you are working on, do one of the following:
Or use Menu > Save As.... See the next section.
Copying a Dashboard
To copy a dashboard, do the following:
  1. Display the dashboard as described in Displaying DeepSee Dashboards,” earlier in this book.
  2. Specify the options as described in the previous section (and in Modifying Dashboard Settings)”
  3. Click OK.
Deleting a Dashboard
One way to delete a dashboard is as follows:
  1. Display the dashboard as described in Displaying DeepSee Dashboards,” earlier in this book.
  2. The system prompts you to confirm.
  3. Click OK.
Note:
When you delete a dashboard, DeepSee moves it into a folder named $TRASH, which the User Portal does not display. If you have access to Studio, you can restore the dashboard. For details, see Restoring Deleted Folder Items in the chapter “Packaging DeepSee Elements into Classes” in the DeepSee Implementation Guide.
Deleting a Dashboard in the User Portal
You can also delete a dashboard in the User Portal.
The User Portal does not display private dashboards. To delete a private dashboard, you must change it to be public and then delete it; see Modifying Dashboard Settings.” Or delete the dashboard in the Folder Manager, which displays all items (both public and private); see Introduction to the DeepSee User Interfaces in Getting Started with DeepSee.