Working with templates
- Pascal Perreault [Okapya]
- Maxime Lefebvre
Available since 5.1.0
Templates make it easier to create checklist items for recurring tasks. They help standardize processes and ensure that the required steps get completed.
With templates, users don’t have to input each item by hand, which reduces the risk of human error. They can then just adjust bits and pieces as needed and focus on completing their tasks.
Templates are bound to a checklist’s configuration scheme context and can be used in either one specific project or in all projects within that context.
The features that are available to use within the template are dictated by the configuration scheme context’s settings.
Templates can be viewed from the following pages:
Issue’s checklists
While editing a checklist field inside an issue, open the template drop-down and select Manage Templates.
Manage apps
Go to Administration > Manage apps.
In the sidebar, go to Checklist for Jira > Templates.
The administrator template page will be displayed, where you can browse all templates.
Project settings
Field config context
Some fields and layouts may vary depending on what page you are viewing the templates on. The fundamentals are the same, but the interface changes slightly for ease of use if you are already inside a custom field or project. All screenshots on this page are taken from the Manage apps page.
Searching templates
At the top of the template list, various filter options are available. All filters are cumulative; for example, filtering by checklist and project would only show templates that matched both filters.
Filter by name
Manage apps project settings field config context
This filter is case insensitive and returns templates with names that contain the entered text.
Filter by checklist
manage apps project settings
This filter returns templates that can be used in the specified checklist. Because a checklist can have multiple configuration scheme contexts, it can be simpler to filter by the checklist field itself.
Filter by context
manage apps
This filter returns templates that can be used in the specified configuration scheme context.
Filter by project
manage apps field config context
This filter is used to filter the Project column specifically. It is not used to display all the templates that are available for a certain project.
For more information on the Project column, see the table in the Creating templates section below.
Creating templates
To create a template:
Click the Create template button at the bottom right of the template list.
In the Create Template dialog that appears, fill out the fields as described in the table below and click Next.
In the next page, fill out the template’s items and click Create.
Field | Description |
|---|---|
Name | mandatory The name of the template that will be seen and searched by users. |
Description | Additional information about the template that can be seen when browsing templates in template lists. |
Owner | The owner of the template. Non-administrators can edit templates they own. Defaults to the creator of a template. Only editable by administrators from the Field config context and the Manage Apps pages. |
Checklist (Context) | mandatory The configuration scheme context to which the template can apply. This determines what features are available when adding and editing items. On the Project settings page, this field is replaced with a Checklist selection drop-down, but its role remains the same. |
Project | The project to which the template is specific. Project-specific templates can be edited by the project’s administrator from the Project Settings page or through REST APIs. Templates that are not project-specific are considered global and will be available in all projects within the template’s custom field context. Because global templates can be used in other projects, only administrators can edit or delete them from the Manage apps or Field config context pages or through REST APIs. A preview will still be available when the preview icon is clicked. |
Importable | Indicates if this template is available when importing a template in a checklist. Templates that are marked as “not importable” are typically used for Default Local Items and/or Post Functions and aren’t meant to be used by end users. |
Pinned | Indicates if the template appears at the top of the template menu for quicker access. |
Checklist items | The checklist items that the template contains. For more information about working with checklist items, see Editing checklists in Jira issues. |
Editing templates
To edit a template:
Click the pencil icon at the end of a template row.
In the Edit Template dialog that appears, edit the items as needed and click Update.
Configuring templates
To configure a template:
Click the cog icon at the end of a template row.
In the Configure Template dialog that appears, edit the fields as needed and click Update.
Deleting templates
To delete a template:
Click the trash icon at the end of a template row.
In the Delete Template dialog that appears, click Confirm.
Template usages
If the template is in use, the Delete Template dialog will show a warning.
By deleting the template:
Default local items using this template will be empty.
Post function(s) using this template will now be empty. Depending on the configuration, they will either append no items or replace the checklist’s contents with an empty checklist.
References should be updated if these are not the desired behaviors.