2.2 Placeholders

Owned by Wolfgang Diehl
Last updated: Aug 15, 2024
3 min read

Overview

Enhance the functionality of your templates by incorporating placeholders. Placeholders are a fundamental feature across all template types.

Upon creating a placeholder, you have the flexibility to insert it at any location within the template settings.

Throughout the template utilization, users will receive prompts to input values for the placeholders. Subsequently, the application will seamlessly substitute all placeholders with the specified values for the new or target project.

The placeholders {{projectName}} and {{projectKey}} are natively supported and therefore reserved names. You can use these placeholders in any text field within the template settings, and they will automatically be replaced with the project name and key, respectively, during template usage.

Create new placeholders

  1. Click either on ‘2. Configure template settings and predefine components/versions/issues' in the dialog or on the settings icon in under Actions.

     

  2. In the template settings modal, click on the tab ‘Placeholders’.

    image-20240723-135345.png

  3. Click on ‘Create placeholder’.

  4. Specify the new placeholder.

    1. Placeholder field type

    2. Placeholder name
      Will be shown to users and will be used to place the placeholder inside the template settings using this syntax: {{placeholderName}}. Must be unique, alphanumeric and max 80 characters long.

    3. Default value
      Preselect values in the placeholder prompt for users during template usage

  5. Click on ‘Create’

    Once the placeholder is created it can be selected in other areas of the project template.

Select placeholders inside the template

Text Field Placeholders

Text Field placeholders can be used inside every text field of the template settings. The available text field placeholder will be shown in the field description and can be copy pasted from there.

Examples usages:

  • To write a dynamic project description that replaces the customer name individually for each project.

 

  • To create predefined issues with a dynamic summary and description using placeholders.

 

User Picker Placeholders

User Picker Placeholder can be selected inside the dropdown of user pickers.

Examples usages:

  • To allocate project roles to the users selected within a placeholder.

  • To assign the project lead, reporter of cloned issues, component lead of predefined issue or assignee/reporter of predefined issue to the user selected inside a placeholder.

Prompt for Placeholder Selection During Template Usage

When a user initiates to use a template they will be prompted to input values for various placeholders within the template usage modal.

The placeholders will come with default values preselected for convenience.

After clicking on ‘Create’, the application will seamlessly integrate the user-selected placeholder values into the template, replacing all instances where the placeholders were initially designated.

Overview | 3. Permission

Â