Using hyperlinks in Klips

Hyperlinks enable Klipfolio dashboard users to navigate within their dashboard and to external websites and by clicking a specially formatted field in a klip. 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.

The following Klip types support hyperlinks:

Adding a hyperlink

Watch this short video to learn how to set hyperlinks and use them with variables. 

To add a hyperlink to a Klip:

  1. Select the subcomponent that will contain the hyperlink, for example a Table column.
  2. Inline Frame, Map and News Klips support hyperlinks by default. For Label, Table and Value Pair Klips, go to the Properties tab:
    • Set Format as to Hyperlink
    • To have the hyperlink open in the current browser tab, check Open link in current browser tab. Otherwise the hyperlink, when clicked, will open a new browser tab
    • Optionally set Show label to the label (this is what the user will see and click). Alternatively, the label can be set in the formula as described in the next step. If a label is set in both the formula and by Show Label, the Show Label value will be displayed.
  1. Go to the Data tab and type your hyperlink. 

Examples:

https://www.klipfolio.com
#tab-0123456789abcdef0123456789abcdef

To set a label in the formula, prefix the hyperlink with "label|", for example:

label|#tab-0123456789abcdef0123456789abcdef

Using hyperlinks to add, reuse or replace a dashboard

Watch this short video to learn how to navigate your dashboards with hyperlinks.

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: To access this functionality, the user's role must be enabled to Manage dashboard visibility. For a complete description of access permissions, see User roles and access permissions.

Dashboards were formerly called tabs. The term tab remains in use for parameters such 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.

Creating a dashboard hyperlink

For example, to create a Table Klip 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 the dashboard ID (to be used in step 4) using one of the following methods:
    • Go to Library > Dashboards and select the dashboard to be hyperlinked or
    • Select the dashboard in Klipfolio, and beside the dashboard name, click the More 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

  1. In the Klip Editor, add a column to the table.
  2. Under the Properties tab,
    • Set Format as to Hyperlink
    • To have the hyperlink open in the current browser tab, check Open link in current browser tab. Otherwise the hyperlink, when clicked, will open a new browser tab
  3. Under the Data tab, type one of the following (within quotes):
    • "#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"
  1. To assign a label (this is what the user will see and click) create a hyperlink:

CONCAT ("label","|","#tab-reuse-<tab ID>")

Dashboard hyperlink parameters

If a hyperlinked dashboard has Klips that respond 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

Note: Dashboard variables have a higher precedence than User Input Controls with an "all dashboards" scope

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

To add a parameter to the hyperlink, use the CONCAT function to build the expression. For example, to build the following hyperlink, 

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

which will pass in var1 when tab ID 0123456789abcdef0123456789abcdef is opened:

  1. In the formula editor, wrap the CONCAT function around the hyperlink:

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

  1. Append "?param:var1=" (without the quotes) to the hyperlink. Insert a second parameter (for example, value1) into your CONCAT formula to specify the value to be assigned to var1value1 can be another variable or hard-coded or come from one of your data sources.

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

If value1 = 5, this CONCAT evaluates to 

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

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

Any Klips on this tab with formulas that use the var1 variable will use the value assigned to var1.