Custom Field Cleanup & Where-Used for Jira

What the app does

The app has seven pages: Overview, Fields, Explorer, Cleanup, Audit log, Trash and Settings.

• Overview: scan status (state, progress, last scan, objects, points, failed steps), coverage, the “Run scan” button, findings tiles, and a field-limit meter. The meter shows custom fields per company-managed project as a percentage of Jira’s 700-field limit. Team-managed projects show “n/a”.
• Fields: a sortable, filterable table of custom fields, with CSV export of all rows or the filtered rows.
• Explorer: search for a field by name or ID, and see its detail and reverse detail.
• Cleanup: a candidate list, a dry run, and “Move to trash”.
• Audit log: a read-only list of cleanup actions.
• Trash: trashed fields, with “Restore”.
• Settings: the points cap per rolling hour, which limits how fast a scan calls Jira.

A scan reads custom and system fields, field contexts, screens and tabs, screen schemes, issue type screen schemes, field configurations and schemes, workflows, workflow schemes, statuses, projects, saved filters (JQL), boards, dashboards and gadgets. System fields are shown only as references. They are never findings.

Install the app

1. Install Custom Field Cleanup & Where-Used for Jira on your Jira Cloud site from the Atlassian Marketplace.
2. In Jira administration, open Apps, then open Custom Field Cleanup & Where-Used for Jira.

The app is paid via Atlassian. Without an active licence, the app shows only a “Licence needed” screen, and scans, dry runs, trash, restore and CSV export do not run.

Run a scan

Open Overview and select Run scan. The scan runs in the background, and Overview shows its state and progress. Only one scan runs at a time: if you select Run scan again while a scan is running, the app tells you a scan is in progress.

How long a scan takes depends on the size of your site and on the points cap in Settings. When the scan reaches the cap for the rolling hour, it waits, then continues.

Coverage on Overview shows what the scan could see. Private filters and dashboards owned by other users may be missing.

Read the Fields page

The Fields table has one row for each custom field, with these columns: name, type, status, deletion confidence, issues with values, last value set, screens, and JQL references. Sort and filter the table, then export all rows or only the filtered rows to CSV.

• Unused: the field has no values and no references.
• Stale: the field has values, and the last change is older than 12 months.
• Duplicates: a “(migrated)” suffix pair, or field names that are at least 95% similar.

Other statuses are Unknown and OK. Deletion confidence is a number from 0 to 100, shown with the evidence behind it. A score is not a guarantee. Check the evidence and the dry run before you remove a field.

Read the Explorer page

Search for a field by name or by ID. The field detail shows where the field is used. The reverse detail lists referenced fields and referenced statuses.

Run a dry run

Open Cleanup and select fields from the candidate list. You can select up to 50 fields. Team-managed fields and locked fields cannot be selected.

Then run the dry run. It shows:

• the selected fields;
• the screen placements that will be removed;
• issues with values, which will be hidden, not lost;
• references that will break, in saved filters, boards and dashboards;
• a notice of what is not checked.

A dry run changes nothing in Jira.

Move fields to trash, and restore them

After the dry run, select Move to trash. This needs the Administer Jira global permission. Other users can see the dry run, but cannot move fields to trash. The app never deletes a field permanently. It only moves fields to Jira trash.

To undo, open Trash, find the field, and select Restore. Restore also needs Administer Jira. Jira keeps trashed fields restorable for 60 days, independently of this app. Restore a field within those 60 days.

Audit log

Every move to trash and every restore is recorded. The Audit log page lists these records. Each record has the acting admin, the time, the action and the fields. The list is read-only. Records cannot be edited or deleted from the app.

What is not checked

The app does not check automation rules, scripts, or other apps’ data. Check them yourself before you move a field to trash.

Data residency

• In scope for data residency: all app data in Forge SQL (the account IDs, Jira configuration copy, findings, settings and audit log described in the privacy notice).
• Out of scope: the Forge logs described in the privacy notice, and processing at the moment a page is viewed. Atlassian may sometimes run the app’s code from a region other than your site’s.

All app data is stored in Forge SQL, hosted by Atlassian, and follows your Jira site’s data residency location. Nothing is stored outside Atlassian. When you uninstall the app, the app can no longer read its data. Atlassian keeps the data in a soft-deleted state for 28 days and then deletes it. If you reinstall the app and want the earlier data back, ask us within 21 days of uninstalling. With your consent, we will ask Atlassian to re-link it to your new installation. After that, it can’t be recovered. We never hold a copy of the app’s data.

Privacy

Read the Custom Field Cleanup & Where-Used for Jira privacy policy for what the app stores, what is logged, and how data is deleted.

Terms and security

Read the Custom Field Cleanup & Where-Used for Jira end user terms and the Custom Field Cleanup & Where-Used for Jira security page.

Support

Email contact@neirfeno.com.