System functions

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.

When used in a dimension expression, CalcDim() overrides the engine's automatic interpretation of how to internally handle the expression. Specifically, the function prevents a new internal field from being created in the data model. Instead, selections made in the app are treated as selections in applicable fields from the original data model.

calcdim(expr)

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

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 field expression 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)

The GetSysAttr() function is used to return information about the tenant and space in which an app is located. With the GetSysAttr() function, you can evaluate the tenant ID and name, space ID and name, and other details about the environment where the app resides. This function simplifies space and tenant identification of a Qlik Sense app that might be moved between different environments. The function makes it easy to identify the specific environment you are working in. This is particularly useful during the development, testing, acceptance and production (DTAP) stages of an app's life cycle.

GetSysAttr(name)

The GetUserAttr() function returns information for the user accessing an app. It can be used in both the data load script and in a chart expression.

GetUserAttr(name)

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

IsPartialReload()

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.

InObject(id_str)

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.

ObjectId([object_type_str])

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

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. 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.

StateName()