Adding, editing, and deleting a custom field

On this page

Still need help?

The Atlassian Community is here for you.

Ask the community

How to create a new custom field

  1. Select the Jira icon (, or ) > Settings > Issues.

  2. In the Fields section, click Custom Fields.
  3. Select Add custom field. Make sure to select All to view the available field options. 
  4. Select a field and click Next.
  5. Add the details for your field.
    Note that the name you select will appear as the custom field's title wherever the field appears. As shown below, the description will appear below the field when creating and editing issues, but not when browsing issues:

  6. When you have entered the field details, select Create.
     

tip/resting Created with Sketch.
Expand to check out tips for custom fields...
  • Create custom fields directly from an issueJira Admins can also create a custom field (or add an existing custom field) while viewing an issue by selecting Admin > Add field.
  • Limit the number of custom fields — Be careful how many custom fields you define in Jira. More than a thousand is a large number and may affect Jira's performance. For more information, see Scaling Jira.  
  • Use fields for reporting — Consider what reports are needed from Jira and only create fields that support those fields. Custom field types, such as select and multi-select are great for reporting. On the other hand, text fields are not as useful, since people don't always enter data as expected by the report's query.
  • Combine field content — If just want to make sure that someone remembers to enter some information, then consider a multi-line custom text field with a text template as a default value. You may also want to try using a "table grid" custom field which lets you enter data in a searchable table. The Atlassian Marketplace has add-ons that provide this kind of functionality. Note, the standard Jira fields such as Description do not currently support default values (see JRA-4812).
  • Don't duplicate names — Don't create new custom fields with the same name as other existing custom fields. Always check to see whether a custom field with the same name already exists before you create it. If you do, then choosing the correct field in JQL searches can become confusing for users. Also, don't create custom fields with the same name as the standard Jira fields. For example, having two "Status" fields is particularly confusing. 
  • Make names as generic as possible — Give custom fields non-specific names that can be reused in other places later on. For example, instead of naming a field "Marketing Objective", name the field "Objective", and provide a description in the field configuration that states the Jira projects where that field is used.

How to edit a custom field

  1. Select the Jira icon (, or ) > Settings > Issues.

  2. In the Fields section, click Custom Fields.
  3. Find the custom field you want to edit and click  > Edit to update the following:
    • The custom field name, which appears on issues 
    • The custom field description, which appears below the field on issues

    • Search templates, which are responsible for indexing a custom field and making the field searchable in basic and advanced issue search. Custom fields come with a default search template, so you shouldn't need to change this setting.

  4. Modify the fields as needed and click Update.
Note for changing the custom field description...

Jira allows you to define a description of a custom field. If the field configuration descriptions are left empty, then the original description text will appear when you create or edit an issue and as help text in the Issue Navigator. You can define different descriptions in each field configuration to override the description you added.

For example, if a custom field "My Field" is defined with a description of "This is my field" and no field configuration changes are made, then the displayed text will be "This is my field" as expected. If field configurations are used and a description "This is my excellent field" is set for the custom field in the field description, then the displayed text will be "This is my excellent field". 


How to associate your custom field with a screen

When you create your field, you'll see a list of screens that the field can be associated with. Your field will not appear on issues unless you select a screen. To have your field display on a screen, tick the corresponding box and select Update.

tip/resting Created with Sketch.

If you're using the new issue view, you can set which custom fields appear by configuring the view issue screen. Head to Project settings > Screens, expand the appropriate screen scheme, and select the "View issue" screen to configure it. Field order isn't configurable in the new issue view just yet.

How to delete a custom field

You may noticed some custom fields that were created by your Jira application. We highly recommend that you don't delete these, because you won't be able to get them back.


  1. Select the Jira icon (, or ) > Settings > Issues.

  2. In the Fields section, click Custom Fields.
  3. Find the custom field and click  > Delete to remove the custom field and any information entered in the field from all issues.
Last modified on Feb 5, 2018

Was this helpful?

Yes
No
Provide feedback about this article
Powered by Confluence and Scroll Viewport.