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 Sep 20, 2021

Template’s fields

This chapter provides information on how to set and maintain template’s fields.

Which fields are copied and when?

Issues from template are created in two steps:

  1. Basic issue is created in target project. Its required fields have values taken right from the template. At this point, Scope is not taken into account.
    Note
    If an issue type in target project contains required fields, make sure that the template has the same fields filled with values. Otherwise, issue won’t be created.
  2. Issue is updated based on the template’s fields (scope). All non-empty values listed in template’s fields are gathered from the template and then used to update the issue. At this point, screen settings are not taken into account.

What is Template’s fields (Scope)?

Scope is a set of fields used during the process of creating new issue or applying the template to an existing issue. With Scope, you can decide which optional fields are copied. In order to copy an optional field, you need to explicitly add it to the scope.

Required fields are obligatory to create an issue. Therefore, those fields will be copied even if they’re not included in scope.

By default, a new template is configured to inherit the scope. It is useful especially when you create epics with many stories and subtasks, and you need the same scope for whole issue’s hierarchy. If scope can’t be inherited, default scope will be used.

Tip
We recommend you to configure scope at least for your primary templates (those you explicitly select when you apply a template, i.e. epics, primary stories).

Default scope can’t be deleted. However, you can set any of your scopes to be the default one. For further information navigate to Default scope section.

To configure Scopes navigate to the Template’s repository > Project settings > Issue Templates. Open Scopes tab to:

Issue Templates for Jira Cloud: Set of fields - Scope
Set of fields - Scope

How to add a new scope?

Steps

To add a new scope:

  1. Click Add in the left column, under scopes. The Add scope dialog box appears.
  2. Type Scope name.
  3. Click Add.
Issue Templates for Jira Cloud: Set of fields - Scope
Set of fields - Scope

Result

A new scope has been added. Now you can add fields to the scope

Issue Templates for Jira Cloud: Set of fields - Scope
Set of fields - Scope

How to add fields to the scope?

Steps

To add a field to the scope:

  1. Click on the target scope.
  2. Click the drop-down menu and choose a field, which you want to add to the scope.
Issue Templates for Jira Cloud: Set of fields - Scope
Set of fields - Scope

Result

Selected field has been added to the scope.

(Inherit) option

If you choose to inherit scope, we will try to use the scope set in the parent issue. This means that all issues under an epic inherit its scope. If you have an epic > story > subtasks structure, then the subtask will inherit scope from the story, but if the story’s scope is also set to (inherit), then the subtask will inherit scope from the epic directly.

Issue Templates for Jira Cloud: Set of fields - Scope
Set of fields - Scope

Note

Scope inheritance does not work for linked issues, therefore you should explicitly set the scope in each one of them.

Default scope

Newly created templates are configured to inherit scope. However, there are some cases when we can’t use this option. Then, the default set of fields will be used.

This scope cannot be deleted, but it’s possible to change it. You can choose one of your scopes and set it as default at any time.

Steps

To configure the default scope:

  1. Click More icon.
  2. Click Set a default.
    Issue Templates for Jira Cloud: Set of fields - Scope
    Set of fields - Scope

Result

Your scope has been set as the default one.

Issue Templates for Jira Cloud: Set of fields - Scope
Set of fields - Scope

Which fields should be included in scope?

There’s no silver bullet for building the perfect default scope. However, there are few fields that you should consider while preparing a set of template’s fields:

  • Reporter - copying the Reporter field may be the best solution for cloning issues. On the other hand, if you’d like users to use templates and be the reporters, remove it from the scope or use All fields except and Reporter options.
  • Linked Issues - by adding or removing Linked Issues field you can decide if links should be copied or not.
  • Epic Link - in most cases the correct epic link is added automatically and no other action is required. However, there’s one exception to that rule. Suppose you have a story template with an Epic parent template (Epic Link points to the epic template). You are using the default scope, which copies all the fields including Epic Link. If you apply the story template to some existing issue (let’s call it EXG-1), all the fields including Epic Link will be copied. As a result, EXG-1 will be linked to your Epic template. Consider if this is the desired outcome and decide whether Epic Link should be added or removed from the scope.
  • Sprint - if you decide to add a Sprint field to the scope, the template and new issue will share the sprint. For further information navigate to Jira Software chapter.
  • Summary - if you apply template to an existing issue, changing its Summary may be redundant. Placing Summary in scope is the best solution in case of creating new issues from the template.

Need help?

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

*Include as much information as possible to help our support team resolve your issue faster.