topic Re: Mashup API context in Integration, Extension & APIs

Mashup API context

rbecher — Wed, 24 Sep 2014 15:51:20 GMT

Hi,

is it possible to use the Mashup API from a different context than http://localhost:4848 ?

- Ralf

Re: Mashup API context

ToniKautto — Wed, 24 Sep 2014 19:33:51 GMT

Mashups API are used to display Qlik Sense objects on your website. It allows you to get objects, add buttons, create bookmarks and interact with fields.

https://help.qlik.com/sense/en-us/developer/index.html#../Subsystems/Workbench/Content/BuildingWebsites/API/qswb_mup_api…

The Qlik Sense Workbench (http://localhost:4848 ) is a way to make the mashup easier to use.

Re: Mashup API context

rbecher — Wed, 24 Sep 2014 19:40:48 GMT

I know. But how can I use it from a different webserver? I would usually not use it on the Qlik Sense server...

Re: Mashup API context

ToniKautto — Wed, 24 Sep 2014 20:04:08 GMT

The mashup calls are directed to the server defined in the mashup JS file. So if you make a template based mashup, you will find these details in the JS file named as the mashup. In the first section a config and application setup is done, as described in the help page below.

ps://help.qlik.com/sense/en-us/developer/index.html#../Subsystems/Workbench/Content/BuildingWebsites/API/qlik.htm

Re: Mashup API context

rbecher — Wed, 24 Sep 2014 20:17:50 GMT

Yes, I have seen this. But how can I load http://<server>:4848/resources/js/qlik.js (and other js/css files) from another context? Or, is there a package of js/css files I can use?

Re: Mashup API context

ToniKautto — Thu, 25 Sep 2014 19:26:47 GMT

If you generate your mashup through the Qlik Sense work bench, the mashup html file will have the required includes in the html head. The JS file will initiate the connection to Qlik Sense Server and get the referred objects.

If you have included a custom extension the required JS files for that extension will be included automagically. There is no need for additional inclusions from the Qlik Sense server.

The arbitrary page where you include the Qlik Sense objects will include and handle CSS and JS just as usual.

I have a hard time understanding exactly what you are trying to do, and where you get stuck. Can you upload a couple example files to exemplify the scenario?

Re: Mashup API context

rbecher — Thu, 25 Sep 2014 19:34:09 GMT

I undestand everything what is created from workbench very well but it works only in the same context. For my opinion nobody needs a mashup running on Qlik Sense context. How can we create mashups running on a different web server? So, how we can pull in Qlik Sense objects in a web site or portal? That would be the normal use case.

Re: Mashup API context

Fri, 26 Sep 2014 08:10:32 GMT

Hello Ralf,

I guess you run into CORS (HTTP access control (CORS) - HTTP | MDN) problems, as the browser declines usage of JS loaded from a different webserver than the one your mashup-Page is hosted on.

Maybe providing a simple proxy on your host apps server that redirects all calls to the Qlik Sense Proxy and thus acts as if everything is provided by your own web server would solve this.

I am currently dealing with such a problem in Nodejs and QlikView.

Or alternatively, adding the allow-origin-access-control response header to the proxy might help:

But I could not test this, so please give it a try on your own - and pray.

Good luck!

Re: Re: Mashup API context

ErikWetterberg — Fri, 26 Sep 2014 08:45:29 GMT

Hi Ralf,

You actually need to make changes in both HTML and js files. In the HTML file you need to change the links that are at the beginning so that they point to your QlikSense server:

<link rel="stylesheet" href="/resources/assets/qirby/autogenerated/qirby.css">

    <link rel="stylesheet" href="/resources/assets/client/client.css" media="all">

    <script src="/resources/js/external/requirejs/require.js"></script>

This will make the browser find the css files and requirejs javascript library.

In the javascript file you need to configure requirejs with your QlikSense host so that it finds qlik.js and the apps:

var config = {

     host:'yourhost.com'

     prefix: "/",

     port: 443,

     isSecure: true

};

require.config( {

baseUrl: ( config.isSecure ? "https://" : "http://" ) + config.host + (config.port ? ":" + config.port: "") + config.prefix + "resources"

} );

The default configuration is based on running the mashup from Qlik Sense and takes configuration from windows.location.

There is a known limitation that using extensions in a mashup hosted on an external web server does not work because of CORS problems. We are working on a solution for this. We hope to be able to simplify this setup in future releases, but this is how it works in 1.0.

Re: Re: Mashup API context

rbecher — Fri, 26 Sep 2014 15:46:47 GMT

Thanks Thomas and Erik! Would it help to have all used and related js/css soruces on the different site locally?

Re: Mashup API context

ErikWetterberg — Mon, 29 Sep 2014 06:12:26 GMT

As far as I know we haven't really verified saving qlik's css and js files on the external web server. Iguess that it is possible at least with the links in the html file. Note that in the mashup created from mashup workbench the config object is used both for requirejs config basepath and when opening the actual app (the websocket url is based in this data).