CreateSessionVariable method

Overview

Creates a transient variable.

To set some properties to the variable, use the SetProperties method.

Definition

A variable in Qlik Sense is a named entity, containing a data value. This value can be static or be the result of a calculation. A variable acquires its value at the same time that the variable is created or after when updating the properties of the variable. Variables can be used in bookmarks and can contain numeric or alphanumeric data. Any change made to the variable is applied everywhere the variable is used.

When a variable is used in an expression, it is substituted by its value or the variable's definition.

Example:

The variable x contains the text string Sum(Sales) .

In a chart, you define the expression $(x)/12 . The effect is exactly the same as having the chart expression Sum(Sales)/12 .

However, if you change the value of the variable x to Sum(Budget), the data in the chart are immediately recalculated with the expression interpreted as Sum(Budget)/12 .

Parameters

Name	Description	Type
qProp	Name of the variable. Variable names are case sensitive. This parameter is mandatory.	GenericVariableProperties

Name

Description

Type

qProp

Name of the variable. Variable names are case sensitive.

This parameter is mandatory.

GenericVariableProperties

Name	Description	Type
qInfo	Identifier and type of the object. This parameter is mandatory.	NxInfo
qMetaDef	Meta data.	Dynamic properties
qName	Name of the variable. The name must be unique. This parameter is mandatory.	String
qComment	Comment related to the variable. This parameter is optional.	String
qNumberPresentation	Defines the format of the value. This parameter is optional.	FieldAttributes
qIncludeInBookmark	Set this property to true to update the variable when applying a bookmark. The variable value will be persisted in the bookmark. The value of a variable can affect the state of the selections. Script variables cannot be persisted in the bookmark. The default value is false.	Boolean
qDefinition	Definition of the variable.	String

Name	Description	Type
qId	Identifier of the object. If the chosen identifier is already in use, the engine automatically sets another one. This parameter is optional. If an identifier is not set, the engine automatically sets one.	String
qType	Type of the object. This parameter is mandatory.	String

Name

Description

Type

qId

Identifier of the object.

If the chosen identifier is already in use, the engine automatically sets another one.

This parameter is optional. If an identifier is not set, the engine automatically sets one.

String

qType

Type of the object.

This parameter is mandatory.

String

Name	Description	Type
qType	Type of the field. Default is U.	One of: • U for UNKNOWN type. • A for ASCII; Numeric fields values contain only standard ASCII characters. • I for INTEGER; Numeric fields values are shown as integer numbers. • R for REAL; Numeric fields values are shown as real numbers. • F for FIX; Numeric fields values are shown as numbers with a fix number of decimals. • M for MONEY; Numeric fields values are shown as in the money format. • D for DATE; Numeric fields values are shown as dates. • T for TIME; Numeric fields values are shown as times. • TS TIMESTAMP; Numeric fields values are shown as time stamps. • IV for INTERVAL; Numeric fields values are shown as intervals.
qnDec	Number of decimals. Default is 10.	Integer between 0 and 15.
qUseThou	Defines whether or not a thousands separator must be used. Default is 0.	One of: 0 for false 1 for true
qFmt	Defines the format pattern that applies to qText. Is used in connection to the type of the field (parameter qType). For more information, see Struct FieldAttributes. Example: YYYY-MM-DD for a date	String
qDec	Defines the decimal separator. Example: .	String
qThou	Defines the thousand separator (if any). Is used if qUseThou is set to 1. Example: ,	String

Outputs

The following is returned in the output:

"result": { "qReturn": { "qType": "GenericVariable", "qHandle": <Handle of the variable> } }

Learn more

Create a variable

Did this page help you?

If you find any issues with this page or its content – a typo, a missing step, or a technical error – let us know how we can improve!

Leave your feedback here