|
Wie man mpmX in Ihre IT-Landschaft integriert |
Scroll Previous Topic Top Next Topic More |
Zur Integration in eine bestehende, heterogene IT-Landschaft bietet mpmX neben einer Vielzahl an standardmäßigen Konnektoren zur Datenübergabe auch eine Reihe an standardisierten Programmierschnittstellen (APIs), die die Kommunikation bestehenden Systemen vereinfachen. Je nach Deployment-Modell, Software as a Service (SaaS/Cloud) oder On-Premise, unterscheiden sich die zur Verfügung stehenden APIs.
APIs in einem SaaS-Deployment
mpmX bietet in einem SaaS-Deployment-Szenario eine Vielzahl von APIs, die sich wie folgt unterteilen:
•Authentication (REST APIs)
o.well known
oAPI Keys
oLogin
oOAuth
oOAuth Tokens
oWeb Integrations
•Build (REST APIs)
oApps
oAutomations
oAutoML Dataset Predictions
oAutoML Real Time Predictions
oConditions
oData Assets
oData Files
oData Sets
oData Stores
oEvaluations
oRepors
•Embed
oJavaScript
▪App Integration
▪Capabilties
▪Enigma.js
▪Vielzahl von Nebula Visualisierungen / Diagrammen
▪Sense Client Objects
▪Single Integrations
oREST
▪CSP Origins
▪CSRF Tokens
▪Natural Language
•Extend
oJavaScript
▪Enigma.js
▪Extensions
▪Nebula.js: stardust
▪Picasso.js
▪Sense Client Objects
oREST
▪Extensions
▪Themes
•Manage
oEvent
▪Apps
▪Users
oJSON-RPC
▪QIX
oREST
▪Apps
▪Automations
▪Data Connections
▪Data Alerts
▪Encryption
▪Glossaries
▪Identity Providers
▪Licenses
▪Reloads
▪Users
▪und viele mehr
Eine komplette Dokumentation der zur Verfügung stehenden Schnittstellen finden Sie in der Qlik-Sense-Online-Hilfe: https://qlik.dev/apis/
APIs in einem On-Premise-Deployment
In einem On-Premise-Deployment-Szenario stehen als APIs folgende zur Verfügung:
•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
Eine vollständige Liste aller zur Verfügung stehenden APIs und deren Verwendung steht in der Qlik-Sense-Online-Hilfe zur Verfügung: https://help.qlik.com/en-US/sense-developer/November2023/Content/Sense_Helpsites/APIs-and-SDKs.htm
Beispiel: Externes Setzen von Filtern mithilfe der FieldAPI und der SelectValues-Methode
Die Field-API von mpmX ermöglicht es Ihnen, von extern auf bestimmte Felder des Datenmodells zuzugreifen und mit Ihnen zu interagieren. Die selectValues-Methode selektiert bestimmte Werte in einem Feld, die als Parameter über die API mitgegeben werden.
Methode:
qlik.app.field.selectValues(array, toggle, softlock)
Parameter:
•array: Array von qFieldValues, die selektiert werden sollen
•toggle: boolean. Ist der Parameter true, wird der aktuelle selektierte Status umgeschalten.
•softlock: boolean. Ist der Parameter true, werden eigentlich festgesetzte Status überschrieben
Beispiele:
Array von qFieldValues wird selektiert
var app = qlik.openApp('c31e2aba-3b46-4b13-8b87-c5c2514dea1d', config); app.field('LastName').selectValues([{qText:"Andersson"},{qText:"Bush"},{qText:"Obama"}], true, true),
Vereinfachte Syntax mit Strings und Zahlen
var app = qlik.openApp ('c31e2aba-3b46-4b13-8b87-c5c2514dea1d', config); app.field(fld).selectValues([5], true, true); app.field(fld).selectValues(["Andersson"], true,true);
Beispiel: Externes Setzen von Filtern mithilfe von Bookmarks
Die Bookmark-API enthält Methoden, die es ermöglichen innerhalb der mpmX-Anwendung mit Bookmarks zu interagieren. Bookmarks enthalten Status von bestimmten Filtern, die sich bei der Anwendung des Bookmarks auf die aktuelle App auswirken. Die Verwendung von Bookmarks ermöglicht die effiziente Zusammenarbeit mit Teammitgliedern, sodass alle Mitarbeiterinnen und Mitarbeiter und schnell auf die gleiche Datenauswahl zugreifen können.
•Zunächst müssen Sie sich mit der bestehenden mpmX-App verbinden um Bookmarks zu erstellen, zu löschen oder anzuwenden. Dazu nutzen Sie die qlik.openApp-Methode.
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');
Beispielanwendungen
| a. | Ein neues Bookmark auf Basis der aktuellen Auswahl erstellen Nutzen Sie die qlik.app.bookmark.create-Methode um ein Bookmark auf Basis der aktuellen Selektion zu erstellen. |
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');
}
| b. | Ein bestehendes Bookmark anwenden Nutzen Sie die qlik.app.bookmark.apply-Methode um ein bestehendes Bookmark auf die aktuelle App anzuwenden. |
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');
}
| c. | Ein bestehendes Bookmark entfernen Nutzen Sie die qlik.app.bookmark.remove-Methode um ein bestehendes Bookmark zu entfernen. |
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');
}
