Data dictionaries for reporting

Report authors can access theIBM® Engineering Lifecycle Management (ELM) data through the data warehouse or access live data from the applications using reportable REST APIs. The application-based data dictionaries in this section show how elements map to artifacts in Engineering Lifecycle Management.

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

Using the data dictionaries to author document-style reports

Live data from the applications can be incorporated into document-style reports in IBM Engineering Lifecycle Optimization - Publishing by 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 REST API documentation on Jazz.net, to help you determine how to build the reports.

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

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®.

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, use 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.
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
  • Report output.
Table 1. Application data: UI element and field
Column name Description
UI Element The application artifact. Unless otherwise specified in the dictionary, UI elements map directly to a REST API resource or a data warehouse table.

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 can be entered by users or specified automatically by the process based on various 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 2. Output from REST API
Column name Description
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 3. Data warehouse operational data store (ODS) mapping
Column name Description
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 you specify during data warehouse configuration.
Data Warehouse Table The table where data is stored for the corresponding application information. Tables often correspond directly to UI elements, but the table names do not always correspond to element names. Tables and their names often correspond directly to FM model query subjects.
Data Warehouse Column The column within a table in the data warehouse where data is stored for the corresponding application information.
Table 4. Description of mapping
Column name Description
Description Details about the mapping identified in the row. The description often explains what you can expect to see in the output when the data in this row is included in a report.

video icon Video

Jazz.net channel
Software Education channel

learn icon Courses

IoT Academy
Skills Gateway

ask icon Community

Jazz.net
Jazz.net forums
Jazz.net library

support icon Support

IBM Support Community
Deployment wiki