What is an 'Issue Type Scheme'?
An Issue Type Scheme is a sub-set of issue types. An Issue Type Scheme allows you to:
- restrict the set of available issue types for each project.
- control the display order of available Issue Types and the default Issue Type for each project (ie. the Issue Type that is displayed in the selection-box when a user creates an issue).
An Issue Type Scheme can be shared across multiple projects, so that a group of similar projects can share the same issue type settings.
For example, in your company all projects may be one of two types, a development project or a support project. You could then create one scheme called Task with issue types Bug and Development and another called Support Projects, with issue types Development Query and Support Request. You can then associate each scheme with the appropriate project(s), giving your users a different set of issue types depending on which project they decide to create issues in. Your future maintenance workload is minimised, because any change you make to a scheme is made across all projects that are associated with the scheme. In this example, adding a new issue type to all support projects only requires the simple step of adding the issue type to the Support Projects scheme.
Managing Issue Type Schemes
- Log in as a user with the 'JIRA Administrators' global permission.
- Select 'Administration' > 'Issues' > 'Issue Types' to open the 'Manage Issue Types' page. (For more information about this page, see Defining 'Issue Type' Field Values.)
Keyboard shortcut: 'g' + 'g' + start typing 'issue types'
- Click the 'Issue Type Schemes' tab. This will display all existing Issue Type Schemes, their related Issue Types and the associated projects:
Screenshot 1: the 'Issue Type Schemes' tab on the 'Manage Issue Types' page
The 'Default Issue Type Scheme' contains all the issue types that exist in your JIRA system. This scheme is associated with all newly created projects by default. If some of your issue types are not relevant to all of your projects, create one or more new Issue Type Schemes (e.g. 'Development Projects' in this screenshot) as described below, and associate them with the appropriate projects instead of using the Default Issue Type Scheme.
Creating a new Issue Type Scheme
To create a new Issue Type scheme:
- Go to the 'Issue Type Schemes' tab (see above) and enter the 'Name' and 'Description' for the new Issue Type scheme. Ensure that the name is meaningful as this will be visible to other administrators and will allow them to better reuse the scheme.
- Click the 'Add' button to display the 'Add Issue Type Scheme' page.
Screenshot 2: the 'Add Issue Type Scheme' page
- Set the default for the new scheme from the select list.
The default issue type is the one that is displayed in the selection-box when a user creates an issue (see Creating an Issue).
- To add issue types to your scheme, drag and drop an issue type from the right-hand list to the left:
Screenshot 3: dragging an issue type into a new scheme
- If you need an issue type that does not currently exist, you can easily add this by using the 'Add Issue Type' form at the bottom of the page. This will add the issue type to your JIRA system and also add it to the scheme you are editing.
- To reorder the issue types, drag and drop them into the preferred positions.
Reordering issue types changes the order in which they are displayed to the user who is creating an issue.
- Click the 'Save' button to create your new scheme.
Editing an Issue Type Scheme
To edit an Issue Type scheme:
- Go to the 'Issue Type Schemes' tab (see above) and click the 'Edit' (in the 'Operations' column) for the relevant Issue Type scheme.
The process of editing a scheme is identical to the creation process. You can set defaults, reorder, add and remove issue types from your scheme. However, if you are removing issue types from the scheme and there are issues associated with that issue type, you will be prompted to use the Issue Type Migration Wizard which will move your issues from the obsolete issue type to a valid one. Note that if you cancel out of this process at any time, your changes will not be saved. See below for more information about the Issue Type Migration Wizard.
Associating an Issue Type scheme with Projects
To associate an issue type scheme with one or more projects:
- Go to the 'Issue Type Schemes' tab (see above) and click 'Associate' (in the 'Operations' column) for the relevant Issue Type scheme.
- Choose the projects that you wish your scheme to apply to. All selected projects will change from their current scheme to the selected scheme.
Screenshot 4: associating a scheme with a project
If the new scheme does not have an issue type that was present in the old scheme, you will be asked to use the Issue Type Migration Wizard (see below) to migrate the issues to a new issue type.
Choosing a Project's Issue Type Scheme
You may want to change a project to use a different set of issue types. To do this, choose a different Issue Type Scheme for the project as follows:
- Log in as a user with the 'JIRA Administrators' global permission.
- Click the 'Administration' link at the top of the screen.
- Click 'Projects' and select the project of interest. You will now see the 'Project Summary' screen (see Defining a Project).
- In the 'Issue Types' section, click the name of the current Scheme (e.g. 'Default Issue Type Scheme') to display the details of the project's issue type scheme.
- If using JIRA 4.4.1 or later, click the 'Actions' dropdown menu and choose 'Use a different scheme'.
If using JIRA 4.4.0, click the pencil icon instead.
Screenshot 4: The top of the Issue Types page (JIRA 4.4.1 and later)
This opens the 'Select Issue Type Scheme for project' page.
- There are three ways you can select your issue type scheme. Select the radio button that is most relevant:
- Choose an existing issue type scheme — If you know the name of your scheme (e.g. Support Projects), you can immediately choose it from the list. You will see a preview of issue types that would be available for your project as well as the description of the scheme.
- Choose a scheme that is the same as an existing project — If you do not know the name of the scheme you would like to use, but you do know the name of the project whose set of issue types you wish to use for the project you are editing, please select this option. You will be prompted to select a project and the scheme that is currently associated with the selected project will be used for your project as well.
- Create a new scheme and associate with current project — Select this option if you can't find any existing scheme that fits your needs and would like to quickly create a new scheme. Simply select the relevant issue types for your project and a new scheme will be created with the default name and order. You can edit the name, default value and order of the newly created scheme later.
- If after you make your changes there are any issues in the selected project that will have obsolete issue types, they will have to be migrated with the Issue Type Migration Wizard.
Using the Issue Type Migration Wizard
The Issue Type Migration Wizard allows you to migrate issues from an obsolete issue type to a valid issue type. The wizard will be triggered whenever an action (e.g. editing a project's issue type scheme) results in an issue type becoming obsolete (not available in the scheme).
The wizard is similar to the Bulk Move function except for that you can't change the project of the issues. The major steps are:
- Overview — provides a summary of the issues that will require migration
- Choose Issue Type
- Set new status
- Set field values
Steps 2 to 4 will be repeated for each issue type that requires migration. After you have migrated all the issues you'll see a summary of changes that will occur. If you click the 'Confirm' button, the wizard will migrate your issues to the new issue types and then complete your action.
Please refer to the Bulk Move documentation for more information on status changes and setting of fields values.