Upgrading the MS SQL Server JDBC driver in TIBCO Spotfire Server

Product:TIBCO Spotfire Server
Versions:10.3 and later versions

Summary:
This article provides details steps on how to replace/upgrade the MS SQL server JDBC driver in TIBCO Spotfire server

Details:
This article states the driver update procedure for MS SQL Server JDBC driver for TIBCO Spotfire server Configuration tool

Resolution:
There are two different files to upgrade.
1. One JAR file contains the Java library
2. One DLL file contains native libraries for doing integrated authentication (Kerberos, NTLM).

TIBCO Spotfire Server 10.3.9 runs on Java 8, so the MSSQL Server JDBC driver used must be built for Java 8. TIBCO Spotfire Server 10.10 and higher versions runs on Java 11, with an MS SQL Server driver built for Java 11, so these cannot be used.

Driver files can be picked from a later TSS, or from Maven (TSS 10.3.9 ships with version 8.2.2, TSS 11.7.0 with version 9.4.1):
https://mvnrepository.com/artifact/com.microsoft.sqlserver/mssql-jdbc (pick a file ending in .jre8)
https://mvnrepository.com/artifact/com.microsoft.sqlserver/mssql-jdbc_auth (pick a file ending in .x86)

Steps to upgrade MS SQL Server JDBC driver for TSS:

1. Stop the TSS
2. Replace the file <install-dir>/tomcat/webapps/spotfire/WEB-INF/lib/mssql-jdbc.jar
3. Replace the file <install-dir>/tomcat/spotfire-lib/mssql-jdbc_auth-X.X.X.x64.dll
4. Start the TSS

Following lines are seen in startup.log that contains information about which files get loaded at startup. E.g. (11.7.0 TSS):

2022-01-28T13:02:49,294+0100 Listing components and resources in C:\tibco\tss\11.7.0\tomcat\webapps\spotfire\WEB-INF\lib:
[...]
2022-01-28T13:02:49,341+0100 - mssql-jdbc.jar (1358692 bytes, last modified: 2022-01-28 10:54:44 +0100)
[...]
2022-01-28T13:02:49,388+0100 Listing components and resources in C:\tibco\tss\11.7.0\tomcat\spotfire-lib:
[...]
2022-01-28T13:02:49,388+0100 - mssql-jdbc_auth-9.4.1.x64.dll (313840 bytes, last modified: 2022-01-28 10:54:44 +0100)

Please note that there should be no other mssql-jdbc JAR or DLL files loaded from any other directory (e.g. custom-ext).

Steps to upgrade MS SQL Server JDBC driver for TIBCO Spotfire Server Configuration Tool installed on Local computer:

1. Replace the file spotfireconfigtool/lib/mssql-jdbc-X.X.X.jre11.jar
2. The Remote TIBCO Spotfire Server Config Tool in 10.3.9 does not bring its own DLL file. Make sure that the file mssql-jdbc_auth-X.X.X.x64.dll is available on the PATH, e.g. by copying it to C:\Windows\System32. Make sure that no other mssql-jdbc-auth.dll is on the path.