On this page:

Welcome to Integrity Check for Jira

Integrity Check for Jira is a Jira app that helps you identify and resolve any configuration errors in your Jira instance. It is available as a standalone app and as a feature bundled with Configuration Manager for Jira.

Its goal is to identify, report, and resolve Jira configuration problems, which prevent users from performing their day-to-day activities. For example, users might have broken filters referring to missing configuration elements like custom fields. In this case, the Jira users won't be able to view the issues matching the filter.

Resolving the configuration errors in your Jira also helps improve the performance and efficiency of the entire system.

When Integrity Check is used as part of Configuration Manager, it allows you to find and resolve the problems with your Jira configuration, which prevents you from creating or deploying Configuration Manager snapshots.

Detect configuration errors in Jira

Integrity Check detects missing elements which are referred to by other elements in the Jira configuration, for example (but not limited to):

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

  • References to missing custom fields, groups, or users in JQL queries.

  • References to missing users and groups in project roles.

  • References to missing events.

Integrity Check verifies the consistency of all supported objects in a Jira configuration, including filters, agile boards, and dashboards.

With this app, you can run integrity checks either on the whole Jira system (System scope), selected projects (Project scope), or on the last failed snapshot (Snapshot scope, available only with Configuration Manager).

Learn more about the different integrity check scopes in the next section.

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 the configuration integrity errors in your Jira 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 a project or several projects in your Jira without running a check on the entire configuration.

  • Snapshot Scope (only with Configuration Manager) - When using Integrity Check as part of Configuration Manager for Jira, you can use one more scope called snapshot scope. The snapshot scope allows you to run an integrity check on the last failed Configuration Manager snapshot. Choose Snapshot Scope on the Integrity Check page and discover the root causes of configuration errors in failed snapshots.

If your instance contains integrity errors, you'll not be able to create or deploy Configuration Manager snapshots that have errors within their scope. However, if Integrity Check detects a missing workflow on the system that is not used by a particular project, you still will be able to create a snapshot of this project.

Integrity errors and quick fixes

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. In addition, integrity Check for Jira shows the error location and a link to navigate to the object directly.

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

Quick fix actions

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

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