How do you pre-populate the Description field for certain issue types?

[cvanduyn]

I'm a Jira Site Admin and I'm looking for guidance on the best approach to add boilerplate text to the Description field for newly created Bug issues in a specific company-managed project.

My goal is for users to see a template of text each time they create a Bug work item type in specific Spaces such as:

• Steps to Reproduce
• Expected Result
• Actual Result
• Environment

Is this an out-of-the-box Jira Premium capability or do I need to consider third-party apps from the Marketplace?

[Evgenii]

Hi, @cvanduyn 

You can use an automation to add a description template immediately after issue is created.
If you want to pre-populate field on issue creation stage - you need to use additional plugins, like ScriptRunner, for example 

[David Fabila]

@cvanduyn Automation is the safest way to go because you'll be able to controll exactly what is populated, the Automation can be restricted to be only configurable by certain users and you will not incur in extra costs.

You'll spend some ramp up time learning Automation, but it is worth it as later you'll be able to do many other things.

[Trudy Claspill]

Hello @cvanduyn 

For a company managed project, without access to the ScriptRunner Behaviours or Appfire Live Fields apps, they only way to present prefilled text in the Description field when you open the Create dialog is (summarized):

1. Create a custom paragraph field and set its default value to your template text.

2. Add that field to the screen associated with the Create operation for the Bug issue type. Remove the native Description field from the same screen.

3. Ensure that the custom field is not on the screen associated with the Edit or View operations for the Bug issue type.

4. Ensure that the native Description field is on the screen associated with the Edit or View operations for the Bug issue type.

(So you need one screen to associate with the Create operation, and a different screen to associate with the Edit and View operations for the Bug issue type.)

6. Add automation triggered by creation of the Bug to copy the text from your custom paragraph field to the native Description field -OR- add post functions to the Create transition to copy the data.

The following posts describe the above solution in detail:

https://community.atlassian.com/forums/Jira-questions/Default-text-for-Description-field-on-Jira-Cloud/qaq-p/785597

https://community.atlassian.com/forums/Jira-questions/How-to-create-a-template-for-issue-description/qaq-p/1041636

https://community.atlassian.com/forums/Jira-questions/How-do-I-create-a-custom-template-for-a-description-text-input/qaq-p/2764424

[Trudy Claspill]

@cvanduyn 

I must disagree with the folks suggesting that Automation is the solution, if your goal is to show the template text in the Create Item dialog before the item is actually saved and assigned an item key.

Automation rules are triggered by events when the event completes, like when an item field is updated when a new item is created (when it is saved), and when an item completes a status change.

Automation can't be used to change what appears in the Create Item dialog before the new item has been saved.

If you want to change the Description after the new item is saved then an Automation Rule is the correct solution.

[Monika Ambrozowicz_Seibert_]

Hi @cvanduyn, Description Templates from Templating.app do exactly what you're describing. Full disclosure: I am affiliated with the team behind the app, but I use it a lot myself to achieve the same result. 

You basically define a description template that automatically loads when a user creates a Bug in a specific project. So when someone opens the "Create work item" dialog and selects a Bug in your target project, the description field is already filled in with your structure. You can scope this to specific projects, specific work item types, or even specific users, so it only fires for Bugs in the projects you care about - it won't affect Stories or Tasks, or other projects.

Above you can see the end result, and the configuration is very easy. If you have any questions, I'd be happy to help. 

The app is built on Atlassian Forge and also supports issue hierarchy templates, subtask and checklist templates, board and project templates if those are useful down the road.