DATA CENTER AND SERVER | CLOUD

Checking the Database Integrity

Owned by Marcel Patzschke
Last updated: Nov 18, 2024 by David SedlockVersion comment
3 min read

Overview

Since easeRequirements extends the Data Model of Jira it also comes with an additional integrity checker.

The integrity checker searches for common data inconsistencies in the easeRequirements data and attempts to keep the data in a consistent state. It also comes with a repair function which, in case of errors, attempts to reset the data to a stable state.

Performing Integrity Checks

  1. Navigate to the Integrity checker page.

    1. Login as Jira Administrator.

    2. Choose Cog icon > Manage apps.

    3. Select easeRequirements > Integrity Checker from the sidebar.

  2. Select one or more items whose data you would like to check the integrity of.
    If executing the integrity check after an upgrade, “Select all“ is recommended.

  3. At the bottom of the page, select the Check button to execute the integrity check.

  4. Once the integrity checker has finished processing, the result will be shown.
    The result contains passed test as well as information about the found inconsistencies.

    1. If all checks passed, proceed to the next step.

    2. If there are failed results, select the Fix button to correct the inconsistencies.

There are other integrity checks available but are typically only ran when issues in the specific area is encountered that cannot be fixed by the General checks.

  1. Find Duplicate Tree Items - run when there are errors or inconsistencies in a specific project tree.

  2. Find Invalid Baseline Revisions - run when there are errors or inconsistencies in a specific project’s baselines.

  3. Find References of Deleted Project(s) - run when there have been projects deleted in the instance to avoid failures on pages with data associated to the deleted projects.

Repeat steps 3 and 4 when executing these integrity checks.

Important: It is strongly recommended taking a backup before trying to correct any inconsistencies.
If you chose to correct any inconsistencies, you will be presented with the result of the actions that have taken place.

Available Integrity Checks

General

Check Folder & Issue References

  • Check for issues that have been added to a folder but do not exist anymore

  • Check for parent issue and child issue references

  • Check for discrepancies in folder references

  • Check for discrepancies in requirement paths

  • Check for discrepancies in project tree structure

Check Add-on Configuration

  • Check revision blacklist for fields that are unsupported or have been deleted

  • Check reuse configurations for fields and link types that have been deleted

  • Check suspect configurations for projects and fields that have been deleted

  • Check baselines and issue revision history for projects that have been deleted

  • Check project categories that have been deleted

Check Add-on Permissions

  • Check global permissions for groups and projects that have been deleted

  • Check project permissions for groups and projects that have been deleted

Check Suspect Links

  • Check for issue links that have been set to suspect but do not exist anymore

Check Automatic Issue Import Configurations

  • Check for automatic issue import configurations whose projects do not exists anymore

  • Check for automatic issue import configurations whose users do not exists anymore

  • Check for automatic issue import configurations that are non-existent in easeRequirements and Jira tables in the database V4.20

Specific

Find Duplicate Tree Items

  • Check for issues that have been added to the same project more than once

Find Invalid Baseline Revisions

  • Checks for empty and inconsistent baseline revision history data that may result in discrepancies in baseline details display

Find References of Deleted Project(s)

  • Check for references of deleted projects across all easeRequirements data