Connect SQL Server to IBM WebSphere Using the CData JDBC Driver

IBM WebSphere is a powerful application server that runs many enterprise level Java applications and services. When paired with the CData JDBC Driver for SQL Server, IBM WebSphere applications can connect to SQL Server and work with data using standard SQL queries instead of complex APIs. This simplifies integration, reduces development effort, and provides secure, real-time access to critical business data.

Prerequisites

1. Access to a SQL Server account (with API permissions)
2. IBM WebSphere Application Server (configured and running)
3. CData JDBC Driver for SQL Server
4. Java Servlet WAR application ready for deployment

Note: This article uses Salesforce as a demonstration data source, but the same steps can be followed to connect to any of the 250+ JDBC Drivers available in our portfolio.

Getting Started

Step 1: Download and install the CData JDBC Driver for SQL Server

Download and install the CData JDBC Driver for SQL Server, which provides a .jar file: cdata.jdbc.sql.jar

Step 2: Install and configure IBM Websphere

1. Create an account in IBM WebSphere using the official IBM site.
2. Install and configure the IBM Websphere Application server in the local system using the documentation: IBM Websphere Application Server
3. Once the application server is installed, start the WebSphere Server using the Admin Console in your browser: https://your-server:9043/ibm/console

Step 3: Set up the JDBC provider and data source for SQL Server

1. Go to Resources, expand the JDBC section, and then select JDBC providers to create a new provider

2. Select the appropriate scope from the drop down menu

3. Click New to add a JDBC provider
• Choose User defined as the database type
• Enter cdata.jdbc.sql.SQLConnectionPoolDataSource as the implementation class name
• Type a name for the provider, for example User defined JDBC Provider
• Enter the full path of the JDBC driver JAR file in the classpath field
• Click Next, then Finish, and save the changes to the master configuration.

4. Once the JDBC provider is created, add a JDBC data source.
• Enter the basic details such as Data Source Name and JNDI name
• Select the existing JDBC provider created earlier (e.g., CData SQL Server Provider)
• Provide the Implementation class name: cdata.jdbc.sql.SQLConnectionPoolDataSource
• Add the Data Store Helper Class Name: com.ibm.websphere.rsadapter.GenericDataStoreHelper
• Configure security by setting authentication aliases if required
• Review the Summary page to verify all details and click Finish to complete the data source creation

5. Select the newly created data source from the list and open Custom properties
6. Add the JDBC connection string under the URL property and press OK. For example:

   jdbc:sql:RTK=5246...;User=myUser;Password=myPassword;Database=NorthWind;Server=myServer;Port=1433;

   Connecting to Microsoft SQL Server

   Connect to Microsoft SQL Server using the following properties:

   • Server: The name of the server running SQL Server.
   • User: The username provided for authentication with SQL Server.
   • Password: The password associated with the authenticating user.
   • Database: The name of the SQL Server database.

   Connecting to Azure SQL Server and Azure Data Warehouse

   You can authenticate to Azure SQL Server or Azure Data Warehouse by setting the following connection properties:

   • Server: The server running Azure. You can find this by logging into the Azure portal and navigating to "SQL databases" (or "SQL data warehouses") -> "Select your database" -> "Overview" -> "Server name."
   • User: The name of the user authenticating to Azure.
   • Password: The password associated with the authenticating user.
   • Database: The name of the database, as seen in the Azure portal on the SQL databases (or SQL warehouses) page.

   SSH Connectivity for SQL Server

   You can use SSH (Secure Shell) to authenticate with SQL Server, whether the instance is hosted on-premises or in supported cloud environments. SSH authentication ensures that access is encrypted (as compared to direct network connections).

   SSH Connections to SQL Server in Password Auth Mode

   To connect to SQL Server via SSH in Password Auth mode, set the following connection properties:

   • User: SQL Server User name
   • Password: SQL Server Password
   • Database: SQL Server database name
   • Server: SQL Server Server name
   • Port: SQL Server port number like 3306
   • UserSSH: "true"
   • SSHAuthMode: "Password"
   • SSHPort: SSH Port number
   • SSHServer: SSH Server name
   • SSHUser: SSH User name
   • SSHPassword: SSH Password

   SSH Connections to SQL Server in Public Key Auth Mode

   To connect to SQL Server via SSH in Password Auth mode, set the following connection properties:

   • User: SQL Server User name
   • Password: SQL Server Password
   • Database: SQL Server database name
   • Server: SQL Server Server name
   • Port: SQL Server port number like 3306
   • UserSSH: "true"
   • SSHAuthMode: "Public_Key"
   • SSHPort: SSH Port number
   • SSHServer: SSH Server name
   • SSHUser: SSH User name
   • SSHClientCret: the path for the public key certificate file

   Built-in Connection String Designer

   For assistance in constructing the JDBC URL, use the connection string designer built into the SQL Server JDBC Driver. Either double-click the JAR file or execute the jar file from the command-line.

         java -jar cdata.jdbc.sql.jar
         

   Fill in the connection properties and copy the connection string to the clipboard.

   

   Note: If the URL property is not available, create it and then add the JDBC connection string.

   Tip: Always test the connection string with the driver before entering it in the URL property.
7. Now open the data source and choose Test Connection

Step 4: Build the web application

1. Build the web application using preferred Java framework (Servlet, JSP, or Spring). The resulting .war file will typically follow a structure like this:

		SQL ServerServletApp.war
		|--webcontent
		|  |--index.jsp                 -- JSP page (entry point)
		|  |
		|  |--WEB-INF/                  --Hidden from direct browser access
		|     |--web.xml                 -- Deployment descriptor
		|     |
		|     |--classes/                  --Compiled .class files
		|       |--com/example/SQL Server/
		|          |--SQL ServerServlet.class
		|
		|--lib/                      --Dependency JARs
		|--cdata.jdbc.sql.jar
	

2. Define the data access logic using JDBC or JPA, referencing the data source through a JNDI name
3. This article walks through JDBC connection setup and deploying a Java Servlet application
4. Package the project as a WAR (Web Application Archive) or EAR (Enterprise Archive) file for deployment
• In a terminal compile the java file using the command:

  			cd webcontent
  			jar cvf ..\SQL ServerServletApp.war *
  		

Step 5: Deploy the SQL Server application in WebSphere

1. In the WebSphere admin console, go to Applications and select Install New Application
2. Browse and upload the WAR file, then continue with the installation wizard.

Step 6: Retrieve SQL Server data through WebSphere

1. Access the application using its context root: http://hostname:port/context-root/page
Note: Ensure the deployed application is started before opening it in the browser.

We can now view the retrieved data from the source. The data is accessible directly through IBM WebSphere. This setup demonstrates how a servlet can be deployed in WebSphere to retrieve SQL Server data using the JDBC driver, creating a strong foundation for building advanced SQL Server powered enterprise applications.

Get Started with Connecting SQL Server to IBM WebSphere

Start connecting SQL Server to IBM WebSphere with the CData JDBC Connector today. Download the free 30-day trial and explore how easy it is to enable secure, real-time data access for your applications. As always, our world-class Support Team is available to help with any questions you may have.