GetSysAttr - script and chart function

In this example, we define 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 in a shared space.

2. Open the Data load editor.

3. Paste the following load script into a new tab:

   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 vTenantId = GetSysAttr('tenantId');
   Let vTenantName = GetSysAttr('tenantName');
   Let vTenantUrl = GetSysAttr('tenantUrl');
   Let vTenantUrlAlias = GetSysAttr('tenantUrlAlias');
   Let vTenantRegion = GetSysAttr('tenantRegion');
   Let vSpaceId = GetSysAttr('spaceId');
   Let vSpaceName = GetSysAttr('spaceName');
   Let vSpaceType = GetSysAttr('spaceType');

This load script contains the following:

• A new table, called Transactions, contains 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 can be fetched by GetSysAttr().

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

Create a Table object and add the following expressions as dimensions, along with their respective labels:

• =vTenantId, with label Tenant ID

• =vTenantName, with label Tenant Name

• =vTenantUrl, with label Tenant URL (Default)

• =vTenantUrlAlias, with label Tenant URL (Alias)

• =vTenantRegion, with label Tenant Region

• =vSpaceId, with label Space ID

• =vSpaceName, with label Space Name

• =vSpaceType, with label Space Type

You now have a table in your app that dynamically displays each of the available environment attributes. Exporting the app and uploading it to a different tenant and space would give you these attributes for the newly uploaded version of the app.

In this example, rather than defining variables in the script, we define several variables using the dialog in advanced edit mode. The variables can then be used in chart expressions in the app.

Do the following:

1. Create a new Qlik Sense app in a shared space.

2. Open a new sheet in advanced edit mode.

3. Click to open the variables dialog.

4. Click Create new.

5. Under Name, enter vTenantId.

6. Under Definition, enter =GetSysAttr('tenantId').

7. Click Create.

This creates an app variable to display the ID of the tenant. Repeat steps 3 to 6 to create a variable for each of the remaining attributes. Use the following parameters:

• Tenant Name

  • Name: vTenantName

  • Definition: =GetSysAttr('tenantName')

• Tenant URL

  • Name: vTenantUrl

  • Definition: =GetSysAttr('tenantUrl')

• Tenant URL Alias

  • Name: vTenantUrlAlias

  • Definition: =GetSysAttr('tenantUrlAlias')

• Tenant Region

  • Name: vTenantRegion

  • Definition: =GetSysAttr('tenantRegion')

• Space ID

  • Name: vSpaceId

  • Definition: =GetSysAttr('spaceId')

• Space Name

  • Name: vSpaceName

  • Definition: =GetSysAttr('spaceName')

• Space Type

  • Name: vSpaceType

  • Definition: =GetSysAttr('spaceType')

Create a Table object and add each of following expressions as dimensions, along with their respective labels:

• =vTenantId, with label Tenant ID

• =vTenantName, with label Tenant Name

• =vTenantUrl, with label Tenant URL (Default)

• =vTenantUrlAlias, with label Tenant URL (Alias)

• =vTenantRegion, with label Tenant Region

• =vSpaceId, with label Space ID

• =vSpaceName, with label Space Name

• =vSpaceType, with label Space Type

You now have a table in your app, dynamically displaying each of the available environment attributes. Exporting the app and uploading it to a different tenant and space would give you these attributes for the newly uploaded version of the app.

The main benefit of using the function in chart expressions is that the app does not need to be reloaded for these attributes to be refreshed. This enables smoother movement of apps between tenants and spaces as part of the app life cycle.

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 in a shared space.

2. Open the Data load editor.

3. Paste the following load script into a new tab:

   Attributes:
   
   Load RowNo() as Key,
   GetSysAttr('tenantId') as TenantID,
   GetSysAttr('tenantName') as TenantName,
   GetSysAttr('tenantUrl') as TenantUrl,
   GetSysAttr('tenantUrlAlias') as TenantUrlAlias,
   GetSysAttr('tenantRegion') as TenantRegion,
   GetSysAttr('spaceId') as SpaceID,
   GetSysAttr('spaceName') as SpaceName,
   GetSysAttr('spaceType') as SpaceType autogenerate 1;

Load the data. A table is created in the data model, displaying each of the attributes in individual fields.

Now you can 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 main benefit of using the function in chart expressions is that the app does not need to be reloaded to refresh these attributes. This enables smoother movement of apps between tenants and spaces as part of the app life cycle.

Do the following:

1. Create a new Qlik Sense app in a shared space.

2. Open a new sheet in advanced edit mode.

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

4. Click inside the blank chart to add text, and type:

   Tenant ID:

5. In the properties panel, click Add measure.

6. Enter the following expression:

   =GetSysAttr('tenantId')

7. Repeat these steps for the other attributes on new lines, using the expressions presented in the attributes table in the introduction of this help topic.