System functions

System functions provide functions for accessing system, device and Qlik Sense app properties.

This functionality is not available in SaaS editions of Qlik Sense.

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.

Author 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 computer as returned by the operating system. It can be used in both the data load script and in a chart expression.

If the name of the computer has more than 15 characters, the string will only contain the first 15 characters.

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( )

This function is not supported in standard mode. See File system access restriction

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.

EngineVersion()

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.

GetObjectField([index])

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)

This function is not supported in standard mode. See File system access restriction

This function returns - 1 (True) if the current reload is partial, otherwise 0 (False).

IsPartialReload()

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( )

In Qlik Sense Desktop and Qlik Sense 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().

ProductVersion()

This function returns a timestamp for when the last data load finished. 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.

StateName()

System functions

See also: