QlikView Management API - Getting Started and Examples

[Joe_Bickley]

Introduction

This document is part of a series of documents that discuss how to get started with using the QlikView Management API and provides a number of examples.

The QlikView Management API is a web service against which you can issue a range of commands to automate management activities on a QlikView environment. These activities can include the following:

• Creating new document tasks
• Modifying permissions
• Viewing updating licences
• Modifying server settings

To use the QMS API you need to be familiar with working with web services an writing code however the examples here cover many common tasks which avoid the need for detailed coding skills. All of the examples provided in these pages are written using Visual Studio with .net and C#.  Other languages can be used and the free versions of Visual Studio can be used also.

Getting Started

Before you begin using the API or using the examples you need to be familiar with out to set up Visual Studio for using the APIs web service. You can find this information here:

QlikView Management API - #1 Setting up a Visual Studio project

In addition the official project documentation can be found here on the QlikView SDK pages here:

QlikView Version 11 SDK

Examples

Below are links to a number of community documents with examples of using the API for particular tasks.  All of the examples are built on top of the Getting Started project provided above but the code is easy to port to other applications.

• #1 Setting up a Visual Studio project
• #2 Export / Add / Delete Document CALs
• #3 Export / Add / Delete Named CALs

Coming soon

• Creating and running Document Tasks
• Creating document triggers
• Applying server licenses

[#2]

Hi,

I find that some functions are not flexible in QMSAPI as on qlikview desktop.

For ex) GetCurrentSelections() accepts parameters in desktop, but, it is not so while using C# via QMSAPI. Are there any workarounds for this?

Thanks and Regards,

Anju

[Joe_Bickley]

The QMSAPI only contains functions for managing the server environment, it doesnt overlap with the functions in the client.  So as "selections" is a client side behavior there is no equivilent in the management API

[#4]

Hi Joe,

Thanks a lot for replying. This is my problem statement:

This is what I have coded.

    IReturn5 selections = axQlikOCX1.ActiveDocument.GetCurrentSelections();

                IList selectionValues = (IList)selections.Selections;

                IList selectedFields = (IList)selections.VarId;

But say I have partner names....if the first entry is BT,UK  and second is ATT..then I get three values in selectionValues since the delimiter is comma. So, is there any way I can specify what the delimiter should be?

I am not sure if I can specify the delimiter in the .qvw file itself. I checked the list box properties, user preferences dialog box..etc...but nothing helped!

Regards,

Anju

[#5]

Where can I get a complete list of functions available via QMSAPI and their functionalities?

[Joe_Bickley]

The above functions you are using and their purpose are nothing to do with the management API,  they are client API functions.

You can find listings of functions in all the APIs here..

http://community.qlik.com/docs/DOC-2639

[leonardo_raed]

Hi Joe,

Do you know if it's possible create an ExternalProgramTask with the QMS API?

Thanks!

Leo.

[agigliotti]

Any news about "Creating and running Document Tasks" using QMS API ?

[arieidel]

Hello,

Is there any feature or method using QMS API that I can use to manage .Shared files? For example, to delete specific server objects.

Thanks,

Ariel

[StefanBackstrand]

Ariel,

Please see my comment here, in the other thread about this: Re: Is it possible to get a "Shared File Editor" in Powertools next to the Viewer and Repair?

[#11]

Hi,  I need to import and manage nearly 500 users held in an AD group into the QMC?  Could I accomplish this using this API?

Many thanks,