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 28, 2020

User Variables

Learn about user variables and their configuration options.

User Variables

In the first tab, under User, you’ll see the variables that you’ve created before. You can use the search function to find additional ones or just copy the variable key and paste it in any text field in the template.

If you have administrator access, you may also create and define new variables. Just click New variable:

Issue Templates for Jira - Variables
Issue Templates for Jira - Variables

… and you’ll see a new panel with all the configuration options.

Configuration Options

There is a range of possible settings in the panel. Scroll down to read their descriptions:

Issue Templates for Jira - Variables
Issue Templates for Jira - Variables
  1. Define variable
  2. In other words, give it a name. You will be able to search for your variable using the key typed within square brackets.


  3. Field type
  4. Here you can select the type of the field that should appear every time you use the variable in issues built on your template. There are four types available:


    • Text (single line)
    • Text (multi-line)
    • Select
    • Multi-select

  5. Options
  6. If you decide to use select or multi-select, you can define which options should be available. You may also rearrange them by drag and drop.


  7. Label
  8. It's a good idea to add a label to your variable in order to make your templates look more elegant. Example: to avoid showing a generic START_DATE in your final issue, just type in Start date in here and it will be replaced in all the issues built on your template.


  9. Description
  10. You may want to give other users a hint about what your variable does. The description will appear right below the variable's field.


  11. Required on create screen
  12. Use this option if you want to make your variable mandatory on the create screen. Then, every user creating an issue using your template will be prompted to fill in the variable's field with the required information.


  13. Available in other template issues
  14. By switching the toggle you can share your variable across all template issues. It will then have the label "GLOBAL" next to it, but it doesn't mean it's now available in all projects - just in templates (TEMP).


Panel Options

After saving, your new variable will appear in the Issue Templates Variables panel. You can apply some options directly from there, too:

Issue Templates for Jira - Variables
Issue Templates for Jira - Variables
  1. Copy
  2. Copy your variable's key to clipboard. You just need to paste it wherever you want to use it.


  3. Enable for all template issues
  4. Change your variable's status to "GLOBAL", which means that it will become available in all issues across template projects (TEMP).


  5. Remove from create screen
  6. Use this option if you don't want the variable to be mandatory every time someone creates an issue built on your template.


Default Values

As an Administrator, you can set default values in the variables’ fields. They will be displayed to your template’s users as recommended input. It can be a simple word or a longer Multi-line text, for example a “Thank you for contacting us” note:

Issue Templates for Jira - Variables
Issue Templates for Jira - Variables

You may also set default values in the Select and Multi-select fields. For example, suggest most commonly used options in a list of available applications. You just need to click Set as default on the chosen field:

Issue Templates for Jira - Variables
Issue Templates for Jira - Variables