Qlik Sense .NET SDK: Create an ODBC data connection

This is an example regarding how to create a data connection with the Qlik Sense .NET SDK.

API reference can be found on the Qlik help site:
https://help.qlik.com/en-US/sense-developer/November2018/APIs/net+sdk/html/M_Qlik_Engine_App_CreateConnection.htm

Environments:

• Qlik Sense June 2017 and later

 

This is an example creating a connection to a Data Source Name called XXX connecting to an excel file through ODBC.

Create a simple .NET console app in Visual Studio with the following code :
 

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

namespace ConsoleApp2
{
    class Program
    {
        static void Main(string[] args)
        {
            Uri uri = new Uri("https://qlikserver1.domain.local/");
            ILocation location = Qlik.Engine.Location.FromUri(uri);
            location.AsNtlmUserViaProxy(proxyUsesSsl: true);
            IAppIdentifier appIdentifier = location.AppWithId("5217c456-b37c-4a13-becc-9259ce2fdc61");
            using (var app = location.App(appIdentifier))
            {
                var connection1 = new Qlik.Engine.Connection();
                connection1.ConnectionString = "ODBC CONNECT32 TO [XXX;DBQ=C:\\xxx.xls;]";
                connection1.Name = "testSDK-ODBC";
                connection1.Type = "ODBC";
                var layout = app.CreateConnection(connection1);
                Console.WriteLine(layout);
                Console.ReadLine();
            }
        }
    }
}

Please note that the connection string needs to be valid and available to connect from the Qlik Sense Server.
If the Qlik Sense server is not able to connect to the database, it will not create the connection.

Some good steps to test if you get errors when creating the connection is to try to create the same connection from the Data Load Editor and see what error you get.