GetUserAttr - script and chart function

This example defines a set of script variables that can be used in the app content you create. Each time the app is reloaded, the attributes are evaluated and added to the app.

Do the following:

1. Create a new Qlik Sense app.

2. Open the Data load editor and add the load script below to a new tab. The load script contains:

   • A new table, called Transactions, with sample transaction data. This could be replaced with any data, and is added as a placeholder.

   • A series of script variable definitions for the available attributes that the GetUserAttr function can return.

   Transactions:
   Load * inline [
   id,date,amount
   1,1/1/2023,500.67
   2,1/2/2023,458.91
   3,1/3/2023,12.34
   4,1/4/2023,90.90
   5,1/5/2023,256.30
   6,1/6/2023,789.16
   7,1/7/2023,501.25
   8,1/8/2023,87.01
   9,1/9/2023,161.16
   10,1/10/2023,300.06
   ];
   Let vUserEmail = GetUserAttr('userEmail');
   Let vUserSubject = GetUserAttr('userSubject');
   Let vUserGroups = GetUserAttr('userGroups');

3. Load the data and open a new sheet in advanced edit mode.

4. Create a Table object and add the following expressions as dimensions:

• =vUserEmail

• =vUserSubject

• =vUserGroups, this returns a comma-separated list in a string

The output in the table dynamically displays the available user attributes. The following table shows an example of results returned using the GetUserAttr function.

In this example, instead of defining variables in the load script, variables are defined in the app. Once defined, variables can be used in chart expressions in the app. The main benefit of using the function in chart expressions is that the attributes will automatically refresh without having to reload the app. This enables smoother movement of apps between users as part of the app life cycle.

Do the following:

1. Create a new Qlik Sense app.

2. Open a new sheet in advanced edit mode.

3. Open the variables dialog.

4. Select Create new, and then do the following:

   • Under Name, enter vUserEmail.

   • Under Definition, enter =GetUserAttr('userEmail').

   • Select Create.

An app variable is created to display the email address of the user. Repeat this step to create a variable for the remaining attributes using the following parameters:

• User Subject

  • Name: vUserSubject

  • Definition: =GetUserAttr('userSubject')

• User Groups

  • Name: vUserGroups

  • Definition: =GetUserAttr('userGroups')

5. Create a Table object and add the following expressions as dimensions:

• =vUserEmail

• =vUserSubject

• =vUserGroups (returns a comma-separated list in a string)

The output in the new table dynamically displays the available user attributes. The following table shows an example of results returned from the GetUserAttr function.

You can also use the function in your apps without a variable. This example demonstrates how to load a table with each attribute as an individual field. From here, you can create visualizations in the app to display these details.

Do the following:

1. Create a new Qlik Sense app.

2. Open the Data load editor and add the load script below to a new tab. The load script contains:

   • A new table, called Attributes, that contains each attribute as a field.

   Attributes:
   Load RowNo() as Key,
   GetUserAttr('userEmail') as UserEmail,
   GetUserAttr('userSubject') as UserSubject,
   GetUserAttr('userGroups') as UserGroups autogenerate 1;

3. Load the data. A table is created in the data model that displays each of the attributes in individual fields.

You can now use the attribute fields in visualizations, such as tables or text & image objects.

You can enter the function directly into chart expressions without using a variable. The user attributes will refresh without having to reload the app. This enables smoother movement of apps between users as part of the app life cycle.

Do the following:

1. Create a new Qlik Sense app.

2. Open a new sheet in advanced edit mode.

3. Drag a Text & image object onto the sheet.

4. Click inside the blank chart and enter the following label:

   User Email:

5. In the properties panel, select Add measure.

6. Enter the following expression:

   • =GetUserAttr('userEmail')

7. Add labels and measures for the other attributes, User Subject and User Groups, on new lines. Use the following expressions for each attribute:

   • =GetUserAttr('userSubject'), for User Subject

   • =GetUserAttr('userGroups), for User Groups​