getGlobal method

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

qlik.getGlobal(config)

Opens a WebSocekt connection to the Qlik Associative Engine for global methods.

Version history

Introduced 1.1

Parameters

config

Type: Object

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.

openWithoutData Boolean

Optional.

Open app without loading data.

Introduced in version 1.1.

identity String

Optional.

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

Returns

A global JavaScript object with global methods.

Global API

Example

var config = {
	host: "myhost.com",
	prefix: "/",
	port: window.location.port,
	isSecure: true
};
var global = qlik.getGlobal(config);
global.getAuthenticatedUser(function(reply){
	alert('User:'+reply.qReturn);
});

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?