In this article
Overview
You can use this account type to connect SQL Server Snaps with data sources that use SQL Server database accounts. Account details specified in this account (at a Snap level) are called Service Accounts.
Limitations
Authentication of SQL Server Account using NTLM Protocol is limited to Windows Snaplexes.
Account Settings
Asterisk ( * ): Indicates a mandatory field.
Suggestion icon (
): Indicates a list that is dynamically populated based on the configuration.Expression icon (
): Indicates the value is an expression (if enabled) or a static value (if disabled). Learn more about Using Expressions in SnapLogic.Add icon (
): Indicates that you can add fields in the fieldset.Remove icon (
): Indicates that you can remove fields from the fieldset.
Field Name* | Field Type | Description | |
|---|---|---|---|
Label* Default Value: N/A | String | Specify a unique label for the account. | |
Account properties* | Use this fieldset to enter in the information to create a connection to the databse. | ||
Hostname* Default Value: N/A
| String/Expression | Specify the server's address to which you must connect. If you need to connect to an on-premise server, specify the domain name or the IP address. For example, test.mydbserver.com or 190.159.0.124. | |
Port number* Default Value: 3306 | Integer/Expression | Specify the port number of the database server to which you must connect.
| |
Database name* Default Value: N/A | String/Expression | Specify the name of the database to which you must connect. | |
Username Default Value: N/A | String/Expression | Specify the username to connect to the database. This username is used as the default username when retrieving connections and must be valid to set up the data source. | |
Password Default Value: N/A | String/Expression | Specify the password used to connect to the data source. This password is used as the default password when retrieving connections and must be valid to set up the data source. | |
JDBC JARs | Use this fieldset to specify the list of JDBC drivers to connect to the SQL Database. | ||
JDBC driver Default Value: com.microsoft.sqlserver.jdbc.SQLServerDriver | String | The SQL Server Snap Pack is bundled with The SQL Server Snap Pack does not support jTDS driver.
 | |
JDBC driver class* Default Value: com.microsoft.sqlserver.jdbc.SQLServerDriver | String | Specify the JDBC driver class name to use. | |
Advanced properties | Use this fieldset to specify the advanced properties for connecting to the database. | ||
Auto commit Default value: Selected | Checkbox/Expression | Select this checkbox to commit each of the batches immediately after it is executed. If the Snap fails, only the batch being executed at that moment is rolled back. Deselect this checkbox to commit the output only after all the batches are executed. If the Snap fails, the entire transaction is rolled back, unless the Snap finds invalid input data before it sends the insert request to the server, and routes the error documents to the Error view. | |
Batch size* Default value: 50 | Integer/Expression | Specify the number of statements to execute at a time.
| |
Fetch size* Default value: 100 | Integer/Expression | Specify the number of rows to fetch at a time when executing a query. Large values could cause the server to run out of memory. | |
Max pool size* Default value: 50 | Integer/Expression | Specify the maximum number of connections a pool will maintain at a time. | |
Max lifetime (minutes)* Default value: 30 | Integer/Expression | Specify the maximum lifetime of a connection in the pool. Ensure that the value you enter is a few seconds shorter than any database or infrastructure-imposed connection time limit. A value of 0 indicates an infinite lifetime, subject to the Idle Timeout value. An in-use connection is never retired. Connections are removed only after they are closed. | |
Idle timeout (minutes)* Default value: 5 | Integer/Expression | Specify the maximum amount of time a connection is allowed to sit idle in the pool. A value of 0 indicates that idle connections are never removed from the pool. | |
Checkout timeout (milliseconds)* Default value: 10000 | Integer/Expression | Specify the number of milliseconds to wait for a connection to be available when the pool is exhausted. If you specify 0, the Snap waits infinitely until the connection is available. Therefore, we recommend you not to specify 0 for Checkout Timeout. | |
URL properties | Use this field set to define URL properties to use if any. | ||
URL property name Default Value: selectMethod | String/Expression | Specify a name for the URL property if any. | |
URL property value Default Value: cursor | String/Expression | Specify a value for the URL property name. | |
SQL Server Authentication
In the Account Settings, provide the Username and Password as defined for the user on the SQL Server instance. This SQL Server account must have the required privileges to run the operations seamlessly defined for the Snaps in this Snap Pack.
DO NOT use the default sa account for SQL Server Authentication. Learn more about how to choose between SQL Server Authentication and Windows Authentication: SQL Docs: Security: Authentication mode
Windows (Active Directory-based) Authentication
Service Account Authentication
Ensure that Snaplex is running on Windows and an AD user with required access privileges has logged into the Snaplex.
To use the default jar bundled with the Snap Pack, place the latest version of
sqljdbc_auth.dllin$SL_ROOT/ldlib (c:\opt\Snaplogic\ldlib). You do not have to add the custom jar file to the account. You can find the latest version of the DLL on the Microsoft SQL Server JDBC Driver website.
If you upload customized JDBC jars to the directory, the following error might occur:
java.lang.UnsatisfiedLinkError: Native Library C:\\opt\\snaplogic\\ldlib\\sqljdbc_auth.dll already loaded in another classloader
To fix this issue, remove all JDBC jars from the SQL server account and restart the JCC node.
Service Account Authentication implies that the active AD user session on the Snaplex is leveraged to obtain access to the SQL Server instance. Therefore, you need not provide values in the Username and Password fields.
Do not specify a port number.
SnapLogic recommends using the default JAR. You can download the latest JAR file from here.
Configure the following properties for JDBC under URL properties:
Url property name | Url property value |
|---|---|
| Your domain name Domain name must be added as a URL property and not along with the user name. |
|
|
Connecting to an MSSQL Instance
You can connect to a specific instance of MSSQL by using the instance name along with the server name in Hostname <server_name>/<instance_name>.
Alternatively, you can define the instance name by using the URL property name, instanceName.
If the Snap fails to connect to the database, it retries three more times.
You can Validate an account connection when creating a SQL Database Account but not when creating a SQL Server Dynamic Account because the account properties of a dynamic account are provided dynamically as pipeline parameters.
User Impersonation
In addition to providing the account properties such as Hostname, Database name, Username, and Password, ensure that the following settings/configurations are done for Active Directory Kerberos or NTLM Protocol (as the case may be) to implement User Impersonation with the SQL Server instance.
Authentication Using Active Directory Kerberos
Prerequisites
Set up Active Directory and SQL Server in the same domain and verify that you are able to perform Windows authentication using SQL Server Management Studio.
On the Active Directory Server, Set the Service Principle Name(SPN) for the SQL Server. Learn more.
SQL Server Snap Pack does not support this mode of authentication on Cloudplexes.
SnapLogic supports (tested and certified) Active Directory authentication for SQL servers on the following driver JAR version for Java 11:
mssql-jdbc-12.2.0.jre11.jar
Refer to Microsoft JDBC Driver for SQL Server for details.
Ensure that you have installed the correct JAR file. Also, use the following configurations in Account Settings to configure Active Directory authentication:
JDBC Driver class:
com.microsoft.sqlserver.jdbc.SQLServerDriverJDBC Connection URL:
jdbc:sqlserver://ServerNameFQDN:portNumber;databaseName=DBNAME
SnapLogic supports Active Directory authentication for SQL Server using the User impersonation method. The prerequisites are as follows:
In the account settings, add the following to Url property name and Url property value:
URL property name | URL property value |
|---|---|
|
|
|
|
| The domain name must be added as a URL property and not along with the user name. |
In the account settings, enter your Active Directory Username and Password.
Any version of the JAR files available in Microsoft Java and JDBC Support page later than the versions mentioned here can be used.
Authentication Using NTLM Protocol
SQL Server Snap Pack supports this mode of authentication on both Groundplexes and Cloudplexes. Authentication of SQL Server Account using NTLM Protocol is limited to Windows Snaplexes.
To authenticate Windows SQL Server connection with the NTLM protocol, follow these steps:
Configure your SQL Server Account settings as shown below:
JDBC Driver Class:com.microsoft.sqlserver.jdbc.SQLServerDriver
Url propertiesDomain =<Your Active Directory domain name>integratedSecurity = trueauthenticationScheme = NTLM
Note: After adding the domain name as an Url property (as mentioned above), do not include it again when providing the SQL Server username.
Click Validate and select the Snaplex when prompted. The "Account validation successful" message is displayed.
Click Apply to finish setting up NTLM-based authentication.
If you are using the default driver bundled with the SQL Server Snap Pack, you do not have to copy sqljdbc_auth.dll to the jcc ldlib folder.
Linux (Active Directory-based) Authentication
The SQL Server Account supports Linux-based authentication in Groundplexes. The setup instructions must be configured on the Groundplex to align with the Kerberos configuration, and then updating the connection settings provides an integrated authentication. Refer to Microsoft documentation for more information: https://learn.microsoft.com/en-us/sql/connect/jdbc/using-kerberos-integrated-authentication-to-connect-to-sql-server?view=sql-server-ver16
Troubleshooting
Error | Reason | Resolution |
|---|---|---|
| You have uploaded customized JDBC JAR files to the directory. | Remove all JDBC JARs from the SQL Server account and restart the JCC node. |
com.microsoft.sqlserver.jdbc.SQLServerException: This driver is not configured for integrated authentication. | The correct sqljdbc_auth.dll file is not available in the ldlib folder. | Download the appropriate |
No valid credentials provided | The Service Principal Name (SPN) is not setup properly. | Ensure that you have setup the SPN for |
Defective token detected. | Kerberos fails when a mismatch occurs between the SPN for the SQL Server service and the hostName. For example, if FQDN of the machine is used to setup SPN, the hostname must be an FQDN and not an IP address, while establishing a connection. | Provide a value for |