Hyperlink Elements
  • 23 Aug 2024
  • 2 Minutes to read
  • Dark
    Light

Hyperlink Elements

  • Dark
    Light

Article summary

General

A hyperlink element can be used to insert a hyperlink into the report document.

Properties

Every hyperlink element has the following properties:

Name

Description
NameThe name of the chart element. This name will be displayed in the tree hierarchy of the content explorer of the Report Designer.
CodeThe code of the chart element. There must be no other report element within the same report with the same code. The code is used to reference the report element from within a Template (see below).
ConditionAn optional condition Expression; if it returns True or 1 the condition is considered to be fulfilled and the chart will be included in the report document. If it returns something other than True or 1 the exclusion settings (see below) will be applied. If you leave this property empty, the condition is considered to be always fulfilled. The condition expression is evaluated after the preparation Actions of the chart element have been executed.
Preparation ActionsA list of Actions that will be executed before the chart element will be processed.
Fail On Filter ExceptionDetermines what shall happen if an exception occurs when executing a preparation action that performs a filter (e.g. because the value to which you want to filter does not exist). When enabled, an exception will be thrown and the report document creation will be cancelled; when disabled, the exclusion settings (see below) will be applied.
URLAn Expression that returns a String that contains the URL of the hyperlink.
TextAn Expression that returns a String that contains the displayed text of the hyperlink.

Insertion

You can drag & drop a hyperlink element from the content explorer of the Report Designer into a template. A hyperlink acting as a placeholder for the element will be inserted with the following syntax:

Hyperlink Element Placeholder

%%Code%%

Visitor URL Hyperlinks

Hyperlink elements can be used in combination with Visitor URLs. This allows to include a hyperlink in the created report document that leads the user to a Datasource object.

Example: You can create a visitor URL that opens a specific sheet of a Qlik Sense Datasource in the web browser.

You can achieve that by using a Datasource Object Visitor URL Placeholder in the Expression used as the URL property:

Datasource Object Visitor URL Placeholder Example

[Datasource].[MyDatasource].[VisitorURL].[MyObjectID]

The above example would return a String that contains the visitor URL for the object with object ID MyObjectID in the Datasource named MyDatasource.


Was this article helpful?

What's Next