topic QVS API Support in QlikView

QVS API Support

Mon, 26 Jan 2026 18:19:17 GMT

My question is if there is any help or guidance on how to use the QVS API besides the help file (which is not very helpful...).

It doesn't seem that there is much examples out there on how to use the QVS API. Please can anyone shed some light!

I need to use the API to get detailed license information, ie to whom is licenses assigned and usage, as well as reload scheduled information.

Any help would be appreciated!!!!

QVS API Support

deepakk — Thu, 03 Mar 2011 10:52:19 GMT

Once you hae installed Qlikview server. QVsRefrence manul is stored in the installation folder.

check out you C:\Programfiles\Qlikview\Document.

It would be helpful in knowing the API of Server.

QVS API Support

suniljain — Thu, 03 Mar 2011 11:08:24 GMT

qlikview server reference manula and QVS API both are different thing.

QVS API helps in how to use packeges OR library but qlikview server reference manula not.

QVS API Support

deepakk — Thu, 03 Mar 2011 11:23:02 GMT

hi,

If you can specify exactly what your are looking at then we might be able to help you out.

If you want to see information like how to relaod using Server or Reload status etc you will find it in QVS Refrence manul page no 65 .

It might give you fair bit of idea.

QVS API Support

Thu, 03 Mar 2011 12:44:45 GMT

Thanks for the reply.

I need to

1. Get a list of all the schedules for reloads. We don't have the Publisher, so it's the reload schedules that can be set up in the Management Console.

2. See the users who has Doc CALs and User CALs and when they've last used it.

Regards,
Herman

QVS API Support

deepakk — Thu, 03 Mar 2011 12:52:47 GMT

hi,

1) If you ahve located QvsRefrence manul. then go to 65 page. it shows the different ways of Reloading. Or go to

Management Console --> User Documents --> Reload --

2) For Checking Document Cals See page no 67. for Document Cals or

Management Console --> User Documents --> Document Cals--

For User Cal go Licenses Tab -- > Licenses History. Will display you the history of people who has last access qlikview application.

QVS API Support

ashfaq_haseeb — Sat, 05 Mar 2011 13:23:08 GMT

Hi Herman

I have Monitoring App.

You have to configure it on your server

then you get all the details.

Who is accessing what and what type of licensing they are using.

Hope this will help you..

Regards

ASHFAQ

QVS API Support

StefanBackstrand — Sun, 06 Mar 2011 22:08:03 GMT

Please, try and be more specific in your questions. There are three major versions of Qlikview that are currently released and supported - which one are you using?

If you are using v10, make sure to install the Qlikview SDK, as a part of the Qlikview Server installation, where you can find full documentation for the QMS API; the Qlikview Server/Publisher API in v10.

QVS API Support

Mon, 07 Mar 2011 10:31:49 GMT

Thank you. That was very helpful. I installed the SDK and looked at the samples and help DOCs. It still doesn't look like I will be able to get the licensing details from the QVS API. Can you confirm?

My goal is to write a Windows Application in C# that will be used by selected high profile employees in our company to view QlikView license usage. The application should be able to tell the user who has doc CALs, user CALs etc. and their usage thereof.

Will this be possible using the QVS API?

QVS API Support

StefanBackstrand — Mon, 07 Mar 2011 10:46:00 GMT

You don't need any specific licensing to use the QMS API. You do however need to get the newest version of the web service reference from the QMS to be able to communicate with the API's. To do this; please right-click on the Web References node in the project explorer, select the QMSBackend service (or what it is named in your solution) and select Update (or such).

When that is done, can you run the example? What is the error message? How far do you come?

Regarding your second question; you can get all CAL data from QVS via the QMS API, yes. However, it is not possible to see user activity history via this interface - for that, you need to review the QVS session log, which logs all client CAL usage and such. I believe that a "mash-up" between these two might be the only way.

QVS API Support

Mon, 07 Mar 2011 11:16:06 GMT

I did this and I get the error: "Service key is missing". (trying Taskconsole app in samples)

QVS API Support

Mon, 21 Mar 2011 19:17:21 GMT

Stephan,

I´m trying to be able to add or remove a user from the Authorization List of a Document, have you ever tried that?

I managed to get the list of documents, and the users that they have on Authorization, but i cannot figure out how to modify the DocumentMetaData.

Thanks in advance!

Pablo

QVS API Support

StefanBackstrand — Tue, 22 Mar 2011 06:53:26 GMT

Skoezzi; what version of Qlikview Server are you using? And are you using the web service from that servers QMS service?

QVS API Support

Tue, 22 Mar 2011 07:16:30 GMT

I'm using version 10 R1. I changed the default QMS service to my servers QMS service without any problem. Its just giving 'service key is missing'.

QVS API Support

StefanBackstrand — Tue, 22 Mar 2011 11:15:29 GMT

Skoezzi; I'm not sure what you refer to with R1 - is that IR (8715) or SR1 (8811, 8815)?

Anyways; can you make sure that this step is done (from the API documentation in SR1 (8811))?

13. Add the following XML attribute to the bottom <endpoint ... /> tag of your app.config file: behaviorConfiguration="ServiceKeyEndpointBehavior"

Also, make sure that the value of the constant SERVICE_KEY_HTTP_HEADER in the ServiceKeyClientMessageInspector.cs source file is X-Service-Key.

QVS API Support

StefanBackstrand — Tue, 22 Mar 2011 11:16:58 GMT

Pablo; you need to use the corresponding method SetDocumentMetaData. Extract the information from the API with GetDocumentMetaData, change the data, and re-insert it with the Set.. method.

QVS API Support

Tue, 22 Mar 2011 11:34:36 GMT

Stefan,

Thanks for the reply. I'm refering to SR1 8815.

I made those changes in my app.config & ServiceKeyClientMessageInspector.cs, but I still get "Service Key is missing".

QVS API Support

StefanBackstrand — Tue, 22 Mar 2011 11:46:15 GMT

Ok, the I would recommend that you walk through the steps in the documentation again, you'll find the chapter named "Service key injection sample" in there. You can find the documentation (.chm) under QEMC > System > Setup > Management Service (top node).

QVS API Support

amien — Tue, 22 Mar 2011 12:00:56 GMT

Dear herman,

Check the attachment. It's a working example of how to get CAL licence information and deleting/quarantaine users. Using C++ and QVS API.

Both named and document CAL's.

it took me hours to figure this out! So some applause is welcome 🙂

i'm sure i make more people happy with this!

QVS API Support

StefanBackstrand — Tue, 22 Mar 2011 13:08:04 GMT

Amien; your example is in C#, not C++ as you suggested. Just to avoid confusion.

Skoezzi; I still think that the change haven't "hit through" in the project yet. Did you hit "Build" after you made the changes and ran the project?

Make sure the

behaviorConfiguration="ServiceKeyEndpointBehavior"

is in the app.config in the right place. And remember that is you update the service reference from the QVS, this setting will be overwritten and needs to be applied again.