Ready to get started?

Learn more about the CData JDBC Driver for SQL Server or download a free trial:

Download Now

SQL Server Reporting in OBIEE with the SQL Server JDBC Driver

Deploy the SQL Server JDBC driver on OBIEE to provide real-time reporting across the enterprise.

The CData JDBC Driver for SQL Server is a standard database driver that can integrate real-time access to SQL Server data into your Java-based reporting server. This article shows how to deploy the driver to Oracle Business Intelligence Enterprise Edition (OBIEE) and create reports on SQL Server data that reflect any changes.

Deploy the JDBC Driver

Follow the steps below to add the JDBC driver to WebLogic's classpath.

For WebLogic 12.2.1, simply place the driver JAR and .lic file into DOMAIN_HOME\lib; for example, ORACLE_HOME\user_projects\domains\MY_DOMAIN\lib. These files will be added to the server classpath at startup.

You can also manually add the driver to the classpath: This is required for earlier versions. Prepend the following to PRE_CLASSPATH in setDomainEnv.cmd (Windows) or setDomainEnv.sh (Unix). This script is located in the bin subfolder of the folder for that domain. For example: ORACLE_HOME\user_projects\domains\MY_DOMAIN\bin.

set PRE_CLASSPATH=your-installation-directory\lib\cdata.jdbc.sql.jar;%PRE_CLASSPATH%

Restart all servers; for example, run the stop and start commands in DOMAIN_HOME\bitools\bin.

Create a JDBC Data Source for SQL Server

After deploying the JDBC driver, you can create a JDBC data source from BI Publisher.

  1. Log into BI Publisher, at the URL http://localhost:9502/analytics, for example, and click Administration -> Manage BI Publisher.
  2. Click JDBC Connection -> Add Data Source.
  3. Enter the following information:
    • Data Source Name: Enter the name that users will create connections to in their reports.
    • Driver Type: Select Other.
    • Database DriverClass: Enter the driver class, cdata.jdbc.sql.SQLDriver.
    • Connection String: Enter the JDBC URL.

      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.

      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.

      When you configure the JDBC URL, you may also want to set the Max Rows connection property. This will limit the number of rows returned, which is especially helpful for improving performance when designing reports and visualizations.

      A typical JDBC URL is below:

      jdbc:sql:User=myUser;Password=myPassword;Database=NorthWind;Server=myServer;Port=1433;
    • Username: Enter the username.
    • Password: Enter the password.
  4. In the Security section, select the allowed user roles.

Create Real-Time SQL Server Reports

You can now create reports and analyses based on real-time SQL Server data. Follow the steps below to use the standard report wizard to create an interactive report that reflects any changes to SQL Server data.

  1. On the global header, click New -> Data Model.
  2. On the Diagram tab, select SQL query in the menu.
  3. Enter a name for the query and in the Data Source menu select the SQL Server JDBC data source you created.
  4. Select standard SQL and enter a query like the following: SELECT ShipName, Freight FROM Orders
  5. Click View Data to generate the sample data to be used as you build your report.
  6. Select the number of rows to include in the sample data, click View, and then click Save As Sample Data.
  7. Click Create Report -> Use Data Model.
  8. Select Guide Me and on the Select Layout page select the report objects you want to include. In this example we select Chart and Table.
  9. Drop a numeric column like Freight onto the Drop Value Here box on the y-axis. Drop a dimension column like ShipName onto the Drop Label Here box on the x-axis.
  10. Click Refresh to pick up any changes to the SQL Server data.