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

Selecting a template

This chapter provides information about selecting a template.

There are three ways to select a template:

Warning
Don’t use different ways to select a template at the same time. It will make the app apply template twice.

Template select

The first and the most recommended way to select a template is the Template Select rendered by the ITC app.
For example, while using Create from template dialog or Apply template dialog.

Issue Templates for Jira Cloud: Template Select
Template Select

Template Select allows you to search for templates using search syntax for text fields. In Template drop-down list, names of templates are displayed with issue type icons.

Note
Displayed template’s name is not the Summary of template issue.

Match type

Under each Template Select you will find a Match type checkbox. As soon as you check Match type, templates will be filtered - only those with the same name of issue type as the target issue type will be displayed.

Issue Templates for Jira Cloud: Template Custom Field
Template Custom Field

The Issue Templates for Jira app use the name of issue type instead of issue type ID in order to support team-managed projects.

Template custom field

You can choose a template by using Template custom field, provided by the ITC app.

Note
Use Template custom field only in places, where Template Select is unavailable.
Warning
Don’t use Template custom field if you have already selected a template in Create issue from template dialog. If you select a template twice, it will be applied twice.

Template custom field is rendered by Jira, and its design can’t be changed. Providing new features like categories or filtering is also limited, therefore we recommend using views provided by the app, where Template Select is available.

Issue Templates for Jira Cloud: Template Custom Field
Template Custom Field

Create issue with property

You can use Jira REST API to Create issue and add to the body of the request’s issue.templates.automation property.

{ 
  "properties": [
    { "key": "issue.templates.automation", 
      "value": { 
        "applyTemplate": "TEMPLATE-1"
      }
    }
  ]
}
Note
You need to construct a minimal required payload to create the issue.

Provide:

  • Project
  • Issue type
  • Summary
  • other required fields from your issue type

Example

TEMPLATE-1 is an issue key of your template. As soon as you click Create, TEMPLATE-1 will be applied to the issue. It may overwrite provided summary based on your template’s scope.

Use the example below to create similar configuration.

{
    "fields": {
        "project": {
            "key": "JSA"
        },
        "summary": "Create issue from Postman",
        "issuetype": {
            "id": "10000"
        }
    },
    "properties": [
            {
                "key": "issue.templates.automation",
                "value": {
                "applyTemplate": "TEMPLATE-1",
                "variables": {
                    "MyDynamicVariable": "abc"
                }
            }
            }
    ]
}

You can also provide values for dynamic variables defined in your primary template as shown above.

Add a shortcut to Create from template view

Steps

To add Create from template button under Project:

  1. Go to the Project, where you want to add direct link that opens Create from template screen and click Add shortcut.

  2. Click Add next to the description of shortcut.

  3. In the dialog box select the following:
    a. Provide the [Link].
    b. Type a Name of your shortcut.

  4. Click Add.

Result

Your custom Create from template button is added under the project.

The feature makes possible to create a link that directly opens the issue creation form with Template and other fields already selected. The link can be reused by adding new item on general page or under selected project. There are two kinds of links: Project link and General link that opens Create issue from template view with and without project context (sidebar).

Steps

To create a link which will open Create from template view:

  1. Paste the following link to your Jira Cloud link and replace the data:

https://yourdomain.atlassian.net/plugins/servlet/ac/com.intenso.jira.issue-templates/create-issue-from-template?ac.projectKey=SCRUM&ac.templateKey=PMT-45&ac.issueTypeId=10600

  1. Here’s the list of available parameters, that can be added to the link:
Parameter Example
ac.projectKey SCRUM
ac.issueTypeId 10000
ac.issueTypeName task
ac.templateKey PMT-1
ac.templateId 10000
Info
  • Parameters respected by app must be prefixed with ‘ac.’ Separate them by ‘&’.
  • Make sure all letters size are correct. Otherwise, the link may not work.
  • If you do not know how to find Issue Type ID check the FAQ.

Result

Create from template view has been opened.

Steps

To create a link which will open Create from template view in Your Project context:

  1. Go to the Project, where you want to add direct link that opens Create from template screen and click Create from template.

  2. Use the link below and replace the data accordingly:

https://yourdomain.atlassian.net/projects/SCRUM?selectedItem=com.atlassian.plugins.atlassian-connect-plugin:com.intenso.jira.issue-templates__create-issue-from-template-project-page&ac.projectKey=SCRUM&ac.templateKey=PMT-45&ac.issueTypeId=10600

Here’s the list of available parameters:

Parameter Example
ac.projectKey SCRUM
ac.issueTypeId 10600
ac.templateKey PMT-1
ac.templateId 10000
Info
  • Parameters respected by app must be prefixed with ‘ac.’ Separate them by ‘&’.
  • Make sure all letters size are correct. Otherwise, the link may not work.
  • If you do not know how to find Issue Type ID check the FAQ.

Result

Create from template view has been opened in your project.