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; } } }

Default text for Description field on Jira Cloud

Alex Brelsfoard

After much research, it has been made clear that we cannot update the main description field with default text.

So I now see that I will need to create a custom field for thus purpose.

I have created a custom field, I have given it my default text, I have even adjusted its location on the ticket creation screen. But I'm struggling to get it to be correct on the VIEW page.

What I want: It should look & function just like the main Description field. I want this custom field to be in the same exact location as the main Description field (I will then remove the description field from view).

What I am seeing: The custom field is showing up in the top section with the status, labels, components, type, priority, etc.

I know there are plugins to help with this, but none of them seem to be compatible on the cloud (which is where I am).

Any suggestions?

Accepted answers

All comments

Gabriel Senna

Hi Alex,

You can try to use post functions to set up a default text on the Description field.

This post function would update the value of the field once the issue is created, for example. Using this, every time that specific type of issue is created, the Description is set with a default value.

In the below documentation, there are more information, regarding to using post functions.

https://confluence.atlassian.com/adminjiracloud/advanced-workflow-configuration-776636620.html

Alex Brelsfoard

That's an interesting solution. However I'm looking to setup more of a template.

So each time you go to setup a new ticket, there are some default values in the description field meant to guide you on how best to fill out this field. So this can't be populated once the ticket is created, but rather on the first screen when you are first filling out the ticket details.

Julien Rubiano

Hello,

EDIT : You can now use Jira automation rules to make this easier. Please read Ryan's answer bellow.

ORIGINAL POST :

Just to complete Gabriel's answer, here is a use case I had a hard time with (but found a pretty clean solution) :

1. Click on "Create new ticket"

2. I want to see "Description" field with prefilled text inside it (Create screen)

3. I want to see the final content inside the "Description" (View screen)

4. I want to see "Description" when I edit my ticket (Update screen)

The main contraint here is that Description is a core field in Jira, which cannot be touched at start of the workflow.

What I've done for a quick solution, is to add a "shadow" description:

1. Create a custom field named "Description", multiline text, with wiki render configuration

2. Replace the native "Description" by your custom "Description" in the Create Screen configuration

3. Set default value you want for your custom "Description" (the text which will appear when the modal opens)

4. Go into your workflow configuration, and at the first transition (for me it was a transition between first point and "To be implemented" state) add 2 post functions at the top of the post functions list (rank 1 and 2).

- First post function : Copy value of custom "Description" inside core "Description"

- Second post function : Delete content of custom "Description"

5. Configure your screens like following

- Create screen : must have your custom "Description" only

- View screen : must have the core "Description" only

- Edit screen : must have the core "Description" only

This way, when you click on "Create", your ticket will have the content you wrote inside custom "Description" into the core "Description" and the custom "Description" will not be shown because there's no content inside it.

For the other screens than Create screen, you just have to use the core "Description" instead of your custom "Description", we don't need the shadow Description anymore once the ticket is created.

Raphael Oliveira

Hi guys, any updates if it's possible to create a default value for the description field?

Gonçalo Queirós

Hi, @Julien Rubiano thanks for the awesome reply.

Just did what you described, but with a minor tweak, since I had to name my custom field "Description X" otherwise the post function dropdowns would only display one "Description" field, making it impossible to select a source and a different destination.

After everything was set up, I just renamed the custom field back to "Description" and it works

Jira Admins

The Workflow Essentials plugin for server has an outstanding function, "Default Values for Create Screen". It's super easy to use and allows you to specify a different default for each issue type in a project --- even if they're all using the same screens and schemes.

https://codecentric.atlassian.net/wiki/spaces/WE/pages/39125008/Default+Values+for+Create+Issue+Sub-Task+screen

Sadly, it's not available for Cloud and I haven't been able to find an equivalent add-on or technique.

Galab Venkin _PM_

You are genius. Thank you!

Ana-Maria Manea

Hi,

I tried following the steps described by @Julien Rubiano but I can't seem to understand from where I can configure steps 4 & 5 from his post.

I am new with configuring JIRA Cloud and I would really like creating templates for the description field. At the moment, with what I've done, I've created a new custom field, but it doesn't look the same as the original Description field (i don't have the menu for formatting the text):

Also, the texts that were previously in the description field are now gone.

Can you please help me?

Thank you!

SEBASTÍAN MATAMOROS_ipy8ul

Hi @Julien Rubiano

I made the set up to set value default in field description, just as you indicated, and it worked fine.

But I would like to set up a different value default for two different issue types (Story & Bug). I tried combining both issue types in the same post function, but only it worked with one, it depends on the position the rule in the list of post functions. Can you help me with this?

Post Function.JPG

wilfred.mathanaraj

Hi @Julien Rubiano

I got everything working but the clearing the custom field value... the post function i use does not seem to have an impact.

I have got both post functions on top.. even before creating the issue.

any suggestions please?

wilfred.mathanaraj

I have even tried setting it to ".." or "-" but nothing seem to happen to the value of "Business Case"

Kris Luhr

I have the same problem. Been trying to use different fields for each type but they are not removed when you switch type even if the only thing in them is the default text so it becomes messy very quickly.

Hoping this can be addressed soon, we are really missing our server version!

Jacin Ferreira_qi8jf4

@Kris Luhr

I solved this by creating separate workflows for bugs and tasks.

Julien Rubiano

Hello @wilfred.mathanaraj ,

Sorry for the late answer. Everything looks fine in your post function to me. Have you checked that your draft wokflow is published and that your project is using the correct workflow scheme?

If you want you can now use Automation rules in your project if you want, the UX is way better than post functions screens.

Diana Beldiman

Hello!

Can I copy the template into the description without losing what's written in the first description field?

Kris Luhr

Yes, we ended up using automation to set this up after create.

In our create dialog for bugs and stories (where we have templates) you can only input summary and epic.
So to create a bug is a two step process, but at least we have our template...

jcasarrubias

Hello,

Do you mean, when you create a ticket? when cloned? or in which action?

Diana Beldiman

Hello,

So, when I create a ticket, I have both the description and the bug template field but when on view ticket anything I've written in the description field gets replaced with what's inside the bug template field and I wanted to combine both of them if I'm making myself clear.

Thank you!

Sergei Gridnevskii

It can be some kind of a browser plugin that detects that browser is on Create issue view and adds some text to Description field automatically. I guess it will be very valuable for QA. Anyone volunteers to create the plugin for Chrome?

William Arnold_lqc7bm

I have found the following steps to be the fastest way to default text to a predefined field when creating issue tickets from the backlog.

This has mainly been used with Bugs and Tasks but I am sure it is extendable to other issue types. The functions referenced are from the Jira Settings - Issues page:

Create a custom field and default the text
- Create Custom Field
  - Select a field type - Paragraph
  - Name and Description
- Use the newly created fields "Contexts and default value" to add the default text you want to appear in the predefined field
  - You do not need to associate the field with a context - use the default or a screen

Identify the "Software Simplified Workflow" that is used by the Jira project then copy and modify it
- Workflows
  - List all the workflows used by Jira projects and identify the one that is used for your project
    - Click Copy
      - Name the new workflow and use the diagram editor to view the workflow
      - Click on the "Create" transition, click the post function link, and add a post function
        Use the "Copy Value From Other Field" function
        Source - new custom field
        It might not appear in the list so start typing it and it should show up as a selectable field
        Destination - predefined Jira field
        Add
        Move up the post function until it is the first in the list of actions
      - Publish the workflow if necessary

Add the newly created workflow to the Workflow Scheme for the project and associate it with the Bug Issue type
- Workflow Schemes
  - List all workflow schemes and identify the one that is used for your project
    - Click Edit
      - Click Add Workflow and select the newly created workflow from the list of workflows
        Click Next
        Associate to Issue Type "Bug" and save
      - Publish the changes to activate the new workflow for the Bug Issue type on your project

I hope this helps.

jcasarrubias

Hello,

I do agree with you, I did it in the same way and it works fine.

I only added an extra automation rule to cover the case when tickets are cloned

I hope this helps to robust the solution

Regards,

JLuis

Steven Rhodes

Like https://jiratemplate.com ?

Anthony Conti_2a7y81

Supremely thorough and helpful, @William Arnold. This worked for me. Thank you! One item to add. The new custom field rich text paragraph that I replaced the default description with did not have a wysiwyg/editor for altering text, adding bullets, links, etc. I found this article that was a simple fix for that.

Matthew Rochman

Hi All

I see a neat little trick that has been pointed out here and another post on same topic - creating a second description field and doing a post function on create to copy the contents into the real system description field.

This does work and the logic seems sound, but this causes two problems: first you need to create the ticket, then fill out the details in long text field after creation. This didn't sit well with some users.

Second, it creates a problem with cloning tickets (a native Jira functionality)

We had a situation where there are 'repeated' tickets on a monthly basis and cloning and slightly tweaking last month's ticket is all that's needed. If you clone a ticket with that post function on create, it will overwrite the description and copy in the description as it was when the source ticket was first created.

Also - I think the solution might be fine for some, but if you start doing integrations with third party systems that create tickets automatically in certain scenarios, this post function will cause headaches as it applies whenever a ticket is created.

I actually ended up just shifting out the system Description field and creating new long text custom fields like "User Story" and "Acceptance Criteria" and "Support Request Details", then using Jira's native default text feature to apply the template. It's clean and in the cloning scenario, you don't have an issue. This approach does present a problem when you "Move" a ticket to a project on a different screen scheme, but you can do some automation to sort that out.

My thoughts

Roman Balakin_yqkoso

@jcasarrubias Thank you for this solution!

Edit: for those who are unable to make this automation rule work, you need to use smart value {{issue.description}} alongside variable name clonedDescription, and then in the last component Edit issue fields - set Description field value {{clonedDescription}}

Mario Thor

Hi,

Please try the Cloud version of our Default Values for 'Create Issue' screen app.

You can set default values for Description (rich text editor included), Summary, Labels, Assignee, Priority fields.

Your feedback is welcome!

Cheers,
Mario

Sergei Gridnevskii

One more simple yet effective approach. User fills an important part of description right there on issue creation. Automation adds structure. User adds other sections after creation.

One of our rules looks like this:

h1. Business Requirements
{{Description}}
\\
\\
h1. General Flow
\\
\\
h1. UI
\\
\\
h1. Task Scope
\\
\\
h1. Definition of Done
\\
\\
h1. Out of Scope
\\
\\
h1. Next Phases
\\
\\

Nar Kumar C_ - Narva Software

Hi everyone,

If you need default values in summary and description fields, we recently released an app which does exactly that:

Issue Template for Jira - Summary & Description Templates

You can define a template per issue type and that template will be automatically prefilled when users open create issue window.

Our app works with both team and company managed projects. Also, have a look into Atlassian Marketplace here if you have slight different requirement here, you will surely find an app for your needs.

Regards,

Nar

Michael Aglas_ocluj7

So for every project that uses a slightly different template, I used to copy the workflow to apply another custom field with the according template value? No way...

Srinivsarao Mutyam

Hello julien Rubiano,

I agree with your answer, I implemented the same thing for my requirement, but I have some further questions.

Problem statement: whenever I clone tickets I get custom description table content on the new ticket, instead of the original description from the original ticket.

Expected: keep the description field on ticket cloning, it is very useful when trying to create multiple related tickets on the same topic, but with slight variations.

Kawtar Amajoud

I love this idea, very clean

Thank you!

Leander Rijnders

Hi @Alex Brelsfoard ,

I have finally found a solution which is much easier.

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

You just need to install it, configure a few things and it's free

I was worried about having to migrate data from old to new fields and so on, but with this solution it's just editing the values in the 'create' field, and the existing issues are untouched so it doesn't delete data.

So I'm happy with this app and wanted to share this with you.

Alex Ivanov_9lqzn6

Hello everyone, im trying to implement same logic (prefill description field during ticket creation) with right Markdown formating and raw text, then, after ticket is created, only raw text appears, any idea?

Diane Wolf_xusuxi

Hello,

Did you create field with "rich text" ? I don't know if it's the proper name, my jira is in french

Alex Ivanov_9lqzn6

@Diane Wolf not sure, just created custom field, and post action on "create" transition to copy from this field to description, code was tested in jira automation, it works well

Alex Ivanov_9lqzn6

solved by changing renderer to "wiki style renderer" in field configuration

Alex Ivanov_9lqzn6

Anyone tried to pre-fill Summary field by the same way? im getting errors from post function

Welcome!

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

Quick Links

Find more posts tagged with

custom-field

jira

cloud

jira-cloud

template