Link List Headings to Data Cookbook Definitions

Cognos Analytics report authors can create links in report column headings to Data Cookbook definitions. This provides clarity and context to the user about the data displayed in a report column. It is especially helpful for users who are new to Brown and not familiar with university data.

There are 2 sets of procedures described on this page.

  • Show Definition in a New Browser Tab
    This procedure shows you how to create links on report headings that will open the approved functional definition in a new browser tab.
  • Show Definition in a Popup (optional)
    This procedure builds on the first "Show Definition in a New Browser Tab" procedure and, for HTML format only, shows you how to set the link to open the definition in a popup window (instead of a new browser tab).

Show Definition in a New Browser Tab

With this procedure, when the user clicks a linked report heading, a new browser tab will open with the approved functional definition.

  1. Edit the report in report authoring, and then navigate to the report page where you want to link to a definition.
  2. On the toolbar in the upper right corner, click ... (More), and then select Locked.
    The report is unlocked.
  3. From the toolbox pane, drag a Hyperlink object to the left of the column title cell.
    A hyperlink object appears in your column title cell.
  4. Drag the column title text item into the hyperlink object.
    The column title text becomes a hyperlink object.
  5. Delete the hyperlink named Hyperlink.
    You're left with the column title text hyperlink object.


  6. Select the hyperlink object (not the text item contained within it), and then in the Properties Pane in the URL field, paste the following URL:
    https://reporting.brown.edu/dcb/dcb_term_lookup.php?term_id=######


  7. At the end of the URL, replace ###### with the Data Cookbook ID of the definition, and then click OK.

    Find the Data Cookbook ID

    You can find the ID at the end of the Data Cookbook definition web address. In the example below, the ID is 161458.


  8. In the Properties Pane, set the Open in new window property to Yes.
    When the user clicks the definition in your report, this property will open the definition in a new browser tab.

  9. For each column title you want to link to a Data Cookbook definition, repeat steps 3–8.
  10. Save your report.

Show the Definition in a Popup (optional, for HTML format only)

As an additional enhancement that will improve the user experience (but takes more effort to set up), when the user runs the report to HTML, you can configure the HTML format to display the functional definition in a popup window instead of opening in a new tab.

These steps are completely optional. If you are satisfied with the functional definition appearing in a new tab for all formats (including HTML), then you can skip these steps.

The steps below assume you have already completed the steps under Show Definition in a New Browser Tab above.

  1. In the Queries pane, click the Condition Explorer, and then click the Variables folder.
  2. From the Toolbox, drag a Boolean Variable to Variables.
    A Report Expression window appears.
  3. In the Report expression dialog box, copy and paste the following to the Expression Definition field, and then click OK.
    ReportOutput () = 'HTML'

  4. In the properties of the new Boolean variable, change the name to Output is HTML.

  5. If your report isn't already unlocked, on the toolbar in the upper right corner, click  ...  (More), and then select  Locked .
    The report is unlocked.

  6. Navigate to the report page, and then from the Toolbox pane, drag a Conditional Block to the left of the hyperlink you created in the previous set of steps.
  7. Select the conditional block you just added, and then in the Properties pane in the Block Variable, select Output is HTML, and then click OK.
  8. With the conditional block still selected, in the Properties pane, change the Current block value to No.
  9. Drag the hyperlink (be careful not to drag the text) into the conditional block.
  10. Select the text item inside the hyperlink item and copy it (Ctrl + C).
  11. Select the conditional block, and change the Current block property to Yes.
    Your hyperlink will disappear.
  12. Paste (Ctrl + V) the text item that you copied in step 10 into the conditional block.
  13. From the Toolbox pane, drag an HTML item to the left of the column title text.

    Note:

    Depending on the width of the column, the header may wrap making it appear that the item is above instead of to the left of the text.

  14. Double click the HTML item, and then in the dialog box that appears, copy and paste the entire following text.

    <a href=" https://apps.biomed.brown.edu/dcb/dcb_term_lookup.php?term_id= ##### "
    onclick="javascript:void window.open(' https://apps.biomed.brown.edu/dcb/dcb_term_lookup.php?term_id= ##### ',
    '_blank', 'menubar=no, titlebar=no, toolbar=no, status=no, scrollbars=yes, resizable=yes, top=300, left=300, width=400, height=400'); return false;" >

  15. In the HTML dialog box, replace the two instances of  #####  with the Data Cookbook ID of the definition, and then click OK.

    After  modifying the text, it will look like this:
    <a href=" https://apps.biomed.brown.edu/dcb/dcb_term_lookup.php?term_id= 161458 "
    onclick="javascript:void window.open(' https://apps.biomed.brown.edu/dcb/dcb_term_lookup.php?term_id= 161458 ',
    '_blank', 'menubar=no, titlebar=no, toolbar=no, status=no, scrollbars=yes, resizable=yes, top=300, left=300, width=400, height=400'); return false;" >

    Find the Data Cookbook ID

    You can find the ID at the end of the Data Cookbook definition web address. In the example below, the ID is 161458.

  16. From the Toolbox pane, drag a second HTML item to the right of the column title text.

    Note:

    Depending on the width of the column, the header may wrap making it appear that the item is below instead of to the right of the text.

  17. Double-click on the new HTML item, type </a>, and then click OK.
    Your report now contains a link that will open the Data Cookbook functional definition in a pop-up window when the report is run to HTML.

  18. Test your report to confirm the link produces a pop-up window in HTML output and that the link in other output formats still works.

Comments (0)


Brown Community members, log in to submit a comment.

Top