Project-level Templates

In JEditor 3.5.0, we've added a new feature — project-level templates. This feature allows creating and editing templates that appear in the Templates dialog and/or prepopulate JEditor fields (note: for project-level templates, we renamed JEditor Prepopulation to Autofill).

This is the first JEditor configuration screen that doesn't require the Jira System Administrator permission. To access the project-level templates configuration screen, a user must have the Administer Projects permission.

Managing a project's templates

Projects administrators can manage JEditor Templates in Jira Project Settings:

  1. Go to a project and click Project Settings (⚙️)
  2. Choose JEditor > Templates from the project settings sidebar

The JEditor Templates page is displayed showing a list of already available project-level templates (none by default). From here, you can create new templates, manage existing project-level templates, or import global-level JEditor templates (managed by Jira System Administrators).

How to add a new template

To create a template:

  1. Click the Create Template button
  2. The Create Template dialog appears
  3. Input template name, template description, and template's HTML code into the Name, Description and Body fields
  4. These are the only required fields for a new template
  5. Click Save

The new template will appear in the JEditor Template dialog when editing a field in the current project.

How to limit template visibility in the Template dialog

It is possible to limit template visibility to a range of project's issue types and/or fields and/or user groups:

  1. When creating a template select values in the Visibility Constraints section
  2. Select one or more issue types if you want the template to only appear in the context of those issue types
  3. Select one or more fields if you want the template to only appear in those fields
  4. Select one or more user groups (you need to start typing to see available user groups) to restrict template visibility to users who are members of those groups
  5. Important:
    1. If you leave a constraint field empty, that particular constraint will not apply
    2. If you select issue types and fields and user groups, the resulting template will only appear if all those conditions are matched\

Examples:

mceclip0.png

In this case, the resulting template will appear in the Template dialog if the current Jira issue's issue type is Task or the Task issue type is selected in the Create Issue dialog. The template will be visible in all fields and for all users.

mceclip1.png

In this case, the resulting template will appear in the Template dialog only in the context of issue type Task, only in the Description field and only for users who are members of either jira-testers or jira-developers user group.

How to autofill a JEditor field with a template

Project-level templates can be configured to automatically populate JEditor fields:

  1. When creating a template select values in the Autofill Conditions section
  2. Select one or more specific issue types if you want the template to autofill selected fields in those issue types
  3. Select All issue types if you want the template to autofill selected fields in all project's issue types
  4. Select one or more fields that you want to be auto-filled with the template
  5. Important:
    1. If you leave a condition empty, the autofill will not work

Examples:

mceclip2.png

In this case, the resulting template will autofill the Description field for all project's issue types.

mceclip3.png

In this case, the resulting template will autofill the Description field only in the context of Task and Sub-task issue types (when one of these issue types is selected in the Create Issue or Create Sub-task dialog).

How to import a template

You can import global-level JEditor templates created and managed by Jira System Administrators:

  1. On the project's Templates page click the Import button
  2. Wait for the list of global templates to load
  3. The list will contain global-level templates that are configured to appear either in the current project or in all projects
  4. You can filter the templates by name or description
  5. Click the Import link to import a particular template
  6. The Create Template dialog appears with name, description, and body values imported from the global template

Please note:

When searching for duplicates, the Template dialog filters the list of templates by template name. If you keep the name after importing a global template, the JEditor Template dialog will not show the old template. Otherwise, both templates will be shown.

Jira System Administrators can disconnect global templates from specific projects.

Have more questions? Submit a request

0 Comments

Article is closed for comments.
Powered by Zendesk