Adding Hyperlinks

Report Designer provides you with several hyperlink options. You can:


When you use the Report Designer linking features, you are building a URL that takes consumers of the content to specific data you want them to see.

Follow the instructions below to link to content in the Pentaho Solution Repository:

  1. Select the element in the report you for which you want to create a hyperlink.
  2. Go to the Format menu and select Hyperlink. The Format Element dialog box appears.
  3. Under Location, select the Pentaho Repository option.
  4. Enable the Include server name in URL option if you want users to see the server name in the URL associated with the report to which you are linking.
  5. If you are not logged on to the BI server, click Login.
  6. Click Browse to locate the report and click OK.
  7. Select your Target option.
    Option Description
    ="_TOP" Loads the linked report in the topmost frame
    ="_BLANK Opens the report in a new window
    ="_PARENT" Used in instances when a frameset file is nested inside another frameset file; a link in one of the inner frameset documents which uses "_parent" loads the report in the location where the inner frameset file had been

    If none of the target options work for you, click [...] (ellipsis) to open the Formula Editor.

  8. Enter a Tooltip (hover text) that displays with your hyperlink. Alternatively, click [...] (ellipsis) to create a tooltip using the Formula Editor.
  9. Enable Hide Parameter UI on Server if you do not want users to see a parameter list on the report in the Pentaho User Console.

    In most instances, the link you are creating takes users directly to the content on the report you want them to see; therefore, the parameter list is not necessary.

  10. Define your parameter values; if necessary, click (Refresh Parameter) to see the list of available parameters. Click down arrow next to Value to select your parameter value or click [...] (ellipsis) to add a value using the Formula Editor.

    The parameters listed under the Report Parameters tab are defined by a report author. For example, suppose the report author created a parameter called "line" (product line). In the Format Element dialog box, the report author entered Motorcycles as the value for the line parameter.

    When the report runs in the Pentaho User Console, users of the report will link to data associated with Motorcycles. Alternatively, the report author could have created a link to a specific field on the report. In that scenario, the data in the field changes dynamically when the report displayed.

    Every piece of content, (reports, dashboards, analyzer reports), in the solution repository has associated parameters that define how the content is launched. For example, these System Parameters determine if the content displays in dashboard mode or if the UI displays the parameter list. In most instances, you will not have to provide values for these parameters. See Plugin Parameter Names for more information.

    Custom parameters are parameters that you define manually to create your link. If you choose to enter custom parameters and their associated values, click (Add). Type the parameter name and its value in the available text fields.

  11. Click OK to save your entries.
When you generate report output that supports inline hyperlinks, the URL you specified will be linked to the element you specified. This also applies to preview scenarios that support hyperlinks; however, the built-in Report Designer preview mode (the eye icon) does not allow for clickable links.