TrackerDiffRecalculation
 |
For a general, step-by-step guide on using the corrector module, see Using the Data Inconsistency Corrector Module.
|
Description
This correction detects and automatically corrects inconsistencies in tracker configuration inheritance.
In Codebeamer, a derived tracker can inherit some or all of the configurations of its template tracker. A special data structure, called the tracker-diff, stores the differences between template trackers and their derived trackers. Every derived tracker has its own tracker-diff, which stores the tracker configurations that are not inherited from the template tracker by the derived tracker.
An entry in a tracker-diff indicates that inheritance for a tracker configuration has been broken, that is, that configuration is not inherited by the derived tracker when a change is made to the template tracker. Tracker-diffs are checked when a change is made to the template tracker, and the changes to configurations with an entry in the tracker-diff are not propagated from the template tracker to the derived tracker.
Errors can sometimes cause tracker configurations to be inherited incorrectly, that is, some configurations may not be inherited when they should be, or are inherited when they should not be.
Clicking Detect recalculates tracker-diffs by comparing template trackers to derived trackers.
Clicking Restore overwrites the previous tracker-diffs (contained in the persisted_tracker_diff column of the report table) with the corresponding recalculated tracker-diffs (contained in the recalculated_tracker_diff column of the report table).
Report Table
The report table for the TrackerDiffRecalculation correction is named tracker_diff_recalculation_report_table. It contains the following information:
|
Column
|
Description
|
|---|---|
|
id
|
The ID number for the detected issue.
Detected issues are numbered, starting at 1.
|
|
project_id
|
The ID of the project that contains the tracker where the issue was detected.
This is the project that contains the tracker with the incorrect tracker-diff.
|
|
project_name
|
The name of the project that contains the tracker where the issue was detected.
This is the project that contains the tracker with the incorrect tracker-diff.
|
|
tracker_id
|
The ID of the tracker where the issue was detected.
This is the tracker with the incorrect tracker-diff.
|
|
tracker_name
|
The name of the tracker where the issue was detected.
This is the tracker with the incorrect tracker-diff.
|
|
template_id
|
The ID of the template tracker.
|
|
template_name
|
The name of the template tracker.
|
|
persisted_tracker_diff
|
The incorrect tracker-diff of the derived tracker, in JSON format.
|
|
recalculated_tracker_diff
|
The recalculated tracker-diff of the derived tracker, in JSON format.
|
|
additional_diff_in_persisted_diff
|
Items contained in the persisted_tracker_diff column that are not contained in the recalculated_tracker_diff column, in JSON format.
|
|
additional_diff_in_recalculated_diff
|
Items contained in the recalculated_tracker_diff column that are not contained in the persisted_tracker_diff column, in JSON format.
|
|
flag
|
The flagged status of the issue, which can be 0 or 1. Clicking Restore corrects issues with a flagged status of 1.
For more information, see the Flagging and Processing Inconsistencies page on the Codebeamer Help Center.
|
|
processed
|
The processed status of the issue, which can be 0 or 1.
For more information, see the Flagging and Processing Inconsistencies page on the Codebeamer Help Center.
|
Changes to Tracker-Diffs While the Correction Is Being Used
Derived trackers can change while the corrector module is in use. For example, this may happen if a derived tracker is changed in the system after clicking Detect in the TrackerDiffRecalculation correction but before clicking Restore.
In this case, changes made to the tracker after clicking Detect are not lost after clicking Restore. These changes can be detected by running the TrackerDiffRecalculation correction again. You can run the correction again by clicking Reset, and then clicking Detect. This recalculates tracker-diffs again, including any new changes.
To avoid this situation, it is recommended to use the TrackerDiffRecalculation correction when the affected trackers are not being changed, for example, outside standard operating hours.