Configuring JDBC database drivers

A JDBC driver (Java Database Connectivity) is a way for Java programs to connect to databases. When you run the Blueriq installer, a H2 JDBC driver is configured out-of-the-box. While this driver is great for development, we don't recommend nor support to use this database in a production environment. On this page you find instructions how to install a JDBC driver for your database and application server.

Supported JDBC Drivers

All supported database platforms can be found on the Platform support page.

Microsoft SQL Server

For Microsoft SQL Server, we recommend using the Microsoft JDBC Driver 12.2.0. This driver can be found at maven central https://repo1.maven.org/maven2/com/microsoft/sqlserver/mssql-jdbc/12.2.0.jre11/

This driver uses encryption by default and therefor you either have to

• setup a truststore with the correct certificate and reference it in the jdbc url
• auto accept the certificate using the trustServerCertificate=true inside the jdbc url

Oracle

For Oracle, we recommend to use the ojdbc8 driver: ojdbc8.jar version 21.9.0.0. The ojdbc8 driver can be downloaded from the Oracle website.

Application servers

Tomcat

On Tomcat, the JDBC driver is usually placed in the $CATALINA_HOME\lib folder.

https://tomcat.apache.org/tomcat-9.0-doc/jndi-datasource-examples-howto.html

JBoss EAP

For JBoss EAP the JDBC drivers should be added as a module.

https://access.redhat.com/documentation/en-us/red_hat_jboss_enterprise_application_platform/7.2/html/configuration_guide/datasource_management#jdbc_drivers

JDBC Driver configuration

When configuring the JDBC drivers for blueriq, a library xml element needs to be added to the server.xml, the library xml elements needs to contain an "id" attribute which is used as reference later on. In the fileset element the dir attribute must be set to the directory containing designated support driver. In this example oracle is used.

<library id="oracle-lib">
    <fileset dir="C:\drivers" includes="ojdbc8.jar"/>
</library>

Once the library element is added it can be used inside the application element to add the library to the application classloader. Inside the classloader element the attribute "commonLibraryRef" is set the newly created id of the library element.

<application id="Blueriq" location="blueriq-runtime-application-12.0.0.0.war" name="Blueriq" context-root="runtime" autoStart="true">
	<classloader commonLibraryRef="oracle-lib"/>
</application>

JNDI datasources configuration

JDNI datasources are driver specifc, in the examples only the supported drivers are shown.

Oracle

In the xml element jdbcDriver, the libraryRef attribute is set to the library id. In the properties.oracle element the connection URL, user and password attributes need to be set in order to create a database connection. Fill in the blanks at <...> with your own configuration.

<dataSource id="CustomerDataSource" jndiName="jdbc/customer">
	<jdbcDriver libraryRef="oracle-lib"/>
	<properties.oracle URL="jdbc:oracle:<driverType>:@<server_name>:<port>:<SID>" user="user" password="password"/>
</dataSource>

Microsoft SQL Server

In the xml element jdbcDriver the libraryRef attribute is set to the library id. In the properties.microsoft.sqlserver element, fill in the attributes with your own configuration.

<dataSource id="CustomerDataSource" jndiName="jdbc/customer">
	<jdbcDriver libraryRef="mssql-lib"/>
	<properties.microsoft.sqlserver databaseName="database" portNumber="portnr" serverName="server" user="user" password="password"/>
</dataSource>