Documentation for JIRA 6.4 (This documentation includes the project navigation sidebar). Not using this? See below:
(JIRA 6.4 without sidebar documentation | JIRA 6.3.x documentation | JIRA Cloud documentation | earlier versions of JIRA)

Skip to end of metadata
Go to start of metadata

JIRA lets you add custom fields in addition to the built-in fields. When creating a custom field, you can choose between Standard and Advanced types. For standard types, a preview image is shown for each type, so you can see what you are creating in advance. This ensures that you get the custom field you want, much faster. To configure search templates or add contexts to custom fields, use the Configure option on each custom field.

JIRA ships with over 20 custom field types and you can find many more in the Atlassian Marketplace (e.g. the JIRA Toolkit). To build your own custom field types, see the tutorial at the JIRA Developer Documentation.

Custom fields are always optional fields. This means that you can create a new custom field without requiring existing issues to be changed. The existing issues will contain no value for the new custom field, even if a default value is defined.

Adding a field directly to an issue

JIRA Admins can add an existing field or create a custom field while in View Issue with the Admin > Add field option. You can even configure the options for that custom field without having to leave the screens you are presented with.

See this page for instructions on adding a field from View Issue: Adding a field to an issue.

Adding a field using the Add Custom Field button

  1. Log in as a user with the JIRA Administrators global permission.
    Choose > Issues. Select Fields > Custom Fields to open the Custom Fields page.
    (tick) Keyboard shortcut: g + g + start typing custom fields
  2. Click the Add Custom Field button. The following dialog is displayed:

    By default, this dialog displays the Standard, or most common, choices for custom fields. Click on the Advanced option in the left navigation or use the search box if you don't see the field you are looking for right away.
  3. Select a field and click the Next button.
  4. Configure the selection criteria for your field, as shown in the example below:

    (info) The Field Name will appear as the custom field's title in both entering and retrieving information on issues, whereas the Field Description is displayed beneath the data entry field when entering new issues and editing existing issues, but not when browsing issues.
  5. Click the Create button when you are ready. You will be presented with a dialog that displays your field, in context, and you can select the display options at this point:

    Anything you select here will be displayed in the issue you are editing.
  6. Click Submit to finalize the process. You will now see your new custom field and selected criteria displayed in the issue, as shown here:

Next steps

If you wish to change the context or other variables in your custom field, see Configuring a Custom Field.

54 Comments

  1. Labels are great, but:

    I added a custom field "System Component/s" of type Labels. In "Choose applicable issue types" I specify a few Issue Types and in "Choose applicable context" I select a specific project, i.e. this is NOT a global field. However, the field "System Component/s" is visible in ALL projects when I browse any project's labelled issues:

    Field: Labels | Epic/Theme | System Component/s

    So this custom field seems to be global after all. Is there any way around this?

    1. Anonymous

      What you tried to do was to create a "Context" which links an issue to a Project, I do not have my litterature on me at the moment so I am not sure what happened. You appeared to do that but go back and double check. Also if this does not work create a custom screen and a screen scheme. This should work.

       

  2. Regarding this feature (issues custom fields) an important point to remark, and unclear in the documentation (at least to me), is that custom fields can not be added to the projects screen, I mean, custom fields can't be added to a project (i.e. to state the total price of a project, the client to be billed, etc.).

    I saw lot of questions regarding this, and this was confirmed by Attlasian support, a "must be" feature (to custimize the project itself, not the individual issues of it) is not yet available.

  3. Anonymous

    Is it possible by any way to give rights to the user/owner of project (other than global admins) to add custom filed within his project?

    Or to configure the custom field like adding values to it etc?

    1. Anonymous

      Yes create a group and link it to the project role project_administrator. Then assign to the project role the project administration rights. This should work. I do not explicitly know if creating custom field rights is explicitly reserved for Jira Admins. This could be the case, which would mean there was nothing you could do and would have to give the project leader these rights. However I do not believe this to be the case. Also check permission rights scheme.

  4. Anonymous

    Is it possible to add custom fields at the project or user level, say you wanted yo add a "Project Owner" field to the project.

    Thank you.

  5. Anonymous

    Is it possible to change the field type of a custom field later??

    For example: textfield (<255 characters) into free text field (unlimited text).

  6. It would be a great feature if you could allow project admins to perform select Jira admin functions such as managing the option list of a custom select list without having to grant jira administrator permissions.

  7. Anonymous

    Agreed - having to grant full admin privileges to work with custom fields is less than ideal to say the least. We have a lot of users who want to manage their own custom fields so either i have to rant admin priv's to them (not ideal) or do it for them (even less ideal).

  8. Anonymous

    Is there a way to create a custom field for Project overview and not assigned to Issues?

  9. Anonymous

    Where's the regular ol' boolean checkbox?

  10. Anonymous

    Is it possible to link a new Custom field to existing issues ?

    1. Anonymous

      I am also interested in this. I added a tester field to a large backlog of issues however the field is only available to new issues created after the tester field was added.

  11. Anonymous

    Hi Document Experts @ Atlassian,

                                                       Just to let you know that the when you add any custom field (especially a select list / radio button ) there is another option added to the screen not the field which is "NONE" even make sure that you have a option to specify how to remove that if not needed from the screen.

    0_0

    1. Hi there,

      If you're attempting to point out something that should be clarified in the documentation above, could you please be clearer about what you mean by:

      ...there is another option added to the screen not the field which is "NONE" even make sure that you have a option to specify how to remove that if not needed from the screen.

      (It would also help if you could quote the section of text in the documentation above that needs improvement.)

      Kind regards,

      Giles.

  12. Anonymous

    Did you correct the limitation of one context by projet ie i want to use a context for an issue type in a project and another context for another issue type in the same project?

     

  13. We are an OnDemand user and have the custom field type of multi-issue key searcher.  I don't see this in the list above and was wondering how to use it? I tried to use it and add the field I created to the screen. But, the field would never display on the screen - consequently, I couldn't figure out what it was or how to use it correctly. Please advise.

     

  14. I am trying to make a custom field but only have a select group be able to view it.  For example: I made a field for our dev's to add a link to.  We do not want our clients to see this link though.  I have only been able to make it so both people see the field or neither see the field.


    I assume this is possible but have had no luck reading though this documentation.  If someone could point me in the right direction I would GREATLY appreciate it!

     

    Thanks,

    Kevin McClennen

    1. Anonymous

      Kevin,

      I believe you can do this by creating a Field Configuration Scheme. This is slightly complicated but should work.You have to create two field configuration naming each. One scheme will be for your developers and one will be for your clients. The configuration defines which fields of information are shown and which one are "invalid" aka invisible, so one configuration will have the link shown (I am assuming the link is either seen in a description or you created a cusom field for it) and one configuration where the link (the field where it is posted) is hidden. Then you need to create a field configuration scheme which will link one of the configurations (so link shown or not shown) to a group in this case employees versus clients. It is the combination of Both that works. This is rather complicated and I quite frankly dont think the Atlassian website is organized very conherently. That being said I recommend a book called JIRA 4 Essentials by Patrick Li. The book is very thorough and was of great help to me.

  15. Anonymous

    Is there any way to validate the format of a custom field, say using a regex etc? e.g., suppose I need to add a reference field to another system that MUST consist of the letter "H" followed by an integer number....

    Not sure where to go on this...

    Thanks

  16. I added a radio button control to my screen with button "yes" and "no". But there is also a 3rd "None" button which I didn't add.

    How do I get rid of this magical "None" button?

    1. Anonymous

      Make the custom field a required field in the "Field Configuration" which applies to your project / issue tyep. Then the "None" button will not be available.

      1. Thanks mate!!

        Worked fine for "Radio Button".

        Any idea what needs to be done for "Select List"?

      2. This makes the field required at issue creation.  We want to have a radio group that isnt used until later in the workflow

         

  17. We use the built-in and number fields and have custom Number Fields and we want to see a total on screen of all the filtered data.  How can we do this ? I have heard a rumour of the totalfielddecorator but no info found on the JIRA docuemntation.

     

  18. I need to add a field that will appear for each individual issue. It needs to be a Yes/No field called "Response Required." And only one or the other can be selected. Which field type would I need to do this?

  19. Anonymous

    Is there any way to filter out some versions in a version picker?  I would like to be able to limit the list to only ones that make sence for the context you are in.  For example only version for a specific release, or only unreleased versions.  We also use versions to designate the sprint so I would like to only show sprint versions in one case

  20. I would like to insert a couple of fields (e.g. Names of a customer, company and phone number). Then, when creating a new issue, the user should be able to pick a name out of the list and automatically, all the other values are shown as well. I want the users to be able to edit these customer informations as well. How can I create such fields?

  21. Anonymous

    I am unable to set the default value for select field in JIRA 4..4.5. It is showing all the statuses(Open,InProgress....) but by selecting them they are not configured as default values.The same has worked correctly with JIRA 4.1.2.

     

    Also the methods are  returning null values .

    public Object getDefaultValue(final FieldConfig fieldConfig) {
    Object object = genericConfigManager.retrieve(
    CustomFieldType.DEFAULT_VALUE_TYPE, fieldConfig.getId()
    .toString());
    if(object==null)
    LOG.debug("<<object value is null in getdefaultvalue()");

    return object;

    }  

     

    private Object getDefaultStatuses(CustomField field) {

    try {
    FieldConfigSchemeManager sm = (FieldConfigSchemeManager) ComponentManager
    .getComponentInstanceOfType(FieldConfigSchemeManager.class);
    long fieldConfigId = ((FieldConfigSchemeImpl) ((List) sm
    .getConfigSchemesForField(field)).get(0)).getId();
    Object list = genericConfigManager.retrieve(
    CustomFieldType.DEFAULT_VALUE_TYPE,
    Long.toString(fieldConfigId));
    if(list==null)
    LOG.debug("<< the list in getdefaultstatuses() is empty");
    return list;

    } catch (NullPointerException npe) {
    return new ArrayList<String>();
    }
    }

     

    I hope the problem is with this.how to solve this please help me .

     

    Thanks in advance.

     

     

     

     

     

     

     

     

     

     

     

     

     

     

     

     

     

     

     

  22. I would like to create a derived field, when an issue is created with 2 fields selected, this field should be calculated based on the selections on the other 2 fields. How can I do that?

  23. Anonymous

    Can custom fields only be added against issues, or can they be applied to other types as well.  I'd like to be able to have a custom field stored at the Project level, or even better, at the Version level.  Is this possible?

  24. Anonymous

    How to create user defined fields?

    For example: I want to create a field called "Trade off" then how do I do it? Using custom field option I cannot create fields I want for my project.

     

  25. How to create user defined fields?

    For example: I want to create a field called "Trade off" then how do I do it? Using custom field option I cannot create fields I want for my project.

     

  26. Anonymous

    Dear Sir or Madam,

    it seems that it is not possible to add custom fields for "wiki-syntax" content (like "Description" or "Environment").

    Is this feature planned to be added in future releases?

    Is there a way to enable wiki-formatting for a custom field with the current (5.2) Version of JIRA?

     

    Kind Regards

    1. You'll need to configure the "Renderer" for your custom field.  I tried this in version 6.0:

      1. Browse to JIRA Admin.
      2. Select Field Configurations.
      3. Locate your field configuration and select Configure.
      4. Locate your custom field and select Renderers.
      5. Update the renderer to Wiki Style Renderer.
      1. i don't have Wiki Style Renderer to choose, only Default text Renderer when i create a multi-line text-field.

        We have the latest version 6.2. 

        do I need to do something in JIRA administration in order to be able to get the Wiki Style Renderer visible in custom fields?

        1. Hi Stefan,

          Without having access to your instance I can't say exactly what the situation is, but I'd guess it could be that wiki style renderer is not enabled. If you follow the documentation here you should be able to enable it.

          Thanks,

          Warren

  27. I've created a Cascading Select field with a set of values, but when the drop-down lists appear on the screen there is a "None" option present.  Is there a way to remove the "None" value from the drop-down list?

  28.  

                  

    Is there a way to create custom search templates? We have multiple groups and I really only want to choose from 3 or 4 for my custom field instead of the 20+ available. Is this possible?

    Thanks!

               
  29. Adding a custom field directly in the view screen is a good idea. What i still miss is a feature to do that change just for that particular Edit screen only eventually causing screen, screen scheme and issue type screen copies. Also it should be possible to place the field into  a specific configuration context during that Admin operation.

  30. Anonymous

    Could you add a list of JIRAs custom field types? Not just "JIRA ships with over 20 custom field types". More details here would be very helpful.

  31. I am playing around with this feature but it looks like adding a field directly from the issue will only present you with global fields. Per best practices our fields are restricted based on issuetype and or project. 

  32. D G

    I don't see a way for an optional field to always be shown on a screen.  You have to set a default value for it to show up using some fictional value like "unspecified".  If the field is multi-valued, that means a user must delete the "unspecified" value when adding a real value.  Why can't the field be configured to always be displayed on a screen without requiring a value?

  33. Is it possible to add a custom date field to the Fix Version? It doesn't matter if it's globally applied. 

  34. Hannah Gilberg you're able to add a custom date field to screens, yes. It's up to you to put conventions in place for how that field is used and how it relates to Fix Version.

  35. Ori

    Anybody knows if it is possible adding a table custom field.

    I want to add a table with several columns, and see it as part of the issue. Is it possible? Thanks

  36. Hello, I have a problem. I have created a custom field with multiple choice of users. Administrators can to change it's value, but users with other project roles can't to change it. What can I do?

  37. can we add a mandatory custom field to our project??? If so how to add mandatory validation?

    1. Hi. I am also interested in a mandatory field. Is this solved? what's the solution?

       

       

  38. I noticed the link for "Adding a field to an issue" re-routes back to this page.  However, is this in fact addressed in this tutorial?  Also, is there a solution that allows a custom field to be mandatory?

     

  39. if i am a program administrator(not JIRA administrator) can i add a custom field?