Qlik Sense Enterprise on Windows: Getting started with the .NET SDK

Damien_V · Jun 3, 2017 5:42:34 AM

This article explains how to get started with the .NET SDK

The following must be installed to test the example provided in this article:

Microsoft Visual Studio (The community version can be used)
Qlik Sense Enterprise on Windows Server

If installed on different machines, ensure the appropriate ports are open for incoming connections on the Qlik Sense Enterprise on Windows server.

The user connecting from the .NET SDK must have a license assigned.

Environment

Qlik Sense Enterprise on Windows any version

Steps

Open Visual Studio and create a new project. In this example, we have selected Console App (.NET Framework)
Go to Tools > NuGet Package Manager > Package Manager Console
Use Install-Package QlikSense.NetSDK to install the latest version of the SDK or Install-Package QlikSense.NetSDK -Version x.x.x to install a specific version.
The version must match the Qlik Sense server version.
To check the correct command for your version, see https://www.nuget.org/packages/QlikSense.NetSDK/

If the initial package installs fails with an error message such as:

install-package: unable to find package 'QlikSense.NetSDK at source ''.
1. Open Package Source from Tools > NuGet Package Manager> Package Manager Settings and review the content.
  
  Example:
2. Then update "Package Source" with the following path: https://api.nuget.org/v3/index.json

Once the package is installed, it will appear in the References for your project. We can thus create a small program with the following code to connect to the Qlik Sense server and show the Product version, OS Name, and OS Version.

Example One

In the below program, we are using Windows authentication, so we have to use the AsNtlmUserViaProxy function to specify that we want to use Windows authentication.

If the connection is done through https, the certificate on the proxy must be trusted (You have to install root.cer in the "Trusted root certificate authorities" certificate store on the machine that is making the API call)

// using System, etc. 
using Qlik;
using Qlik.Engine;

namespace ConsoleApp1
{
    class Program
    {
        static void Main(string[] args)
        {
            Uri uri = new Uri("https://qlikserver3.domain.local/");
            ILocation location = Qlik.Engine.Location.FromUri(uri);
            location.AsNtlmUserViaProxy(certificateValidation: false);
            using (var hub = location.Hub())
            {
                Console.WriteLine("Product Version: " + hub.ProductVersion());
                Console.WriteLine("OS Name:    " + hub.OSName());
                Console.WriteLine("OS Version: " + hub.OSVersion());
                Console.WriteLine("Press enter to close...");
                Console.ReadLine();
            }
        }
    }
}

This should show something like this:

Product Version: 3.2.3
OS Name: WindowsNT
OS Version: 6.2.9200
Press enter to close...

Example Two

In this example, we are connecting to an app:

using System;
using System.Collections.Generic;
using System.Linq;
using System.Text;
using System.Threading.Tasks;
using Qlik;
using Qlik.Engine;

namespace ConsoleApp1
{
    class Program
    {
        static void Main(string[] args)
        {
            Uri uri = new Uri("https://qlikserver1.domain.local/");
            ILocation location = Qlik.Engine.Location.FromUri(uri);
            location.AsNtlmUserViaProxy(certificateValidation: false);
            IAppIdentifier appIdentifier = location.AppWithId("03bbedf2-2c45-4e10-bf5a-fded0c21cda8");
            using (var app = location.App(appIdentifier))
            {
                var layout = app.GetAppLayout();
                Console.WriteLine(layout.Title + " [" + app.Type + "]");
                Console.ReadLine();
            }
        }
    }
}

The result would be:

Test1 [Doc]

Tip: If the program does not run, try to build it and execute the .exe file from the Qlik Sense server. If that works locally from the server itself, it might be that there is a network device that is not allowing the connection or the proper ports are not open.