QlikView: Connect to QMS API with Visual Studio

[Damien_V]

This article explains how to connect to the QMS API in Visual Studio.

Environment:

QlikView 

Steps:

Create a new project

Create a new project in Visual Studio (for instance a simple Console Application).

Add the QMS service reference

1. Right-click the References node of the project in the Solution Explorer and select "Add Service Reference..."
   
   (If you cannot find the Solution Explorer at the right of your screen, go to "View" > "Solution Explorer" to show the pane.)
   
   
   
   
2. Type the address to your running QlikView Management Service using port 4799
3. Press the Go button.
   
   If the QlikView Server is running on another machine, make sure that the server can be reached and port 4799 is open for incoming connections.
   
   Port 4799 is the default port for QMSBackendWebServicePort, found in the QVManagementService.vshost.exe.config file, located in Program Files.
   
   
4. If the service is found, QMSBackendService will appear after a few seconds.
5. Choose a namespace for the imported types (for instance "QMSAPI").
6. Press OK when done. 
   
   
   

Adding ServiceKey handling

The QMS API cannot be connected out-of-the-box. It needs the HTTP header "X-Service-Key" to be populated with a key retrieved by the QMS before any regular communication may occur.

This is achieved in .NET by adding a client MessageInspector via an EndpointBehavior attached to the QMS API client.

Attached to this article is a one-class implementation (QMSClientServiceKeySupport.cs) of this behavior, that can be reused straight away. 

Add this class to your project!

Note: Don't forget to replace "YOUR_NAMESPACE_HERE" and "YOUR_QMSAPI_NAMESPACE_HERE" by the correct namespaces.
 

Initiating Communication

First, you'll need an instance of the QMSClient class, and then you should initiate the ServiceKey management using the class QMSClientServiceKeySupport just added:

QMSClient qmsClient = new QMSClient();
QMSClientServiceKeySupport.Initiate(qmsClient);

Note: If you want your client to connect to a different URL you should use the following constructor instead:

QMSClient qmsClient = new QMSClient("BasicHttpBinding_IQMS", "http://yourmachinename:4799/QMS/Service");

*If you wish to use the newest interface - IQMS2 then use QMS2Client class for initiating communication.

Now the code is prepared to start using the API.

Important Note: The user running the code must be a member of a group called "QlikView Management API".

Simply create this group locally on the system if it's not there, and add yourself to it.
Note that you must log off / on for this change to be activated.


If you wish to connect to the QMS API using HTTPS instead of HTTP, please follow QlikView: Connecting to QMS API using HTTPS

[BuTbka]

Hello!
Why are so many operations missed in QMS Backend Service?
For example - GetExternalProgramTask, GetLoadedDocuments
How can I use them?

[Sonja_Bauernfeind]

Hello @BuTbka 

Please post your query with as much detail as possible in the appropriate forum. We cannot provide further guidance directly in this article, and posting the correct forum will make your post visible to our large user base and our active support agents.

All the best,
Sonja