New and important in version 4!
- The app has been renamed to Custom Field Toolbox
- The app page has moved: Cog -> System -> (TROUBLESHOOTING AND SUPPORT section) Custom Field Toolbox
- In the list of fields, the "Warning" icon and the "Used" column are now the "Unused fields" audit rule. The "Unused fields" rule is now disabled for fields that were marked as "used."
- In the list of fields, the "lost" label is now the "Lost fields" audit rule.
The ability to create custom fields makes Jira a powerful tool for managing workflows and allows you to create highly adapted objects for modeling your organization's work. However, too many custom fields can seriously degrade the performance of your Jira instance. Scaling tests show that the number of custom fields plays a crucial role in Jira performance.
Custom Field Toolbox for Jira - an app for Atlassian Jira that allows you to improve the performance of your Jira instance by optimizing custom fields. In addition, the app provides advanced information about custom fields for more efficient administration and customization of your instance.
A key feature of the app is an in-depth analysis of the use of custom fields in issues, as well as in various Jira configuration objects, such as screens, workflows, saved filters, etc. This analysis allows you to delete unnecessary fields without losing important information and side effects, and thus optimize your instance's performance.
Install the app via the Atlassian Marketplace or follow the standard installation process through the UPM. The app doesn't have any settings, so you can start using it right away.
The app page is at Cog -> System -> (TROUBLESHOOTING AND SUPPORT section) Custom Field Toolbox
The Fields tab allows you to review the use of custom fields in various Jira configuration objects, as well as get additional information about the fields themselves. The list of fields is displayed as a table with custom columns. Here is a list of all the columns (columns marked with asterisks are hidden by default):
You can filter and sort the table by almost any column. The table can be downloaded in CSV (comma separated) format.
To open .csv files with Excel, see MS doc
Click on the field name for more detailed information.
This page contains detailed information about the field and its use in your Jira configuration. Depending on the Jira configuration, the page may contain all or some of the following tabs:
The Project page contains a list of issues where this field is filled in, as well as the value of this field stored in the database. Issues are displayed in the list regardless of access settings, so it's possible that you will see the issue but not be able to access it.
The Audit tab is where you can get tips on optimizing the configuration of your instance's custom fields. An audit is conducted according to a number of rules. Each field is checked for compliance with each rule. Each rule represents one or more criteria that a field must meet in order to satisfy this rule. The rule can be disabled completely, or for individual fields.
Unused fields can negatively affect the performance of your instance, as well as make it difficult to administer. This rule shows the following fields.
In order to comply with this rule, the field must not be used:
In addition, there should not be any issues in which this field would contain a value stored in the database.
Please note that there may be situations in which this rule will work for a field that is calculated and actually used. If you find a field like this, just disable the rule for it.
Lost fields are what remains from deleted apps. In some cases, deleting the values of these fields may improve performance.
If you delete an app that proided a custom field type, the values of this field remain in the database for issues. Performance can be negatively affected if there are too many values like this.
The Custom Field Toolbox analyzes the database; if values are found in a custom field, even if the field type is not available, it is assumed that the "lost fields" rule has been applied to this field.
The presence of fields with the same name significantly complicates the setup and administration of the instance, and can also lead to errors during customization.
It is strongly not recomended to use HTML/JS customizations in custom field descriptions. It's hard to maintain, harder to get right and generally the wrong solution. If you insist on doing it, then building your own add-on is the only real way to do it.
Leading or trailing spaces of the field name can make it difficult to customize if there is a need to refer to the field by name.
Field description makes instance administration more efficient.
Capitalize your field name.
The Field Types tab contains a list of available field types in your instance. When you create a new field, you are prompted to select the field type from this list. Each type has a name, key, description, provider, category, and access. A field provider is an app that provides functionality for this field type. Apps can be supplied by third-party developers, or they can be embedded in Jira, depending on the package (Core/Software/Service Desk/Ops). For example, the Custom Field Types & Searchers provider is in all packages, while the JIRA Agile provider is only in Jira Software. If the Field Type is provided by a third-party app, it will not be available when the app is deleted.
See our Troubleshooting guide.