Troubleshooting the Jazz Reporting Service

This page is the starting point to find information and techniques that you can use to diagnose and troubleshoot issues related to reporting, Lifecycle Query Engine (LQE), Data Collection Component (DCC), Report Builder (also know as JRS - Jazz Reporting Service). This page is expected to be used by administrators of IBM Engineering Jazz Reporting Service as supplemental guidance to the IBM Documentation.

IBM Engineering Jazz Reporting Service users should use the IBM Support Jazz Reporting Service 101 which contains links to News; Must gathers; Technical Notes; JRS video tutorials; and more.

Where is the issue?

Reporting issues usually involve multiple products. For example, when a report shows incorrect or stale data:

• is it an issue with the query in Report builder?
• is it an issue with the datasource within LQE or DCC
• does the application expose the right data to LQE or DCC?
• is the TRS provider (ELM application) correct and up-to-date?

If the following guidance does not resolve your issue, then refer to the following mustgathers:

• Mustgather: Investigating problems with wrong data available in LQE data source
• MustGather: Investigating Invalid updates in Lifecycle Query Engine data source
• Mustgather: Investigating LQE or LDX performance problems
• MustGather: Investigating skipped resources in Lifecycle Query Engine data source

Once you have collected this data, raise a case with IBM Support, who will assist you.

Troubleshooting Report Builder

• Troubleshooting Report Builder provides links to the following topics:
  • Repairing reports with missing artifact types or parameters. You can replace missing or renamed artifact types or parameters from other IBM Engineering Lifecycle Management applications in Report Builder.
  • Report Builder log files. If errors or exceptions occur while you use Report Builder, log files and application logging help you research and resolve the issues.
  • Troubleshooting the error in exporting the report to Microsoft Word, PDF, or HTML. If the exported report returns an empty .zip folder and you get the SSL Handshake error in the log file, consider the following solution.
  • Run the report with data completeness check enabled. You can use Data completeness check to verify whether a specific report has problems.
  • Resolving a corrupt database error. Every six hours a backup mechanism in Report Builder verifies that the Jena TDB database can be read, and creates a backup copy. If the database cannot be read, an error occurs.
  • General troubleshooting tips. You might not be able to view the latest enhancements or fixes in Report Builder, when you upgrade or apply a patch to Jazz Reporting Service (JRS).

Lifecycle Query Engine issues

Configuration aware reporting Troubleshootingcovers many of the known issues for those who use Lifecycle Query Engine for reporting on configurations.

• Reindex operations
  • What to check before requesting a reindex on a LQE or LDX datasource
  • Reasons and considerations for reindexing all datasources again
• How can I make sure the set of data from a data provider is complete in LQE/LDX?
• What can happen from the Data Provider (TRS)?
• What can happen fetching resources identified by TRS?
• In a configuration-aware report, what controls which artifacts are within scope?
  • Report Builder - Data Completeness Checker
  • Run the report with data completeness check enabled
• What can be done to check that selection resources are correct?
• LQE status information

Validating the applications (TRS providers)

One of the mechanisms available to administrators, if their users' reports are inconsistent is to validate the TRS provider. Each application that provides a data source to LQE, will have a way to validate that what is being presented to LQE is consistent. For more information on validating data providers, see the What can happen from the Data Provider (TRS)? link and also the IBM documentation:

• Validating TRS feeds and the Lifecycle Query Engine or Link Index Provider index
• Validating the TRS providers, Jazz Team Server, Engineering Workflow Management, Rhapsody Model Manager, Engineering Requirements Management DOORS Next, Engineering Test Management, and Global Configuration Management

There are additional pages for advanced troubleshooting the validation output from the applications. TRS Validation explains how to deeper investigate issues that have been reported previously, including how to set verbose logging.
DOORS Next has an application-specific troubleshooting page that address issues reported with both modes of TRS validation with DOORS Next.
Log-based TRS provides further information on the process of switching to the new mode of TRS processing with DOORS Next.

LQE rs

There are specific steps to graduating from LQE (Jena store) to LQE (relational store). The IBM documentation Working with Lifecycle Query Engine relational store reports is your starting point for this. The topics covered within that document are:

• Making reports available in Report Builder
• Editing queries to create advanced reports
• Converting a SPARQL query to an SQL query in Report Builder
• Manually converting SPARQL to SQL Resources
• Comparing query results between SPARQL and SQL

Database sizing for LQE relational store provides guidance for sizing database servers that host the Lifecycle Query Engine - Relational store (LQE rs) application.

Data Warehouse Data source

Troubleshooting Data Collection Component is the starting document for Data Warehouse issues.

• Data warehouse records are missing for a project area
• Data warehouse reports are showing links to deleted artifacts

For further troubleshooting guidance, technical notes on issues or details of Known Issues, visit the Jazz Reporting Service 101 page.

Additional Log4j traces

Prior to versions 7.0.1 SR1 / 7.0.2 SR2: here are some traces that can be added in log4j.properties per product

For versions 7.0.1 SR1 / 7.0.2 SR2 and beyond: traces are to be added in log4j2.xml per product

• Report Builder

• Lifecycle Query Engine
• Data Collection Component

Other scenarios

Related topics: Deployment web home, Deployment web home

External links:

• IBM, IBM Support Jazz Reporting Service 101

Additional contributors: TWikiUser, TWikiUser