Design BIRT Reports on SQL Server Data

Ready to get started?

Download for a free trial:

Download Now

Learn more:

SQL Server Driver

Rapidly create and deploy powerful Java applications that integrate with Microsoft SQL Server.



Provide current SQL Server data to your embedded analytics.

The CData JDBC Driver for SQL Server integrates connectivity to SQL Server APIs into your data-driven Java applications. You can use the CData JDBC Driver for SQL Server with the BIRT (Business Intelligence Reporting Tools) platform to create BIRT reports that reflect changes to your data in real time.

  1. If you have not already done so, install the BIRT Framework plugin and the Database Development plugin for Eclipse.
  2. Click File -> New -> Report. The Report Design perspective is opened.
  3. In the Data Explorer, right-click Data Sources and click New Data Source.
  4. Select the Create from a Data Source Type in the Following List option and select JDBC Data Source.
  5. Click Manage Drivers and add the driver JAR, located in the lib subfolder of the installation folder.
  6. In the Database URL box, enter the JDBC URL containing the connection string.

    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;
  7. Right-click the Data Sets folder and select the JDBC data source for SQL Server.
  8. In the resulting dialog, build the SELECT query to be used to retrieve the data for the report. This article uses the following query: SELECT ShipName, Freight FROM Orders
  9. In the Palette, drag a Chart onto the editor. The chart wizard is displayed.
  10. After selecting the chart type, drag columns onto the chart fields on the Select Data tab.
  11. Click Run -> View Report -> In Web Viewer to view the report.

Your BIRT reports can now pick up any updates to SQL Server data.

To publish the report to your application server, add the driver JAR to the BIRT Viewer's classpath. For more information, see the CData KB for guides to deploying the JDBC Driver on Java application servers.