nav[aria-label="Primary Navigation"] { padding: 0; & ul { list-style: none; width: 100%; display: flex; flex-direction: row; justify-content: start; align-items: start; gap: 30px; padding: 0; & li { margin: 0; } & ul li { list-style: none; } } }

How to create a template for issue description?

Ronnie Hilmersson_pzgjre

Hi everyone!

I try to find out if there are a way to insert a template in the issue description that shows up for everyone when someone wishes to create a new user story. It could be a template where te designteam shoud do something, next part the test team and last one the developer team.

Any ideas?

Jira Skärmklipp.PNG

Accepted answers

Zeev Suraski

So, turns out there IS a way to do it without adding any extra steps or changing the (human) workflow in any way. It's just not very intuitive to come up with - and that's an understatement. For the record - I didn't come up with it myself - I was given the tip from a new employee that did it in a previous company. Still, getting it to work took some time.

Since it's anything but obvious, even once you have the idea - I'm sharing this, both to help others and also - documenting it so that if I have to do it again in the future I won't have to spend as much time tinkering with the system... Note that this is from memory, so there might be small mistakes here and there - but the gist of it is correct.

Here's what you have to do (no doubt getting it to work is cumbersome to - but once it works - it works perfectly and flawlessly):

- Add a new custom field (a reasonable name would be 'Bug Description'), that contains the template you want to use as the default value (see https://confluence.atlassian.com/adminjiracloud/configure-a-custom-field-991923771.html for details).

- Go to the Field Configurations, select your field configuration, search for your new custom field, select Renderers and pick the Wiki-style renderer.

- Make sure you have a dedicated screen for creating issues of type Bug (Bug Creation Screen). If you don't (by default you don't) - create one - start by simply creating a copy of your existing issue screen. In that screen - add the new custom field you created in the previous step, and place it near the Description field. Once we're done we'd want to remove the original description field altogether, but keep it for now as you're still tinkering with setting things up.

- Once that screen is created - create a screen scheme that associates the Create operation with the new Bug Creation Screen, and then, in your Issue Type screen scheme - associate issues of type Bug with that screen scheme.

If everything worked so far - then when hitting Create and selecting the issue type Bug, you should see the Bug Description field alongside the Description field. When switching to another non-Bug issue type, it should disappear. Works so far? You're half way through:

- If you don't already have a separate workflow for bugs (which you probably don't) - now's the time to create it. Just copy your existing workflow, and associate it with the issue type Bug.

- In that workflow - edit the Create transition, and add a Post Function that will copy the value of the Bug Description field into the Description field. Here too - if you don't already have a separate workflow for bugs This is what it would look like after configured:

"The field Description will take the value from Bug Description. Source and destination issue are the same."

NOTE: That post function must be the first one in order. It must appear before the "Creates the issue originally." step, as unintuitive as it might sound. Otherwise, it just wouldn't do anything (https://confluence.atlassian.com/jirakb/post-function-on-create-issue-transition-appears-to-not-work-718836210.html).

Publish the workflow, and test it. If everything is configured properly (and assuming I haven't forgotten any steps - it's been quite a journey), then whatever you put in the Bug Description field, would override anything that's in the built-in Description field (upon submission). I.e., right after submission - if you open the issue - you should see whatever you put in the Bug Description field, appearing in the Description field (the Bug Description field shouldn't be visible when viewing an existing issue). Given that the built-in Description field is updated, your workflow for viewing, searching - or doing anything else - remains completely unchanged. This workaround only affects the issue-creation workflow.

If everything is working - you can now go back to the Bug Creation Screen, edit it, find the built-in Description field, and select Remove, as it's no longer relevant during creation of new bugs.

That should be it!

Let me know if anybody manages to pull it off

Zeev

All comments

Kumar_ow8zf3

Hi @Ronnie Hilmersson by using the Behaviour Plugin you can a default description

Admin Settings > Add-ons > Behaviours > Give a name and Add > Right Side choose Fields >

Select Description and add below Script with Template > Save it > come out from that

Window > Choose add Mapping in that Select Project and Issue type and save it.

def desc = getFieldById("description")

def defaultValue =<span> </span>""" // ...Start Adding the Default Template       

End Here..""".replaceAll(/    /,<span> </span>'')

if (!underlyingIssue?.description) {    

desc.setFormValue(defaultValue)

}

When you try to create that project Issue it will show you default given template in Description Field .

I hope it Helps.

Thanks,

Kumar

Sloan N_ B_

Hi Ronnie

Out of the box this is not possible in Jira.

There are multiple ways to implement this functionality with apps. @Kumar already explained one way.

You could also use one of these apps:

These are the ones I know. If you search in the Atlassian Marketplace you maybe find a few more.

Cheers
Niklas

Paul Pavlovsky_AppLiger_

Hi @Ronnie Hilmersson ,

You can also try Easy Templates for Jira Issues add-on . Your team will be able to create Jira tickets (even with subtasks) from saved templates like Stories, Bug reports and other processes.

Cheers,

Pavel

Ronnie Hilmersson_pzgjre

Hi!

Thanks everyone! It was exactly what I was looking for!

Best regards/Ronnie

Michael Haywood

Which solution did you end up using?

Michael Haywood

Maybe not a perfect solution, but we ended up using the "free" Automation tools built into JIRA. So when someone creates an issue, it adds our template details to the issue description and puts the original description into a section of the template. It also applies the labels we need.

Not perfect in that it requires first creating the issue, then you get the template, but works for us!

Joshua Urban

Hey Michael- do you have any more info on this? Curious about this implementation.

Michael Haywood

https://www.atlassian.com/software/jira/features/automation Start here.

Basically, we setup an automation to trigger on Story/Bug creation. Then told it to add the labels we wanted, assign it to a person, add additional text to the description, etc...

The only downside is if you're using the 'Create' modal, you won't see all this until after the story is created. It's most helpful to our users who insert stories using the add feature at the bottom of the backlog. Once you enter the story and hit save, clicking it to open it will show all the automation stuff.

Paul Rowlands_qr1bho

A simple approach is to create a dummy ticket and clone from that...

Aline Chapman

@Michael Haywood I am using the same solution you describe, however how were you able to "add additional text to the description"? This is the missing part for me.

I appreciate if you can share this information.

Zeev Suraski

Here's what you have to do (no doubt getting it to work is cumbersome to - but once it works - it works perfectly and flawlessly):

- Go to the Field Configurations, select your field configuration, search for your new custom field, select Renderers and pick the Wiki-style renderer.

- If you don't already have a separate workflow for bugs (which you probably don't) - now's the time to create it. Just copy your existing workflow, and associate it with the issue type Bug.

"The field Description will take the value from Bug Description. Source and destination issue are the same."

If everything is working - you can now go back to the Bug Creation Screen, edit it, find the built-in Description field, and select Remove, as it's no longer relevant during creation of new bugs.

That should be it!

Let me know if anybody manages to pull it off

Zeev

Vineela Durbha

Hi Kumar,

I tried the above as suggested by you but it didnt set any default text on description field. Any idea where is it going wrong?

Thibault Lamadieu_yntnh8

I just did, it does work flawlessly. My only issue is about having to use markup for formatting the default value. Other than that, it works well and should support a variety of scenarios.

Thank you very much for this guide !

Ivan Z_7a60sp

It took 1 hr to configure but then it works like magic. Thanks, this is smart!

Arvid Kongstad

Thank you very much, Zeev!

As warned, it took a while to set up but the guide was accurate enough and I managed to achieve the desired result, learning a thing or two about Jira in the process.

Hope you all have a nice day.

Ta Minh Thuy

Hi guys,

No need to use add-on in this case. All you need is creating a custom field name with the same name, Description and in the Field configuration, you render the field to make it wiki

It will looks exactly the system field Description From this newly created custom field, you can add template as you wish.

I did it!

Rafi Barry

Hi, I know it's been a while since this last answer..
I've tried this solution as well, so the "description" field is using the inserted template. But now, each time text is added in newly opened bugs, while using this template, after selecting a different field to fill, the "Description" field returns to it's default state, and erase the user's inserted text...
Any ideas how to overcome this problem/ or there is a solution for that?
Thanks,
Rafi.

dagny wicklund

Hi!
First off, thank you for detailed description!
I got all the way to add a Post Function that will copy the value of the Bug Description field into the Description field. But I am not able to do that. I don't have any post function called Copy value from field to field. I tried googling this, and from what I can see this is only available in Jira cloud. Is that really so? And if so, does anyone have any suggestions for how to create a template for issue description on prem?

Thanks

unknown

It might be a silly question but does this apply to Jira Cloud as well?

Michael Haywood

I can confirm my solution above works on Cloud. I haven't tested any of the others. Two years later and we are still using this method and works well for our team.

Rachel Irving

A side effect of implementing this seems to be when cloning an issue the default template overwrites the cloned issue's description. Has anybody worked around this issue?

Adnan Ali_odfnr7

This is the first step in the process. Now is the time for the workflow to be published and tested. My journey has been quite a journey - I still haven't forgotten a step - and I haven't forgotten a step yet. It is important to note that, once all of the settings have been configured, whatever you put in the Bug Description field overrides anything that is already in the built-in Description field (upon submission). I would like to stress that if you open an issue after submitting it, whatever you put in the Bug Description field should appear in the Description field (the Bug Description field should not be visible when viewing the existing issue).

As far as I can tell, after this step, the Bug Description is still intact on my side of things. Would you mind letting me know if there is anything that I have missed in the process?

The second is the most important. When I remove the original description from the Bug creation screen, it appears that the post action to "copy value from Bug Description to Description" no longer works. In the creation result, a Bug Description is displayed, but it is not displayed along with the original built-in description that was inserted by the developer.

unknown

Hi everyone,

We just released an app: Issue Template for Jira

It allows defining template for summary and description fields will will be automatically pre-filled for all users when they open the create issue window.

There exists solution for team managed projects like other users have posted, however our app also makes it possible for company managed projects.

This app is currently in beta. You can install it free from Atlassian Marketplace.

Please try it out and give us feedback.

Regards,

Parva

See the demo template in issue create window screenshot below👇

Tenzing Doleck

Hi I was able to configure this - but with an outstanding issue.

The post function works in that it is copying the customdescirption field to the description field . However it only does so once ticket is done being created . Not at the moment when you hit create ..

So now when I hit create-- the description field is still bank

This is my set up :

Screen Shot 2022-10-27 at 11.19.27 AM.png

Roman Tsoi

@[deleted]I don't have your widget working. Can you help me? Can you write your email, I'll get back to you. The sooner the better)

Fábio Magalhães Costa

Worked for me! Thanks!

unknown

Hi Roman,

For any issues related to our app Issue Template for Jira, you can send us an email at support@bitwelt.atlassian.net

Regards,

Parva

Catherine Ojok

I've just set this up and it looks like it will save all the headache of the long workaround of the top answer here. Thank you for doing this!

Dennis Christilaw_rk0qlb

This is a great solution, as long as it's free. If they add a cost to it using the Atlassian licensing model (per user), then it's going to outlive it's usefulness to cost benefits in comparison to just doing the leg work on the free fix.

Just my thoughts.

unknown

Hello together,
I don't know if I'm in the right place.
It's about Jira tickets. Some tickets are displayed in tables in the description (HTML). Sometimes the texts are not displayed correctly. Can someone help me here?

Scot Angus

Just look at all the time hundreds of people have spent trying to do what should be really simple for Atlassian to implement. Companies agree to buy the software even though it doesn't do the most fundamental things teams need it to do. This is because "teams" don't buy the software... the executives do, and this template thing... well that's not important to them.

Birger Püschl_k9h3s1

Found this free app which might help

https://marketplace.atlassian.com/apps/1211873/default-values-for-create-issue-screen-issue-templates?tab=overview&hosting=cloud

Barış Özer

Hi @Ta Minh Thuy

Can we do it for free on Jira Cloud?

When there is a "create" issue in the project, I want the desired texts to appear in the "description" field.

Can you please explain? Can you also post a screenshot?

Thank you very much! (:

Johan van de Ven

We have solved this by simply installing the addon "Default values for 'Create issue' screen - Issue Templates" .

Using this app you can create default issue descriptions and select for which projects and issue types to apply them.

Yatiraj Sharma

Hi,

Use the Automation and below script to create the template whenever a issue gets created.

{{triggerissue.Description}}
{panel:title=Feature Objective}
//Add your Feature Objective
{panel}
----
||Feature Attributes||Attribute Description||
|{color:#0747a6}Benefit Hypothesis{color}| |
|{color:#0747a6}Measures of Success, KPIs{color}| * {color:#172b4d} {color}
*
*
* |
|{color:#0747a6}Environmental and Sustainability Impact{color}| * |
|{color:#0747a6}Risks and Dependencies{color}| * Dependency -
* Risk - |
|{color:#0747a6}Architecture, Design, Flow{color}| * |
|{color:#0747a6}Migration{color}| * |
|{color:#0747a6}Assumptions{color}| * |
|{color:#0747a6}In Scope{color}| *
* |
|{color:#0747a6}Out Of Scope{color}| * |
|{color:#0747a6}Feature Acceptance Criteria{color}|This Feature will be complete when;
* 1
* 2
* 3
* 3 |
|{color:#0747a6}Test Automation{color}| * |
|{color:#0747a6}Release Plan{color}| *
*
*
* |

Yatiraj Sharma

You will see something like this

automation 1.png image (5).png

David Holman_jbwq7o

The good news is that silly things like this have thrown the door wide open to incredible competitors like Linear 😂

Jeroen Loosli

For everybody with scriptrunner:

Example Behaviour for a Problem Template in the field description

import com.atlassian.jira.component.ComponentAccessor

import static com.atlassian.jira.issue.IssueFieldConstants.*

def desc = getFieldById("description")

if ((getActionName() == "Create") && (desc.getRawValue() == "")) {

String defdes = ('h4. Problem \n * Description of the problem, symptoms, customer complaint etc. \n \n \n h4. Analysis \n * F.e. which logs did you check, what are the key take aways from these logs? \n \n \n h4. Impact \n * How many unique customers are affected over the last day or last 7 days? \n \n \n h4. Workaround \n * Is there a way this problem is/can be mitigated? \n \n \n h4. Next actions \n * What are the next actions to be done?')

desc.setFormValue(defdes)

Welcome!

It looks like you're new here. Sign in or register to get started.

Quick Links

Find more posts tagged with

jira

jira-core