Skip to main content

Create a Microsoft SQL Server connection

To access your data stored on a Microsoft SQL Server database, you will need to know the server and database name that you want to connect to, and you must have access credentials. Once you have created a connection to a Microsoft SQL Server database, you can select data from the available tables and then load that data into your app or document.

In Qlik Sense, you connect to a Microsoft SQL Server database through the Add data dialog or the Data load editor.

In QlikView you connect to a Microsoft SQL Server database through the Edit Script dialog.

Setting up the database properties

Database properties that can be configured
Database property Description Required
Server Host name to identify the location of the Microsoft SQL Server database yes
Port Server port for the Microsoft SQL Server database yes
Database The name of the Microsoft SQL Server database yes
Encrypt Select to use encrypted communication with the database server. no
Minimum TLS

Select the minimum version of TLS (Transport Layer Security) supported by the Microsoft SQL Server. If you select 1.0 and the servers runs 1.2, the connector will accept the connection. If you select 1.2 and server runs 1.1, the connector will not accept the connection.

Warning: SSL v3 is no longer supported by the Microsoft SQL Server Connector.
yes
CA Certificate Path to file system location of the root CA certificate yes, when Encrypt is selected
Trust Server Certificate Rely on the CA certificate provided by the server to verify secure data transfer. no

Authenticating the driver

To use Single Sign-On, both the Microsoft SQL Server and the Qlik Sense engine must be running under a service account and they must have SPNs (Service Principal Names) assigned to them.

The ODBC Connector Package's Microsoft SQL Server Connector does not support single sign-on (SSO) in:

  • QlikView
  • Qlik Sense Desktop
  • SaaS editions of Qlik Sense

Qlik Sense: Microsoft SQL Server credentials

Authentication properties that can be configured
Authentication property Description Required
Single Sign-On

Use the Kerberos single sign-on service specified in the Server SPN property.

Note: When a connection is created or edited with Single Sign-On selected, the connection uses the credentials of the user who is currently logged into Qlik Sense.

If a user ID is specified for the Delegation UID property, then the connection is tested with the user ID specified in the Delegation UID property and the password for the Delegation UID. Any time the connection properties are changed, the password for the Delegation UID must be reentered to test or save the changes to the connection.

no
Use NTLM

Use the NTLM (NT LAN Manager) security protocol for authentication.

Note: NTLM cannot be used when Single Sign-On is selected.
Required when the user is registered with NTLM for authentication on the database server. Cannot be used if the user's credentials are not registered with NTLM on the database server.
Server SPN The service principal name (SPN) for the Microsoft SQL Server. yes, when Single Sign-On is selected.
Delegation UID

The user ID to use for scheduled, automatic reloads. If a Delegation UID is specified, it is also used to test the connection when it is created or edited. The ID must be entered in the format domain\username.

Note: Manual reloads always use the ID of the user who is logged into Qlik Sense, not the Delegation UID.

no, but the ID can be provided when Single Sign-On is selected.

Note: Because scheduled reloads are performed under a system account instead of a real user, Single Sign-On may not be necessary, The scheduled reloads can be performed using predefined NTLM authentication.
User name User name for the Microsoft SQL Server connection. yes, when Single Sign-On is not selected.
Password

Password for the Microsoft SQL Server connection.

Note: When Single Sign-On is selected, the password is for the user identified with the Delegation UID. If a user is not specified in the Delegation UID property, then Password property must be left blank for single sign-on (SSO).
yes, when Single Sign-On is not selected.
Name Name of the Microsoft SQL Server connection. The default name will be used if you do not enter a name. yes

QlikView: Microsoft SQL Server authentication properties

Authentication properties that can be configured
Authentication property Description Required
Use NTLM Use the NTLM (NT LAN Manager) security protocol for authentication. Required when the user is registered with NTLM for authentication on the database server. Cannot be used if the user's credentials are not registered with NTLM on the database server.
Username User name for the Microsoft SQL Server connection. yes
Password Password for the Microsoft SQL Server connection. yes

Account properties

Credentials

Credentials are used to prove that a user is allowed to access the data in a connection.

There are two types of credentials that can be used when making a connection in SaaS editions of Qlik Sense. If you leave the User defined credentials check box deselected, then only one set of credentials will be used for the connection. These credentials belong to the connection and will be used by anyone who can access it. For example, if the connection is in a shared space, every user in the space will be able to use these credentials. This one-to-one mapping is the default setting.

If you select User defined credentials, then every user who wants to access this connection will need to input their own credentials before selecting tables or loading data. These credentials belong to a user, not a connection. User defined credentials can be saved and used in multiple connections of the same connector type.

In the Data load editor, you can click the Primary key underneath the connection to edit your credentials. In the hub or Data manager, you can edit credentials by right-clicking on the connection and selecting Edit Credentials.

Account properties that can be configured
Account property Description
User defined credentials Select this check box if you want users that access this connection to have to input their own credentials. Deselect this check box if credentials can be shared with anyone who has access to this connection.
New credentials Drop-down menu item that appears if User defined credentials is selected.
Existing credentials Drop-down menu item that appears if User defined credentials is selected.
User User name for the connection.
Password Password for the connection.
Credentials name Name given to a set of user defined credentials.

Load optimization settings

Load properties that can be configured
Property Description Required

Enable Bulk Reader

Select this to include larger portions of data in the iterations within a load. This may result in faster load times for larger datasets. If not selected, data will be loaded row by row. No
Max String Length

Maximum length of string fields. This can be set from 256 to 16384 characters. The default value is 4096. Setting this value close to the maximum length may improve load times, as it limits the need to allocate unnecessary resources. If a string is longer than the set value, it will be truncated, and the exceeding characters will not be loaded.

No

Advanced options

Advanced options that can be configured
Option Description Required

Name

Name of additional properties.

You can add more than one additional properties.

no
Value

Value of additional properties.

You can add more than one additional properties.

no
Note: When you connect to a Microsoft SQL Server database with the Data load editor or the Edit Script dialog, Test Connection enables you to test the connection before you attempt to create it.