qsea 0.1.17

Convenient way to work with Qlik Sense Engine API from Python

Title

QSEA refers to the Qlik Sense Engine API.

Description

QSEA is designed to automate basic operations with Qlik Sense Enterprise apps in a Pythonic way. With QSEA, you can quickly view and edit variables, master measures, and dimensions, as well as main sheet objects. For example, you can replace variables in all master measures of your app with just one line of code.

for ms in App.measures: ms.update(definition = replace(ms.definition, '$(var1)', '$(var2)'))

or quickly move all measures from one app to another:

for ms in App1.measures: App2.measures.add(name = ms.name, definition = ms.definition)

Installation

pip install qsea

Table of Contents

• Getting started
• Full Guide
  • App class
    • App.load()
    • App.save()
    • App.reload_data()
    • App.children
  • AppChildren class
    • AppChildren add
  • Variable class
    • Variable properties
    • Variable.update()
    • Variable.delete()
    • Variable.rename()
    • Variable.get_layout()
  • Measure class
    • Measure properties
    • Measure.update()
    • Measure.delete()
    • Measure.rename()
    • Measure.get_layout()
  • Dimension class
    • Dimension properties
    • Dimension.update()
    • Dimension.delete()
    • Dimension.rename()
    • Dimension.get_layout()
  • Sheet class
    • Sheet properties
    • Sheet.load()
    • Sheet.get_layout()
  • Field class
    • Field properties
  • Object class
    • Object properties
    • Object.export_data()
    • Object.load()
    • Object.get_layout()
  • ObjectChildren class
  • ObjectMeasure class
    • ObjectMeasure properties
    • ObjectMeasure.update()
    • ObjectMeasure.delete()
  • ObjectDImension class
    • ObjectDimension properties
    • ObjectDimension.update()
    • ObjectDimension.delete()
• License

Getting started

QSEA uses the Qlik Sense Engine API via the Qlik Sense Proxy Service as its main tool, so you'll need the correct API credentials to start working with QSEA. Please refer to the following links for help.

https://help.qlik.com/en-US/sense-developer/May2023/Subsystems/EngineAPI/Content/Sense_EngineAPI/GettingStarted/connecting-to-engine-api.htm

https://help.qlik.com/en-US/cloud-services/Subsystems/Hub/Content/Sense_Hub/Admin/mc-generate-api-keys.htm

Your credentials should look something like this

header_user = {'Authorization': 'Bearer <Very long API KEY>'}
qlik_url = "wss://server.domain.com[/virtual proxy]/app/"

Now we can connect to the Qlik Server:

conn = qsea.Connection(header_user, qlik_url)

Let's create an App object, which represents the application in Qlik Sense.

app = qsea.App(conn, 'MyAppName')

By default the App class object is almost empty. Use the load() function to make use of it:

app.load()

Now all variables, master measures, and dimensions are uploaded to our App object. We can access them by their name:

var = app.variables['MyVar']
var.definition

ms = app.measures['MyMeasure']
ms.label_expression

Or, we can overview their properties via a pandas DataFrame.

app.dimensions.df

Let's create a new measure:

app.measures.add(name = 'MyMeasure', definition = 'sum(Sales)')

or update a variable:

var.update(definition = 'sum(Sales)')

Save the app to ensure that the changes are reflected in the real Qlik Sense application.

app.save()

Let's copy the set of master dimensions into a new app:

source_app = qsea.App(conn, 'Source AppName')
target_app = qsea.App(conn, 'Target AppName')
source_app.load()
target_app.load()

for dim in source_app.dimensions:
    if dim.name not in [target_dim.name for target_dim in target_app.dimensions]: target_app.dimensions.add (name = dim.name, definition = dim.definition)

target_app.save()

For unknown reasons, on certain instances of Qlik Sense, changes in the App may not be visible in the Qlik Sense interface. The usual workaround is to make a new copy of the Application (via QMC or Hub). Usually, all changes can be seen in the copy.

Note that as it stands, only basic properties, such as names, definitions, and a couple of others, can be accessed via the qsea module.

Most read-only operations (such as loading apps) can be performed on published apps. However, it is recommended to modify objects only in unpublished apps.

Besides master measures, master dimensions, and variables, tables and charts in the App can also be uploaded.

It's highly recommended to make a backup copy of your application.

app.load()
sh = app.sheets['MySheet']
sh.load()
for obj in sh.objects:
    for ms on obj.measures:
        print(ms.definition)

Good luck!

Full Guide

App class

The class, representing the Qlik Sense application. This is the main object to work with. The class is empty when created; run the load() function to make use of it.

App.load()

Loads data from the Qlik Sense application into an App object.

Args:

• depth (int): depth of loading
  • 1 - app + variables, measures, sheets, fields, dimensions (default value)
  • 2 - everything from 1 + sheet objects (tables, sharts etc.)
  • 3 - everything from 2 + object dimensions and measures

Different levels can be useful when working with large apps, as a full load can be time-consuming. Only dimensions and measures from standard Qlik Sense charts are uploaded. Uploading dimensions from filter panes is currently not supported.

App.load(level = 3)

App.save()

You have to save the App object for the changes to be reflected in the Qlik Sense Application. Note that it is recommended to modify objects only in unpublished apps.

App.save()

App.reload_data()

Starts the script of reloading data into the Qlik Sense Application.

App.reload_data()

App.children

app.load(level = 1) creates several objects of AppChildren class

AppChildren class

The class contains collections of master objects in the Qlik Sense Application:

• app.variables: a collection of Variable class objects, representing the variables of the Qlik Sense application
• app.measures: a collection of Measure class objects, representing the master measures of the Qlik Sense application
• app.dimensions: a collection of Dimension class objects, representing the master dimensions of the Qlik Sense application
• app.sheets: a collection of Sheet class objects, representing the sheets of the Qlik Sense application
• app.fields: a collection of Field class objects, representing the fields of the Qlik Sense application

You can access the main information about each group of objects in a pandas DataFrame via the .df attribute:

app.variables.df

AppChildren.add()

Use the add() function to add new variables, master measures or master dimensions to the app.

Args:

• name (str): Name of the object to be created.
• definition (str): Definition of the object to be created.
• description (str, optional): Description of the object to be created. Defaults to ''.
• label (str, optional): Label of the object to be created. Defaults to ''.
• label_expression (str, optional): Label expression of the object to be created. Defaults to ''.
• format_type (str, optional): Format type of the object to be created. Defaults to 'U'.
  • 'U' for auto
  • 'F' for number
  • 'M' for money
  • 'D' for date
  • 'IV' for duration
  • 'R' for other
• format_ndec (int, optional): Number of decimals of the object to be created. Defaults to 10.
• format_use_thou (int, optional): Use thousands separator for the object to be created. Defaults to 0.
• format_dec (str, optional): Decimal separator for the object to be created. Defaults to ','.
• format_thou (str, optional): Thousands separator for the object to be created. Defaults to ''.

Returns: True if the object was created successfully, False otherwise. Only parameters applicable to the specific class will be used

App.variables.add(name = 'MyVar', definition = 'sum(Sales)')
App.measures.add(name = 'MyFunc', definition = 'sum(Sales)', format_type = 'F')
App.dimensions.add(name = 'MyDim', definition = 'Customer')

Variable class

The class represents variables of the application and is a member of the App.variables collection. You can access a specific variable by its name or iterate through them:

var = app.variables['MyVar']
print(var.definition)

for var in app.variables:
    if var.definition == 'sum(Sales)': var.update(name = 'varSales')

Variable properties

• name: this is the name of the variable you generally use in the Qlik Sense interface
• definition: the formula behind the variable
• description: the description of the variable
• auxiliary
  • handle: the internal handle of the object in the Qlik Sense Engine API; can be used to access the variable via the query() function
  • app_handle: the handle of the parent App object
  • id: Qlik Sense internal id of the variable
  • parent: App-children object; you can access the App class object like this var.parent.parent
  • created_date: creation date of the variable, as stored in Qlik Sense
  • modified_date: date of the last modification of the variable, as stored in Qlik Sense
  • script_created: True if the variable is created via the application load script, False if not.

Variable.update()

Updates the variable on the Qlik Sense Server

Args:

• definition (str, optional): new definition of the variable (leave None to keep the old value)
• description (str, optional): new description of the variable (leave None to keep the old value)

Returns: True if the variable was updated successfully, False otherwise

var = app.variables['MyVar']
var.update(definition = 'sum(Sales)')
app.save()

Variable.delete()

Deletes the variable from the Qlik Sense Server

Returns: True if the variable was deleted successfully, False otherwise

var = app.variables['MyVar']
var.delete()
app.save()

Variable.rename()

Renames the variable on the Qlik Sense Server. Since there is no direct method to rename the variable, it essentially deletes the variable with the old name, and creates a new one, with the new name.

Returns: True if the variable is renamed successfully, False otherwise

var = app.variables['MyVar']
var.rename('MyVarNewName')
app.save()

Variable.get_layout()

Returns the json layout of the variable; a shortcut to the GetLayout method of the Engine API

var.get_layout()

Measure class

The class represents master measures of the application and is a member of the App.measures collection. You can access a specific measure by its name or iterate through them.

ms = app.measures['MyMeasure']
print(ms.definition)

for ms in app.measures:
    if ms.definition == 'sum(Sales)': ms.update(name = 'Sales')

Measure properties

• name: the name of the measure you generally use in the Qlik Sense interface
• definition: the formula behind the measure
• description: the description of the measure
• label: the label of the measure, as it appears in charts
• label_expression: the label expression of the measure
• format_type: Format type of the object
  • 'U' for auto
  • 'F' for number
  • 'M' for money
  • 'D' for date
  • 'IV' for duration
  • 'R' for other
• format_ndec: Number of decimals for the object
• format_use_thou: Use thousands separator for the object
• format_dec: Decimal separator for the object
• format_thou: Thousands separator for the object
• auxiliary
  • handle: the internal handle of the object in the Qlik Sense Engine API; can be used to access the measure via the query() function
  • app_handle: the handle of the parent App object
  • id: Qlik Sense internal id of the measure
  • parent: AppChildren object; you can access the App class object like this ms.parent.parent
  • created_date: creation date of the measure, as stored in Qlik Sense
  • modified_date: date of the last modification of the measure, as stored in Qlik Sense

Measure.update()

Updates the measure on the Qlik Sense Server

Args:

• definition (str, optional): The definition of the measure
• description (str, optional): the description of the measure
• label (str, optional): the label of the measure, as it appears in charts
• label_expression (str, optional): the label expression of the measure
• format_type (str, optional): Format type of the object to be created. Defaults to 'U'.
  • 'U' for auto
  • 'F' for number
  • 'M' for money
  • 'D' for date
  • 'IV' for duration
  • 'R' for other
• format_ndec (int, optional): Number of decimals for the object to be created. Defaults to 10.
• format_use_thou (int, optional): Use thousands separator for the object to be created. Defaults to 0.
• format_dec (str, optional): Decimal separator for the object to be created. Defaults to ','.
• format_thou (str, optional): Thousands separator for the object to be created. Defaults to ''.

Returns: True if the measure was updated successfully, False otherwise

ms = app.measures['MyMeasure']
ms.update(definition = 'sum(Sales)', label = 'Total Sales', format_type = 'F')
app.save()

Measure.delete()

Deletes the measure from the Qlik Sense Server

Returns: True if the measure was deleted successfully, False otherwise

ms = app.measures['MyMeasure']
ms.delete()
app.save()

Measure.rename()

Renames the measure on the Qlik Sense Server.

Returns: True if the measure was renamed successfully, False otherwise

ms = app.measures['MyMeasure']
ms.rename('MyMeasureNewName')
app.save()

Measure.get_layout()

Returns the json layout of the measure; a shortcut to the GetLayout method of the Engine API

ms.get_layout()

Dimension class

The class represents master dimensions of the application and is a member of the App.dimensions collection. You can access a specific dimension by its name or iterate through them. Note that hierarchical dimensions are not yet supported."

dim = app.dimensions['MyDimension']
print(dim.definition)

for dim in app.dimensions:
    if dim.definition == '[Customer]': dim.update(name = 'Customer_dimension')

Dimension properties

• name: the name of the dimension you generally use in the Qlik Sense interface
• definition: the formula behind the dimension
• label: the label of the dimension, as it appears in charts
• auxiliary
  • handle: the internal handle of the object in the Qlik Sense Engine API; can be used to access the dimension via the query() function
  • app_handle: the handle of the parent App object
  • id: Qlik Sense internal id of the dimension
  • parent: AppChildren object; you can access the App class object like this dim.parent.parent
  • created_date: creation date of the dimension, as stored in Qlik Sense
  • modified_date: date of the last modification of the dimension, as stored in Qlik Sense

Dimension.update()

Updates the dimension on the Qlik Sense Server

Args:

• definition (str, optional): The definition of the dimension
• label (str, optional): the label of the dimension, as it appears in charts

Returns: True if the dimension was updated successfully, False otherwise

dim = app.dimensions['MyDimension']
dim.update(definition = 'Customer', label = 'Customer_dimension')
app.save()

Dimension.delete()

Deletes the dimension from the Qlik Sense Server

Returns: True if the dimension was deleted successfully, False otherwise

dim = app.dimensions['MyDimension']
dim.delete()
app.save()

Dimension.rename()

Renames the dimension on the Qlik Sense Server.

Returns: True if the dimension was renamed succesfully, False otherwise

dim = app.dimensions['MyDimension']
dim.rename('MyDimensionNewName')
app.save()

Dimension.get_layout()

Returns the json layout of the dimension; a shortcut to the GetLayout method of the Engine API

dim.get_layout()

Sheet class

The class represents the sheets of the application and is a member of the App.sheets collection. You can access objects on the sheets, such as charts and tables, via the Sheet class object.

for sh in app.sheets:
    print(sh.name)

Sheet properties

• name: that's the name of the sheet
• description: the description of the sheet
• auxiliary
  • handle: the internal handle of the object in Qlik Sense Engine API; can be used to access the sheet via the query() function
  • app_handle: the handle of the parent App object
  • id: Qlik Sense internal id of the sheet
  • parent: AppChildren object; you can access the App class object like this ms.parent.parent
  • created_date: creation date of the sheet, as stored in Qlik Sense
  • modified_date: date of the last modification of the sheet, as stored in Qlik Sense
  • published: True if the sheet is published, False if not
  • approved: True if the sheet is approved, False if not
  • owner_id: GUID of the owner of the sheet
  • owner_name: name of the owner of the sheet

Sheet.load()

Loads objects from the sheet in a Qlik Sense application into a Sheet class object

sh = App.sheets['MySheet']
sh.load()

for obj in sh.objects:
    print(obj.type)

Sheet.get_layout()

Returns the json layout of the sheet; a shortcut to the GetLayout method of the Engine API

sh.get_layout()

Field class

The class represents the fields of the application and is a member of the App.fields collection. You can only use the class for information purposes; no changes can be made with fields via QSEA."

for fld in app.fields:
    print(field.table_name, field.name)

Field properties

• name: name of the field, as it appears in the model
• table_name: name of the table, containing the field
• information_density, non_nulls, rows_count, subset_ratio, distinct_values_count, present_distinct_values, key_type, tags: properties of the fields as they can be found in the data model
• auxiliary
  • handle: internal handle of the field object
  • app_handle: handle of the parent App object

Object class

The class represents the objects on the sheet, such as charts and tables, and is a member of the SheetChildren collection.

Object properties

• type: type of the object, such as 'piechart' or 'pivot-table'
• col, row, colspan, rowspan, bounds_y, bounds_x, bounds_width, bounds_height: parameters referring to the location of an object on the sheet
• auxiliary
  • handle: the internal handle of the object in the Qlik Sense Engine API; can be used to access the object via the query() function
  • sheet_handle: handle of the parent sheet
  • sheet: the Sheet object, on which the object itself is located
  • id: Qlik Sense internal id of the object
  • parent: SheetChildren object

Object.export_data()

Performs data export of an object (such as a table or chart) to an xslx or csv file.

Args:

• file_type (str, optional): 'xlsx' or 'csv', 'xlsx' by default

Returns: the path to the downloaded file in case of success, None if failed

Object.load()

Loads measures and dimensions of the object in a Qlik Sense application into an Object class instance.

sh = App.sheets['MySheet']
sh.load()

for obj in sh.objects:
    if obj.type == 'piechart': 
        obj.load()
        print(obj.dimensions.count)

Object.get_layout()

Returns the json layout of the object; a shortcut to the GetLayout method of the Engine API

obj.get_layout()

ObjectChildren class

The class contains collections of measures and dimensions in the object on the sheet:

• object.measures: a collection of ObjectMeasure class objects, representing the measures in the object on the sheet
• object.dimensions: a collection of ObjectDimension class objects, representing the dimensions in the object on the sheet

You can access the main information in pandas DataFrame via .df:

App.sheets['MySheet'].objects['object_id'].measures.df

Adding measures and dimensions to app objects is not supported yet.

ObjectMeasure class

This class represents measures of the object on the sheet and is a member of the object.measures collection. Since there may be no specific name for the measure in the object, the internal Qlik ID is used instead of the name. Thus, you can either iterate through measures or call them by the internal Qlik ID:

ms = obj.measures['measure_id']
print(ms.definition)

for ms in obj.measures:
    if ms.definition == 'sum(Sales)': ms.update(definition = 'sum(Incomes)')

ObjectMeasure properties

• name: internal Qlik id of the measure
• definition: the formula behind the measure
• label: the label of the measure, as it appears in the charts
• label_expression: the label expression of the measure
• calc_condition: calculation condition for the measure
• library_id: if a master measure is used, this refers to its ID
• format_type: Format type of the object
  • 'U' for auto
  • 'F' for number
  • 'M' for money
  • 'D' for date
  • 'IV' for duration
  • 'R' for other
• format_ndec: Number of decimals of the object
• format_use_thou: Use thousands separator for the object
• format_dec: Decimal separator for the object
• format_thou: Thousands separator for the object
• auxiliary
  • app_handle: the handle of the parent App object
  • parent: ObjectChildren object
  • object: you can access the Object class object like this ms.object

ObjectMeasure.update()

Updates the measure in the object on the sheet.

Args:

• definition (str, optional): The definition of the measure
• label (str, optional): the new label of the measure, as it appears in charts
• label_expression (str, optional): the label expression of the measure
• calc_condition (str, optional): calculation condition for the measure
• library_id (str, optional): id of the master measure
• format_type (str, optional): Format type of the object. Defaults to 'U'.
  • 'U' for auto
  • 'F' for number
  • 'M' for money
  • 'D' for date
  • 'IV' for duration
  • 'R' for other
• format_use_thou (int, optional): Use thousands separator for the object. Defaults to 0.
• format_dec (str, optional): Decimal separator for the object. Defaults to ','.
• format_thou (str, optional): Thousands separator for the object. Defaults to ''.

Returns: True if the measure was updated successfully, False otherwise

ms = obj.measures['measure_id']
ms.update(definition = 'sum(Sales)', label = 'Total Sales', format_type = 'F')
app.save()

ObjectMeasure.delete()

Deletes the measure from the object on the sheet

Returns: True if the measure was deleted successfully, False otherwise

ms = obj.measures['measure_id']
ms.delete()
app.save()

ObjectDimension class

This class represents dimensions of the object on the sheet and is a member of the object.dimensions collection. Since there may be no specific name for the dimension in the object, the internal Qlik ID is used instead of the name. Thus, you can either iterate through dimensions or call them by the internal Qlik ID:

dim = obj.measures['dimension_id']
print(dim.definition)

for dim in obj.dimensions:
    if dim.definition == '[Customer]': dim.update(definition = '[Supplier]')

Note that hierarchical dimensions are not supported yet.

ObjectDimension properties

• name: internal Qlik id of the dimension
• definition: the formula behind the dimension
• label: the label of the dimension, as it appears in the charts
• auxiliary
  • app_handle: the handle of the parent App object
  • parent: ObjectChildren object
  • object: you can access the Object class object like this dim.object

ObjectDimension.update()

Updates the dimension in the object on the sheet

Args:

• definition (str, optional): the definition of the dimension
• label (str, optional): the label of the dimension, as it appears in charts
• calc_condition (str, optional): calculation condition for the dimension

Returns: True if the dimension was updated successfully, False otherwise

dim = obj.dimensions['dimension_id']
dim.update(definition = 'Customer', label = 'Customer_dimension')
app.save()

ObjectDimension.delete()

Deletes the dimension from the Qlik Sense Server

Returns: True if the dimension was deleted successfully, False otherwise

dim = app.dimensions['dimension_id']
dim.delete()
app.save()

License

This project is licensed under the MIT License - see the LICENSE file for details.

History

[0.0.16] - 2023-10-03

• Minor changes

[0.0.15] - 2023-10-03

• Minor changes

[0.0.14] - 2023-10-01

Added

• object.export_data() function which performs data export of an object (such as a table or chart) to an xslx or csv file
• get_layout() function for measures, dimensions, variables, sheets and objects; the functions return the json layout