Integrity Check

Owned by Rosen Marinkov
Last updated: Sept 19, 2023 by Stanley Neychev
4 min read

On this page:

Overview

Configuration Manager for Jira provides you with the ability to find and resolve any errors in the configuration of your Jira instance.

This can be achieved by using the Integrity Check feature. The Integrity Check detects missing objects which are referred by other objects in the configuration, for example (but not limited to):

  • References to missing custom fields, groups, and users in workflows (conditions, validators, post functions)

  • References to missing users and groups in project roles

  • References to missing events

  • etc.

You can run Integrity Check for your whole Jira system (system scope), for selected projects or just for the last failed snapshot (snapshot scope). Learn more about the different Integrity Check scopes in the next section.

Integrity Check verifies the consistency of all supported objects listed in this document.

If your instance contains integrity errors, you'll not be able to create or deploy snapshots that have errors within their scope. E.g. if a missing workflow is detected on the system, and a project does not use this workflow, you can still create a snapshot of this project.

Run Integrity Check

Integrity check allows you to find and resolve errors in your Jira instance’s configuration.

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 Scope, Project Scope, or Snapshot Scope.

  5. Choose integrity check options: Check all filters, 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 choose). 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 scopes:

  • 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 want 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.

Integrity error details

When Integrity Check detects errors in your Jira configuration, it shows a list with the detected violations. You can click on each violation to learn more about the configuration problem by reviewing its details. Integrity Check for Jira shows the error location and a link to navigate to the object directly.

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 that there is a reference to a missing object. The Details section shows the path to the missing object.

The details show the path to the missing object - in this case, this is the filter "Documents Impacted", which uses a query, which in turn refers to a missing custom field with the name Documents Impacted.

The Solution section describes how integrity errors can be resolved.

The name shown in each box in the path is a link to the object in the Jira admin UI, so you can easily navigate and fix the problem.

Integrity error types

There are different error types you can detect and resolve with Integrity Check. For more information about the kind of errors detected by Integrity Check, visit Integrity Error Types.

Integrity check quick-fix actions

Integrity Check gives you effective tools to fix detected configuration errors automatically. For the most common problems you might face in a Jira configuration, the app offers you so-called quick-fix actions. These quick fixes allow you to resolve configuration problems with a single click.

For more information about the Integrity Check quick fix and a list of supported problems, visit Quick Fix.

What is the effect of running the Integrity Check on Jira Data Center cluster performance?

Jira Data Center allows you to run a cluster of multiple Jira nodes providing stable performance under high load. The Integrity Check’s operations always run on a single node. This is the node where the user is logged in currently and starts the check from.

Running Integrity Check on a single node ensures that your Jira performance across all other nodes remains stable and no slowdowns in response time occur. Your Jira performance will be affected only on the node where Integrity Check is running.