Adding Interactivity to Pages and Dashboards

Pages and dashboards become much more effective for data reporting and analysis when you add interactivity to them. A single action in one report can cause other reports to refresh simultaneously and show the data associated with the action.

You can enhance the page interactivity by

• defining global filters

• enabling the sharing of drill-up and drill-down actions

• enabling the sharing of drill-through actions

Defining Global Filters

Global filters are used to control the display of one or more reports in a single portal page or in a dashboard. For example, a global filter can be on a report that contains only a prompt or prompt controls. This allows for a single selection to drive a number of reports at once. When a prompt answer is changed, all related reports refresh dynamically to show the data that answers the prompt. For example, if you answer a prompt for a country with Brazil, all related reports on the page are filtered to show the data for Brazil. When this is used in a dashboard, the context is passed to all corresponding tabs.

Perform the following tasks to set up a page or a dashboard with global filters:

	Prepare the Reports
	Create the Global Filters
	Assemble the Reports on a Page

Preparing the Reports

Before you start creating a page or a dashboard with global filters, you must know which reports you can use, and have the reports ready. The reports can be authored in Report Studio, Query Studio, or Analysis Studio.

If you include reports from only one package, the global filters share parameters using the model item. If you include reports from different packages, the following conditions must be met:

• All reports must use the same parameter name in their filter statements.

  An example of a relational filter is Country = ?pCountryPrompt?. An example of an OLAP slicer filter is Great Outdoors Company].[Sales Territory].[SalesTerritory].[Country]->?pCountryPrompt?.

  We do not recommend using the default parameter name, such as Parameter1.

• The Report Studio reports must follow the naming convention used in one of the other studios.

  For example, in Query Studio the convention is [attribute name] or [level name], such as Order_Method1. In Analysis Studio the convention is [hierarchy name], such as Order Method.

  Note: If the page contains only Report Studio reports, we recommend using the p[attribute name]Prompt convention, for example, pCountryPrompt.

Create the Global Filters

A global filter is a value that is shared across different reports. At least one of the reports that you are using for the dashboard needs to contain a prompt or prompt control. The prompted report is embedded into a page or a dashboard using the Cognos Viewer portlet and linked with other reports in the page using the global filter portlet properties. The prompts that are used as global filters control the display of your chosen linked reports. If this functionality is implemented in a single page, the prompts control linked reports in different sections of the page. If the page is a dashboard with multiple tabs, the prompts can control the report filtering across tabs.

We recommend creating prompt reports in Report Studio. The rich editing environment of this studio gives the author access to a variety of prompt controls, such as the Next, Reprompt, or Finish buttons. These controls add more interactivity to portal pages.

For more information about building prompts and prompt pages, see the Report Studio Professional Authoring User Guide.

Using Metrics as Global Filters

You can use metrics and strategy elements in Cognos Metrics portlets as global filters. In a page, or in a dashboard with multiple tabs, the Metric List, Metrics Impact Diagram, and Metrics Custom Diagram portlets can filter prompted parameters for the Cognos Viewer portlet. You must configure Cognos Viewer to show a report associated with a metric or a strategy element, and set up communication between the portlets using the same channel name .

When a user clicks a metric name in Metric List, Metrics Impact Diagram, or Metrics Custom Diagram, Cognos Viewer dynamically updates the report if the report prompt parameters are based on metric values. When a user clicks a strategy element in Metrics Custom Diagram, Cognos Viewer dynamically updates the report if the report prompt parameters are based on strategy element values.

For this functionality to work, the following parameters that are broadcast on a channel after a click action in a Cognos Metrics portlet must match the names of the report prompt parameters:

• scorecard_extid
• scorecard_sid
• strategy_sid
• metric_sid
• metric_extid
• time_period_sid

Steps to Create a Prompted Report

1. In Report Studio, create a prompt on a report page, not on a prompt page, of the report.

   Set the Auto-Submit property for the prompt to yes.

   If you want to use cascading prompts, only the last prompt in the sequence needs to be on the report page.

   For some prompts, such as the value prompts, you may need to add a Finish button to signal that the prompt selection is complete. For cascading prompts, the Reprompt button is also required to restart the prompting sequence.

2. Add other details, such as background images, instructions, or a title.

The prompt can now be added to a portal page or a dashboard .

Assemble the Reports on a Page

The prompts and the target reports in a page or a dashboard create an interactive and easy way to access IBM Cognos BI environment.

Each report is displayed using the Cognos Viewer portlet. The reports communicate with each other using the properties of this portlet.

You can use different design strategies to implement global filters in a page. Here is an example of a basic layout:

If your page includes reports from different packages, ensure that the prompt reports use the same parameter names as the target reports.

Use the following steps when defining global filters in a single page. If you want to implement this functionality in a dashboard, you must complete additional steps. For more information, see Create a Dashboard with Multiple Tabs.

Steps

1. In IBM Cognos Connection, click the new page button .

2. Type the name, and select a location for your page.

3. Click Next.

4. In the Set columns and layout page, set the number and width of columns.

   For example, the reports that display the prompts and prompt controls can be placed in one column, and the target reports in a separate column to the right.

5. Click Add at the bottom of the first column.

6. In the Available Entries box, click IBM Cognos Content.

7. Select the Cognos Viewer portlet, click the right arrow button  to move the portlet to the Selected Entries box, and click OK.

8. Repeat steps 5 to 7 for each column.

   You must add the Cognos Viewer portlet for each report that you want to include in the column. For example, if the column on the left will contain a prompt and prompt controls, add two Cognos Viewer portlets.

9. Click Next.

10. Complete the remaining steps in the wizard, if needed, and click Finish.

    For more information, see the steps in the section Create a Page.

11. Go to the folder where you saved the new page, and open it.

    In the page columns, you can see the empty frames of the Cognos Viewer portlets.

12. For any portlet in the page, click the edit button  in the portlet toolbar.

13. In the portlet properties page, click Select an entry to select the report you want to display in the portlet.

14. Click Edit Properties.

    The Advanced Properties Editor appears.

15. For the Fragment Action property, specify the default portlet action when the portlet is invoked in a page.

    You can choose to show the run icon, run the report, or view the most recent saved output.

    Tip: For more information about the portlet properties, click the Help button in the portlet.

16. For the Prompt the user property, specify how to execute the prompts.

17. For the Prompt values property, select the Communicate with other portlets check box.

    This property enables communication between this portlet and other portlets in the page that have this property set up.

    • When you select Every time, if the report contains optional or required prompts, the user is prompted to enter the prompt values before the report is run.

    • When you select Only when required parameter values are missing, the user is prompted if the report contains required prompts and the values are missing. Otherwise the report runs successfully.

    • When you select Never and show the report only when required values are provided, Cognos Viewer attempts to run the report, but the page remains hidden until the required prompt values are provided.

    • When you select Based on the prompt settings of the report, Cognos Viewer uses the prompts specified in the report.

18. If you want to set up communication between only specific portlets in the page, type the channel name in the box provided.

    Only the portlets that share the same channel name can interact. By specifying the channel name, you have more control over the page. For example, you can link only the reports that have matching parameters.

    For more information about this property, click the Help button in the portlet.

19. If you want to see the portlet toolbar in the page, for the Show Toolbar property, select the Normal mode and Maximized mode check boxes.

20. Click OK to close Advanced Properties Editor, and click OK again to close the general properties page.

21. Repeat steps 12 to 20 for each portlet in the page.

Enable Sharing of Drill-up and Drill-down Actions

In pages, you can enable sharing of drill-up and drill-down actions, between reports that are based on a dimensionally modelled data source. A drill action on an item in one report causes the same action in an associated report if the report is on the same page and contains the same item. For example, when you drill down on the item 2005 in one report, all reports in the page drill down on the same item and the data for the year 2005 appears in all reports.

This functionality is enabled using the properties of the Cognos Viewer portlet. By default, drill actions are disabled in a page.

This functionality is not supported for dashboards with multiple tabs. However, a single page with drill-up and drill-down actions enabled can be embedded into a dashboard as one of the tabs.

Steps

1. In IBM Cognos Connection, create a page that contains the Cognos Viewer portlet for each report that you want to add to the page.

   For more detailed information, see the steps in Create a Page.

2. Configure the Cognos Viewer portlets to display the reports that you want to add to the page.

   In the portlet properties page, click Select an entry to select the report you want to display in the portlet.

3. In the Advanced Properties Editor of the Cognos Viewer portlets, for the Drill down and drill up property, select the Communicate with other portlets on the page check box.

   This property enables communication between all portlets in the page using the default channel.

   For more information, click the Help button in the portlet.

4. If you want to set up communication between only specific portlets in the page, type the channel name in the box provided.

   Only the portlets that share the same channel name can interact. By specifying the channel name, you have more control over the page.

Enable Sharing of Drill-through Actions

You can enable sharing of drill-through actions in a page. When a user drills from a source report to a target report, the target report appears in the specified area of the page.

For this feature to work, a page must have a report that contains an authored drill-through path. The page must also contain a placeholder Cognos Viewer portlet that is set up to receive the drill-through requests.

Report-based drill-through works with both interactive reports and saved report outputs. However, it only works for a single drill-through request. If the drill-through contains multiple targets, it must be invoked from the context menu.

This functionality is enabled using the Channel property of the Cognos Viewer portlet. You must specify the same channel name for the portlet that contains the source report and the portlet that receives the target report. By default, drill-through actions are disabled in a page.

This functionality is not supported for dashboards with multiple tabs. However, a single page with drill-through actions enabled can be embedded into a dashboard as one of the tabs.

Steps

1. In IBM Cognos Connection, create a page that contains the Cognos Viewer portlets for the drill-through source report, and the target report.

   For more detailed information, see the steps in the section Create a Page.

2. Configure one of the Cognos Viewer portlets to display the Report Studio source report that contains the drill-through path.

   In the portlet properties page, click Select an entry to select the report you want to display in the portlet.

3. Configure the other Cognos Viewer portlet to display the drill-through target report.

   As the target report, we recommend using a report that contains prompts.

   In the portlet properties page, click Select an entry to select the report you want to display in the portlet.

4. For both portlets configured in step 2 and 3, in the Advanced Properties Editor page, for the Report-based drill-through property, select the Communicate with other portlets on the page check box, and type the channel name in the box provided.

   The channel name is mandatory.

   For more information about this property, click the Help button in the portlet.