Using hyperlinks to add, reuse or replace a dashboard

A dashboard hyperlink is used to add, reuse or replace a dashboard in Klipfolio and optionally pass in parameters to control the data displayed on that dashboard. 

Note that dashboards were formerly called tabs. The term tab remains in use for parameters sucn as the ones listed below. 

There are three types of dashboard hyperlinks:

Dashboard hyperlink

Dashboard exists in Klipfolio

Dashboard does not exist in Klipfolio

tab- 

Goes to specified dashboard in Klipfolio. If a parameter is passed in, a new dashboard will be added each time the parameter changes.

Adds specified dashboard in Klipfolio. If a parameter is passed in, a new dashboard will be added each time the parameter changes.

tab-reuse-

Goes to specified dashboard in Klipfolio. If a parameter is passed in, this dashboard will be reused each time the parameter changes.

Adds specified dashboard in Klipfolio. If a parameter is passed in, this dashboard will be reused each time the parameter changes.

tab-replace-

Replaces the current dashboard with the specified dashboard in Klipfolio. If a parameter is passed in, this dashboard will be reused each time the parameter changes.

Replaces the current dashboard with the specified dashboard in Klipfolio. If a parameter is passed in, this dashboard will be reused each time the parameter changes.

Dashboard Hyperlink Parameters


If a hyperlinked dashboard has a Klip that responds to variables, you can add one or more parameters to the hyperlink to dynamically pass data to the hyperlinked dashboard, using the syntax:

param:var1=value1

where
param is a keyword 
var1 is a Klipfolio dashboard variable used by a klip on the hyperlinked dashboard
value1 is the value assigned to var1

The first parameter in the hyperlink must be prefixed with a question mark (?) and subsequent parameters must be prefixed with an ampersand (&) .

?param:var1=value1&param:var2=value2&param:var3=value3

Example

To create a Table klip with a column of hyperlinks that redirect the user to another dashboard when clicked, follow these steps:

  1. The dashboard ID in the hyperlink identifies the dashboard to be displayed when the hyperlink is clicked. Note that this dashboard must be shared in order to be displayed on a dashboard. Get this dashboard ID using one of the following methods:

    • go to Library > Dashboards and select the dashboard to be hyperlinked or
    • select the dashboard in Klipfolio, click the gear icon and select About this dashboard.

    The browser URL will display something like https://app.klipfolio.com/tabs/view/0123456789abcdef0123456789abcdef where 0123456789abcdef0123456789abcdef is the dashboard ID.

  2. In the klip editor, add a column to the table. Under the Data tab, click Insert literal string or number and type one of the following:

    • #tab-<dashboard ID>, for example, #tab-0123456789abcdef0123456789abcdef
    • #tab-reuse-<dashboard ID>, for example, #tab-reuse-0123456789abcdef0123456789abcdef
    • #tab-replace-<dashboard ID>, for example, #tab-replace-0123456789abcdef0123456789abcdef

    Where #tab is equivalent to dashboard.

  3. To assign a label (this is what the user will see and click) to the hyperlink, either

    • prefix the #tab- reference with your label: label|#tab-reuse-<tab ID>, for example,

    •      hyperlinkName|#tab-reuse-0123456789abcdef0123456789abcdef 

    • under the Properties tab, set Show Label to your label.

  4. Optionally, to add a parameter to the hyperlink, you will need to use the CONCAT function to build the expression:

  5.      hyperlinkName|#tab-reuse-0123456789abcdef0123456789abcdef&param:var1=value1

    If tab ID 0123456789abcdef0123456789abcdef has klips that respond to the var1 variable, this hyperlink will pass var1 in when the tab is opened. 

    This step describes how to add a single parameter. If multiple parameters are required, repeat these steps for each parameter, using "?param:" for subsequent parameters. For example, 
      hyperlinkName|#tab-reuse-0123456789abcdef0123456789abcdef?param:var1=value1&param:var2=value2&param:var3=value3
    1. Wrap the CONCAT function around the hyperlink (do not type the quotes, they will be added by the formula editor):

    2.    CONCAT( "hyperlinkName|#tab-reuse-0123456789abcdef0123456789abcdef" ) 

    3. Append "?param:var1=" to the hyperlink.

    4. Insert a second parameter (for example, value1) into your CONCAT formula to specify the value to be assigned to var1. value1 can be another variable or hard-coded or come from one of your data sources.

    5.    CONCAT( "hyperlinkName|#tab-reuse-0123456789abcdef0123456789abcdef?param:var1=", value1)

      If value1 = 5, this CONCAT evaluates to 

         hyperlinkName|#tab-reuse-0123456789abcdef0123456789abcdef?param:var1=5

  6. Under the Properties tab, set Format as to Hyperlink.

  7. To open the hyperlink in the current browser tab, select Open Link. Otherwise the hyperlink, when clicked, will open a new browser tab.

The result is a table with a column of hyperlinks that, when clicked, open the hyperlinked dashboard, passing in the specified parameter.

Related links

Feedback and Knowledge Base