BIRT Developer Center Download

BIRT with ClearQuest


Overview

With the 7.1 release of IBM Rational ClearQuest, it is now possible to use the ClearQuest ODA adapter to connect externally to a ClearQuest database. Out of the box ClearQuest provides a Report Designer view, however if you choose to use another BIRT Designer, Viewer, or Server you must setup the ClearQuest ODA connector yourself.

Currently, the ClearQuest ODA adapter has been tested and known to work with the Actuate 9 BIRT Product Line. The instructions below will provide the steps necessary to connect to ClearQuest 7.1 data from the Actuate 9 products.

An archived webinar showing how BIRT, ClearQuest, and Actuate work together can be viewed here

Additional information on using ClearQuest and Actuate together can be found in a whitepaper here

ClearQuest ODA Driver Files

Access to the ClearQuest Data is achieved through the Eclipse Open Data Access (ODA) functionality. The following list of files are needed in order access the ClearQuest data outside the ClearQuest client. The location where these files need to copied to will be different depending on which products you would like to allow access to your ClearQuest data.

These files can be found either at:

  • C:\Program Files\IBM\IMShared\plugins
    ...or inside the following archive file:
  • C:\Program Files\IBM\IMShared\native\cqec-ide-cqec-ide_1.0.0.7-1-D080916.zip
    ...or from the plugins directory of your Installation Manager repository:
  • http://[YOUR_SERVER]/7.1.0.0/CQ/nt_i386/plugins/
    Required ClearQuest ODA driver files:
  • org.eclipse.emf.edit_[version].jar
  • org.eclipse.emf.common.ui_[version].jar
  • org.eclipse.emf.edit.ui_[version].jar
  • com.ibm.rational.clearquest.core.lib_[version].jar
  • com.ibm.rational.clearquest.jdbc_[version].jar
  • com.ibm.rational.clearquest.oda.jdbc_[version].jar
  • com.ibm.rational.clearquest.oda.jdbc.ui_[version].jar
  • com.ibm.rational.stp_[version].jar

Optional files:

  • com.ibm.rational.clearquest.oda.jdbc.nl1_[version].jar
  • com.ibm.rational.clearquest.oda.jdbc.ui.nl1_[version].jar
  • com.ibm.rational.clearquest.jdbc.nl1_[version].jar

ClearQuest BIRT reports with Actuate BIRT Designers

The Actuate BIRT Report Designer Pro can be used to create reports based on ClearQuest data and allows for easy deployment of those reports to the Actuate BIRT iHub. In order to design a ClearQuest report in Actuate BIRT, you will need to make the ClearQuest ODA drivers are available to the designer.

  1. Download Actuate BIRT Designer from below: compare designers
  2. Copy ClearQuest ODA Driver files listed above to:
    • C:\Program Files\Actuate\BDPro\eclipse\plugins
    • ... OR ...
    • C:\Program Files\Actuate\BD\eclipse\plugins
  3. Remove conflicting driver file
    • Delete the file called com.actuate.data.oda.jdbc.connectionpool_[version].jar from the C:\Program Files\Actuate10\BRDPro\eclipse\plugins directory.
  4. Test Connection to ClearQuest data
    • Start/Restart BIRT Designer Pro
    • File | New Project - For BD Pro only, select the Business Intelligence and Reporting Tools | Report Project
    • File | New Report - Name the report what you want, and choose any template.
    • New Data Source - Right Click on Data Sources to create a new Data Source, be sure to select ClearQuest Data
    • New Data Set - Select a ClearQuest Query to use for this report

ClearQuest BIRT reports with the Actuate BIRT iHub

The Actuate BIRT iHub can be used to manage your ClearQuest reports allowing you to run, schedule, distribute, and secure your ClearQuest reports. In order to run ClearQuest reports in Actuate BIRT iHub, you will need the correct version of Actuate and will need to make the ClearQuest ODA drivers available to the server.

  1. Download BIRT iHub from the link below:
  2. Copy ClearQuest ODA Driver files listed above to:
    • C:\Program Files\Actuate10\MyClasses\eclipse\plugins
  3. Test Connection to ClearQuest data
    • Start/Restart the BIRT iHub Service
    • Launch iHub Management Console
      • Windows menu - Start | Programs | Actuate | iHub Management Console
      • ...or from a browser at http://[SERVER]:8900/acadmin/?
      • Log in with the administrator username and password you created during setup.
    • Upload report design - Use the Add File button to upload a report design. If you have created the SAMPL database schema, then you can upload one of the associated sample reports from C:\Program Files\IBM\IMShared\plugins\com.ibm.rational.clearquest.report.samples_[VERSION]\BIRT...otherwise, upload a report that connects to your CQ database.
    • Upload any needed libraries - The sample reports mentioned above depend on a library file so that the connection to the ClearQuest data base is managed in one place. That file is called CQSamples.rptlibrary and needs to be copied to C:\Program Files\Actuate\iHub\resources
    • Run report
      • Use the blue drop-down arrow next to your report in the iHub Management Console and select Run...
      • You can also view the ClearQuest report in the iPortal (The users view into the BIRT iHub)
        • Launch BIRT iHub<
          • Windows menu - Start | Programs | Actuate | BIRT iHub
          • ...or from a browser at http://[SERVER]:8900/iportal/?
          • Log in with a username and password you created during setup.
        • Run Report by clicking on the report name
        • For a complete evaluation, see the full BIRT iHub Deployment Guide

ClearQuest BIRT reports with Actuate BIRT Studio (web-based designer)

The BIRT Studio provides the ability to design ClearQuest reports over the web. These reports start from a template created in a BIRT Designer and use the ClearQuest data adapter. These steps below assume you have downloaded and installed the Actuate BIRT iHub above.

  1. Create a report template
    • Open the Actuate BIRT Designer, or Report Designer perspective of the ClearQuest Client for Eclipse.
    • File | New Template
    • New Data Source - Right Click on Data Sources to create a new Data Source, be sure to select ClearQuest Data
    • New Data Set - Select a ClearQuest Query to use for this report template
    • Add Table - A table is necessary as a place for the user to drop data into the report.
      • Insert a table onto the report
      • Right-click on the table and select Create Template Report Item
  2. Publish the template
    • Create a directory to host your ClearQuest templates
      • Open c:\Program Files\Actuate\iHub\servletcontainer\iportal\resources\BizRDRptTemplates
      • Create a directory (for this example, we created a directory called 'ClearQuest Reports')
      • Copy the Template (rpttemplate file) created in the earlier steps to the new directory
      • Restart the BIRT iHub service
  3. Testing the BIRT Studio
    • Launch BIRT iHub
      • Windows menu - Start | Programs | Actuate10 | BIRT iHub
      • ...or from a browser at http://[SERVER]:8900/iportal/?
      • Log in with a username and password you created during setup.
  4. For a complete evaluation, see the full BIRT Studio Guide