Reporting on data in configurations with Report Builder
If you use local or global configurations, you can use Report Builder and Lifecycle Query Engine (LQE) to report on the data in the configurations, or on configurations themselves.
You can also report on global and local components. For example, list the configurations in the components of a project, or search by tags to see which components are part of a specific release.
Before you begin
Reporting on data in configurations is available, but with limitations. For more information, see Getting started with reporting by using Lifecycle Query Engine data sources on Jazz.net.
About this task
- You must use an LQE data source.
- Lifecycle Query Engine: For reporting on components and configurations themselves. Example: Report across all components and configurations in a configuration-enabled project area, as in these scenarios:
- Show all the components of a Car project.
- Show all the streams of the Engine component in the Car project.
- Show the artifacts (for example, test plans) in a stream of the Engine component.
If your report contains Artifact A in the results, and different configurations in the project area have different versions of Artifact A, your report contains information about all the versions.
- Lifecycle Query Engine scoped by
a configuration: For reporting on a specific global configuration, or on local
configurations that are not in a global configuration. When you run the report, you must choose a
configuration. Choosing a component is not mandatory. If you have a versioned type system, such as
for IBM Engineering Requirements Management
DOORS® Next (DOORS Next), see
Reporting on applications that have versioned type systems.Example: Report on artifacts in multiple projects in the same domain, such as showing all incomplete test cases assigned to you.
- Lifecycle Query Engine: For reporting on components and configurations themselves.
- Report Builder reports with the data source selected as Data warehouse do not contain information for the projects that are enabled for configuration management.
- BIRT-based reports are no longer available for the projects that are enabled for configuration management.
Procedure
What to do next
- To see your report in the list of other reports, click All Reports or My Reports.
- To further edit your report, click a pencil in the My Choices pane at the right. Click Save to save your changes.
- You can export your report to various document types (Microsoft Word, PDF, HTML). To do further editing on the report, export it to IBM Engineering Lifecycle Optimization - Publishing if you have a license. You can also export a report graph to an image file. See the related topics.
Step 1. Choose data
Procedure
Step 2. Format results
Procedure
- Format the results to determine whether to show the report as a table or a graph.
- Click Refresh to see a sample layout of your report. To see all the data, you must run the report.
Step 2a. Show the report as a table
Your report already has some columns, including columns for the attributes you created conditions for.
Procedure
Step 2b. Show the report as a graph
Report Builder picks the graph type based on your selections so far. Experiment to find the best graph type. Typically, line graphs convey trend information effectively, but you might find that a bar chart (stacked or grouped) works better with your data.
Procedure
Before you can preview a graph, you must select a value for the unit of measure. You can also select the dimension.
Step 3. Optimize the report
About this task
When you create a report, Report Builder generates the underlying query resource. If you are using Data Warehouse as the data source, an SQL query is generated. If you are using Lifecycle Query Engine, a SPARQL query is generated.
If you want to manually edit the generated query, see this topic. You can also generate alternate queries and optimize your reports based on your requirements.Procedure
Generate alternate queries by using the following options. To find what works best, try turning these options on and off. The options appear only when you select Lifecycle Query Engine or Lifecycle Query Engine scoped by a configuration as the data source.
- Select the Defer finding relationships with an alternative query checkbox to generate an alternate query that filters on source artifacts before finding relationships. Try this option if your data has one-to-many relationships in the Artifacts relationships section.
- Select the Defer scoping by projects with an alternative query checkbox to generate an alternate query that filters on artifacts first before scoping by projects. Try this option if your data has large number of projects in the 'Limit the scope section.
Step 4. Name and share the report
Procedure
Step 5. Run the report
About this task
You can use the dynamic Filters option to edit the configuration or conditions set for the report. When you clear dynamic filters, the default choices from the report, which include the conditions specified in the "Set conditions" section and the projects selected in the "Limit the scope" section, are retained.
To find out details about the logic behind the dynamic filters, read the topic Considerations for reporting on data in configurations.If you show the report as a table, you can add and change filters on columns by clicking the pencil icon.
- To change the filter values, click that icon.
- To see which filter values are applied, hover over the column name.
If Report Builder reports don’t show the artifacts that you expect, show artifacts more than once, or show a different number of artifacts than application views, ask an application administrator to validate the TRS feeds for the application. See Validating TRS feeds and the LQE index.
Run the report with data completeness check enabled
You can use Data Completeness Check to verify whether a specific report has problems. The Data Completeness Check feature is applicable for reports that use Lifecycle Query Engine scoped by a configuration as the data source. Problems that might affect the report results include skipped resources, missing resources, or resources with failed patches. If your reports do not show the artifacts that you expect, show artifacts more than once, or show a different number of artifacts when compared with the application, perform a data completeness check.
Before you begin
The Data Completeness Check option is not available on the Run report page by default. If you want to use this option, contact your system administrator.
- Add the enable.lqe.data.completeness.check.feature property in the JTS_install_dir/server/conf/rs/app.properties file.
- Set the property value as true.
- Restart the Report Builder server.