Creating DeepSee Dashboards
Adding Widget Controls
|
|
This chapter describes how to add controls to widgets in a dashboard. It discusses the following topics:
Note:
The following buttons are not controls and are not discussed in this chapter:
The print button

can be a control or can be specified as a widget setting.
To add a control to a widget:
-
-
-
Click the plus sign + button.
The system displays a dialog box where you specify the control.
-
Specify the options as appropriate for the type of control you need, as described in the rest of this chapter.
-
Click
OK to add the control.
-
Optionally save the dashboard.
For reference, this section lists the control options and describes their purposes.
-
Location Specifies where the control is shown:
-
Widget (the default) displays the control on the widget toolbar.
-
Do not use
Dashboard if you have configured this as a zero-worklist dashboard, because the control would not be visible to users.
-
Onclick Event configures the control as an onclick control. No visible indication of the control is given.
-
Target Specifies which widgets this control affects. Specify one of the following:
-
If this option is blank, the control affects only the widget that owns it.
-
If this option is
*, the control affects all widgets.
-
If this option is the name of the widget, the control affects that widget. In this case, use the value given in the
Widget Name option for that widget.
-
Action Specifies the action. Custom actions are shown at the end of the list.
-
-
Type Specifies the visual form of the control:
-
auto The system chooses the suitable form based on your other selections.
-
dropdown The control is shown as a drop-down list.
-
searchBox The control is shown as a searchable drop-down list. The user can type a value and then search for values that match the input.
-
radio The control is shown as a set of radio buttons.
-
button The control is shown as a button.
-
hidden The control is not shown.
-
custom The control is based on a custom portlet.
-
-
-
Active When Specifies when this control is active. Choose one of the following values:
-
Always This control is always active.
-
Item Selected This control is active when the user selects one or more cells in a pivot table. The control is inactive otherwise.
-
1 Listing Item Selected This control is active when the user selects a single row of a listing. The control is inactive otherwise.
-
Listing Item Selected This control is active when the user selects one or more rows of a listing. The control is inactive otherwise.
-
Control Tooltip Specifies a tooltip to display when the user hovers the cursor over the control.
-
-
Read Only If selected, this option prevents a user from changing the value in this control.
-
-
Note that you must also specify
Default Value so that the dashboard always has a value for this filter.
Not all combinations of these options are suitable. Later sections of this chapter provide recommended configurations for specific kinds of controls.
To reconfigure a control on a widget:
-
-
-
-
-
Optionally save the dashboard.
To add a control to filter one or more widgets, add a control as described
earlier in this chapter and configure it as follows:
-
-
Target If this control is going to automatically refresh the display, do one of the following:
-
Leave this option blank, if you want to refresh only this widget. This is the default.
-
Specify
* to refresh all widgets.
-
Specify the name of the widget to refresh (use the value given in the
Widget Name option for that widget).
-
Action Select one of the following:
-
Apply Filter sets the filter and automatically refreshes the display.
-
Set Filter sets the filter but does not refresh the display.
-
Filter Select the filter for this control to use:
-
For a pivot table created in the Analyzer, the system lists all levels available in the same subject area.
If there are any named filters in the subject area, the list include the item
Named Filters. If you select this option, the user will be able to select any one of those named filters.
-
For a KPI, the system lists all filters defined in the KPI.
-
For an Ensemble business metric, the list includes
Instance (the instance to display),
MaxHistory (the number of historical points to display for the properties that specify
AUTOHISTORY), and
Properties (the metric property to display).
-
-
Control Label or Icon Optionally type the text that you want to display above the control. Or select an icon to display next to the control.
-
-
Value Required If the user must specify a value for this filter, enable the
Required option. Also specify a value for
Default Value so that the dashboard always has a value for this filter.
-
Control Tooltip Optionally type a tooltip to display when the user hovers the cursor over the control.
Alternatively, click the magnifying glass. The system displays the following dialog box:
Here do one of the following:
Note:
Also, if a user accesses the dashboard via a URL, any filter values in the URL take precedence over the default value specified in this control.
If you type a value into the
Enter an MDX Key field, use one of the following forms:
Note:
An onclick filter control is supported only in a widget that uses a pivot table as its data source.
-
-
Target Do one of the following:
-
Specify
* to refresh all widgets.
-
Specify the name of the widget to refresh (use the value given in the
Widget Name option for that widget).
-
Note:
You do not need to select the filter to apply. DeepSee automatically filters based on the complete context in which the user selects; that is, DeepSee considers the row and column context as well as any currently active filters applied to the widget. Furthermore, if you do specify a filter within the widget configuration,
that filter is ignored.
As an example, see the dashboard Listing with OnClick Filter, in
SAMPLES. This dashboard is defined as follows:
-
In the dashboard definition, the upper widget has an onclick filter whose target is the lower widget.
-
The pivot table shown in the top widget Use in Dashboards/Product Info displays product categories as rows.
-
The pivot table shown in the bottom widget Use in Dashboards/HoleFoods Sales Listing is defined as an unfiltered detail listing that does not auto-execute. To define a pivot table in this way, do the following in the Analyzer:
-
Create a pivot table that uses the desired cube and that has no column or row definition and that also has no filter, like this:
-
-
Click the listing button

.
You can perform steps 2 and 3 in either order.
-
To add a control to refresh the dashboard (which is necessary if you have controls that set
filters but that do not apply them automatically), add a control as described
earlier in this chapter and configure it as follows:
-
-
Target Do one of the following:
-
Leave this option blank, if you want to refresh only this widget. This is the default.
-
Specify
* to refresh all widgets.
-
Specify the name of the widget to refresh (use the value given in the
Widget Name option for that widget).
-
-
-
If you select
auto, the control appears as follows:

-
If you select
timer, type a value into
Time (in seconds). In this case, the refresh control will automatically run at the specified interval.
-
Control Tooltip Optionally type a tooltip to display when the user hovers the cursor over the button.
You can add controls with which users can print parts or all of the dashboard. The output is a PDF file (opened in a browser window) with one page for each widget.
-
-
Target Specify a list of the names of the widgets to print. The first widget in the list determines the print settings.
Or, if you want to print all the widgets and do not need to control the print settings, type
*.
-
-
The default type is a small button with a picture on it.
-
Control Label or Icon Optionally type the text that you want to display on the control. Or select an icon to display next to the control.
-
Control Tooltip Optionally type a tooltip to display when the user hovers the cursor over the control.
To add a control to reload the dashboard, add a control as described
earlier in this chapter and configure it as follows:
-
-
Target Ignore this option. All widgets are refreshed.
-
-
-
If you select
auto, the control appears as follows:

-
If you select
timer, type a value into
Time (in seconds). In this case, the reload control will automatically run at the specified interval.
-
Control Tooltip Optionally type a tooltip to display when the user hovers the cursor over the button.
You can add controls with which users can change the display type from one chart to another. You can provide two different kinds of controls:
-
A drop-down list from which the user can choose a type.
-
A button that immediately switches to a different type. In this case, you typically provide at least two buttons, so that the user can easily return to the original type.
-
-
Target Leave this blank. Or type
* if this control should affect all widgets in this dashboard.
-
Action Select
Set Chart Type or
Choose Chart Type. The first option adds a button (which you configure later) to set the display type to a specific type. The second option adds a drop-down list (which you configure later) of display types.
-
-
Control Label or Icon Optionally type the text that you want to display on the control. Or select an icon to display next to the control.
-
Control Tooltip Optionally type a tooltip to display when the user hovers the cursor over the control.
Then select the control again and display the
Control menu. Select
Chart Type. This displays a list of chart types, which includes the pivot table type. Then:
-
-
To unselect a given type, click it a second time. To unselect all types, click
Clear Selection.
In a pivot table widget, if a user double-clicks a column header in a pivot table, the system automatically sorts the pivot table by the data in that column. No configuration is needed for this.
You can also add a control that affects the row or column sort. To add such a control, add a control as described
earlier in this chapter and configure it as follows:
-
-
Target Leave this blank. Or type
* if this control should affect all widgets in this dashboard.
-
-
-
Control Label or Icon Optionally type the text that you want to display on the control. Or select an icon to display next to the control.
-
Control Tooltip Optionally type a tooltip to display when the user hovers the cursor over the control.
For pivot table widgets, to add a control that changes the row or column count, add a control as described
earlier in this chapter and configure it as follows:
-
-
Target Leave this blank. Or type
* if this control should affect all widgets in this dashboard.
-
-
-
Control Label or Icon Optionally type the text that you want to display on the control. Or select an icon to display next to the control.
-
Control Tooltip Optionally type a tooltip to display when the user hovers the cursor over the control.
For widgets that display pivot tables (rather than other data sources), you can add a control that enables the user to change the specification for the rows or columns of the pivot table. To add such a control, add a control as described
earlier in this chapter and configure it as follows:
-
-
Target Leave this blank. Or type
* if this control should affect all widgets in this dashboard.
-
-
-
[gend].[h1].[gender].MEMBERS
{MEASURES.[avg test score],MEASURES.[avg allergy count]}
If this setting is an empty string, DeepSee ignores the specification and uses the specification defined in the original data source.
-
Control Label or Icon Optionally type the text that you want to display on the control. Or select an icon to display next to the control.
-
Control Tooltip Optionally type a tooltip to display when the user hovers the cursor over the control.
Note:
Such controls are supported only for widgets that use pivot tables as the data source. Also note that it is not practical to use
Set Column Spec or
Choose Column Spec (see the
subsection) with meters and scorecards because these options change the property names of the data source.
To provide a similar control that provides a list of choices for the row or column specification:
-
Create a term list to hold the choices.
For each term list item, specify
Key as the name of the specification and specify
Value as an MDX set expression. For example:
-
Use the preceding steps, with the following changes:
Pivot variables provide another way for your end users to interact with your dashboards. A pivot table can be defined so that its underlying query uses pivot variables in selected parts of the query. (Similarly, an MDX-based KPI can use pivot variables in the same way.) When a dashboard includes this pivot table, that dashboard can include a
pivot variable control, with which the user can change the value of the corresponding pivot variable. DeepSee simply substitutes the given value into the query, executes the query, and then redisplays the pivot table.
To add a control to set a pivot variable, add a control as described
earlier in this chapter and configure it as follows:
-
-
-
Control Label or Icon Optionally type the text that you want to display on the control. Or select an icon to display next to the control.
-
Control Tooltip Optionally type a tooltip to display when the user hovers the cursor over the control.
The control is useful only if the data source for the widget uses the given pivot variable.
For a pivot table widget, you can provide a control that displays a different pivot table as the data source. The original data source does not have to be a pivot table. To add a control to display a specific pivot table in a widget, add a control as described
earlier in this chapter and configure it as follows:
-
-
-
-
-
-
Control Tooltip Optionally type a tooltip to display when the user hovers the cursor over the control.
Note:
Such controls are supported only for pivot table widgets.
To provide a similar control that provides a list of choices:
-
Create a term list to hold the choices.
For each term list item, specify
Key as the name of the specification and specify
Value as the name of a pivot table, ending with
.pivot
-
Use the preceding steps, with the following changes:
-
-
Type Select
auto (which becomes a drop-down list),
dropdown, or
radio (if there is a small number of choices).
-
DataSource List (this option is available only when you
reconfigure a control) Select the term list that you created for this purpose.
You can display listings from any pivot table widget whose data source defines a listing.
Important:
A map listing uses the Google Maps API. Be sure that your usage of this API is consistent with the Terms of Use, which you can access via a link displayed in this listing.
To add a control that displays a listing, add a control as described
earlier in this chapter and configure it as follows:
-
-
-
Then choose the listing from the drop-down list to the right.
-
For a regular listing, this control appears as follows:
For a map listing, this control appears as follows:

-
Control Tooltip Optionally type a tooltip to display when the user hovers the cursor over the control.
For a widget that displays a pivot table, you can add a control that displays the Pivot Analysis window. To add such a control, add a control as described
earlier in this chapter and configure it as follows:
-
-
-
-
Analysis Select the analysis option to display, from the following:
If you do not choose an option, the user can select any option. If you do choose an option, the user sees only that option.
-
Type Select
auto (which is shown as the

button in this case).
-
Control Tooltip Optionally type a tooltip to display when the user hovers the cursor over the control.
To add a control that displays another dashboard, add a control as described
earlier in this chapter and configure it as follows:
-
-
-
-
Dashboard Click the Search button

, click the dashboard, and click
OK.
-
Type Select
button or
auto (which is shown as a button in this case).
-
Control Label or Icon Optionally type the text that you want to display on the control. Or select an icon to display next to the control.
-
Control Tooltip Optionally type a tooltip to display when the user hovers the cursor over the control.
To pass values from a dashboard to a web page, include the following tokens in the URL:
DeepSee replaces this token with a comma-separated set of values for the selected rows of the widget, as follows:
-
For a scorecard widget, the values are taken from the property that is configured with
Value Column.
-
For a pivot table widget that displays a listing, the values are taken from the listing IDs.
-
For a pivot table widget that displays a KPI, the values are taken from the property that is configured with
Value Column, if any. Otherwise the values are taken from the first column.
-
The values are assumed not to contain commas.
As a simple example, the URL could be as follows:
http://www.google.com/search?q=$$$VALUELIST
DeepSee replaces this token with the current value of the widget, as follows:
-
For a scorecard widget, the value is taken from the property that is configured with
Value Column.
-
For a pivot table widget that displays a listing, the value is taken from the first selected cell that was displayed before the listing was shown.
-
For other pivot table widgets, the value is taken from the first selected cell.
-
To add a control that displays a web page, add a control as described
earlier in this chapter and configure it as follows:
-
-
-
-
-
Type Select
button or
auto (which is shown as a button in this case).
-
Control Label or Icon Optionally type the text that you want to display on the button. Or select an icon to display next to the control.
-
Control Tooltip Optionally type a tooltip to display when the user hovers the cursor over the control.
To add a control that performs a custom action, add a control as described
earlier in this chapter and configure it as follows:
-
-
-
Action Select the custom action. The custom actions are at the end of the list.
-
Type Select an option as follows:
-
Control Label or Icon Optionally type the text that you want to display on the button. Or select an icon to display next to the control.
-
Control Tooltip Optionally type a tooltip to display when the user hovers the cursor over the control.
In some cases, a custom action might require information about the context that is, the row that the user selected before launching the action. (Other actions operate the same way no matter what the context is.) When you use custom actions, make sure that you know whether this context is required.
If a custom action requires context, do the following to specify which column contains the value to pass to the actions:
-
-
Reconfigure that column or property and select the
Value Column option.
Do not select the
Value Column option for more than one property or column in the same widget; if you do, the result is indeterminate.
Sometimes it is useful to add a control, specify a default value, and hide it. To hide a control, for
Type, select
Hidden.