Application data, storage and Reportable REST APIs

Each application creates data, has storage for that data, and has a reportable REST API to provide reports with access to that data.
Figure 1. Data warehouse reporting architecture: CLM applications component
Diagram
of the basic reporting architectural components with the CLM applications
highlighted. Jazz Team Server data, storage and Reportable REST API Data warehouse Rational Reporting for Development Intelligence architecture
Image key:
  • CLM = Rational solution for Collaborative Lifecycle Management
  • QM = Quality Management application
  • CCM = Change and Configuration Management application
  • RM = Requirements Management application
  • UI = User interface
  • ODS = Operational data store

Each application in CLM provides functionality for creating and storing information about a variety of artifacts. It also provides an interface for running and viewing reports on that data.

Sections in this topic:

CLM Applications

Reportable REST APIs

Each application provides a schema for accessing the application data. The ETLs use this schema to collect data out of the application data storage. These APIs are web-base network APIs used by the CLM data collection jobs (or "ETL"s) to extract data from the applications and write it to the data warehouse. They can also be used to author live reports (development intelligence or document-style live reports), which call data directly from the applications using the REST API resource URLs. For more information, see Application Reportable REST APIs.

ETL "data collection" files

Each application provides one or more files for mapping application data to tables in the data warehouse. This file is used during the ETL data collection process. These files determine how data is extracted from the application data storage, transformed, and then loaded into the data warehouse. For more information, see Data collection with ETL processes.

Quality Management (QM) application and data storage

Quality management application includes interfaces for browsing, managing, and running reports; viewing and saving report output; and viewing report output in dashboards.

QM data storage includes artifact data; the RQM Reportable REST API schema; RQM ETL files; BIRT report definitions; and (optional) Rational Reporting for Development Intelligence report definitions and views.

The QM reportable REST API makes the following artifact data available for reporting:
  • Test Plan
  • Test Case
  • Test Script
  • Test Suite
  • Test Schedules
  • Test Suite Result
  • Test Execution Record
  • Test Case Execution Results*
  • Lab Resource
  • Resource Group
  • Reservation
  • Test Environment
  • Automation Job
  • Automation Job Result
  • Build Record
  • Quality Objective
  • Remote Script
  • Test Suite Execution Record
  • Project
  • Keyword
  • Lab Request
  • Deprecated in version 3.0.1:
    • Requirements
    • Defect/Work Item
    • Contributor
Note: Starting with IBM® Rational Quality Manager Version 4.0.3, in order to improve performance, QM data collection (ETL) operations only load test case execution step results that are linked to defects. In previous releases, QM ETL operations loaded all of the test case execution step results. For existing test case execution step results that were loaded into the data warehouse by a QM ETL operation prior to Version 4.0.3, the records are marked as soft deleted by the Version 4.0.3 QM ETL migration operation.

The Rational Quality Manager Version 4.0.3 data collection jobs load the URL and the index of step results in a test case execution result into the data warehouse. You can use Rational Reporting for Development Intelligence or IBM Rational Insight to obtain the results by using the query Operational Data Store->Execution Result Area->Execution Step Result in the Framework Model Reporting Data Model (DW).

Due to performance considerations, some Rational Insight users might have disabled the test case execution step result-related ETL builds in the RQM ODS job. In this case, run the RQM_StepResMig_4.0.3_Standalone job before running the RQM 4.0.3 ODS job.

Change and Configuration management (CCM) application and data storage

The Change and Configuration management application includes interfaces for browsing, managing, and running reports; viewing and saving report output; and viewing report output in dashboards.

CCM data storage includes artifact data; the RTC Reportable REST API schema; RTC ETL files; BIRT report definitions; and (optional) Rational Reporting for Development Intelligence report definitions and views.

The CCM reportable REST API makes the following artifact data available for reporting:
  • Project Area
  • Team Area
  • Contributor
  • Iteration
  • Workspace/Stream
  • Component
  • Build Result
  • Unit Test Result
  • Compilation Result
  • Unit Test Event
  • Work Item
  • Work Item State
  • Work Item Type
  • Work Item Category
  • Custom Attribute

Requirements management (RM) application and data storage

The Requirements management application includes an interface that can access Rational Reporting for Development Intelligence reports stored on the report server.

RM application data, including artifact data; the RRC Reportable REST API schema; and RRC ETL files, are stored on the Jazz Team Server, which is why the RM application and the Jazz Team Server share the same downloadable archives (sample reports and data model) and configuration files.

The RM application reportable REST API makes the following artifact data available for reporting:
  • Requirement (with links)
  • Link Types
  • Custom Attributes


Have a problem or a question? Post it in the Jazz.net forum.