- Template management
- Create a template
- Template Navigator
- Template details
- Direct links
- Use as a template
- Delete a template
- Using template
- Create Structure
- Apply template
- Comment field support
- Default template
- Global configuration
- Set of Fields (Scope)
- Template Repository Management
- Event log
- JQL Searchers
Follow this configuration guide and learn more about Issue Templates.
Once you’ve installed Issue Templates for Jira from the Atlassian Marketplace, our app onboarding will guide you through the initial configuration.
Choose template repository
The first step is to choose the repository for your future templates. We’ve prepared a default project called Templates (TEMP) but you may decide to store your templates elsewhere, too.
All issues created in the chosen project will automatically become templates. This is why we always recommend the Templates (TEMP) project.
Get sample templates
On the second onboarding screen you can download a set of ready-to-use sample templates. You will find them later, in the Issue Templates - Examples (TEX) project. You can as well skip this step and get back to it later if needed.
You can choose one set of templates at a time. If you’d like to download another one, you can always go through the onboarding one more time and select a different set.
The next step offers some initial configuration of the projects where you would like to use templates. There are two basic requirements for a template to work:
- Adding a custom field Template to an issue screen (in most cases it will be the Create issue screen).
- Adding the post function Create Structure to the project’s workflow in case of:
- creating sub-tasks
- 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.
Please keep 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.
Get started with Issue Templates
Finally, the onboarding brings you to the Create a template screen, where you can start creating your own templates. You will be able to edit and configure them later, in your Templates (TEMP) project.
Use Case - Sport Card Benefit
Learn how to use Issue Templates by following a simple example
Let’s start with the simplest case. Say, you’d like to have a single template for requesting a Sport Card Benefit. The template will generate the same Summary and Description every time someone uses it to create an issue.
Create a template
Templates are like regular Jira issues, so the first thing you need to do is to create a single template issue.
To create a template:
- Click Create at the top of the screen to open the Create issue dialog box.
- In the Create Issue dialog box, select the Template Repository project - the default repository is called Templates (TEMP).
- Choose Template as the Issue Type.
- Fill in the Summary and Description fields.
- Click Create.
Edit a template
Your template is already working, but you might want to refine it. In order to manage it further:
- Go to Template Navigator.
- Click on the newly created template to open the Template Details panel to the right.
Go to the General tab.
Add a Template name
The summary you provided while creating the template will automatically become your template’s name. You can change it if you wish, in order to easily find it later.
Add a Category
Adding a category to your template is also a good idea. It will help you organize greater numbers of template issues thanks to a dedicated display mode for it. It might become very helpful in the future as your template repository grows.
Add a Description
It is not mandatory but adding a short description could help your colleagues choose the right template for their task. It will appear on the Create Issue screen, right below the Select Template field.
Choose a Set of fields
Decide which Jira fields should be automatically filled in on the Create Issue screen in issues generated by this template. There is always a default set that you can use, but you may decide to add fields separately. Summary and Description will be enough for this simple case.Info
Read more about Set of fields here.
Manage the Availability
Choose where your template should be available. By default, it will be selectable on the Create Issue screen. If you wish to make it available on the Customer Portal, turn on the switch right next to Request Form.
In order to use your template, you need to add the Template field to the Create Issue screen of your target project. You can either configure all projects at once in the initial project configuration panel, or you can add the Template field to each project separately.
Configure all projects at once
You can access the initial project configuration panel at any time.
To add the Template field to the Create issue screen in one or more projects:
- Go to Issue Templates in the upper navigation bar.
- Select Get Started.
- Click through the Onboarding steps until you arrive at the Configure project screen.
- Click the plus icon next to the selected projects.
Configure one project at a time
You may want to add the Template field to a screen in one project only. This way is particularly useful when you wish to add the Template field to other screens, like the Edit issue screen.
To add the Template field to a screen in one project:
- Open the project, where your template should be used and go to the Project settings.
- Go to Screens and select the screen. (In this example we’ll choose the Create Issue screen).
- Select the Template field in the lower search bar and click Add.
Every time someone creates an issue in this project they will be able to select a template from a drop-down list.
Create an issue using your template
Now you can create the first issue using your template:
- Go to the project where your template should be applied.
- Click the Create button.
- Navigate to the Template field and expand the drop-down list.
- Select your template from the list.
Summary and Description have been populated by your template in the new issue.
If you can’t find the answer you need in our documentation, raise a support request*.