topic Re: QS mashups and preserving selections in Integration, Extension & APIs

QS mashups and preserving selections

d_pranskus — Mon, 09 Mar 2015 11:46:01 GMT

I have several html pages where I use QS objects from single document. What I want is to preserve/transfer selections which I make on one page to another page. What is the best/correct way to do it? Is it some setting or I need to invoke API. Any samples would be much helpful. Thanks

Re: QS mashups and preserving selections

Aiham_Azmeh — Mon, 09 Mar 2015 12:56:15 GMT

Hi Darius,

If I understood you well, you want to from a Single Object page be able to influence selections in another Single Object selection page!?

You can do that with the identity parameter (http://help.qlik.com/sense/en-us/developer/#../Subsystems/Workbench/Content/BuildingWebsites/Overview/single-configurato…)

by passing the same identity to all your Single Object pages.

example:

let's say you have 2 iframes on different pages

by adding the identity=[some_id] parameter to both, you will be able to reflect selections from the first object to the second one.

I hope It will help,

aiham

Re: QS mashups and preserving selections

d_pranskus — Mon, 09 Mar 2015 13:16:29 GMT

Thanks Aiham

It is really helpful. What I want is to embed any number of objects on the html, which includes charts and lists and have one selection box. I was doing it through workbench by placing some divs with ids on thye page and then replacing them by actual QS ojects in the Javascript code.

It seems that embedding single objects with URL is much simpler but I need to figure out how to have single current selection box on a page for several embedded objects. I know that I can add current selection boxes to all of them. But how to have single one.

Cheers

Re: QS mashups and preserving selections

Aiham_Azmeh — Mon, 09 Mar 2015 13:33:54 GMT

So you have different pages with different objects, and want to drive selections from ex: page 1 to all other objects inclusively page 2 etc ?

- add selection bar to page 1 :

app.getObject( 'your_element_id', 'CurrentSelections' );

- add all objects on all pages width workbench

- modify all your different pages config object to use the same identity:

var config = {

host: window.location.hostname,

prefix: "/",

port: window.location.port,

isSecure: window.location.protocol === "https:",

identity : "[U_ID]"

};

so now any changes in page1.html will also affect page2.html.

I hope I got it right this time,

aiham

Re: QS mashups and preserving selections

d_pranskus — Mon, 09 Mar 2015 13:50:00 GMT

Thanks

Is it possible to do that by embedding current selections as iframe & URL and not by javascript?

Re: QS mashups and preserving selections

Aiham_Azmeh — Mon, 09 Mar 2015 14:08:17 GMT

With no object, not really; but...

I do not recommend that : - you can always create an "empty" extension and after saving it to your app, in single object add current selection with &opt=currsel (and identity parameter) then use it in an iframe.

Why I do not recommend it:

- The use of many iframes will be limited in certain browsers since Qlik Sense uses web-sockets, so for example for Internet Explorer users you will have a limit of maximum 6 connections == 6 iframes.

- It will have a huge impact in your page loading performance.

aiham

Re: QS mashups and preserving selections

d_pranskus — Mon, 09 Mar 2015 14:56:14 GMT

Thanks

Re: QS mashups and preserving selections

d_pranskus — Mon, 09 Mar 2015 15:34:22 GMT

It must be the correct answer, I included the identity parameter in the js code, but when I select something on a page it appears in Current Selections page, but if I reload page, it is gone.

Do I need to use that parameter identity somewhere or just in config?

What could be a problem?

Re: QS mashups and preserving selections

Aiham_Azmeh — Tue, 10 Mar 2015 07:02:40 GMT

Hi Darius,

I don't think it's possible to have persistent selections without having a bookmark.

You may find more insights in this thread : Current selections lost when loading new page

aiham

Re: QS mashups and preserving selections

pnowicki — Mon, 04 Jul 2016 12:24:52 GMT

After reading several posts on this topic, is it the conclusion that it is not possible to preserve the selections when moving between different html pages in a mashup? If so, that is really disappointing.

@Qlik - is there anyway to improve this as the mashup idea is really being embraced by users?

Re: QS mashups and preserving selections

Mon, 11 Jul 2016 07:18:17 GMT

Hello,

maxim1500 7 juil. 2016 13:05 (en réponse à Maxime Dumas )

I talked with people at Qlik about this, and they recommanded using a single page (one session) and destroying the model whenever you change "page" (in Angular, for example) or you hide the divs (if you do it yourself). That way, you won't get reduced performances.

We were using iframes and their guess was that we used to many sessions, and that Qlik Server would drop the sessions after a while.

Here is the code to disconnect charts before hidding them. If you have many, you could keep a collection and close the model for each chart.

var modelRef;

app.getObject(<elemId>, <objId>).then(function(model) {

modelRef = model;}

//then when you want to close it

modelRef.close();

An other possibilities is to create a bookmark before leave the first tab ( or first mashup page), apply this bookmark (it's the last bookmark) when you load the second mashup page and remove this bookmark.

Re: QS mashups and preserving selections

Mon, 11 Jul 2016 15:33:14 GMT

Hi Darius,

We are also planning for Mashup app and want to host our app to server which don't have Qlik Sense install.

Can you please send me some doc/ links where I can get started and code about how to get session ID for a particular user and pass it to QLik Sense server.

Would appreciate you help.

Re: QS mashups and preserving selections

pnowicki — Fri, 15 Jul 2016 07:01:05 GMT

I plan on converting to the single page idea. But this is a workaround. I was hoping for Qlik to address the root cause and provide a solution to the problem. You should be able to pass selections from one .html to another without having to perform the div hiding gymnastics of the single page concept.

For example, in Qlikview you can pass selections in hyperlinks from one Qlikview report to another by modifying the url and adding the selections at the end.

Re: QS mashups and preserving selections

Alexander_Thor — Fri, 15 Jul 2016 10:38:28 GMT

Which you also can in QS

App Integration API ‒ Qlik Sense

Re: QS mashups and preserving selections

pnowicki — Fri, 15 Jul 2016 13:25:28 GMT

I don't believe this works with extensions, can you give an example?

I tried something like this:

https://QlikSenseServer/extension1/mashup1/mashup1.html/field1/selection1

Re: QS mashups and preserving selections

brijeshvma — Fri, 15 Jul 2016 13:46:35 GMT

Hi Aiham

In Our Company as well , We Created Mashup with Multiple Page . To Create a Mashup we used a Single Configurator

IFrame Option. Am facing a Same issue that selection made on one page is not showing on another page . I tried your

given Suggestion on that . and i tried like this Way

But its not helping anything. Can you suggest me anything on this?

Re: QS mashups and preserving selections

Aiham_Azmeh — Fri, 15 Jul 2016 21:00:27 GMT

Hi Brijesh,

The real issue with multipage-mashup is actually the reloading part => so if you have a mashup (or a Sense sheet) open on in a browser on a single tab, by making selections then reloading the page, you will lose all your selections -- and the reason is obvious: the websocket (communicatinig to the app(s)) is closed and on reload newly created, so you will get a new session thathas nothing to do with the previous one. It's a WAD (Works As Designed), and practically an other software found in the wild works like that.

The solution/workaround:

A - [the recommended one] instead of a multipage-reload mashup, try to build you mashup as a "single page", without reloading your app on navigation - can be done with angular routing, location.# parsing etc...

B - [the hack] on[window]beforeunload create/save a bookmark with the actual selections, which can be applied on the new freshly opened page. AFAIK (I think), this is how it is done in QlikView, but I really do not recommend this approach; it's a hack, and probably not something that you want to have in production.

C - [the real workaround] do not open the new pages in the same tag; use target="_blank" or window.open(URL,'_blank') => this way your websocket connection will still be reusable in that browser, and the user will be able to keep his selections between pages

Conclusions:

In your case I will definitively go for solution C, it will be the easiest to implement

Considerations:

- identity: It feels like the identity parameter is a little bit misunderstood - the purpose of "identity" is to keep the users using the same session in an isolated scope, not altering the shared session - passing selections from session to session will not be solved by it.

- keeping selections between newly created sessions: at R&D we are trying to find a solution for solving this issue, it's under investigation - and I hope that soon we will be able to provide it to you .

regards,

aiham

Re: QS mashups and preserving selections

pnowicki — Tue, 19 Jul 2016 13:15:18 GMT

Thibaut,

I've converted to a single page mashup, but did not choose angular, just implemented the div hiding and # target setup. I am now having performance problems since I load all objects all the time. I'm trying to implement your code example to only have the current objects open when I need them. I have a .js code that performs actions whenever the page is changed, I can use the trigger in this code to initiate the open/close of the objects. Is it possible to detect which objects are currently open and close all those before manually getting the new objects for the target page? Any additional coding examples would be helpful.

Re: QS mashups and preserving selections

Wed, 20 Jul 2016 12:31:36 GMT

I don't use this method, I keep my multi-pages mashups. I create a bookmark before leave the first tab, apply this bookmark and remove it.

Re: QS mashups and preserving selections

pnowicki — Tue, 26 Jul 2016 14:07:03 GMT

FYI

I've updated my mashup and implemented the modelRef code from above. I'm not sure if I'm actually destroying the objects as I haven't seen a noticeable performance improvement. Here is the code I've implemented.

var tabs = true;

var flag1 = 0;

var modelRef;

var app = qlik.openApp("xxxxxxxxxxxxxx", config);

app.getObject('CurrentSelections','CurrentSelections');

if (tabs) {

$(document).ready(function () {

$(".view").hide();

$(window).on("hashchange", function() {

//destoy

destroyQlikObjects(flag1)

var hash = window.location.hash;

if (hash === "") {

window.location.hash = $("ul.nav li:first-child").children().attr("href");

}

$("ul.nav li").removeClass("active");

$("ul.nav li").find('a[href="' + hash + '"]').parent().addClass("active");

$(".view").hide();

$(hash).show();

qlik.resize();

$(window).scrollTop(0);

updateBreadcrumbs(hash);

updateQlikObjects(hash);

});

$(window).trigger('hashchange');

});

}

function updateQlikObjects(hash) {

if (hash == "#EBBIT") {

flag1 = 1;

//EBBIT Summary Objects

app.getObject('QV1-1','HduqPNJ').then(function(model){modelRef = model;}); //Change Date

app.getObject('QV1-2','BaPBR').then(function(model){modelRef = model;}); //Report as of:

app.getObject('QV1-3','typMcue').then(function(model){modelRef = model;}); //KPI box - T Ebbit Global

app.getObject('QV1-4','FrDerNe').then(function(model){modelRef = model;}); //KPI box - T-1 EBBIT Global

}

if (hash == "#NetRev") {

flag1 = 1;

//Net Rev Objects

app.getObject('QV2-1','mtTkRbU').then(function(model){modelRef = model;}); //KPI box - T-1 Net Revenue Global

app.getObject('QV2-2','VepYmCk').then(function(model){modelRef = model;}); //KPI box - MTD Net REvenue Global

app.getObject('QV2-3','BayF').then(function(model){modelRef = model;}); //KPI box - YTD Net Revenue Global

app.getObject('QV2-4','fJcQAFu').then(function(model){modelRef = model;}); //Bar Chart - Moving Averages

}

function destroyQlikObjects(flag1) {

if(flag1 == 1) {

modelRef.close();

}