AJAX and URL parameters

[Alexander_Thor]

Sometimes you want QlikView to open with a specific set of selections, apply a bookmark or perhaps even deep link to a specific sheet.

A typical use case could be to embed an entire app or a single object inside a CRM or ERP system and depending on the context, current customer for example, filter the QlikView app to only show records related to that specific context.

So how do I use this black magic?

One approach would be to use triggers with the obvious downside being that the trigger would always fire regardless of how you opened the app.

Another approach is to supply a set of parameters to the URL for that specific app.

Let’s take an example, the Sales Compass demo from the demo site. Below us the URL to access the app and the different components explained.

Actual URL

demo.qlik.com/QvAJAXZfc/opendoc.htm?document=qvdocs%2FSales%20Compass.qvw&host=demo11

Explained URL

<host name>/<virtual directory>/opendoc.htm?document=<url encoded full name for the application>&host=<name of QVS>

In addition to this URL you can also supply some extra parameters to control which actions will fire when the app is opened. For example the URL below will open the Sales Compass app with the value “Q2” selected in the listbox with id LB5699 (yes we create way to many objects )

demo.qlik.com/QvAJAXZfc/opendoc.htm?document=qvdocs%2FSales%20Compass.qvw&host=demo11&select=LB5699,Q2

Of course this is only a simple example, in the table below you will find all the available parameters you can append to your URL.

Feel free to mix and match these til your hearts content.

Action	Parameter	Example
Select a single value	&select=<Listbox ID>,<Value>	&select=LB01,Total
Select multiple values	&select=<Listbox ID,(Value|Value2)	&select=LB02,(2011|2012)
Open the app on a specific sheet	&sheet=<Sheet ID>	&sheet=SH01
Open the app with a bookmark applied	&bookmark=<Bookmark ID>	&bookmark=Server\BM01

Wait a minute, you mentioned single objects?

Ah, yes! When QlikView 11 was launched we also introduced the capability to display a single object from an app.

This allowed customers to integrate objects from different applications into a single view in a external system. It is also this screen that powers the small devices client.

Substitute opendoc.htm with singleobject.htm and specify the object id you want to display,

demo.qlik.com/QvAJAXZfc/singleobject.htm?document=qvdocs%2FSales%20Compass.qvw&host=demo11&object=CH378

And voila! You now have a fully interactive single QlikView object!

[shawn-qv]

Thanks Alex. This will definitely come in handy for all future development

[thanstad]

Very Nice, already tested it and informed the QV users in the company

/Tormod

[#4]

Stefan Walter has blogged about the subject and has built up a great set of resources for anyone to use, available here:

http://www.qlikblog.at/2343/qliktip-48-qlikview-mashup-examples-documentation/

some great examples too!

Erica

[sudeepkm]

the single object mode is wonderful. but i think I faced an issue as the chart caption was visible instead of the chart's window title. I can provide the exact error scenario once I find my qvw.

[#6]

Hi, just to say that Stefan Walter has done some great posts on the subject and source materials at his blog (google "Qlikview Mashups qliktip #48" - my last comment is waiting moderation for the link)

If you are searching multiple values, wrapping them in brakets sometimes doesn't work (the ( value1 | Value 2 |....) in some versions of qlikview

I separate my values with commas, and that works instead.

EG &select=LB42,value1,value2....

I use QV 10 SR6

Erica

[Alexander_Thor]

Ye brackets was added for QV11 which also allows you to specify a entire search mask for selections.

[thanstad]

Iam looking for a solution to add a URL ie. with the latest periode. I would like to add YEAR(TODAY()) and MONTH(TODAY()) in the &select stmt, to make it most flexible for the enduser . I have tried but not succeded - is it possible ?

Tormod

[#9]

Yes it's much neater, I like it!

[Alexander_Thor]

Hey Tormod,

No you can't leverage any native QV functions in the url. Normally this would be done on the embedding site, usually through javascript or some other language. A typical use case would to be extract the current user/customer/whatever and filter the data set depending on that context.

You might have all the orders in a QV app but want to show that information in your CRM-system, so instead of integrating the ERP and CRM-system on a data level you could instead have a table in QV that is filtered depending on the customer you view in the CRM-system.

[datanibbler]

Hi,

that might be very usable in my scenario, but I'm not sure, maybe you can help:

- We have a pyramid-like structure with team-specific apps (lower level) and a mgmt_Dashboard (upper l.)

- When the managers open a team-specific app via document_chaining (in the browser) from the
    mgmt_Dashboard, then a specific sheet within that app should open, depending on which button in the
    mgmt_Dashboard they used (there might be several KPIs from the same app, so then every button should
    result in a different sheet opening)

<=> When the team members, who don't have access to the mgmt_Dashboard, open their team_app, it
         should always open on the homepage.

That functionality should actually be in Qlikview itself, but in our outdated version, it doesn't work. I'm wrangling with a macro that would open the sheets based on a selection in an inline_table that I can transfer with the doc_chaining, but that doesn't really work yet - not reliably anyway.

The question would be, how can I tell QlikView the precise URL it is supposed to open - could I perhaps use the action "open URL" instead of the action "open QlikView document"? Then it would only work in AJAX, not in the client_software, but if it works ...

Thanks a lot!

Best regards,

DataNibbler

P.S.: The Single_Object thing also seems great. I don't yet know any use for it and I don't know if it would be a good idea to open up that construction site, but that really sounds like we could do some pretty cool things with that.

P.P.S.: OK, it seems to be working - I am only wrangling a bit with the selections - by default, I need to make selections on several different fields (year and month or year and week). That does seem to work going from the overarching Dashboard in AJAX, but not going from the overarching Dashboard in the client_software ... can you explain to me why this is so and if I can fix it and how?