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 Sep 2, 2020

Variables

Learn how to use variables in your templates

Variables are placeholders that get automatically filled in when you create an issue using a template. They make your templates consistent and easier to use. Not to mention saving you a lot of time!

A wide range of repetitive tasks can be significantly improved:

  • Service Desk activities get a lot faster, with customized variables like selection and multi-selection lists, as well as ready-to-use support forms with only a few gaps to fill in.
  • Software Development tracking gets a lot easier with system variables like PARENT_STATUS, PARENT_DUE_DATE or TODAY (day of the issue creation).
  • Human Resources teams can automate new joiners’ hiring process by creating custom user variables, like [NEW EMPLOYEE NAME], [DEPARTMENT], [START DATE], and basically any value you can think of - you configure them yourself!

There are two types of variables available:

System variables are placeholders with a fixed definition. You can paste them into text fields in your template issues. They are available in all projects within the Template Repository (TEMP) and will always have the same meaning. See a list of all available system variables here.

User variables are created by you. You can choose any values to become variables in your templates and adjust them to your needs. You may also make them available for your team in all templates. Read more about user variables’ configuration here.

Permissions

Depending on your Jira permissions, you might be able to perform different actions with variables.

If you have the Create issue permission, you’re able to:

  • view the list of variables
  • preview the variable’s definition
  • use variables in issues (copy & paste)

If you are an Administrator (either Project Administrator or Jira Administrator), you can also:

  • create new variables
  • edit variables’ properties
  • remove variables
  • reorder variables within the variables’ list
  • reorder options within selection and multi-selection lists

How to start

Here’s a short guide on adding variables while creating a template.

Create a template

Steps

To create a template with variables:

  1. Go to Projects > Templates and click Create.
  2. Choose the Issue Type and add a Summary. If it is an epic, you need to add an Epic Name as well. Template’s Description can be added in the next step, together with variables.
  3. Click Create.
Issue Templates for Jira - Create a Template with Variables
Issue Templates for Jira - Create a Template with Variables

Edit the template

Now that your template draft is ready, reopen it by clicking on the template’s issue key:

Issue Templates for Jira - Open the Issue View
Issue Templates for Jira - Open the Issue View

You can start writing the Description and add variables to every text field in your template. There are several ways to add variables:

  1. Copy an existing user variable from the panel and paste it into the text.
  2. Create a new user variable by clicking on the plus icon. It will then be added to the panel where you can copy it and insert it into your description.
  3. Use a system variable: go to the System tab and select a system variable of your choice. Copy and paste it, just like the user variables.
Issue Templates for Jira - Add Variables to a Template
Issue Templates for Jira - Add Variables to a Template
Note
  • Make sure you’ve added the Template field to the Create issue screen of your project.
  • If you want to use your template in the Customer Portal, go to the Availability tab and switch on the toggle next to Request form.

Now let’s see our template in use:

  1. Go to your target project, click Create and select the new template.
  2. Type in the values for each variable. (System variables will be replaced automatically).
  3. Click Replace values in fields and then Create.
Issue Templates for Jira - Add Variables to a Template
Issue Templates for Jira - Add Variables to a Template

Result

All the variables you defined have been replaced in the newly created issue. If the issue has sub-tasks, then the variables have been replaced there, too:

Issue Templates for Jira - Add Variables to a Template
Issue Templates for Jira - Add Variables to a Template

Customer Portal

Variables work on the Customer Portal as well. Here’s what our example looks like when seen from the user’s perspective:

Issue Templates for Jira - Variables on the Customer Portal
Issue Templates for Jira - Variables on the Customer Portal
Tip

Read our use case and learn how variables work in practice.

Need help?

If you can’t find the answer you need in our documentation, raise a support request*.

*Include as much information as possible to help our support team resolve your issue faster.