Skip to main content

Setting general connection properties

This section describes how to configure general connection properties. For an explanation of how to configure advanced connection properties, see Setting advanced connection properties.

To add a Microsoft SQL Server source endpoint to Qlik Replicate:

  1. In the Qlik Replicate Console, click Manage Endpoint Connections to open the Manage Endpoints Connections dialog box. Then click the New Endpoint Connection button. For more information on adding an endpoint to Qlik Replicate, see Defining and managing endpoints.
  2. In the Name field, type a name for your database. This can be any name that will help to identify the database being used.
  3. In the Description field, type a description that helps to identify the Microsoft SQL Server database. This is optional.
  4. Select Source as the database role.

  5. Select Microsoft SQL Server as the database Type.
  6. Specify the Server name. This is the host name or IP address of the computer with the Microsoft SQL Server instance containing the source database.

    • When working with AlwaysOn Availability Groups, you need to specify the IP address/host name and access credentials of the AlwaysOn Listener
    • To override the default port, add the port to the server name, separated by a comma. For example, if the server name is and the port is 3333, then the server name should be entered like this:,3333

  7. Select Windows authentication (only relevant when Replicate is installed on Windows) or SQL Server authentication.

    If you select Windows authentication, the Qlik Replicate Server will use a trusted connection to connect with SQL Server using the LogOn account set up for the Qlik Replicate Server service – no explicit username nor password are needed. This mode must be configured in the Microsoft SQL Server database by the database administrator. Note that this option is not relevant when Microsoft SQL Server is running on Linux.


    When using Windows authentication, make sure that the user account that is associated with the Qlik Replicate Server service has Network read and write permissions. This must be configured by a Windows system administrator.

    See also Working with Windows authentication.

    If you select SQL Server authentication, you must specify a username and password for connecting to Microsoft SQL Server. The username and password may be of a domain user or of a database user, depending on the configuration of Microsoft SQL Server. If you do not know this information, see your Microsoft SQL Server Database Administrator.

    To ensure that the password provided to Replicate is never used by any other principal, Replicate can be configured to automatically replace the user-entered password with a strong random password. For more information, see Configuring Replicate to automatically replace the user-entered password.

    • This information is case sensitive.

    • To determine if you are connected to the database you want to use or if the connection information you entered is correct, click Test Connection.

      If the connection is successful a message in green is displayed. If the connection fails, an error message is displayed at the bottom of the dialog box.

      To view the log entry if the connection fails, click View Log. The server log is displayed with the information for the connection failure. Note that this button is not available unless the test connection fails.


    Make sure that the Microsoft SQL Server user has the correct access privileges. For information on how to provide the required privileges, see Required permissions.

  8. Type the Database name or click Browse and select one from the list of available databases. This is the name of the database from where you are replicating the data.