Documentation for JIRA 6.3. Not using this? See below:
(JIRA 6.2.x documentation | JIRA Cloud documentation | earlier versions of JIRA)

Skip to end of metadata
Go to start of metadata

You can modify each of the custom fields in your JIRA system by changing the following:

  • Name — the label that appears to the left of the custom field when it is displayed to a user. See below.
  • Description — the Help text that appears below the custom field when it is displayed in the Simple Search column. See below.
  • Search Template — the mechanism for making a custom field searchable. See below.
  • Default Value — the default value of the custom field when it is first displayed to a user. See below.
  • Options (for Select and Multi-Select fields only) — the values from which a user can choose. See below.
  • User Filtering (for User Picker fields only) — the set of users from which a user can choose. See below.
  • Context — the combination of project(s) and issue type(s) for which a given Default Value and Options will apply. See below.
    (tick) You can create multiple Contexts, allowing you to specify different Default Values and Options for different combinations of projects and/or issue types.
  • Screens — the screen(s) on which the custom field will appear when an issue is created, edited or transitioned through workflow. See below (also see Defining a Screen).
  • Renderers(for certain types of fields only) — see Configuring Renderers and Specifying Field Behavior.
  • Hide/Show — see Specifying Field Behavior.
  • Required/Optional — see Specifying Field Behavior.

On this page:

Viewing custom fields

To view the custom fields in your JIRA system:

  1. Log in as a user with the JIRA Administrators global permission.
  2. Choose > Issues. Select Fields > Custom Fields to open the Custom Fields page.
    (tick) Keyboard shortcut: g + g + start typing custom fields

Editing a custom field

Editing a custom field allows you to change its Name (label), Description (Help text) and Search Template.

To edit a custom field:

  1. Navigate to the Custom Fields page, locate the desired custom field and choose cog icon > Edit:
    • The Name is the label that appears to the left of the custom field when it is displayed to a user.
    • The Description is the Help text that appears below the custom field when it is displayed in the Simple Search column.

    • Search Templates are responsible for indexing a custom field as well as making it searchable via Simple Search and Advanced Search (note that custom fields are not searchable via Quick Search). Every custom field type has a preconfigured search template, but you may select a different template using this procedure.

  2. Modify the fields as desired and click Update.

Configuring a custom field

The custom field context – also known as custom field configuration scheme is not related to the field configuration scheme – specifies the following for the custom field:

You can create multiple contexts if you need to associate different default values and options with particular projects or issue types.

Each custom field has a context named Default Configuration Scheme for ..., which is created automatically when you add your custom field.

Context

To change the project(s) and issue type(s) to which a given Default Value and Options apply:

  1. Navigate to the Custom Fields page, locate the desired custom field and choose cog icon > Configure.
  2. Locate the context named Default Configuration Scheme for ... and click the Edit Configuration link.
  3. Under Choose applicable issue types, select the issue type(s) to which you want this Default Value and Options to apply. You can select any issue types if you wish.
  4. Under Choose applicable contexts, select the project(s) to which you want this Default Value and Options to apply. Note that this will apply to only issues with the selected issue type(s) as above.

Adding a new context

Adding a new context allows you to configure a custom field differently for different combinations of issue types and projects.

To add a new context:

  1. Navigate to the Custom Fields page, locate the desired custom field and choose cog icon > Configure.
  2. Click the Add new context link. The 'Add configuration scheme context' page will be displayed (see below).
    • Under 'Add configuration scheme context', enter a 'Label' and 'Description' for your new context — these are used for administrative purposes only and will not be shown to your end-users.
    • Under 'Choose applicable issue types', select the issue type(s) to which you want this Default Value and Options to apply. You can select Any issue types if you wish.
    • Under 'Choose applicable contexts', select the project(s) to which you want this Default Value and Options to apply. Note that this will apply to only issues with the selected issue type(s) as above.

A custom field can only have one context per JIRA project. So you cannot have multiple contexts for different issue types in the same project.

Default value

To edit the default value that a custom field contains when it is first displayed to a user:

  1. Navigate to the Custom Fields page, locate the desired custom field and choose cog icon > Configure.
  2. Locate the relevant context (there will usually only be one, named 'Default Configuration Scheme for ...') and click the Edit Default Value link in the right-hand column. The 'Set Custom Field Defaults' page will be displayed and will be particular to the custom field type:
    • (For a Select List or Multi-Select List) Select the appropriate default value from the drop-down list.
      (info) To clear the default of a select field, click on the current default so it is no longer highlighted and then save, as described here: Unable to De-select Default Value for Multi Select Custom Field.
    • (For a Cascading Select List) Select the appropriate default values from the drop-down lists (one for each level).
    • (For a Date field) Specify a date, or tick the check-box to make the current date the default.
    • (For other types of fields) Type the appropriate default values from the drop-down lists (one for each level).
      (info) Certain types of custom fields, such as calculated custom fields, may not allow for defaults to be selected and will not have the Edit Default Value link.

Options

You can specify option values for custom fields of the following types:

  • Select lists
  • Multi select lists
  • Cascading selects lists
  • Radio buttons
  • Multi checkboxes

You can add, remove, re-order, sort the options alphabetically, and edit the text of an option value. You can also have HTML in an option value — be sure to use complete tag pairs, and check that the HTML will display correctly.

(info) These options are case insensitive, so when using a select or multi-select list for a notification scheme, JIRA-ADMINISTRATORS will match the jira-administrators group. This means you cannot have both a JIRA-ADMINSITRATORS and a jira-administrators option, as they have the same name.

To edit a custom field's options:

  1. Navigate to the Custom Fields page, locate the desired custom field and choose cog icon > Configure.
  2. Locate the relevant context (there will usually only be one, named 'Default Configuration Scheme for ...'), and click the Options link in the right-hand column. The 'Edit Custom Field Options' page will be displayed (see below). Here you can:
    • Select from the Edit parent select list drop-down to choose which list to edit. (For a Cascading Select List only)
    • Click Sort alphabetically to automatically re-order the options alphabetically.
    • Click the arrows in the Order column, or specify a number and click the Move button, to re-order the options manually.
    • Click Edit to change the text of an option.
    • Click Disable to hide an option so that it is no longer available for selection. Options that have been used cannot be removed (to preserve data integrity), but due to changing business requirements, they may become invalid over time and so you may wish to make them unavailable for new issues.
    • Click Delete to remove an option. (This will only be possible for options that have not been used.)

User Filtering

You can limit the set of users available in your user picker field. The users can be limited to users in specific groups and/or project roles.

To filter the users in a user picker field:

  1. Navigate to the Custom Fields page, locate the desired custom field and choose cog icon > Configure.
  2. Click Edit User Filtering.
  3. Click Enable group or project role filtering, then specify the groups and/or roles that you want to limit the user picker to.
    The user picker will only show users that are in the groups and roles selected.
  4. Click Save.

 

Choosing screens

To choose the Screens on which a custom field will appear:

  1. Navigate to the Custom Fields page, locate the desired custom field and choose cog icon > Screens.
  2. Select the check boxes of the screens on which you wish to display this custom field.
    (info) Note that field visibility depends on the field configuration (which is not related to the custom field configuration scheme described above). Refer to Specifying Field Behavior for more information.

 

Translating a custom field

You can translate the name and description of any custom field that you create into another language. You can only select from the language packs that are installed in JIRA.

To translate the field and description of a custom field to another language:

  1. Navigate to the Custom Fields page, locate the desired custom field and choose cog icon > Translate.
  2. Choose the language pack that this custom field translation will belong to (e.g. French) and enter the translated strings for the Field Name and Description.

Troubleshooting custom fields

Using the JIRA admin helper

The JIRA admin helper can help you diagnose why a custom field is not showing on your screens. This tool is only available to JIRA administrators.

To diagnose why a custom field is not showing on the View Issue, Edit Issue or Create Issue screens:

  1. Navigate to the View Issue, Edit Issue or Create Issue screen where the field is not showing.
  2. If you are viewing an issue, click More Actions > Where is my field? If you are creating or editing an issue, click Configure Fields > Where is my field?
  3. Enter the name of the field.
  4. Click Submit.

Tip: You can also access the 'Where is my field?' dialog via the cog menu for each issue in the issue navigator. 

Changing the description of a custom field

Not changing the description in a field configuration means that any changes you make to a custom field's description are not seen.

JIRA allows you to define a description of a custom field, and 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. However you can also define different description texts in each field configuration and this will override the original field description text.

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". 

47 Comments

  1. Anonymous

    Hi,

    I would like to have a custom field like "Number Field" but instead of dot as floating point, i would like a comma and a blank space instead of the commas for the thousand number ... Any clues, please ?

    Thanks,

    Yves

  2. Anonymous

    Hi All,

          I would like to know is there a way to add additional custom validations to custom fields apart from jira standard validation.

    Kindly let me know if you have any idea?

    Thanks,

    Vinutha

  3. Anonymous

    Hi All,

    Can i set a custom field such that it is required only in 1 screen and not others ?

  4. Anonymous

    How do i find the ID of a custom field?

    1. Simple:

      At the backend (administration), go to Issues -> Fields and move your mouse over one of the operations links. If you have your browsers status bar enabled, you should see the ID there.

  5. Anonymous

    Hi,

    How do i add a field that has values displayed in it driven by the value selected in another field. For e.g. I have a Defect Category field that has values like Application, Script and Performace; and I have another field named 'Sub-Defect Category' which should show values based on the value selected in the Defect Category field.

    Lets say, i select Application in the Defect Category then the values in Sub-defect category should show only Main Application, Web Application, Mobile Application and Desktop application. It should not display values like automation script, performance script, regression script and unit script that may be tied to Script value of the Defect Category field.

  6. Anonymous

    I would like to have one field that will depends from two another parent fields.

    The dependence looks like 'where field3=nvl(${jira.customfield.parent.value:0},${jira.customfield.parent.value:1}).

    But it works only when two parens fields aren't empty. What I really need is that it will work even when one of parents fields is empty. How I can do it?

     

  7. Anonymous

    Hi there,

     

    I want to configure my isue's creating and closing fields. For example when I create an isue I want to give an isue number of my custmers tickets, so I can which isue is about which tickets. And also I want to determine the closing fields, when assigned person closing the isue, s/he will enter some numbers that I will give a label and  attachment and these fields will be mandatory fields.

    where can I configure this things?

  8. Anonymous

    Hi,

    I would like to create a custom field to get release versions of a project. How can I do that?

    Thanks.

  9. May i know how can the custom field be added to gadgets for display purpose.

  10. Anonymous

    Is there any way to change the order in which the custom fields are displayed in the different windows? By default all the new custom fields are created at the bottom of the existing fields

  11. Anonymous

    Is it possible to create a custom field as "clients" to appear at the New Project Screen and use it to make filters?

     

  12. Is it possible to create a custom field as "clients" to appear at the New Project Screen and use it to make filters?

     

  13. Anonymous

    How to rearrange order of display in JIRA deffect template.

  14. Anonymous

    I have two problems:

    1. In the "Modify configuration scheme context" screen in the "Choose applicable context" field I am not receiving the radio button "Global Context" vs. "Select Projects" - does anyone has idea why?
    2. In the "Choose applicable context" field in the list of projects not all projects appears in the list - why?
    1. Anonymous

      A project can belong to one context at a time. If you wish him to be displayed in the list of projects make sure it is not already allocated to another context including the default one.

      1. This person probably ran into the same issue I did.  The documentation indicates you can have multiple combinations of issue types and projects, when in reality, you can only have one.  Once a project has been associated with a configuration, it cannot be used again, even for different issue types.  My recommendation was that either update the documentation to state what you can do or fix the issue and allow different configurations for issues types in the same project – the latter is what we needed.  We needed for a Bug issue type, we wanted a specific field configuration for a field, but for an Improvement issue type, we wanted a different field configuration.

  15. It doesn't seem possible to have different configurations for different issues types in the same project. For example, I want custom field ABC to have the values of 1, 4, 5 for bugs.  But for improvements, I want custom field ABC to have the values of 1, 3, 6.   Am I missing something?  When I tried this, the project was not available when setting up the second field configuration if the project was already selected for another field configuration.

     

    It is this statement in the above doc that doesn't seem true: Adding a new context allows you to configure a custom field differently for different combinations of issue types and projects.

    I can currently have a default and then one combination of issue types in a project; not different combinations of issues types within the same project.

    1. Anonymous

      As I just ran into the same issue, I searched for a feature request for the same.

      It seems as if this is related: https://jira.atlassian.com/browse/JRA-22403

      Anyone having the same trouble, please vote/comment on this.

      1. Voted. I also wanted to create more context for a field in one project. If you want a field behave differently per issuetype in a project, this is a must-have.

  16. What is the Configure option in the Custom Field options screenshot? The text doesn't describe the purpose of this option and it wasn't one that I have seen, thus far, in the custom fields that we have set up. Is it only applicable for specific custom field types?

     

  17. Anonymous

    Is it possible to have many translations for a custom field ?

    For example, I want to create a field called "Workload". I want it to be translated when the user is connected in another language than english.

    thank you for your help.

  18. Anonymous

    Why create a custom context for a custom field? Is there a way to select a custom context created for one field on others?

  19. Anonymous

    Some custom fields were created in a particular project field, all were reflected in the screen properly.

    Problem – when we view/export to Excel, the custom fields were not reflected. Mind sharing any troubleshooting steps?

     

    Thank you much.

     

    1. The issue is that if not all fields in the query are associated with that custom field, it won't be included.  In my opinion, that is a bug, or a minimum improvement.  The export should return all fields and the field value is just empty or null for those fields it is not applicable for.  It's quite confusing to many users the current behavior because often, they don't know that a field isn't applicable and cannot understand why their information isn't in their export.

      I get this question/issue asked of me at least once a month and users going away perplexed...but, at least they understand what is happening. 

  20. Is it possible to have one Custom Field (ex. Country) across many projects AND have a default value that is different for each project (Depending which country the project is based from)?

    1. You would need to setup different field configurations for that field. You would have to setup the values for each and set the default - you cannot share a list of values and only set the default.   The downside is that there is a bug in JQL that doesn't seem to always pull back the correct results if you are using that field in the query as criteria.  I've had it really screw up my reporting and actually got rid of all of my field configurations because of it.

      1. Thanks so much for all the information!

  21. Anonymous

    I am not able to configure the Default value for the custom field of multiselect type.I configured it in JIRA 4.1.2 but i am unable do it in JIRA 4.4.5. Please help me and reply me as soon as possible.

     

    Thanks in advance.

     

    1. Anonymous

      go and add options and then select the default value.

  22. Does anyone know if there is a way to have two custom select list fields that back against the same list? Essentially I will have a Target Requested and Target Committed, these are different than affect/s and fixed in versions.

    I want this same style there where the fields are different but back against the same values so I don't need to update two fields each time we have a new target. Is this possible?

  23. Anonymous

    Is it possible to add a list of options to a select or multi-select list instead of one at a time?

  24. Anonymous

    Anyone know of a way to setup a custom field that is only visible to certain groups?  I want to have a field that is visible only to certain groups and not everyone.

    1. The Behaviours plugin does this

  25. May I ask , i have a select list. How can  I  get the project role to be the option of it? 

    And , if the options are persons and notification has been set and actived. why the server won't send email to the select list option?

    Need  help~ THANKS

  26. Anonymous

    Is there a way I can only view custom field when a specific Issue Type is selected?

    1. Use a Field Configuration Scheme

  27. Anonymous

    Hello, I want to search a custom field using jql with the JIRA rest api. The field has its search template set to "CRM Case Number Searcher". Normally with text fields, I would just post something like:   

    {
    "jql": "cf[12345] ~ \"my awesome tokens\""
    }

    but, sadly, this doesn't seem to work here. If it helps, customfield_12345's value is an array of strings.

     

     

  28. Anonymous

    Hello, 

    in my company we use the field "Story points" in different projects. Now I want change the issue types with story points only for my project (and not for all projects in JIRA). I saw that I can configure different "Story Points" items. As my project is configured in the default "Story Point" area, I cannot select it with in the new configured "Story Points" area. But I'm afraid, when I remove my project from the default area, all maintained story points will be lost...

    How is the impact, when I change the story point definition for my project? 

    Thanks!

  29.  

    With JIRA 6 we could translate our custom fields, wich is very cool. But can we translate the list of a custom field ? If not, then what good is it ?

  30. Anonymous

    I have a simple question.    How do I clear the values previously entered using the "AutoComplete Renderer" and stored in the drop down list?    Or better yet, is there a way to configure only values in pre-defined drop down list can be selected in fields, either existing fields or custom fields?

     

    Any help much appreciated.   Thanks.

  31. Hi

    Is is possible to remove the "none" option as value for radio buttons on JIRA 6???

  32. Anonymous

    Please make it possible to NOT want a 'none' value.

    V

  33. Anonymous

    After I created all the custom fields in  my new project, and imported issues from redmine, somehow all custom fields got duplicates now. For example, if I create a field Reviewer with type "User Picker", after the import another Reviewer field with type "text" is created. Worst of all, the values get assigned to unwanted fields instead of the carefully configured ones. What I'm doing wrong?

  34. Is that possible to have custom field that will not be saved in database ? just for pdf print or export ? Does i need developpement or existing addon that someone know ?

     

  35. What is the maximum number of options I can have in a dropdown field? E.g. I want to implement a "select customer", which would have 1000 entries - does that break anything in JIRA, or impede performance?