App page
Issue Templates for Jira
Cloud Server/Data Center
Issue Templates for Jira

Cloud

Server/Data Center

Documentation
FAQ
Release notes
Migration to Cloud
Last updated Oct 22, 2024

Categories

Configuration

Is it possible to configure default template for a particular request type?

Yes, it’s possible to define a template that will be automatically applied to the selected request type.

Note
Before you start, you need to add Template field to the target service screen. If you’re not sure how to add field to the screen, click here.

Steps

  1. Open project settings.
  2. Navigate to Request types.
  3. Select request type.
  4. Open Request form tab.
  5. Click Add field.
  6. Select Template field.
  7. Click Apply.
    Template field appears in Hidden fields with preset values section.
  8. Click Edit value.
  9. Select a Template.
  10. Click Set.

Result

As soon as you create issue from the request type, template will be automatically applied. Fields from template’s scope will be filled with predefined values.

Note
Fields from the Scope will be overwritten. Make sure not to overwrite fields provided by user.

Can I turn off a template?

If you don’t need a template anymore, but you don’t want to delete its issue, you can switch off Use as a template toggle in the template settings.
Template configuration is stored in issue property and is synchronized with Template field option. If you decide to stop using a template, you can simply switch off the Use as a template toggle.

In result, the panel with template settings will collapse and corresponding option will disappear from the Template select field. Switching on the toggle will bring back the configuration.

Warning

If you delete the template (by removing the issue), synced options will be also deleted from Jira. As a result, options from Template select field will be cleared in every issue created from that template. To preserve values in Template fields disable template instead of deleting it.

What happens to my templates if I change a repository from global to local?

Changing availability from global to local is a severe change, users working with this repository might lose access to their templates. The templates won’t be deleted, however, users that don’t have access to this project won’t be able to use them anymore.

This change will clear template availability settings and restore default availability. The templates will be only available locally in this project. If not changed by a Jira admin, your templates’ availability will be limited to this project only.

Issue Templates for Jira - Repository
Issue Templates for Jira - Repository

How can I migrate my old repository into the new, multi-repository system?

If you want to keep your old repository you don’t really have to do anything. The repository and its configuration are migrated automatically.

Your project will be visible on the Template Repository list in global configuration with global availability. Global availability indicates that every other project is able to use templates from that repository. Your existing templates will keep their settings in the template configuration panel (scope, availability, advanced, etc.).

The new version offers additional configuration options in project configuration and the migrated project has the following settings:

  • The template repository toggle is turned on - your project is a repository and is visible on the repository list, as a template source option on create screens and as an apply template option.
  • Permissions are set to every user of the project - this is a new feature that enables setting template permissions for specific users.
  • Template creation settings (template settings tab) are set to automatically enable new issues as templates. In the previous version all issues in a template repository were automatically enabled as templates. From now on a project admin can decide if they want issues to become templates automatically or manually.
  • Default Template Availability is set to all projects. In the previous version every new template in a repository was automatically available in all projects (availability set to apply to all projects). These settings didn’t change, however a repository admin can set a default template availability in newly created templates.
  • All previously created and configured scopes are migrated and available in project configuration. The new version introduces global and project scopes, so scopes are migrated to the project scopes tab and available for selection in template configuration.
  • Variables configuration was moved to global configuration.
Issue Templates for Jira - Repository
Issue Templates for Jira - Repository

Troubleshooting

When should I use multiple repositories and when should I use one global repository?

One global repository is usually helpful when you want all projects to use the same, shared templates. A multiple repository comes in handy if you wish to have templates specific to one or few projects.

You can read more here:

Has the order of creating issues from a template changed?

Yes, the order of creating issues changed slightly. We decided to move to bulk API in order to improve performance and avoid reaching REST API rate limits. It was problematic especially while using large templates. Before the changes, issues on the epic level were created one by one, and for each issue their descendants were created before the next issue.

Now, all issues at the same level are created at once, then for each issue its children are created. In other words, you will see all the tasks on the epic level before any of their children.

The order in which the issues are created now would be the same if you sort them by Rank. In the backlog, issues should be sorted and grouped automatically, in the navigator you can sort by Rank as follows:

project = "yourproject" ORDER BY Rank ASC

In order to filter the latest issues, narrow it down using created clause:

created > startOfDay() and project = "yourproject" ORDER BY Rank ASC

Which issue type will be used to create an issue from my template?

In the most basic scenario, it will be the issue type you can select on the Create Issue screen for the chosen project. For issues created in the background, we will try to choose the best matching issue type from the target project.

Issue types matching steps

  1. By ID - we try to find an issue type from the target project with the same ID as set in the template.
  2. By name - useful for next-gen projects, where issue types are local and always have different ID than in other projects.
  3. By type - that makes sense for the subtask type. If we can’t find a subtask by ID, we will choose any subtask type from the target project.

Why I can’t see template’s sub-tasks in issue created from template.

We can create issues from templates in two ways:

  • by using Create from template button and
  • by using Create Issue dialog box (and selecting template from the Template field afterwards)

While using Create from template, a report with results is generated at the end. Thanks to that, we can easily track if the process of creating sub-tasks is completed or has failed.

In case of using Jira Create Issue dialog box, after clicking on Create button we are immediately transferred to newly created issue. Usually, it takes few seconds for sub-tasks to be created from the parent template.

Solution

If you cannot see the relation between sub-tasks (or sub-tasks are not generated), wait few seconds and refresh the page.

How can I see which scopes are used in particular template?

Go to Manage templates screen and check used scopes in the table.

Why a form doesn’t fill automatically after selecting a template?

This function doesn’t work on the default Create issue screen. That is why we have Create from template button that opens a form which is filled automatically after the template is selected.

Do Dynamic Variables work with sub-tasks?

Yes, Dynamic Variables work with sub-tasks.

Dynamic Variables if used in sub-tasks will be replaced with values provided during creation.
There is one condition to make it work - a variable have to be declared also in a root template (the template from which you create issue). This is because variables are only collected from root issue, which means that input fields, where you fill variables values, will be displayed only for root issue. Once variables is declared in a root issue you can use it freely everywhere, e.g. sub-tasks, stories, linked issues.

When I create an issue from a template there’s an error {"errorMessages":"The value 'TEMP' does not exist for the field 'project'.","No issues have a parent epic with key or name 'TEMP-12'","warningMessages":[]} on the screen with results.

Go to your Templates Repository project settings and check if Browse projects permissions are granted to atlassian-addons-project-access role.

Info
For more information about configuring Repository for Templates, click here.

Where can I find Issue type Id?

Steps

To find Issue type Id:

  1. Go to Jira Settings.
  2. Click Issues.
  3. Click Issue types.
  4. Choose Issue type by clicking Edit.

Result

Issue type Id is in the link address.

My template doesn’t work on the customer portal, why?

Switch to the Advanced tab and turn the Allow Customers to use templates via customer portal. Issues will be created and edited by user: Issue Templates for Jira toggle on. By default, it’s turned off.

Info
Autocomplete doesn’t work on the customer portal due to API limitations. The template will be applied after the issue has been created.

Which fields should be included in scope?

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.
    Tip
    See Atlassian documentation for details about linking issues.
  • 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 a 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.

Which fields can be copied?

See the supported fields section for details.

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.

How can I get access to Template’s repository?

This message appears when you have no browse project permissions in the repository project. Check which project is the repository (stores templates) and ask the project or global administrator for browse permissions.

FAQ - repository browsing permissions
FAQ - repository browsing permissions

I have enabled the automatically enable isssues as templates option, but my subtasks don’t turn into templates.

This is an intended behavior. Subtasks are never meant to be marked as templates.

Pricing

How does Cloud app pricing work?

Cloud pricing is subscription based. You are eligible for support and automatic version updates as long as your subscription is active.

When your subscription renews each month, you are automatically billed for host products and apps based on the number of users in your instance.

If app pricing changes after your initial purchase, there’s a 60-day grandfathering period during which you can renew based on the old pricing.

How do I determine my cloud pricing?

Apps are billed based on the number of users in your Atlassian product. Jira Cloud apps are priced based on the maximum users of the Jira products on your instance. For example, if you have Jira Software (50 users) and Jira Service Management (10 agents) on the same instance, you pay the 50-user price for apps.

Note
While this app has features specific to Jira Service Management and Jira Software, the app is technically available across the whole Jira instance. Therefore the above guidelines for licensing across maximum users still apply.

The pricing structure for cloud apps is as follows:

  • Monthly subscriptions with up to 10 Atlassian product users are billed at a flat rate price.
  • Monthly subscriptions with more than 10 users are billed per user, starting at the first user.
  • Monthly subscriptions with more than 100 users are billed per user. The table above provides example pricing at various user levels.

Annual subscriptions may offer a discount depending on the number of users purchased.

Do you offer academic, community, or open-source licenses?

Yes. Academic, community, and open source licenses are available to qualifying organizations. See our Purchasing & Licensing FAQ for more information.

Can I extend my free trial?

For cloud apps, you cannot extend your free evaluation period. All cloud apps are immediately subscribed by a user, and we provide a free evaluation period. This is a minimum of 30 days and ends on the second billing cycle after you first subscribe to the app.