Reporting data dictionaries

Report authors can access the Rational® solution for Collaborative Lifecycle Management (CLM) data warehouse via a Framework Manager (FM) model or access live data from the applications using reportable REST APIs. The application-based data dictionaries in this section show how elements in the FM model and in the REST API map to artifacts in CLM.

CLM includes a data warehouse, to which each of the CLM applications contribute data. The data dictionary topics in this section detail the relationship between application-specific data (physical data related to artifacts and other elements in CLM applications) and the related queries that need to be incorporated into a report so that the required application data appears in the report ouput. When authoring reports, you can reference these mappings to determine which queries to use.

Sections in this topic:
CLM data dictionaries
Using the data dictionaries to author development intelligence reports
Using the data dictionaries to author document-style reports
Explanation of columns in the data dictionaries

CLM data dictionaries

Using the data dictionaries to author development intelligence reports

The data in this warehouse can be incorporated into development intelligence reports using a Framework Manager (FM) model, which serves as an intermediary between the physical schema in the data warehouse and the report. In Report Studio or Query Studio, you add queries on elements of the data model, and those queries will return information based on the data that is stored in the data warehouse.
CLM and Rational Insight share the same data warehouse and FM model, which is why the FM model contains many terms that are not specific to CLM artifacts. This is by design; the model needs to be general enough that other products can contribute data into the same model.

For example, work items from the Change and configuration management (CCM) application are stored in the Request table in the data warehouse along with change requests from Rational ClearQuest®. This enables the creation of reports that can generate output based on both (and other integrated) products.

The following tables demonstrate some common examples of mismatches between the names of elements in the application interfaces, names of the REST API resource, and the names of the data warehouse tables and metadata model queries that they map to.

Table 1. Example Quality management mismatches
Quality management UI element REST API resource Data model subject
Test Schedule TestPhase Iteration
Test Execution record ExecutionWorkItem Execution work item
Test Environment Configuration Configuration
Table 2. Example Change management mismatches
Change management UI element REST API resource Data model subject
Contributor contributor Resource
Work item workItem Request

The data dictionaries demonstrate detailed mappings for all of the CLM application data that is collected and stored in the data warehouse Operational data store (ODS). There are many cases where data warehouse tables and columns are non populated by CLM application data because they are used for other purposes.

Use the data dictionaries for reference and use the information on Creating development intelligence reports and Customizing development intelligence reports, as well as the information on Jazz™.net, to help you determine how to build the reports.

Using the data dictionaries to author document-style reports

Live data from the applications can be incorporated into document-style reports using a reportable REST API, which serves as an intermediary between the application data and the live report.

Use the data dictionaries for reference and use the information on Creating document-style reports and Customizing document-style reports, as well as the information on Jazz.net, to help you determine how to build the reports.

The REST API is used to retrieve application information when reports are run and also when data collection jobs are run. It is designed to work with a broader context than just CLM, so some of the terms that are used in the REST API schema are not specific to CLM.

For example, work items from the Change and configuration management (CCM) application can be retrieved by a report that is also retrieving data onchange requests from Rational ClearQuest.

Content on Jazz.net is governed by the Jazz.net Terms of Use and is provided as is without warranties of any kind.

Explanation of columns in the data dictionaries

Each column in the data dictionary is useful depending on what you are trying to accomplish. For example:
  • If you are authoring a live report, reference the information in the UI Element and UI Field columns to find the data that you want to report on, then use the REST API Resource and REST API Property path to determine the resource URL that you must add to the report definition or document template.
  • If you are authoring a data warehouse report, reference the information in the UI Element and UI Field columns to find the data that you want to report on, then use the FM Model Path, FM Model Query Subject, and FM Model Query Item to determine which queries to add to your report definition and where to find them in Report Studio or Query Studio.
In the full dictionary, the columns flow from left to right in a similar way that the data flows in the data flow process:
  • Input or automatic creation of application data to
  • Output from REST API to
  • XML data configuration (XML to JDBC) mapping to
  • Data warehouse operational data store (ODS) mapping to
  • Metadata model (FM Model) representation, as seen in Report Studio and Query Studio to
  • Report output.
Table 3. Sample input and output columns
Column name Description of contents
Sample input In future releases, this will contain sample input values for relevant mappings. They will be examples from the Money That Matters sample.
Sample output In future releases, this will contain sample output values for relevant mappings. They will be examples from the Money That Matters sample.
Table 4. Application data: UI element and field
Column name Description of contents
UI Element The application artifact. Unless otherwise specified in thes dictionary, UI elements map directly to a REST API Resource; a data warehouse table; and a FM Model Query Subject.

For example, CCM "Work items" are expressed by the REST API Resource URL as "Request"; are stored in the data warehouse "REQUEST" table; and can be added to report definitions using the "Request" Query Subject and related Items.

UI Field An attribute of the UI element, often a visible field in the element. The values for these fields can be entered by users or specified automatically by the process based on a variety of factors. Not all rows have a specified UI Field because some artifacts are automatically generated without user input.

For example, a user creates a test plan and names it "Test plan 1". The name "Test plan 1" is user-specified in the Name field and stored in the data warehouse in the TESTPLAN table, NAME column. The creation date is not a field that the user can input a value for, but a create date is automatically assigned when the test plan is created and that information is stored in the data warehouse in the TESTPLAN table, CREATION_DATE column.

Table 5. Output from REST API
Column name Description of contents
REST API Resource The value provided in the REST API Resource URL. REST API Resources often correspond directly to UI elements, but the names of resources do not always correspond to the names of the elements.
REST API Property Path Path used in the resource REST API Resource URL to specify a property to retrieve data for.
Table 6. XML data configuration (XML to JDBC) mapping
Column name Description of contents
XDC Resource In the Data Mapping tool, this is the resource that you must navigate to in order to locate the mapping table.
XDC Data Mapping Table In the Data Mapping tool, within the XDC resource, this is the name of the data mapping table that you must navigate to in order to find the corresponding information or to find the column name.
XDC Column Name In the Data Mapping tool, within the XDC resource and the Data Mapping Table, this is the name of the column where the corresponding data is mapped to.
Table 7. Data warehouse operational data store (ODS) mapping
Column name Description of contents
Data Warehouse Schema The signifier of the data warehouse database where the information is stored. This is expressed as a variable because the database can be anything that you specify it to be during data warehouse configuration.
Data Warehouse Table The table in the data warehouse where data is stored for the corresponding application information. Tables often correspond directly to UI elements, but the names of tables do not always correspond to the names of the elements. Tables often correspond directly to FM Model Query Subjects and the names usually correspond as well.
Data Warehouse Column The column, within a table, in the data warehouse where data is stored for the corresponding application information.
Table 8. Metadata model representation, as seen in Report Studio and Query Studio
Column name Description of contents
FM Model Path The path in the FM Model, as depicted in the Report Studio or Query Studio UI, where you can find the Query Subject and Query Item.
FM Model Query Subject FM Model Query Subjects often correspond directly to UI elements, but the names of Query Subjects do not always correspond to the names of the elements. FM Model Query Subjects often correspond directly to tables in the data warehouse and the names usually correspond as well.
FM Model Query Item The item, within a Query Subject, in the FM Model that calls corresponding application data.
Table 9. Description of mapping
Column name Description of contents
Description Details about the mapping identified in the row. Often explains what you can expect to see in the output when the data in this row is included in a report.
Table 10. Changes in this release
Column name Description of contents
Changes in 4.0 Changes in the mapping relationship (ex, schema XDC mapping, etc) from version 3.x to version 4.0 and potential impact on reporting.


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