Creating DeepSee Dashboards
Adding Widget Controls
[Back] 
   
Server:docs2
Instance:LATEST
User:UnknownUser
 
-
Go to:
Search:    

This chapter describes how to add controls to widgets in a dashboard. It discusses the following topics:

For examples of controls and information on where they can be used, see the chapter Orientation to Dashboards in the DeepSee End User Guide.
Note:
The following buttons are not controls and are not discussed in this chapter:
Button Discussion
Opens the pivot table in the Mini Analyzer.
Displays the widget in table format.
Displays the widget in chart format.
Exports the currently viewed data to Microsoft Excel.
Displays the dimension list.
Drills down to a lower level in a hierarchy.
These buttons are specified as settings of the widget, as discussed in Specifying Widget Settings,” earlier in this book.
The print button can be a control or can be specified as a widget setting.
Adding a Control
To add a control to a widget:
  1. Access the Dashboard Editor and select the widget as described in Reconfiguring a Widget,” earlier in this book.
  2. Click Controls.
  3. Click the plus sign + button.
    The system displays a dialog box where you specify the control.
  4. Specify the options as appropriate for the type of control you need, as described in the rest of this chapter.
  5. Click OK to add the control.
  6. Optionally save the dashboard.
For reference, this section lists the control options and describes their purposes.
Not all combinations of these options are suitable. Later sections of this chapter provide recommended configurations for specific kinds of controls.
Reconfiguring a Control
To reconfigure a control on a widget:
  1. Access the Dashboard Editor and select the widget as described in Reconfiguring a Widget,” earlier in this book.
  2. Click Controls.
  3. Click the control name.
  4. Make changes as needed. See the previous section for details.
  5. Optionally save the dashboard.
Adding an Explicit Filter Control
To add a control to filter one or more widgets, add a control as described earlier in this chapter and configure it as follows:
Specifying a Default Value
You may optionally type a value into Default Value.
Alternatively, click the magnifying glass. The system displays the following dialog box:
Here do one of the following:
Then click OK.
If you select a runtime variable, it is shown in the Default Value field with an at sign (@) at the beginning. For example: @DefaultZipCode
Note:
DeepSee assumes that the filter value is a member key rather than a member name. In most cases, the member key and member name are the same. For information on seeing the member key, see Finding the Key for a Member in the chapter Filtering Pivot Tables in Using the DeepSee Analyzer.
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:
Scenario Expression That Returns This Value
A single member "&[keyval]" where keyval is the key for the member. See Key Values in the DeepSee MDX Reference.
A range of members "&[keyval1]:&[keyval2]"
A set of members "{&[keyval1],&[keyval2],&[keyval3]}"
All members of the level except for a specified single member "%NOT &[keyval]"
All members of the level except for a specified subset "%NOT{&[keyval1],&[keyval2],&[keyval3]}"
Adding an OnClick Filter Control
Note:
An onclick filter control is supported only in a widget that uses a pivot table as its data source.
To add an onclick filter control, add a control as described earlier in this chapter and configure it as follows:
Example: Listing with OnClick Filter
As an example, see the dashboard Listing with OnClick Filter, in SAMPLES. This dashboard is defined as follows:
Adding a Refresh Control
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:
Tip:
To use a custom button instead of the standard icon, specify the Type as button and specify a value for Control Label or Icon.
Adding a Control to Print the Dashboard
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.
To add such a control, add a control as described earlier in this chapter and configure it as follows:
Then save the dashboard.
For further details and requirements, see the section Customizing Print Settings for a Widget.”
Adding a Control to Reload the Dashboard
To add a control to reload the dashboard, add a control as described earlier in this chapter and configure it as follows:
Tip:
To use a custom button instead of the standard icon, specify the Type as button and specify a value for Control Label or Icon.
Adding a Control to Change the Display Type
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:
To add such a control, add a control as described earlier in this chapter and configure it as follows:
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:
Then save the dashboard.
Adding a Control to Change the Row or Column Sort
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:
Adding a Control to Change the Row or Column Count
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:
Adding a Control to Change the Row or Column Specification
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:
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.
Variation: Providing a List of Choices
To provide a similar control that provides a list of choices for the row or column specification:
  1. 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:
  2. Use the preceding steps, with the following changes:
Adding a Control to Set a Pivot Variable
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:
The control is useful only if the data source for the widget uses the given pivot variable.
Adding a Control to Display a Different Pivot Table
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:
Note:
Such controls are supported only for pivot table widgets.
Variation: Providing a List of Choices
To provide a similar control that provides a list of choices:
  1. 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
    For example:
  2. Use the preceding steps, with the following changes:
Adding a Control to Display a Listing
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.
Note that in order to use the Google Maps API, you must obtain an API key. See Specifying Basic Settings in the DeepSee Implementation Guide for more information.
To add a control that displays a listing, add a control as described earlier in this chapter and configure it as follows:
Tip:
To use a custom button instead of the standard icon, specify the Type as button and specify a value for Control Label or Icon.
Adding a Control to Display the Pivot Analysis Window
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:
Adding a Control to Display Another Dashboard
To add a control that displays another dashboard, add a control as described earlier in this chapter and configure it as follows:
Note:
You can also configure a pivot table widget so that you can double-click a cell and drill to another dashboard. See the chapter Adding Pivot Table Widgets.”
Passing Values
To pass values from a dashboard to a web page, include the following tokens in the URL:
$$$VALUELIST
DeepSee replaces this token with a comma-separated set of values for the selected rows of the widget, as follows:
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
$$$CURRVALUE
DeepSee replaces this token with the current value of the widget, as follows:
Note:
$$$VALUELIST and $$$CURRVALUE are not macros. They are replaced at run time, not at compile time.
Adding a Control to Display a Web Page
To add a control that displays a web page, add a control as described earlier in this chapter and configure it as follows:
Adding a Control to Perform a Custom Action
To add a control that performs a custom action, add a control as described earlier in this chapter and configure it as follows:
Specifying the Value of a Row
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:
  1. Identify the column or property to use as the value.
  2. 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.
Hiding a Control
Sometimes it is useful to add a control, specify a default value, and hide it. To hide a control, for Type, select Hidden.