User's guide

Owned by Rosen Marinkov
Last updated: May 22, 2024 by Stanley Neychev
3 min read

On this page:

Run Integrity Check for Jira

Integrity Check for Jira provides you with the ability to find and resolve any errors in your configuration.

If your Jira instance contains integrity errors, you'll not be able to create or deploy snapshots.

To run Integrity Check for Jira:

  1. Log in as a user with the Jira System Administrator global permission.

  2. Navigate to the top right of the screen and choose Jira Settings > Configuration Manager.

  3. In the menu on the left, select Integrity Check.

  4. Choose System Scope, Project Scope, or Snapshot Scope (with Configuration Manager only).

  5. Choose integrity check options: Check all filters, Check all agile boards, and/or Check all dashboards.

    An image that shows where all the different scope checks are located.

  6. Click the Run Integrity Check button.

Performance impact

Be mindful that if you decide to run an integrity check on all filters in your Jira instance, then the process could be slower depending on the filters' quantity and complexity. The same goes for any other component Integrity Check inspects.

Integrity check scopes

You can run the Integrity Check app for three different types of configuration scopes:

  • System Scope - Allows you to run an integrity check on the entire configuration of your Jira instance. You can find and resolve all configuration integrity errors on your whole system.

  • Project Scope - Allows you to run an integrity check on the configuration of a single project or sub-set of projects. This way, you can quickly locate the errors in your project or several projects without running a check on the entire configuration.

  • Snapshot Scope - Allows you to run an integrity check on the last failed snapshot deployment. This way, you can find the root cause of configuration errors in your snapshots.

This scope is available only when you use Integrity Check for Jira as part of Configuration Manager for Jira (CMJ) and not as a standalone app. Learn more

Integrity error details

Each error detected has a Summary and Details section in Integrity Check.

When Integrity Check for Jira detects errors in your configuration, it shows you the error type and its description. In the Summary section, you can view the type and description of the error. When you click on each error, you see the Details, Solution, and Location sections.

The Solution section gives you instructions on how you can resolve the particular integrity error.

An image showcasing the Details, Solution, and Location sections in an integrity error.

Integrity error types

With Integrity Check for Jira, you can detect and resolve different configuration errors. For example, you can find missing or duplicate objects which cause integrity problems in your configuration. For more information on the errors detected by Integrity Check, visit Integrity error types.

Quick fix actions

You can quickly fix some of the most common integrity errors in your Jira system with automatic actions offered by the Integrity Check for Jira app. The actions are called quick fixes and are present in the Details section of an error.

You can learn more and find a list of the available quick fixes on the Quick fix page.

Â