Child pages
  • Part 2 - Fields and Screens
Skip to end of metadata
Go to start of metadata
JIRA Quick Start Guide
Unknown macro: {div} Guide Home [!back home.png!]
Unknown macro: {div} The Basic Setup
Unknown macro: {div} Fields and Screens
Unknown macro: {div} Workflow







Customising JIRA fields and screens

Plan your workflow

It's a good idea to draw up your workflow on paper as this will help you with the workflow design.
e.g:

Be sure to note down things like:

  • Issue Types
  • Priorities
  • Resolutions
  • Status (represented here by boxes)
  • Transition Names (represented here by arrows)
  • Screens
    • There are two types of screens: transition screens and issue operation screens.
      • Transition screens appear when an issue is transitioned from one status to another, this is controlled by the workflow.
      • Issue operation screens are screens that JIRA will show when you create, edit, or view an issue.
    • On this page we will be dealing with issue operation screens only.
    • You can read about transition screens on the workflow guide.

Customising Issues

Begin by clicking on the "Administration" button on the top of your navigation bar.
If you do not have this button you are not a JIRA administrator, please ask your JIRA administrator for access.

Create an Issue Types Scheme

Issue Type Schemes determine which Issue Types will be available for each Project.
You can see this in use when you create a new issue in JIRA for a particular project.

Screenshot : Issue Types in JIRA
Click to see the larger image:

We will first create an Issue Type Scheme.
Click the Issue Settings tab in the left column of the administration scheme and then select Issue Types from the menu. In the main screen click on the Issue Types Scheme tab. Type in the name of your New Issue Type Scheme then click Add. This will then take you to the Add Issue Types Scheme page.

Screenshot : Issue Type Scheme
Click to see the larger image:

Referring to the New Issue Types screenshot:
1. You can add new issue types here by entering a new issue type name in the bottom box.
2. Then click Add.
3. Your new issue type will appear in the left hand column Issue Types for Current Scheme.

  • Repeat this step for all your issue types.
  • Note you can also add existing issue types by using drag&drop from the right column Available Issue Types.

4. Then select your Default Issue Type at the top drop down box.

When you are finished click Save.

Screenshot : New Issue Types
Click to see the larger image:

Associate the Issue Types Scheme to a Project

This is where you determine which Issue Type Scheme will be used in each Project.
So you are essentially telling JIRA which Issue Types to use in a particular Project.

By clicking Save on the previous screen you should have returned to to the Issue Types Scheme tab. In the far right column under Operations click the Associate link.

This will take you to the Associate Issue Type Scheme page where you will select which projects you want this Issue Types Scheme to use. (You can select more than one project with the Control key).

Once you have your projects selected click the Associate button.

Screenshot : New Issue Types
Click to see the larger image:

Customising Screens

Here is a good overview of the concepts used in JIRA:

Creating a Screen

A screen is an arrangement of fields that are displayed when the issue is created, edited or transitioned through a workflow.

In the administration console, under the left column, open the Issue Fields tab. Select Screens in the menu. At the bottom of the main window type in your Screen Name then click Add. Once added click the Configure button.

Each transition can have a different screen. If you wish to have this, just repeat this step for all your screens.

Screenshot : New Screen
Click to see the larger image:

Configuring your screen

Referring to the Configure Screen screenshot:
1. Add fields to your screen by selecting them then clicking Add.
2. You can then configure the order of your fields by using the arrows.

Screenshot : Configure Screen
Click to see the larger image:

Customising Fields

Creating a Custom Field

In the left column of the administration console you should still have the Issue Fields tab opened, now select Custom Fields from the menu and in the main screen click Add Custom Field.

Screenshot : Custom Field
Click to see the larger image:

Referring to the Create Custom Field screenshot:

  • Give your new custom field a 'Name'.
  • Select the Issue Types that are to use this custom field.
  • Select the project context for this custom field.
    • note: selecting the context of the custom field will affect which custom fields are shown while searching for issues.

Click Finish when you are done.

Screenshot : Create Custom Field
Click to see the larger image:

The next window to pop will ask you to select which screen you wish the custom field to appear in. Select the screens the custom field will appear in and then click Update.

Repeat this step for all your custom fields.

Screenshot : Field Selection
Click to see the larger image:

This is how the final Open Issue Screen will look in JIRA:

Screenshot : JIRA Screen
Click to see the larger image:

If you wish to change the order you custom field is displayed on the screen, you will need to go back into the configure JIRA:screen view.

Create a Field Configuration

A Field Configuration provides the ability to change field behaviour, it essentially tells JIRA how to handle a particular field.

In the left column of the administration console you should still have the Issue Fields tab opened, now select Field Configuration from the menu and in the main screen type the name of your new Field Configuration and click Add.

Next click configure under the operations menu. Here you can configure your fields to make fields required, hide/show fields and specify the field's description. You can also change which screens certain fields appear on by using the "Screens" link next to each field.

Screenshot : Field Configuration
Click to see the larger image:

Create a Field Configuration Scheme

This is where you select what Field Configurations will be used for each Issue Types.

In the left column of the administration console you should still have the Issue Fields tab opened, now select Field Configuration Schemes in the menu and in the main screen type the name of your new Field Configuration Scheme and click Add.

Next click configure under the operations menu.

Screenshot : Field Scheme
Click to see the larger image:

A Field Configuration Scheme can be associated with one or more projects, thus making issues in these projects use certain Field Configuration for each issue type.

Select your issue type and then select which field configuration you want this issue type to use. Then click Add.

Repeat this step for all your issue types.

Screenshot : Field Configuration Scheme
Click to see the larger image:

Customising Screen Schemes

Create a Screen Scheme

Screen Schemes allow you to choose what screens are shown for each issue operation.

In the left column of the administration console you should still have the Issue Fields tab opened, now select Screen Schemes from the menu and in the main screen type the name of your new Screen Scheme and click Add.

Next click configure under the operations menu.

Screenshot : Screen Scheme
Click to see the larger image:

This is where you select what screen will show for each issue operation.

  • note: it is not where you select what screens are shown for the transition between statuses, this is done via the workflow.

If you have previously created other screens for other issue operations, then this is where you add them.
Otherwise leave it as default.

Screenshot : Screen scheme configuration
Click to see the larger image:

Create your Issue Type Screen Scheme

Issue Type Screen Schemes allow you to choose what Screens Schemes are used for each issue type.
This will specify what Screen Scheme, and hence what Screen will be used for a particular issue operation within the projects' issues.

In the left column of the administration console you should still have the Issue Fields tab opened, now select Issue Type Screen Schemes from the menu and in the main screen type the name of your new Issue Type Screen Scheme and click Add.

Next click configure under the operations menu.

Screenshot : Issue Type Screen Scheme
Click to see the larger image:

Here you can choose what screen scheme to use for each Issue Type. Remember your issue type can also be a subtask.

  • note: it is not where you choose what issue types are used in the project, this is done via issue type schemes.

Screenshot : Configuring Issue Type Screen Scheme
Click to see the larger image:

Associating the schemes in a project

Configuring your project to use the new schemes

You now have created two main schemes: Issue Type Screen Scheme and Field Configuration Scheme.

In the left column of the administration console click on the Projects tab, now select Projects from the menu, and in the main screen click on the name of the Project you created earlier.

Screenshot : Projects
Click to see the larger image:

This will take you to the Project details. At the Field Configuration Scheme line click on the Select option.

Screenshot : Project details
Click to see the larger image:

This will take you to the Field Layout Configuration Association screen. Select your new Field Configuration Scheme and then click Associate.

Repeat this step for your Issue Type Screen Scheme.

Screenshot : Field Association
Click to see the larger image:

Summary

You have now customised JIRA's fields and screens. You have told JIRA what issue types to use in what projects. You have also told JIRA what screens to show during the issue operations and what fields to show on these screens.

Additionally please note that:

  1. Custom fields must have "context" for the project and issue-type
  2. On a view (screen or navigator etc), the field must contain data to be displayed

Video Resources

We have a video that outlines how to add a custom field to an existing screen.
The video is a .mov format which can be played in Quicktime(free).


Contact us

Please contact us if you have any questions on this guide.


JIRA Quick Start Guide
Unknown macro: {div} Guide Home [!back home.png!]
Unknown macro: {div} The Basic Setup
Unknown macro: {div} Fields and Screens
Unknown macro: {div} Workflow