Skip to main content

How to integrate mpmX into your IT landscape

For integration into an existing, heterogeneous IT landscape, mpmX offers a variety of standard connectors for data transfer as well as a range of standardized programming interfaces (APIs) that simplify communication with existing systems. The available APIs differ depending on the deployment model, Software as a Service (SaaS/Cloud) or on-premise.

APIs in a SaaS deployment​

mpmX offers a variety of APIs in a SaaS deployment scenario, which are divided as follows:

Authentication (REST APIs)​

  • well known
  • API Keys
  • Login
  • OAuth
  • OAuth Tokens
  • Web Integrations

Build (REST APIs)​

  • Apps
  • Automations
  • AutoML Dataset Predictions
  • AutoML Real Time Predictions
  • Conditions
  • Data Assets
  • Data Files
  • Data Sets
  • Data Stores
  • Evaluations
  • Repors

Embed​

  • JavaScript
    • App Integration
    • Capabilties
    • Enigma.js
    • Vielzahl von Nebula Visualisierungen / Diagrammen
    • Sense Client Objects
    • Single Integrations
    • REST
    • CSP Origins
    • CSRF Tokens
    • Natural Language

Extend​

  • JavaScript
    • Enigma.js
    • Extensions
    • Nebula.js: stardust
    • Picasso.js
    • Sense Client Objects
    • REST
    • Extensions
    • Themes

Manage​

Event​

  • Apps
  • Users

JSON-RPC​

  • QIX

REST​

  • Apps
  • Automations
  • Data Connections
  • Data Alerts
  • Encryption
  • Glossaries
  • Identity Providers
  • Licenses
  • Reloads
  • Users und viele mehr

A complete documentation of the available interfaces can be found in the Qlik Sense online help: Click here

APIs in an on-premise deployment​

The following APIs are available in an on-premise deployment scenario:

  • About Service API
  • Qlik Engine JSON API
  • Extension API
  • Backend API
  • Capability API
  • qlik-visual web component
  • App Integration API
  • Single Integration API
  • Enigma.js
  • Nebula.js
  • Enigma.go
  • Leonardo-ui
  • Picasso.js
  • Qlik Sense Proxy Service API
  • Qlik Sense Repository Service API
  • Qlik Sense .NET SDK
  • OdagService
  • Qlik Sense Natural Language Query API
  • Qlik Sense User Directory Connector API

A complete list of all available APIs and their usage is available in the Qlik Sense online help: Click here.

📝 Example: Setting filters externally using the FieldAPI and the SelectValues method
The Field API of mpmX allows you to access certain fields of the data model externally and interact with them. The selectValues method selects certain values in a field that are passed as parameters via the API.

Method:

qlik.app.field.selectValues(array, toggle, softlock)

Parameter:

  • array: Array of qFieldValues that are to be selected

  • toggle: boolean. If the parameter is true, the current selected status is toggled.

  • softlock: boolean. If the parameter is true, the set status is overwritten

Examples​

Array of qFieldValues is selected​

var app = qlik.openApp('c31e2aba-3b46-4b13-8b87-c5c2514dea1d', config);
app.field('LastName').selectValues([{qText:"Andersson"},{qText:"Bush"},{qText:"Obama"}], true, true),

Simplified syntax with strings and numbers​

var app = qlik.openApp ('c31e2aba-3b46-4b13-8b87-c5c2514dea1d', config);
app.field(fld).selectValues([5], true, true); app.field(fld).selectValues(["Andersson"], true,true);

Example: External setting of filters using bookmarks​

The Bookmark API contains methods that make it possible to interact with bookmarks within the mpmX application. Bookmarks contain statuses of specific filters that affect the current app when the bookmark is applied. The use of bookmarks enables efficient collaboration with team members so that all employees can quickly access the same data selection.

  • First, you need to connect to the existing mpmX app to create, delete or apply bookmarks. To do this, use the qlik.openApp-Method.

    var config = {
        host: 'QSE_domain',
        prefix: '/',
        port: 443,
        isSecure: true,
        webIntegrationId: 'web-integration-id-here' //only needed for SaaS editions
    };

    require(["js/qlik"], function(qlik) {
        //open apps -- inserted here --
        var app = qlik.openApp('c31e2aba-3b46-4b13-8b87-c5c2514dea1d', config);
        //apply a bookmark
        app.bookmark.apply('pPvpTN');

Example applications​

Create a new bookmark based on the current selection​

Use the qlik.app.bookmark.create method to create a bookmark based on the current selection.

require(["js/qlik"], function(qlik) {
    //open apps -- inserted here --
    var app = qlik.openApp('c31e2aba-3b46-4b13-8b87-c5c2514dea1d', config);
    //create a bookmark
    app.bookmark.create('Test','Test bookmark','fmcJkH');
}

Apply an existing bookmark​

Use the qlik.app.bookmark.apply method to apply an existing bookmark to the current app.

var config = {
    host: 'QSE_domain',
    prefix: '/',
    port: 443,
    isSecure: true,
    webIntegrationId: 'web-integration-id-here' //only needed for SaaS editions
};

require(["js/qlik"], function(qlik) {
    //open apps -- inserted here --
    var app = qlik.openApp('c31e2aba-3b46-4b13-8b87-c5c2514dea1d', config);
    //apply a bookmark
    app.bookmark.apply('pPvpTN');

}

Remove an existing bookmark​

Use the qlik.app.bookmark.remove method to remove an existing bookmark.

var config = {
    host: 'QSE_domain',
    prefix: '/',
    port: 443,
    isSecure: true,
    webIntegrationId: 'web-integration-id-here' //only needed for SaaS editions
};

require(["js/qlik"], function(qlik) {
    //open apps -- inserted here --
    var app = qlik.openApp('c31e2aba-3b46-4b13-8b87-c5c2514dea1d',
    config);
    //remove a bookmark
    app.bookmark.remove('pPvpTN');
}