Designing Gadgets

Gadgets are mini-graphs and data grids that display multiple metrics and can be placed together to create complex dashboard pages. Each gadget is designed to perform a specific type of business analysis such as zoom or compare analysis. You can configure a gadget to display specific data for specific users, and PMF stores user preferences and applies them to each page. Users can select and save various parameters determined by the gadget author to personalize the gadgets on their pages at runtime.

To utilize gadgets in your PMF dashboard pages, you can select from the gadgets already available in PMF or create your own gadgets. When you create a new gadget, you also have to create a gadget class. Overviews of all aspects of gadget design and implementation are provided in the sections that follow. For information about the forms used to design gadgets in PMF, see Manage Tab - Dashboards.

Designing a Gadget Procedure

To design a new gadget, you must first create a gadget procedure, which is usually a WebFOCUS reporting or graph procedure that reports on data from the PMF data mart. (Gadgets can also be designed to extract and report on data from other sources.) All gadget procedures must have a name that begins with a gadget_ prefix.

When using a new or existing WebFOCUS report or graph procedure for a gadget, you can utilize standard WebFOCUS parameter names. There are three types of parameters gadgets can process: display fields, groupings, and filters.

Reference: Gadget Display Fields

Display fields, similar to PRINT or SUM fields in a WebFOCUS request, determine the data fields displayed in the gadget using parameters that indicate whether to display or hide these fields, or to use these fields as data feeds for a graph.

Each display field has the following three possible settings:

Not used. The field is not available to be displayed in the gadget.
Optional. The field, or the result of the field, can be displayed in the gadget if the user chooses to display it.
Required. The field, or the result of the field, must be displayed in the gadget.

The display fields you can choose to include in a gadget are listed and described in the following table:

Display Field

What it Displays

Actual

Actual measure value (raw data).

Target

Target measure value (raw data).

Pct_Reached

Percent reached for actual/target measures.

Pct_Used

Cumulative percent spent for project budget measures.

or

Cumulative percent completed for project schedule measures.

Indicator

Dashboard symbol that indicates the status of a measure, objective, or perspective. For:

Measures. Shows the Pct_Reached to be within or outside set tolerances.

Objectives. Shows the cumulative, weighted Pct_Reached for all linked measures to be within or outside set tolerances.

Perspectives. Shows the cumulative, weighted Pct_Reached for all linked measures and objectives to be within or outside set tolerances.

Indicator + Actual

Combines the actual value with the indicator.

Indicator + Target

Combines the target value with the indicator.

Indicator + Pct_Reached

Combines the percent reached value with the indicator.

Indicator + Pct_Used

Combines the actual measure value with the indicator.

Indicator + Actual + Pct_Reached

Combines the actual and percent reached values with the indicator.

Indicator + Target + Pct_Reached

Combines the target and percent reached values with the indicator.

High-Mid-Low: raw count totals

Shows a raw count of the total number of measures in High (Green), Mid (Yellow), and Low (Red) status for the selected grouping and filtering.

High-Mid-Low: percentages of totals

Shows a percentage of the total number of measures in High (Green), Mid (Yellow), and Low (Red) status for the selected grouping and filtering.

Display Field	What it Displays
Actual	Actual measure value (raw data).
Target	Target measure value (raw data).
Pct_Reached	Percent reached for actual/target measures.
Pct_Used	Cumulative percent spent for project budget measures. or Cumulative percent completed for project schedule measures.
Indicator	Dashboard symbol that indicates the status of a measure, objective, or perspective. For: Measures. Shows the Pct_Reached to be within or outside set tolerances. Objectives. Shows the cumulative, weighted Pct_Reached for all linked measures to be within or outside set tolerances. Perspectives. Shows the cumulative, weighted Pct_Reached for all linked measures and objectives to be within or outside set tolerances.
Indicator + Actual	Combines the actual value with the indicator.
Indicator + Target	Combines the target value with the indicator.
Indicator + Pct_Reached	Combines the percent reached value with the indicator.
Indicator + Pct_Used	Combines the actual measure value with the indicator.
Indicator + Actual + Pct_Reached	Combines the actual and percent reached values with the indicator.
Indicator + Target + Pct_Reached	Combines the target and percent reached values with the indicator.
High-Mid-Low: raw count totals	Shows a raw count of the total number of measures in High (Green), Mid (Yellow), and Low (Red) status for the selected grouping and filtering.
High-Mid-Low: percentages of totals	Shows a percentage of the total number of measures in High (Green), Mid (Yellow), and Low (Red) status for the selected grouping and filtering.

Reference: Gadget Grouping

Grouping involves both sorting and aggregating data values. Selected detail values are sorted using the classifications built into the group, then aggregated at the level implied by the sort.

Many sort groupings are affected by other groupings selected above them. For example, if you select to group by perspective first, and then by objective, the resulting gadget shows measure level details, the measure results are grouped first by perspective and then by objectives within each perspective, and the aggregations occur at the objective level. For each gadget, you can select up to three groupings.

Each grouping has the following two possible settings:

Optional. The gadget can use the grouping, and the gadget instance can include a default value for the grouping.
Required. The gadget must use the grouping, and a value must be specified for the grouping. Note that the default setting from the gadget instance is used, and users can optionally change the default.

The groupings you can choose to include in a gadget are listed and described in the following table:

Grouping Method

What it Does

Perspectives

Sorts results alphabetically by perspective name and aggregates field values at that level.

Objectives

Sorts results alphabetically by objective name and aggregates field values at that level.

Measures

Sorts results alphabetically by measure name and aggregates field values at that level.

User Specified Dimension

Sorts results alphabetically by level values within the dimension specified by the user and aggregates field values at that level.

User specified dimension drill-downs are continuous by level, using a second drill-down on an individual value within a dimension to show data at the next dimension level.

Time

Sorts results alphabetically by level values within the time dimension and aggregates field values at that level.

Time dimension drill-downs are continuous by level, using a second drill-down on an individual value within a time dimension to show data at the next time level, down to the lowest level.

Grouping Method	What it Does
Perspectives	Sorts results alphabetically by perspective name and aggregates field values at that level.
Objectives	Sorts results alphabetically by objective name and aggregates field values at that level.
Measures	Sorts results alphabetically by measure name and aggregates field values at that level.
User Specified Dimension	Sorts results alphabetically by level values within the dimension specified by the user and aggregates field values at that level. User specified dimension drill-downs are continuous by level, using a second drill-down on an individual value within a dimension to show data at the next dimension level.
Time	Sorts results alphabetically by level values within the time dimension and aggregates field values at that level. Time dimension drill-downs are continuous by level, using a second drill-down on an individual value within a time dimension to show data at the next time level, down to the lowest level.

Reference: Gadget Filtering

Gadget filters limit the displayed results to the values a user selects. For example, if a user specified the financial perspective as a filter, the results displayed would be limited to only the details linked to the financial perspective. For each gadget, you can specify up to five different filtering methods.

Each filter has the following two possible settings:

Optional. The gadget can use the filter, and the gadget instance can include a default value for the filter.
Required. The gadget must use the filter, and a value must be specified for the filter. Note that the default setting from the gadget instance is used, and users can optionally change the default.

The filters you can choose to include in a gadget are listed and described in the following table:

Filter

Limits the Output to ...

Scorecard

The default scorecard for the gadget. Enables users to select a default scorecard to display in the gadget. If not selected, the default selection is the default scorecard of the user.

Perspective

The default perspective for the gadget. Enables users to select a default perspective to display in the gadget. If not selected, the default selection is the PMF default perspective.

Note: Requires selection of the Scorecard filter.

Objective

The default objective for the gadget. Enables users to select a default objective to display in the gadget.

Note: Requires selection of the Scorecard filter.

Measure Series

The default measure series for the gadget. Enables users to select a default measure series to display in the gadget.

User Specified Dimension

The default level value for the gadget, for a selected dimension. Enables users to select a default dimension to display in the gadget.

Time

The a default point in the time dimension for the gadget. Enables users to select a default time dimension value to display in the gadget.

Red and Yellow Indicators only

Only retrieve and display measure values, objectives, or perspectives, where the result is a very low or moderately low (red or yellow) condition. This filter blocks out any measure values with a high (green) condition.

Red indicators only

Only retrieve and display measure values, objectives, or perspectives, where the result is a very low (red) condition. This filter blocks out any measure values with a high (green) or moderately low (yellow) condition.

Filter	Limits the Output to ...
Scorecard	The default scorecard for the gadget. Enables users to select a default scorecard to display in the gadget. If not selected, the default selection is the default scorecard of the user.
Perspective	The default perspective for the gadget. Enables users to select a default perspective to display in the gadget. If not selected, the default selection is the PMF default perspective. Note: Requires selection of the Scorecard filter.
Objective	The default objective for the gadget. Enables users to select a default objective to display in the gadget. Note: Requires selection of the Scorecard filter.
Measure Series	The default measure series for the gadget. Enables users to select a default measure series to display in the gadget.
User Specified Dimension	The default level value for the gadget, for a selected dimension. Enables users to select a default dimension to display in the gadget.
Time	The a default point in the time dimension for the gadget. Enables users to select a default time dimension value to display in the gadget.
Red and Yellow Indicators only	Only retrieve and display measure values, objectives, or perspectives, where the result is a very low or moderately low (red or yellow) condition. This filter blocks out any measure values with a high (green) condition.
Red indicators only	Only retrieve and display measure values, objectives, or perspectives, where the result is a very low (red) condition. This filter blocks out any measure values with a high (green) or moderately low (yellow) condition.

Creating a Gadget Class

How to:

Create a Gadget Class

For PMF to call a procedure and store parameters locally for a gadget, you must first create a gadget class. The gadget class enables PMF to manage the gadget. A gadget class defines the input parameters for the gadget and controls how the parameters are saved for each user. The class also controls the parameters that each instance of the gadget can store and recall.

Top of page

Procedure: How to Create a Gadget Class

Before creating a gadget class, add all new gadget procedures to the WebFOCUS pmfgadgets application folder.

In the Manage tab in PMF, click the Dashboards panel button.
Click New Gadget.
PMF displays the New Gadget Class Designer panel. The following image shows the panel, with sample values in the fields.
In the Class Name field, enter a descriptive name for the new gadget class.
From the Content Type drop-down list, click the option that applies to the gadget. For details on the choices, see Adding Various Content Types as Gadgets.
From the Content Display drop-down list, click the option that applies to the gadget.
For example, if the Content Type is PMF gadget focexec, the Content Display drop-down list contains the names of all FOCEXECs that begin with gadget_ and are in the WebFOCUS pmfgadgets application folder.
From the Scorecard filters drop-down list, click one of the following options.
- Use Current Scorecard, to apply the scorecard that is currently associated with this gadget.
- Scorecard not used, to suppress the use of any scorecard with this gadget.
In the Class Width and Class Height fields, type the values, in pixels, that determine the placement of the gadget.
For a graph that is coded according to the standard gadget specification, the width and height that you type here is dynamically passed to the gadget at run time to determine the actual width and height of the output of the graph.
From the Preview image drop-down list, click the name of the .png file that supplies the preview image for the gadget.
The preview image appears on the Catalog chevron in Dashboard Designer. If you do not supply a preview image of your own, you can use the default preview image, preview_na.png.
In the Description field, optionally type a brief description of the gadget.
From the available Display, Groupings, and Filters fields, select the applicable options for the new gadget class.
Click Save when you have finished creating the gadget class.
PMF displays a message saying the new gadget class has been added. The Gadget Definitions navigation tree on the left is refreshed to display the new gadget class.

Creating Gadgets with WebFOCUS InfoAssist

WebFOCUS InfoAssist can be used to develop new operational gadgets that display information from your operational data sources. A new property defines your custom-developed content as a PMF gadget, and allows you to optionally prompt to filter your content using PMF Dimensions. For more information on how to use this, see the WebFOCUS InfoAssist User’s Manual.

Note: InfoAssist integration for setting up parameter receipt requires WebFOCUS 7.7.01 or higher. If you have an earlier version of WebFOCUS, you can still handle parameters in the report code. For more information, see Mapping Parameters to an Operational Report.

Saving Managed Reporting Content as a Gadget

How to:

Save Managed Reporting Content as a Gadget from within PMF

Gadgets can be defined based on standard reports in your Managed Reporting repository. This can be done from within PMF or from within the WebFOCUS MR environment, which is typically from within BID.

Note: MR Save as Gadget integration in WebFOCUS BID requires WebFOCUS 7.7.1 or higher.

Top of page

Procedure: How to Save Managed Reporting Content as a Gadget from within PMF

Saving Managed Reporting content as a gadget will make it available from within PMF to use on features such as Dashboards. MR content can be given parameters from PMF, such as Dimensional filters or sorts, and can optionally receive Broadcasts on a PMF Dashboard.

In the Manage tab, click the Dashboards panel button.
Click New Gadget.
The New Gadget Designer panel opens.
Enter information for the gadget name and its other properties. For more information on these properties, see Creating a Gadget Class.
Note: If you want to pass parameters to the MR Standard Report, make sure you have added code to your report to enable it to receive PMF parameters. For more information, see Mapping Parameters to an Operational Report.
From the Content Type drop-down menu, select MR Report. A MR Domain drop-down menu will become available, which lists all of the MR Domains.
Select the MR Domain where your Standard Report is stored. PMF will list the Standard Reports that are stored in that MR Domain in the Content Display drop-down menu.
Select the MR Standard Report that will become the gadget. Click Save.

Adding Various Content Types as Gadgets

The PMF Dashboard capability allows you to directly add several types of content as gadgets. These types include:

Web applications (for example, Google, Wiki, or other Web widgets)
Adobe® Flex® SWF objects
General WebFOCUS FOCEXEC content

When creating a gadget, or editing a gadget, you can select the content type from a drop-down list on the New Gadget Class Designer panel or the Edit Gadget Class Designer panel, as shown in the following image.

Edit Gadget Class Designer panel

Content Type

Description

PMF gadget focexec

Default. Allows you to select from any FOCEXEC in your environment with gadget_ as the starting characters in the name. Typically, these are PMF gadgets. Since most of the shipped FOCEXEC gadgets are already registered in PMF, you would typically need to use this option only if you have created a custom gadget and want to register it with the system.

Adobe Flex control

Allows you to select from any SWF file that you have installed in any application in your application path. PMF does not search the mainstreet, pmfdata, or pmf[rdbms] app folders.

Tip: If WebFOCUS is installed in a split-tier configuration, the SWF files must be installed in the same app folder on both the WebFOCUS Client and WebFOCUS server machines.

WebFOCUS report

Allows you to select from any FOCEXEC in your environment. Typically, you would select this option to “gadgetize” any existing WebFOCUS report. This allows you to pass standard PMF parameters to the report. For more information on how to receive and use those parameters, see Mapping Parameters to an Operational Report.

MR report

Allows you to integrate Managed Reporting content into PMF. Typically, you would select this option to "gadgetize" an existing WebFOCUS Managed Reporting report. This capability allows you to pass standard PMF parameters to the report. For more information on how to receive and use those parameters, see Mapping Parameters to an Operational Report.

Web Page

Allows you to specify any external Web application that you want to include as a gadget. You can type the entire URL for the application, including any parameters, in the URL field.

Content Type	Description
PMF gadget focexec	Default. Allows you to select from any FOCEXEC in your environment with gadget_ as the starting characters in the name. Typically, these are PMF gadgets. Since most of the shipped FOCEXEC gadgets are already registered in PMF, you would typically need to use this option only if you have created a custom gadget and want to register it with the system.
Adobe Flex control	Allows you to select from any SWF file that you have installed in any application in your application path. PMF does not search the mainstreet, pmfdata, or pmf[rdbms] app folders. Tip: If WebFOCUS is installed in a split-tier configuration, the SWF files must be installed in the same app folder on both the WebFOCUS Client and WebFOCUS server machines.
WebFOCUS report	Allows you to select from any FOCEXEC in your environment. Typically, you would select this option to “gadgetize” any existing WebFOCUS report. This allows you to pass standard PMF parameters to the report. For more information on how to receive and use those parameters, see Mapping Parameters to an Operational Report.
MR report	Allows you to integrate Managed Reporting content into PMF. Typically, you would select this option to "gadgetize" an existing WebFOCUS Managed Reporting report. This capability allows you to pass standard PMF parameters to the report. For more information on how to receive and use those parameters, see Mapping Parameters to an Operational Report.
Web Page	Allows you to specify any external Web application that you want to include as a gadget. You can type the entire URL for the application, including any parameters, in the URL field.

Once you have specified the type of gadget that you are registering, you can configure the passing of parameters, as appropriate to the gadget, as detailed in Designing Gadgets.

Using Analysis Designer Templates to Create Gadgets

How to:

Build a New Gadget From an Existing PMF Template

PMF allows you to use existing Analysis Designer templates to create Gadgets. These Gadgets can display grids with indicators that break PMF metrics, strategic objectives, or themes out Dimensionally. Each data item in the grid contains drill downs to other related PMF content, and provides the same feedback, alerting, and task capabilities as pre-built content in PMF.

Top of page

Procedure: How to Build a New Gadget From an Existing PMF Template

In the Manage tab, click the Dashboards panel button.
Click New Gadget.
The New Gadget Designer panel opens, as shown in the following image.
Enter a name for the gadget. This procedure will use Metric - Actual v Tgt across Dimension.
Select PMF Gadget focexec from the Content Type drop-down menu.
Select gadget_pmf_rpt_tmplt_meas_acrdim from the Content Display drop-down menu.
In the Display section, select Actual in the first drop-down menu, and Indicator + Value + Pct Reached in the Type drop-down menu that appeared. Target, which is your default Target type as configured in PMF, will be selected automatically as the default value.
Select User Specified Dimension in the Groupings section. Make sure Required is selected. Dimensions to be used cannot be specified at this point, and will be made available at runtime.
Click the down arrow to the left of the Grouping that was just created to turn it sideways. This will sort into an Across, because this template wants a Grouping specified as an Across.
Select Measures in the Filters drop-down menu. Then, select Optional and select the Multi-Select check box.
Leave all other options with their default values.
Click Preview. PMF will run the Gadget and display a preview. The auto-selection routine will be run and defaults for the display will be chosen based on the data available for the currently selected Scorecard.
Note: If you are working with your own data mart and Scorecard, and that Scorecard does not have loaded Measure data yet, PMF will display an error message.
Click Save. The Gadget can now be used on the Dashboard.