User's Guide

On this page:

Run Integrity Check

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

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

To run Integrity Check:

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

  2. Choose the cog icon at the top right of the screen, then choose Configuration Manager.

  3. Select Integrity Check to open the Integrity Check page.

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

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

  6. Click the Run Integrity Check button.

Performance impact

Suppose you decide to check the integrity of all filters in your Jira or in the last failed Configuration Manager snapshot (depending on the scope you've chosen). In that case, the option Check all filters can make the integrity check process slower depending on the filters' quantity and complexity.

Integrity check scopes

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

  • System Scope - System scope allows you to run an integrity check on your Jira instance's entire configuration. You can find and resolve all configuration integrity errors on your whole system.

  • Project Scope - 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 - if you would like to run the Integrity Check just for the last failed snapshot, choose Snapshot Scope on the Integrity Check page. This way, you can find the root cause of configuration errors in failed snapshots. This scope is available only when you use Integrity Check as part of Configuration Manager for Jira (CMJ), and not as a standalone app.
    Learn more about the use cases and benefits of running a snapshot scope integrity check.

Integrity error details

Each error detected has a Summary and Details sections in Integrity Check. In the summary, you can view the type and description of the error.

When Integrity Check detects errors in your configuration, it shows you the error type and its description. When clicking on each error, you see the Details, Solution and Location sections.

For example, an error of type Missing Object shows a reference to a missing object. The details show the path to the missing object - in this case, this is the agile board IM Board, which uses a query, which in turn refers to a missing custom field with the name Estimation. The Details section shows the path to the missing object.

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

Locate configuration elements in Jira

The name shown in each box in the Location section is a link to the configuration element in the Jira’s administration UI, so you can quickly locate and fix the problem.

Integrity error types

With Integrity Check, you can detect and resolve different configuration errors in your Jira. 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.

Integrity Check quick-fix actions

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

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