System functions provide functions for accessing system, device and Qlik Senseappproperties.
Use the drop-down on each function to see a brief description and the syntax of each function. For some of the functions, you can get further details about that specific function by clicking the function name in the syntax description.
This function returns
a string containing the author property of the current app. It can be used in both the data load script and in a chart expression.
Information noteAuthor property can not be set in the current version of Qlik Sense. If you migrate a QlikView document, the author property will be retained.
This function returns the user agent string of the client browser. It can be used in both the data load script and in a chart expression.
Example:
Mozilla/5.0 (Windows NT 6.1; WOW64) AppleWebKit/537.36 (KHTML, like Gecko) Chrome/35.0.1916.114 Safari/537.36
This function returns a string containing the name of the engine instance as returned by
the operating system. It can be used in both the data load script and in a chart expression.
ComputerName( )
This function returns
a string containing the name of the current Qlik Sense app, without path but with extension. It can be used in both the data load script and in a chart expression.
DocumentName( )
This function returns
a string containing the full path to the current Qlik Sense app. It can be used in both the data load script and in a chart expression.
DocumentPath( )
Information noteThis function is not supported in Qlik Sense SaaS.
This function returns
a string containing the title of the current Qlik Sense app. It can be used in both the data load script and in a chart expression.
DocumentTitle( )
This function returns
the full Qlik Sense engine version as a string.
This script function returns the culture name of the collation locale that is used. If the variable CollationLocale has not been set, the actual user machine locale is returned.
GetCollationLocale( )
GetObjectField() returns the name of the dimension. Index is an optional integer denoting the dimension that should be returned.
This function returns the value of a key in the Windows registry. It can be used in both the data load script and in a chart expression.
GetRegistryString(path, key)
Information noteThis function is not supported in Qlik Sense SaaS.
This function returns the tenant and space domain attributes for a selected app. It can be used in both the data load script and in a chart expression.
This function returns the index of the active field for the specified cyclic dimension. The first field has index value of 1. Enter the name of the cyclic dimension in single quotes. It can only be used in a chart expression.
GroupDimensionIndex(dim_name Expression)
This function returns the field label of current step in the specified cyclic dimension. Enter the name of the cyclic dimension in single quotes. It can only be used in a chart expression.
GroupDimensionLabel(dim_name Expression)
This function returns - 1 (True) if the current reload is partial, otherwise 0 (False).
The InObject() chart function evaluates whether or not the current object is contained inside another object with the ID specified in the function argument. The object can be a sheet or a visualization.
The ObjectId() chart function returns the ID of the object in which the expression is evaluated. The function takes an optional argument specifying which type of object the function concerns. The object can be a sheet or a visualization. This function is only available in chart expressions.
This function returns a string containing the name of the user that is currently connected. It can be used in both the data load script and in a chart expression.
OSUser( )
Information noteIn Qlik Sense Desktop and Qlik Sense Client-Managed Mobile, this function always returns 'Personal\Me'.
This function returns
the full Qlik Sense version and build number
as a string.
This function is deprecated and replaced by EngineVersion().
Information noteThis function is not supported in Qlik Sense SaaS.
This function returns a timestamp for when the last data load finished. The timestamp returned is in UTC format. It can be used in both the data load script and in a chart expression.
ReloadTime( )
StateName() returns the name of the alternate state of the visualization in which it is used. StateName can be used, for example, to create visualizations with dynamic text and colors to reflect when the state of a visualization is changed. This function can be used in chart expressions, but cannot be used to determine the state that the expression refers to.
Information noteThis function is not supported in Qlik Sense SaaS.
App
This term has several definitions:
A Qlik Sense or QlikView app: Apps are task-specific, purpose-built applications. Apps contain data loaded from data sources that is interpreted through visualizations.
The Qlik Sense Mobile app: A mobile app for iOS and Android devices. In the mobile app, you connect to and interact with your cloud data. You can work with your available apps.