Audit tab
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.
Rules
Unused 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:
- on any screen
- in any of the saved filters
- in any workflow
- in any webhook
- in any notification scheme
- in any issue security scheme
- in any permission scheme
In addition, there should not be any issues in which this field would contain a value stored in the database or in the search index.
Please note that this rule will work for a field that is calculated but not indexed. Some of these fields may actually be used. If you find a field like this, just disable the rule for it.
Lost fields
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 provided 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.
Duplicate Field Names
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.
Field description contains HTML/JS
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.
Field name contains leading/trailing spaces
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.
Empty description
Field description makes instance administration more efficient.
Field name begins with lowercase
Capitalize your field name.