Skip to main content

Customizing Qlik Sense Mobile with AppConfig

ON THIS PAGE

Customizing Qlik Sense Mobile with AppConfig

When administering Qlik Sense Mobile in an Enterprise Mobile Management (EMM) environment, you can customize the Qlik Sense Mobile experience for your users by editing the AppConfig file.

The AppConfig is a .json or .xml configuration file that can be edited using a Mobile Device Manager system. By editing the AppConfig file, you can for example change the default stream shown when Qlik Sense Mobile is launched, hide the demo server, or set a mashup as landing page. The way you modify the AppConfig file may vary depending on which Mobile Device Manager you use.

Configurable settings in AppConfig

The following are the configurable settings in the AppConfig file.

Settings

Type: Object

The settings object has the following properties:

hideDemoServer

Type: Boolean

If set to true, the demo server is hid from the account list.

hideAnalytics

Type: Boolean

If set to true, analytics are not displayed nor sent to Qlik.

If set to false, the end user can choose to send analytics to Qlik.

useBundledResources

Type: Boolean

If set to true, this setting enables to use the visualization client included in the Qlik Sense Mobile app when consuming apps online, making the online consumption of apps more efficient. The visualization client is used by default when consuming apps offline.

By default, this setting is absent and disabled. To be enabled, it needs to be manually added in the AppConfig and set to true.

For compatibility reasons, make sure to use the same version of Qlik Sense Enterprise and Qlik Sense Mobile when enabling this setting.

Accounts

Type: Object

The Accounts object is a JSON formatted list of accounts. Each item has a name that is shown to the user and a url used to authenticate the user. The value is formatted as follows:

{"name":"Account 1","url":"http://www.hub-A.com"}, {"name":"Account 2","url":"http://www.hub-B.com"}

The Accounts object has the following properties:

name

Type: string

The name of the account for which these settings are to be applied.

url

Type: string

The URL to the Qlik Sense hub.

config

Type: Object

The config object has the following properties:

  • DefaultStream

    Type: string

    Changes the default stream that is selected when the Qlik Sense hub is loaded.

  • LandingPage

    Type: string

    The path to a resource, such as a mashup, that should be loaded in place of the hub when a user successfully accesses Qlik Sense.

  • AADAppId

    Type: string

    Used for Microsoft Azure Single Sign On. The value for this key is a string equal to the QSM Azure Active Directory App registration Application/Client ID.

AppConfig example

{
  "Settings":{
    "hideDemoServer": true,
    "hideAnalytics": true,
    "useBundledResources": true
  },
  "Accounts":[
    {
      "name":"Everyone account",
      "url":"https://acme.com/vprefix",
      "config": {
        "DefaultStream": "Everyone",
        "AADAppId": "95c232bc-5ab2-4954-8640-2a865eeb8597"
      }
    },
    {
      "name":"Mashup account",
      "url":"https://acme.com/vprefix",
      "config": {
        "DefaultStream": "mashups",
        "LandingPage": "/extensions/LandingPageMashup/LandingPageMashup.html"
      }
    }
  ]
}

Setting a mashup as landing page

By editing the AppConfig file, you can set a mashup or a mashup stream as the landing page for users accessing Qlik Sense.

In the Configuration Value field, enter the following:

{
  "name":"Mashup account",
  "url":"https://acme.com/vprefix",
  "config": {
    "DefaultStream": "mashups",
    "LandingPage": "/extensions/LandingPageMashup/LandingPageMashup.html"
  }
}

Where:

  • "Mashup account" and "https://acme.com/vprefix" are the account and Sense hub to which these settings will be applied.
  • "/extensions/LandingPageMashup/LandingPageMashup.html" is the path to the mashup to be used as landing page.
  • "mashups" is the ID for a default stream that is loaded when accessing Qlik Sense.