Design BIRT Reports on DataRobot Data

Ready to get started?

Download for a free trial:

Download Now

Learn more:

DataRobot JDBC Driver

Rapidly create and deploy powerful Java applications that integrate with DataRobot automated machine learning platform data including Projects, Models, Predictions, and more!



Provide current DataRobot data to your embedded analytics.

The CData JDBC Driver for DataRobot integrates connectivity to DataRobot APIs into your data-driven Java applications. You can use the CData JDBC Driver for DataRobot 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.

    To connect to DataRobot, the following connection properties are required: User, Password, and PredictionInstance. DataRobotKey may also be required depending on your type of DataRobot predictions instance. If using the Predictions API, DataFile is required. The CSV DataFile should include a header row as the first row of the datafile. APIKey is not required, but can be supplied. If not supplied, the driver will handle obtaining an APIKey.

    User, DataRobotKey, and APIKey are the credentials for the DataRobot account.

    ProjectID, DataFile, and ModelId are the parameters for the project, dataset, and model type.

    Built-in Connection String Designer

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

    java -jar cdata.jdbc.datarobot.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:datarobot:PredictionInstance=myinstance.orm.datarobot.com;DataFile=PATH\TO\input_file.csv;DataRobotKey=123-abc-456-def;User=username;Password=password;
  7. Right-click the Data Sets folder and select the JDBC data source for DataRobot.
  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 Id, Prediction1Value FROM Predictions
  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 DataRobot 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.