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

Cloud

Server/Data Center

Version 8.x
Version 7.x
FAQ
Release notes
Articles & Videos
Last updated Apr 16, 2023

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!

Types of variables

System variables - are placeholders with a fixed definition. You can paste them into text fields in your template issues. They are available in all templates within the Template Repository (TEMP).

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 the templates.

Supported fields

You can use variables in the following fields and custom fields:

  • Summary
  • Description
  • Text Field (single line) custom field
  • Text Field (multi-line) custom field
  • Environment
  • Labels system field
Note

The Labels custom field is not supported.

Examples

A wide range of repetitive tasks can be significantly improved by using variables:

Service Management 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!

Tip

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:

  • create new variables
  • 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 global variables (available to all users)
  • 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.

Adjusting the template

  1. Create a template or use an existing one.

  2. Now that your template draft is ready, select it from the template list :

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

Insert variables

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

Steps

To insert variables into a template:

  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.
Jira Issue Templates - 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.

Define values

Now let’s see our template in use:

Steps

To create an issue using a template with variables:

  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.
Jira Issue Templates - 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 subtasks, then the variables have been replaced there, too:

Jira Issue Templates - 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 customer’s perspective:

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

To use your template in the Customer portal, go to the Availability tab and switch on the toggle next to Request form.

Next steps

Need help?

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