Documentation for JIRA 6.3 EAP developer (EAP) releases only. Not using this? See below:
(JIRA 6.2.x documentation | JIRA OnDemand documentation | earlier versions of JIRA)

Skip to end of metadata
Go to start of metadata

Screens group all available fields (or a subset of all available fields) defined in JIRA and organize them for presentation to a user. Through screens, you can control what fields are displayed to the user during issue operations (e.g. Create Issue and Edit Issue dialog boxes) or workflow transitions (e.g. Resolve Issue dialog box), as well as define the order in which these fields are shown to them. A screen also allows you to split subsets of fields across multiple tabs.

When it comes to field visibility, screens functionally overlap slightly with field configurations. For example, on the Create Issue dialog box, users will only see issue fields that:

Hence, a field may be present on a screen used by a project, but if that field is hidden in the field configuration used by the project, that field will not be visible to the user when that screen in the project is displayed.
(tick) If a particular field needs to be hidden at all times, it is easier to hide the field in the relevant field configuration than remove it from all screens. For more information please see the Overview.

On this page:

JIRA ships with the Default Screen, Resolve Issue Screen and Workflow Screen, which are used as described below:

  • Default Screen — used for the default issue operations for creating, editing or viewing an issue.
  • Resolve Issue Screen — used for the transition view for the default Close Issue and Resolve Issue transitions, originating from the Open, In Progress and Reopened steps in JIRA's default workflow.
  • Workflow Screen — used for the transition view for the default Reopen Issue transitions, originating from the Resolved and Closed steps and Close Issue transition, originating from the Resolved step in JIRA's default workflow.
    The Workflow Screen defines a smaller set of fields than the Resolve Issue Screen.

    JIRA's default workflow, showing transitions (arrows) and steps (blue boxes):

Adding a screen

To add a new screen to JIRA:

  1. Log in as a user with the JIRA Administrators global permission.
  2. Choose > Issues. Select Screens to open the View Screens page, which lists all screens that have been defined in JIRA.
    (tick) Keyboard shortcut: g + g + type screens



  3. Click the Add New Screen button to open the Add New Screen dialog box.
  4. Complete the Add New Screen dialog box:
    • Name — enter a short phrase that best describes your new screen.
    • Description — enter a sentence or two to describe the situations screen will be used.

Editing a screen's details

To change a screen's name and/or description:

  1. Log in as a user with the JIRA Administrators global permission.
  2. Choose > Issues. Select Screens to open the View Screens page, which lists all screens that have been defined in JIRA.
    (tick) Keyboard shortcut: g + g + type screens
  3. Click the Edit link next to the appropriate screen.
  4. You will now be directed to the Edit Screen page where you can edit the name and/or description of the Screen.

Copying a screen

  1. Log in as a user with the JIRA Administrators  global permission.
  2. Choose > Issues. Select Screens to open the View Screens page, which lists all screens that have been defined in JIRA.
    (tick)Keyboard shortcut: g + g + type screens
  3. Click the Copy link next to the Screen you wish to copy. You will be directed to the Copy Screen page, where you can enter a name and a description for the new Screen:

Deleting a screen

  1. Log in as a user with the JIRA Administrators global permission.
  2. Choose > Issues. Select Screens to open the View Screens page, which lists all screens that have been defined in JIRA.
    (tick) Keyboard shortcut: g + g + type screens
  3. Click the Delete link next to the screen you wish to delete. You will be prompted to confirm your deletion

(info) Screens that are associated with one or more screen schemes, or one or more workflow transitions, cannot be deleted.

Configuring a screen's tabs and fields

You can configure the fields that display on a particular screen by adding/removing fields, as well as reordering them. Tabs can also be used to help group related fields. Tabs are useful for organizing complex screens, as you can place less used fields onto separate tabs. You can also add, remove and reorder tabs, as well as rename them.

To configure a screen's tabs and fields:

  1. Log in as a user with the JIRA Administrators global permission.
  2. Choose > Issues. Select Screens to open the View Screens page, which lists all screens that have been defined in JIRA.
    (tick) Keyboard shortcut: g + g + type screens
  3. Click the Configure link (under the Operations column) next to the screen you want to add a field to, to open the Configure Screen page for that screen.



    OperationInstructions
    Add a tabClick Add Tab. Enter the name of the new tab in the dialog that appears and clickAdd.
    Move a tabHover over the dotted part of the tab (next to the tab name) and drag the tab to the desired position.
    Rename a tab1. Hover over the tab name and click the pencil icon.
    2. Enter the new name and click OK.
    Delete a tabHover over the tab name and click the X.
    Add a field1. Click the tab that you want to add the field to.
    2. Type the name of the field in the dropdown displayed at the bottom of the current fields. Field suggestions will appear as you type.
    3. Click Add Field to add it to the current tab.
    Move a fieldHover over the dotted part of the field (next to the field name) and drag the field to the desired position.
    Move a field to a different tab by dragging it to the name of the tab and dropping it.
    Delete a fieldHover over the field and click the Delete button that appears.

Tips on configuring screens

  • Date fields on View Issue screen — Fields of type 'Date' will always be displayed in the 'Dates' area of the default 'View Issue' screen, regardless of how you reorder them. This applies even if the dates are custom fields.
  • System fields on View Issue screen — System fields on the default 'View Issue' screen (e.g. Summary, Security Level, Issue Type, etc.) are fixed. This means that they will always appear on the 'View Issue' screen, even if you configure the Screen to move them onto a separate tab. Any custom fields (except 'Date' fields) that have been added to the 'View Issue' screen can be moved onto a separate tab. Note, this restriction only applies to the screen associated with the 'View Issue' operation.
  • Timetracking— You can add the ability to log work and/or specify/modify time estimates to a screen by adding the special Log Work and/or Time Tracking fields respectively. For more information about how this works for a user, please refer to Logging work and/or specifying time estimates on the same JIRA screen.
    • If these fields cannot be found in the Add Field selection box and they have not already been added to the screen, check whether JIRA's Time Tracking feature has been enabled. These fields will not be available to add to any screen if Time Tracking is disabled.

    • If any screens have the Log Work or Time Tracking fields and JIRA's Time Tracking feature is subsequently deactivated, those screens will retain these fields until you specifically remove them. However, the fields will not be visible to the user until Time Tracking is reactivated.

  • Renaming standard JIRA fields — You cannot rename the standard JIRA fields (e.g. Priority, Summary, etc) via the JIRA administration console. If you want to rename the standard JIRA fields, you will need to modify files in your JIRA installation. Please see this knowledge base article for instructions. Note, renaming standard JIRA fields is not supported.

Activating a screen

To make a Screen available to users, you can either:

16 Comments

  1. This guide is slightly misleading. We've got a situation where we want a field ordering with the following:

    1. Custom Field 1
    2. Custom Field 2
    3. Description
    4. Custom Field 3
    5. Custom Field 4

    We actually have the screen configured this way, but the Description field always gets placed below all custom fields regardless of its order in the screen configuration.
    Neither Jira itself nor the documentation on this page suggest that this would be the case. The same is true for user/group fields. Even though Jira leads you to believe you've got the field in a particular order, the user/groups fields are instead placed in their own "People" section. I think this makes sense, but both this documentation and the Jira screen configuration page should point this out.

    1. According to http://old.nabble.com/-JIRA-user--Customizing-%22issue-details%22-screen-td6067245.html and http://forums.atlassian.com/message.jspa?messageID=257247681 this order is coded in the velocity templates.

      The Issue Details screen does not seem to have a Screen definition that can be edited as one of the Screens.
      At least not in Jira 4.1. I think this is worth a feature request.

  2. How can one add notes to screens? The default workflow has note like this one: 

    Icon

    Resolving an issue indicates that the developers are satisfied the issue is finished.

    But I can't figure out how to add my own notes to other screens.

    1. Anonymous

      Was there ever an answer to this? How do you just add notes to a screen?

      1. That note is in the velocity template itself. You have the power to edit those, but it's not recommended. I was able to get something to work using custom field type with custom rendering, which rendered the field as an edit box for administrators and as html for non- admins.  It was a lot of work.

         

        If you really want to go there look at :

         

        https://developer.atlassian.com/display/JIRADEV/Plugin+Tutorial+-+Creating+a+Custom+Field+in+JIRA

         

        these are deep waters ... mind the sharks ...

         

        You might be able to get the functionality you like by customizing the help content.

  3. Anonymous

    How can I change the main view to Issue details? When I am on some Issue I can see "Detail" and "Action" of this Issue. How can I set what fields are visible in "Details" and what possibilities are visible in "Action". Is it some kind of Screen? I try to manage it in Issue type screen schemes, but it does not work.

  4. Anonymous

    Is it possible to make the summary field optional?

  5. Another condition for the 2nd paragraph that will prevent a field from appearing:   a custom field of type select list configured with no values.

  6. I am currently using a trial version of JIRA, and when in Administration mode if I select Configure Screen I see a page that is not editable, and just includes text "This page shows the way the fields are organized on OOM Request screen." I expect to see the screenshot related to Configure Screen under the "Configuring Screens and Tabs" section above. Can you please help?

  7. Anonymous

    Admin for adding a resolution field to the ReOpen workflow screen. Can it be any harder to figure out. Info above does not map to the JIRA version I'm using. Why not link solutions for different versions in the Q&A?

     

  8. Anonymous

    I'm wondering how you would go about customizing which fields appear in the list of issues on an Epic's view screen.

    Any help would be greatly appreciated.

  9. Anonymous

    Can I show/hide a field based on a value of other field. 

    If user select a value from a List, based on his choice I want to hid/or show anther field in the screen

  10. I'm using a Cascading list to organize a projects course/chapter layout while filing and viewing issues in JIRA, however when I look at the issue, the cascading list show sup in a seperate tab instead of in the details view like all of my other custom fields. Is there any reason why cascading lists aren't showing up in the Details dropdown like my other lists and custom fields?

     

  11. In JIRA 6 is there a way to copy a tab from one screen to another within the same project? Or, better yet between screens in different projects. We have a 'customer information' tab that appears in all projects and it would be most convenient if we only needed to update it in one place.

     

  12. Is it a bug, or as designed that you in 6.2 no longer can move fields between tabs?

    1. Sure looks like a bug. I reproed in 6.2.1 but it doesn't repro in 6.1.7. Kind of disappointing!

      Edit: looks like they're working on a fix: https://jira.atlassian.com/browse/JRA-36964