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!

[IAMDV]

Nice one Alexander. Excellent blog post.

You delivered, as you promised few weeks back. Cheers!

[Bill_Britt]

Great information. Didn't know about the single object.

[Jason_Michaelides]

Awesome info - thank you Alexander. I'll test it soon, but can you tell me if the "single object" can be a sheet...?

[Alexander_Thor]

The singleobject.htm will only show a single object, not a entire sheet.

I usually just append the sheet=<Sheet ID> parameter to the "normal" app URL if I want to show a specific sheet. Then of course you could go wild and write a document extension that would hide the tabrow/menues if a specific parameter exists in the url if you also want to prohibit the users from navigating away from that sheet.

[Jason_Michaelides]

As explained in the main post...d'oh!  Thanks again.

[Marcio_Campestrini]

Alexander, great post.

I'd never heard about it. I started to think what I can deliver to my users.

Thanks a lot.

[Jason_Michaelides]

Any way of specifying a field name? Maybe one you don't have a listbox for?

[stevedark]

Now thinking of use cases for single object in an iFrame...

Thanks for the heads up!

Steve

[#10]

Thank you for a great blog. Do you have an URL syntax for calling a report using Report ID?

[ashfaq_haseeb]

Hi Alexander Karlsson

I must say excellent post.

Can you share some light on passing UID and PWD in the url itself.

Regards

ASHFAQ