Apps documentation
Issue Templates for Jira
Server/Data Center Cloud
Issue Templates for Jira

Server/Data Center

Cloud

8.x
7.x
FAQ
Release notes
Last updated Jun 14, 2020

Use Case - Jira Webinar

See an example of how to use Create Structure in a project

Your team spent a lot of time and effort preparing an event. Why not profit from what you’ve achieved and save it for the next time? You can reuse the entire work schedule using Issue Templates.

Let’s use the Create Structure post function to organize a webinar for developers. We’ll create an epic with stories, sub-tasks and attachments, so we’d better start with some initial configuration.

Configuration

Fields & Screens

First of all, we need to have proper fields available on our Create Screen.

Steps

  1. Open Template Repository project settings and select Screens.
  2. Go to TEMP: Templates Field Screen.
  3. Add new fields. (In our example: Template and Epic Name).
  4. Drag and drop to rearrange the fields in the desired order.
Issue Templates for Jira - Create Structure: Add Fields to Create Screen
Issue Templates for Jira - Create Structure: Add Fields to Create Screen
Issue Templates for Jira - Create Structure: Add Fields to Create Screen
Issue Templates for Jira - Create Structure: Add Fields to Create Screen
Tip

You may also remove the fields you don’t need to make the initial screen short and tidy.

Issue Types

By default, there are only two issue types in the Template Repository (TEMP): Template and Sub-template. If we want to build a more complex structure, we need to add other issue types manually.

Steps

  1. In Template Repository’s projects settings, select Issue Types.
  2. Go to Actions > Edit issue types.
  3. Drag and drop desired issue types* from the table on the right to the one on the left.
  4. Click Save.

*In our case: Epic and Story.

Issue Templates for Jira - Create Structure: Add Issue Types
Issue Templates for Jira - Create Structure: Add Issue Types
Issue Templates for Jira - Create Structure: Add Issue Types
Issue Templates for Jira - Create Structure: Add Issue Types

Set of fields

Next, we need to set up the Set of fields in order to choose which types of fields should be autofilled in our project. We can choose an existing set or add fields manually.

Steps

  1. Open Template Repository project settings.
  2. Select Set of fields.
  3. Add new fields. (In our example: Description, Summary, Attachments and Epic Name.)
  4. Select the field mode with a toggle.
Note

In our example, we’ll use the Overwrite mode, so that those fields in the target issue will be filled in with what’s written in the template. If you’d like those fields to be editable in the target issue, just switch the toggle to turn it off. Read only mode would block editing and make the fields greyed out.

Issue Templates for Jira - Create Structure: Edit Set of Fields
Issue Templates for Jira - Create Structure: Edit Set of Fields
Info
You can create a set of fields or add fields to an existing scope also from the template’s issue screen – under the Set of fields tab. Read more about Set of fields here.

Create New Template

Now the initial configuration is ready and we can create our template.

Create Epic

Let’s build an Epic - the main issue containing our structure. For more complex projects, you’ll be able to link two or more epics together later on.

Steps

  1. Go to Projects > Templates (TEMP) and click Create in the upper bar.
  2. Fill in the fields you’d like to be autofilled in your future projects and click Create at the bottom of the form.
Info
If you’d like to use variables, just re-open the newly created template issue and add them. Read more about Variables here.
Issue Templates for Jira - Create Structure: New Template Issue
Issue Templates for Jira - Create Structure: New Template Issue

Create Story

Now it’s time for Stories - more specific issues that will bind together related sub-tasks.

Steps

  1. Open the newly created Epic and change the Default Template Name to something recognizable to easily find it later.
  2. Click on the plus icon next to Issues in Epic.
Issue Templates for Jira - Create Structure: New Template Issue
Issue Templates for Jira - Create Structure: New Template Issue

Create Sub-task

There are three Stories in our example: Presentation, Mailing and Social Media. Let’s create sub-tasks and see how they can be linked to each other.

Steps

  1. Open the newly created Story (in our example: Presentation).
  2. Go to More > Create sub-task.
Issue Templates for Jira - Create Structure: New Template Issue
Issue Templates for Jira - Create Structure: New Template Issue

Our first sub-task is related to the presentation’s content and must be completed before other colleagues start working on the visual aspects of our webinar: graphics and presentation slides. Let’s see how we can make that relation visible within our project.

Issue Templates for Jira - Create Structure
Issue Templates for Jira - Create Structure

Steps

  1. Open the task you’d like to relate to another Template issue.
  2. Go to More > Link.
  3. Add new fields. (In our example: Description, Summary, Attachments and Epic Name).
  4. Select the field mode* with a toggle.
Issue Templates for Jira - Create Structure: Link Template Issues
Issue Templates for Jira - Create Structure: Link Template Issues

Tip: This function allows us to connect our template to any other issue, as well. If we select relates to from the drop-down list, we’ll be able to choose from all issues we’ve created before:

Issue Templates for Jira - Create Structure: Link Issues
Issue Templates for Jira - Create Structure: Link Issues

Implement Create Structure

Now that our template structure is ready, we can use it to create a new project.

Steps

  1. Open your target project (in our case Basic Software Development).
  2. Go to Projects Settings > Workflows.
  3. Select the default workflow and click on the edit icon under Actions.
  4. Click on the first transition (Create) and go to Post Functions.
  5. Click Add Post Function and select Deviniti (Issue Templates) - Create Structure.
  6. Remember to Publish the changes.
  7. Go to Project Settings > Screens and select your projects Default Issue Screen.
  8. Add the Template field.

Issue Templates for Jira - Create Structure: Add Post Function
Issue Templates for Jira - Create Structure: Add Post Function
Issue Templates for Jira - Create Structure: Add Post Function
Issue Templates for Jira - Create Structure: Add Post Function
Issue Templates for Jira - Create Structure: Add Post Function
Issue Templates for Jira - Create Structure: Add Post Function

Tip

Make sure that the Create Structure post function is listed under the step Creates issue originally and before Re-index an issue to keep indexes in sync with the database.

Issue Templates for Jira - Create Structure: Add Post Function
Issue Templates for Jira - Create Structure: Add Post Function
Issue Templates for Jira - Create Structure: Add Post Function
Issue Templates for Jira - Create Structure: Add Post Function

We are all set to create our structured issue:

Steps

  1. Select the project you’ve set up before (in our case Basic Software Development).
  2. Select Issue Type (in our case Epic).
  3. Select your template from the drop-down list (in our case JIRA Webinar).
  4. Define the Variables and click Replace All.
  5. Fill in other fields and click Create.
Issue Templates for Jira - Create Structure: New Issue
Issue Templates for Jira - Create Structure: New Issue
Tip

If you’d like only your main template (for example epic) to be visible on the create issue screen, just disable all subordinate issues (it doesn’t apply to sub-tasks). Read more about Availability here.

Result

We’ve created a structured template that can be reused anytime to quickly set up a complex project:

  • Stories are listed under the Epic
  • Tasks appear under Stories
  • The relation between tasks is visible
  • Attachments get copied into proper tasks
  • Variables get replaced in the whole structure

Issue Templates for Jira - Create Structure
Issue Templates for Jira - Create Structure
Issue Templates for Jira - Create Structure
Issue Templates for Jira - Create Structure