Apps documentation
Issue Templates for Jira
Cloud Server/Data Center
Issue Templates for Jira

Cloud

Server/Data Center

Documentation
FAQ
Release notes
Articles & Videos
Last updated Apr 16, 2023

Project setup

Prepare your target project for using templates.

Issue Templates can be used in any kind of Jira project. Depending on the project type there are different steps to be taken in order to prepare it for the use of templates. Here we describe all the basics but you’ll find many more configuration ideas in the further chapters.

Configure project

There are two basic requirements for a template to work:

  1. Adding the Template custom field to an issue screen (in most cases it will be the Create issue screen).
  2. Adding the Create Structure post function to the project’s workflow. The post function is necessary for:
  • creating subtasks
  • creating epics with stories
  • creating complex structures of linked issues
  • using the Attachment and Issue Link fields in your templates

We’ve made it easy for you, allowing you to add both in a single step on this onboarding screen.

Warning

Kep in mind that adding a post function to an existing workflow might interfere with some more complex configurations. If you are not sure how it would affect a particular project, we advise you to configure it separately later on. You’ll find it all explained in the next sections.

Jira Issue Templates - Configure project
Issue Templates for Jira - Configure project

About the Template field

Issue Templates provides a dedicated field called Template. It is a Select List (single choice) custom field containing all the templates available in a given context (learn more in the Availability chapter). It allows users to select a template that will be applied on the screen.

Issue Templates for Jira - Project setup: Adding the Template field to a screen
Issue Templates for Jira - Project setup: Adding the Template field to a screen

The Template field can be added to:

  • Create issue screen
  • Edit issue screen
  • Transition screen

Adding the Template field to a screen

You’ll need to add the Template field to all the screens where you wish to apply a template.

Steps

To add the Template field to a screen:

  1. Go to your target project > Project settings.

  2. Open the Screens configuration page.

  3. Expand the Screen Scheme section.

  4. Select the screen where templates should be added.

    Issue Templates for Jira - Project setup: Adding the Template field to a screen
    Issue Templates for Jira - Project setup: Adding the Template field to a screen

  5. Start typing and select Template (Deviniti [Issue Templates] - Template Selection).

  6. Click Add.

    Issue Templates for Jira - Project setup: Adding the Template field to a screen
    Issue Templates for Jira - Project setup: Adding the Template field to a screen

  7. Drag and drop to change the Template field’s position.

    Issue Templates for Jira - Project setup: Adding the Template field to a screen
    Issue Templates for Jira - Project setup: Adding the Template field to a screen

Tip

We advise to place the Template field to near to the top of the screen, as it often autofills the upper issue fields, such Summary and Description. When the Template field is near to the top, the users will instantly see what changed after applying the template.

Result

The Template custom field is added to chosen screens. Users can select a template to be applied on the screen.

Issue Templates for Jira - Project setup: Adding the Template field to a screen
Issue Templates for Jira - Project setup: Adding the Template field to a screen

Examples

Expanded list of templates:

Issue Templates for Jira - Project setup: Adding the Template field to a screen
Issue Templates for Jira - Project setup: Adding the Template field to a screen

Template field when a template containing variables is selected:

Issue Templates for Jira - Project setup: Adding the Template field to a screen
Issue Templates for Jira - Project setup: Adding the Template field to a screen

Changing the name of the Template field

You can change the name of the Template custom field and add a description, just as you would do with any other custom field.

Warning

This change will affect all the projects where templates are used.

Steps

  1. Go to Jira Administration > Issues.

  2. Open the Custom fields configuration page.

  3. Search for the Template custom field.

  4. Click on the cog icon under Actions and select Edit.

    Issue Templates for Jira - Project setup: Changing the name of the Template field
    Issue Templates for Jira - Project setup: Changing the name of the Template field

  5. Provide a new Field Name.

  6. Provide a Description (optional).

  7. Click Update.

    Issue Templates for Jira - Project setup: Changing the name of the Template field
    Issue Templates for Jira - Project setup: Changing the name of the Template field

Result

The name of the custom field has changed.

Issue Templates for Jira - Project setup: Changing the name of the Template field
Issue Templates for Jira - Project setup: Changing the name of the Template field

Need help?

If you can’t find the answer you need in our documentation, raise a support request.