Qlik Community

QlikView Documents

Documents for QlikView related information.

Announcements
Modernize Your QlikView Deployment webinar, Nov. 3rd. REGISTER

QlikView Management API - Getting Started and Examples

Employee
Employee

QlikView Management API - Getting Started and Examples

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.

Coming soon

  • Creating and running Document Tasks
  • Creating document triggers
  • Applying server licenses
Labels (1)
Comments
Master II
Master II

Very good document. Thanks for sharing this info.

0 Likes
Not applicable

You mention "Creating new document tasks" as a functionality with this API, though I have yet to find a method that does this.

I have found methods like DeleteTask, and ImportDocumentTask, but nothing along the lines of a create task method.

Does anyone know if there is actually a method or some sort of way to do this with the API?

0 Likes
Contributor
Contributor

Is it possible to automate creation multiple Custom Us08-04-2020 12-59-09.pngers using the API?Or is there any other way for it.

0 Likes
Employee
Employee

This can be achieved using QlikView-CLI (a PowerShell module for interacting with the Qlik View APIs)

Disclaimer: This QlikView-CLI is made available "AS IS" without warranty of any kind. Qlik support agreement does not cover support for the QlikView-CLI

 

Getting Started: https://github.com/QlikProfessionalServices/QlikView-CLI/wiki

Release Version: https://github.com/QlikProfessionalServices/QlikView-CLI/releases

Add New Directory Services Connectors: https://github.com/QlikProfessionalServices/QlikView-CLI/wiki/Add-New-Directory-Services-Connectors 

0 Likes
Version history
Revision #:
1 of 1
Last update:
‎2012-11-21 06:55 AM
Updated by: