sessionAppFromApp method

Note: STABLE.
This API is reliable and breaking changes are unlikely.

qlik.sessionAppFromApp(appId, config)

Creates a session app JavaScript object with app methods from an existing app. You can create one session app per app.

Note: The sessionAppFromApp method is applicable to Qlik Sense Enterprise on Windows only.
Note: You must at least have update rights on the app you are creating the session app from.

Version history

Introduced Qlik Sense June 2017

Parameters

appId

Type: String

App id of the app to base the session app upon.

Note: In Qlik Sense Desktop, the appId must contain the full path. For example: "C:\\Users\\David\\Documents\\Qlik\\Sense\\Apps\\Helpdesk Management.qvf".

config

Type: Object

Parameter updated in version 2.2.

Optional.

Additional configuration parameters:

Name Type Descr
host String

Optional.

Qlik host.

port

String or integer

Optional.

Port number.

prefix String

Optional.

Qlik virtual proxy. "/" if no proxy.

isSecure Boolean

Optional.

Use SSL.

identity String

Optional.

Unique identity for the session. If omitted, the session will be shared.

Returns

App JavaScript object with app methods.

App API

Examples

Example 1: Basic usage

var sessionApp = qlik.sessionAppFromApp("2abac31e-3b46-4b78-8bxf-c5cea1d2514d");

Example 2: Basic usage with config

var config = {
  host: "myhost.com",
  prefix: "/",
  port: window.location.port,
  isSecure: true
};
var sessionApp = qlik.sessionAppFromApp("c31e2aba-3b46-4b13-8b87-c5c2514dea1d", config);

Example 3: Multiple apps

var sessionApp = qlik.sessionAppFromApp("2abac31e-3b46-4b78-8bxf-c5cea1d2514d");
var sessionApp2 = qlik.sessionAppFromApp("c31e2aba-3b46-4b13-8b87-c5c2514dea1d");

Did this information help you?

Thanks for letting us know. Is there anything you'd like to tell us about this topic?

Can you tell us why it did not help you and how we can improve it?