STM for Jira Cloud - Adding a template

This page explains how to create a new template in STM.  The first step is to go to either the projects STM Templates page (Go to a project, click on Add-ons from the left-hand menu and select STM Templates) or STM Global Templates (click on the Apps dropdown menu at the top of the page then STM Global Templates).

NOTE: This page assumes you have clicked on the plus button and have entered the Add Template page.

The video below covers an overview of this page.

Adding a template

 

On the right-hand side of the templates page is a button with a plus symbol.  Click on this to add a new template.

stm-t-template-list.gif

This will open you into the add templates screen.

stm-t-create-1-details.gif

You can now enter the name for this Template and define if the current user would be added as a watcher. If you want to add more documentation about the template then you can click on the "Show more documentation options" link. This will show two additional fields that allow you to optionally enter a description and a URL.

When you have finished with this you can either click on the next button or the Create Issue section in the left hand panel.

Specify the details of an issue to create

You can now define the values of the issue you want to create.  You can use the "Fields to display" dropdown to add or remove fields whose value you want to set.  The rubbish bin in the top right can be used to remove this Create Issue section and the question marks on the left-hand side of the fields show information relevant to the field.

The following fields are available in the Create Issue sections ONLY if they are in the Issues create screen.  If they are not then you can add them by going to the projects admin section, selecting the Screens menu item and adding them.

  • Summary: the summary of the Issue.  You can refer to parent fields here by using one of: ${Summary}, ${Description}, ${Type}, ${Assignee}, ${Reporter}, ${Priority} or to a custom field, i.e. ${My Custom Field Name}.  If no value is present then the word null show unless an ! is placed after the $ symbol (i.e. $!{Description} will show the description if it is present otherwise it will show nothing). Field references are case sensitive.  If this is a Repeating Template (see below) then you can refer to the repeated field value by using ${RepeatItem}

  • Assignee: The user that the issue will be assigned to.  You can also refer to the parent issues reporter or assignee by entering ${Reporter} or ${Assignee} respectively.

  • Components: The component(s) that the issue should have.

  • Description: a description of the Issue.  You can also refer to the same fields as defined for the Summary (i.e. ${Reporter})

  • Due Date: either the word today (for the day the Sub Task is created), a date (in the format YYYY-MM-DD) or the number of days, weeks and months from the day the Sub Task is created (i.e. 1m 2w 3d for one month, two weeks and three days, 2d for two days ...)

  • Original Estimate: the number of minutes, hours, days and weeks (i.e. 3d 4h, 1w 10m ....), as a percentage of the parent's original estimate (20%) or as a multiplier of the parent estimate (*0.25)

  • Fix Versions: The fix versions for this issue.

  • Issue Type: Defined the issue type for this issue 

  • Labels: Any labels you wish to add

  • Priority: one of the pre-defined priorities for an Issue

  • Reporter: Start typing the user's name and a selection of matching names will appear.  You can also refer to the parent issues reporter or assignee by entering ${Reporter} or ${Assignee} respectively.

  • Custom Field: you can specify any custom field (up to five total) of type single-line text, multi-line text, number, and single select item. The value for that selected field can be specified.

  • Project Key: The key of the project this issue belongs to (can't be used for subtasks).

 

The fields that are showing don't necessarily have to have values in them. In the example above there a a few fields that are visible but empty.  This allows the user, using the template to create Sub Tasks in the Bulk Create pages, to easily enter values for them with minimum fuss.

If you want to create another then you can click on the yellow plus next to the grey plus.  This will have the same "Fields to display" as the last "Create Issue" created. 

stm-t-create-3-add-issue.gif

You will now see the following

Creating a second issue

You can add as many of these issues as you wish, each with the fields that are required.  When you have finished adding new issue details to create there are additional options that you can use.  Click on the Next button or the Path section of the left-hand panel and the panel below will be shown.

Selecting optional paths for the template

Copy From Parent

The Copy From Parent option allows you to copy the fields that belong to the parent of this issue.  If you click on this option then the following page will be shown.

Copy details from parent issue

You can select as many fields as you want and those values will be copied into each issue created UNLESS that "Create Issue" sets a value for it.

Cascade Template

Cascade templates allows you to create a sub-template for the current issues being created.  For example, if template A creates three issues and you have specified a cascade for template B (creates two issues) then each of the three issues from template A will have two issues created for them (i.e. A1 will have B1 and B2, A2 will have B3 and B4 and A3 will have B5 and B6).

Cascading a template

Repeat Template

The Repeating Templates section allows you to create a template multiple times based on either the Component or Fix Version fields. The example below say to create the issue in this template for each component.  If there were two issues in this template and three components then a total of six issues would be created.  The "Set Repeating fields value in new issue" checkbox will make the field, component in this case, have the value that is being iterated over.  So for the previous example the first two issues will be set to the first component, issues 3-4 will be set to the second component ...

Creating a repeating template