Validating TRS feeds and the LQE index
About this task
- A report is missing artifacts.
- A report includes outdated (stale) artifacts.
- A report shows the same artifact more than once, possibly with different attribute values or with its old and new name.
- An application view and a corresponding report in Jazz® Reporting Service show a different number of artifacts.
- A report includes deleted artifacts.
- LQE shows skipped resources.
- Validating a TRS feed compares the current TRS feed to the data in the application repository.
- Validating the LQE index compares the current TRS feed from a Rational® solution for Collaborative Lifecycle Management (CLM) application with the LQE index.
Validate these items when server usage is low, such as during a scheduled maintenance window.
For more information, go to this Jazz.net article.
For a description of TRS feeds in CLM, see Adding Tracked Resource Set feeds for lifecycle management applications.
Jazz Team Server, Rational Team Concert, Rational Quality Manager, and Global Configuration Management
Before you begin
- When you run validation, you must have at least 1 GB of free disk space for each set of 1 million test artifacts in your repository (including planning and execution artifacts, such as test plans, test cases, test scripts, test script steps, test execution records, test execution results, test execution result steps, test suites, test suite execution records, and test suite execution results).
- If you want the validation tool to automatically fix any discrepancies, go to the
Advanced Properties administration page at
https://host:port/qm/admin, and change
the
Automatically resolve discrepancies
option for thecom.ibm.rqm.oslc.trs.validator.TRSValidationWatchdog
property totrue
.Ensure that you configure this advanced property before you start the validation process.
If you don't configure this property, you can compare and resolve discrepancies by using the cleanDifferences option in the TRS Validator.
About this task
- JTS User Resources: This feed contains information about Jazz Team Server (JTS) users. If a report about system users isn't showing the expected results, and you confirm that 10 users are registered in the repository, the validation task checks whether the TRS feed has 10 distinct references to users.
- RTC Process Resources: If a report doesn’t show the project areas, team areas, or iterations that you expect, the validation task can help you determine whether they are missing from this TRS feed. If a user runs a report that doesn't include artifacts from a project that the user belongs to, TRS feed validation can fix the permission problem. After the validation, the report shows all the expected data.
- GCM Resources: This feed contains information about changes to global configurations, for example, when they were created, updated, or deleted.
Procedure
What to do next
If the problem persists, ask an LQE administrator to validate the LQE index.
Rational DOORS Next Generation
Before you begin
-
Important:
- Watch the Rational DOORS Next Generation Reporting Tool video, which explains how to configure and run the validation tasks, and repair data (Adobe Flash is required).
- If possible, consider running this task when system usage is low, such as during a scheduled maintenance window.
- Install the latest Rational solution for Collaborative Lifecycle Management interim fix from IBM Fix Central.
- Contact IBM Support to get the link to the Rational DOORS Next Generation Reporting Tool portal and install the tool as described in the Setting up the Rational DOORS Next Generation Reporting Tool section of the wiki page.
- Find and resolve skipped resources as described in the Retrieve the Rational DOORS Next Generation versioned resources section of the wiki page. This task isn’t mandatory but skipped resources will generate errors in the validation report.
Procedure
Lifecycle Query Engine
Before you begin
- If you upgrade from 6.0.6 or an earlier version, a migration task creates a new partition that is used for validation and shortens reindexing time. This process might take some time.
- If you upgrade from any earlier version, add the following properties to the
JazzInstallDir/server/conf/log4j.properties file to ensure
that your validation logs use the latest format.
# Validation Task log4j.logger.com.ibm.team.integration.lqe.lib.indexer.tasks.ValidationTask = info, lqeValidationTaskLog log4j.additivity.com.ibm.team.integration.lqe.lib.indexer.tasks.ValidationTask=false log4j.appender.lqeValidationTaskLog=org.apache.log4j.RollingFileAppender log4j.appender.lqeValidationTaskLog.MaxFileSize=10MB log4j.appender.lqeValidationTaskLog.MaxBackupIndex=5 log4j.appender.lqeValidationTaskLog.File=logs/lqe-validation.log log4j.appender.lqeValidationTaskLog.layout=org.apache.log4j.PatternLayout log4j.appender.lqeValidationTaskLog.layout.ConversionPattern=%d{ISO8601} [%30t] %5p %-50.50c - %m%n
About this task
CLM application administrators might ask you to validate the LQE index after they validate TRS feeds.
- Run this task when system load is low. The time required for validation depends on the size of the index.
- Don’t validate all the TRS data sources at the same time. Validate large data sources on separate days.
- Validate only one TRS feed for one data source (CLM application) at a time. For CLM applications that have more than one TRS feed, run a separate validation for each feed.
- Administrators can run LQE validation on a regular basis to confirm whether the LQE data has been kept in sync with the TRS feed from the data source. For example, if you run weekly validation and resources of the same type are logged as missing, you should check the data-providing application. You might need to change or configure a setting in that application. If the validation task runs for a few months without reporting any issues, you can extend the validation schedule. For example, you can run the task monthly.
To stop a validation that is running, restart the LQE server.
Procedure
Results
![Data source status link](../images/data_source_status.gif)
![Validation results on the data source status page](../images/lqe_validation_status_page.gif)
![Download logs button](../images/Data_source_status_logs_link.gif)
- Missing resources: These resources are included in the TRS feed but not in the LQE index. The validation process will fetch these resources again to resolve the discrepancy.
- Stale resources: The resources in the TRS feed are newer than the resources in the LQE index. The validation process will fetch these resources again to resolve the discrepancy.
- Extra resources: These resources are included in the LQE index, but not in the TRS feed. The validation process will delete these resources to resolve the discrepancy.
You can enable email notification for validation events. For details see Setting up email notification for Lifecycle Query Engine events.
If you still see discrepancies in the content of a report after validation, consider reindexing.
After you click Validate, no further changes are indexed for that data source. If you scheduled validation to run later, no changes will be processed from the moment you click the validation button, until the validation finishes.