Rational Quality Manager 3.0.1 Reporting integration with Rational ClearQuest


This article provides detailed steps for configuring the integration of IBM Rational Quality Manager (RQM) 3.0.1, IBM Rational ClearQuest (ClearQuest) and IBM Rational Insight (Insight) when Rational ClearQuest is used as an Open Services for Lifecycle Collaboration (OSLC) provider for RQM.

In addition to out-of-the-box reports, Collaborative Lifecycle Management (CLM) 2011 provides Cognos®-based reports. For Cognos-based reporting, users can choose IBM Rational Reporting for Development Intelligence (RRDI) or IBM Rational Insight. RRDI contains everything you need to author and run reports. Insight includes everything that RRDI includes plus tools for adding more data sources and customizing the data warehouse schema, metadata models, and ETL (Extract-Transform-Load) processes. In addition, Insight integrates with other tools such as IBM Rational DOORS, IBM Rational RequisitePro, and IBM Rational ClearQuest, which allows you to include data from these tools for enterprise-level reporting. See Reporting options, for more details about the CLM reporting solutions.

There are two types of data collections deployed for CLM. One uses the fixed RRDI data collection jobs in the Jazz Team Server. The other is a fully customizable data collection managed by the Data Manager tool of Insight (referred to as Data Manager ETL in the following procedure).

In RQM 3.0.1, you can add a Rational ClearQuest server as a defect provider or as a quality management task provider. RQM can integrate with Rational ClearQuest using OSLC or using the ClearQuest Synchronizer (previously called the ClearQuest Connector). The ClearQuest Synchronizer maps ClearQuest records, such as defects, to Change and Configuration Management (CCM) work items. If you use Rational Insight, the records are inserted into the data warehouse database when you run the IBM Rational Team Concert (RTC) Data Manager ETLs. If you use RRDI, the records are inserted when you run the RTC data collection jobs. If you use the ClearQuest Synchronizer, it is not required to configure ClearQuest with RQM in Insight.

To include Rational ClearQuest defects or tasks that are associated with test artifacts in RQM reports when Rational ClearQuest is an OSLC provider for RQM, you must use IBM Rational Insight for reporting. Since the ClearQuest schema can be customized, we are using the sample schema Enterprise in the ClearQuest schema database and the out-of-the-box ClearQuest Data Manager ETL of Rational Insight in the article.

The instructions below assume that you use IBM DB2. Other DBMS are set-up in a very similar way.


  • Install IBM Rational ClearQuest version 7.1.2 or later and the ClearQuest web server component. Apply the OSLCLinks package. For an introduction to this integration, see Rational Quality Manager and Rational ClearQuest.
  • Install IBM Rational Insight on the reporting server and make sure that you select required components such as Data Source Definitions, Data Manager Client and XML Data Configuration when installing Rational Insight on the reporting server. You will find the clearquest.xdc file in the directory [Insight_installtion_dir]etlconfigsConfigurations. The IBM Rational XML ODBC Driver ClearQuest points to the clearquest.xdc file.
  • Install the IBM Rational Insight Data Services with the Rational ClearQuest Adapter on the Rational ClearQuest server and specify the ClearQuest location. (With the automatic installation, the default path in Windows is C:Program FilesIBMRationalSDLCClearQuest.) Then, verify the Rational ClearQuest Data Service by the URL http://[CQ_Server]:[Port]/DataServices/ClearQuest on the reporting server. If you chose the manual installation method when you installed the IBM Rational Insight Data Services, please follow the steps in Essential postinstall tasks for manual installation and Postinstall general tasks for Rational ClearQuest.
  • Follow the steps in Integrating Rational Insight and Rational solution for CLM.
  • If the RQM server was upgraded from RQM 2.x and had legacy data in the IBM Rational Rational Common Reporting (RCR) 1.0 data warehouse database, you need to follow the steps in Migrating to Rational Insight, and then the steps in Migrating report data from version 2.

Associate Rational ClearQuest artifacts with RQM artifacts

If you configure Rational ClearQuest as a defect provider, you can do several things. You can create a new defect. You can add an existing defect to an execution result or to a step in an execution result, or as a blocking defect of a test execution record. The behavior is similar to what you do for any other OSLC defect. You can see these ClearQuest defects and their relationships or traceability with RQM artifacts in RQM reports.

If you configure Rational ClearQuest as a Quality Management task provider, you can create quality tasks in Rational ClearQuest. These tasks are typically associated with test plans, test cases, or test scripts. For example, when a user is asked to complete a section of a test plan, that user is assigned a quality task. Currently, the RQM 3.0.1 ETL can establish the relationship of a quality task and a test case, but it can not establish the relationship of a quality task and other test artifacts, due to the limitations of the data warehouse database schema in this release. There are no out-of-the-box reports that show quality tasks or their relationship with test cases, but you can create customized Cognos reports for this purpose.

Reporting on RQM and Rational ClearQuest data in Rational Insight

Rational Insight provides out-of-the-box ClearQuest XDC and ETLs as a starting point for Rational ClearQuest’s schema samples. You need to customize the XDC and ETLs if you want to support your customized schema in Rational ClearQuest. Please refer to the steps in the document Integrating Rational Insight and Rational ClearQuest. This article just describes the steps about how to configure Rational ClearQuest and Rational Insight for the sample Enterprise schema.


  1. Open the clearquest.xdc in the XML Data Configuration tool. Expand the tree on the left panel to the node XML Data Configuration > Resources > ClearQuest Enterprise > CQEnterprise; then, modify the User name, Password and URL of the schema database including the sample schema. The URL is http://[CQ_Server]:[Port]/DataServices/ClearQuest/[schema_repository]/[schema_database]. The Authentication type is Basic.

    IBM ClearQuest XDC file

  2. Repeat Step 1 to modify the User name, Password and URL of the Default resource group under the ClearQuest Default resource group category in XDC. If your schema database includes the sample schema ALM, you can configure the resource group CQALM in XDC as well.
  3. Open an existing catalog that includes the OOTB catalog file provided by Rational Insight in the Data Manager tool. Otherwise, you need to create a new catalog, then click File > Restore Catalog and select the OOTBDMCatalog.ctg. (The default path in Windows is [Insight_installtion_dir]datamgrinsight_catalogOOTBDMCatalog.ctg). You will see the ClearQuest job CQAll in the Builds and JobStreams > Jobs > CQJobs folder. Click the job CQAll and disable the build ALM in the job, since we just want to fetch the data in the Enterprise schema in this article. You could refer to Configuring the report development tools on Windows systems.

    CQAll job of OOTB IBM Rational ClearQuest Data Manager ETL in Data Manager

  4. Import the Data Manager packages from the CLM server into the existing Data Manager catalog if you haven’t done so before. Please refer to Integrating the Collaborative Lifecycle Management report packages with Rational Insight.
  5. Create a job to execute ClearQuest ETL, CLM ETL and Build_Star, and make sure that the ClearQuest job runs before CLM job. The typical order is CQAll > CLM ODS jobs > Build_Star. You need to set a Boolean variable DelatLoad in the job to determine full loading or delta loading before you’d like to run the job.

    The Data Manager job to execute CQAll, CLM ODS jobs and Build_Star

  6. You can publish the job as a data movement task by clicking Actions > Publish Data Movement Task. Then select the job in Data Manager, and schedule the job on the Rational Insight reporting server. More details are provided in the Rational Insight Information Center.

    NOTE: If the anonymous access is disabled on a SSL-enabled report server, the Data Manager client hangs when attempting to publish a data movement task, please see the tech note to resolve it: Data Manager client hangs when publishing a data movement task to a SSL-enabled report server.

  7. If you are successful with the data warehouse database connection, the signon, and the RQM and Rational Insight configuration, you will see defects or quality tasks in Rational ClearQuest and their relationships or traceability with RQM artifacts in RQM reports after running the ETL job.

    The following is a RQM out-of-the-box Cognos-based report Execution and Defects by Owner running on Rational Insight. In the report, you could see some defects from IBM Rational ClearQuest. In additional, you could see some defects from RTC if you have run RTC data collection job too.

    Execution and Defects by Owner

Data access security of Framework Manager model

The OOTB IBM Rational RequisitePro and IBM Rational ClearQuest Data Manager ETLs provided by IBM Rational Insight do not populate data into the resource project lookup table RIODS.PROJECT_RESOURCE_LOOKUP which is used for access control of the Framework Manager model. If you turn on the secuirty in the Framework Manager model, the user logging to the IBM Rational Insight reporting server could only get the data of the artifacts in the projects in reports when you can find the pair of the user’s RESOURCE_ID and PROJECT_ID in the RIODS.PROJECT_RESOURCE_LOOKUP table. You could follow the steps to turn off the data access security in the Framework Manager if you use IBM Rational Insight with a non-CLM product such as IBM Rational RequisitePro or IBM Rational ClearQuest.

Alternatively, you can customize the ETL by following the instructions in the IBM Rational Insight work item Not all product ETLs support the FM security model (50740):

  1. Create a fact build, e.g. ProjectUsers_default, under Builds and JobStreams > Others > Security in Data Manager.
  2. Insert a Data Source, select Rational Data Warehouse as Database. Input the following sql as Query:
  3. Go to the Result columns tab, click Refresh, input RIODS as the value of the variable ODS, and click OK to close Data Source Properties dialog.
  4. Double-click Data Stream to open the DataStream Properties dialog. Then, click Auto Map, and click OK to close the dialog.
  5. Right click on Transformation Model and select Mapping. Then, click Auto Map and click OK to close the dialog.
  6. Right-click the Delivery Modules > Fact Delivery of ProjectUsers_default build. Then, select Insert Relational Table Delivery. In the Table Properties tab, select Rational Data Warehouse in the Connection drop down list. Input “{$ODS}”.”PROJECT_RESOURCE_LOOKUP” as Table name. Check PROJECT_ID, RESOURCE_ID in Columns, and check Key for each of the columns. Click OK to close the dialog.

    Project users

  7. Right-click on JobStreams > Others > Security > ProjectUsers_default. Then, go to the Variables tab. Add a new variable with Name is ODS, Type is CHAR(10). and value is ‘RIODS’. Click OK to close the dialog.
  8. Click Save to save the changes.

These steps will help to build up the resource project mapping in the RIODS.PROJECT_RESOURCE_LOOKUP table. You can customize the SQL in step 2 according to your specific requirements. In addition to the changes in Data Manager, you need to enable security for the reporting server and the data warehouse to make this work.

If an authenticated user can not view any data through the reporting server, check to see whether the user name that is entered in the reporting server is consistent with the value in RIODS.RESOURCE.REFERENCE_ID.


About the author

Jun Wang is a developer on the reporting team of Rational Quality Manager in the China Software Development Laboratory. He can be contacted at junwbj@cn.ibm.com.

Was this information helpful? Yes No 0 people rated this as helpful.