Setting a Default Value in the Description Field
This page describes how to set a Default Value for the Description field in JIRA. There's a feature request for this at JRA-4812. Please watch and vote on the issue if this is important to you.
There are workarounds to add this functionality. The modification does not persist if you upgrade JIRA so you'll have to re-apply these steps again in the future. Here are directions to set a default value for your Description field in JIRA:
- Locate and backup the file: WEB-INF/classes/templates/jira/issue/field/description-edit.vm
- Open that file:
#controlHeader ($action $field.id $i18n.getText($field.nameKey) $fieldLayoutItem.required $displayParameters.get('noHeader')) ## setup some additional parameters $!rendererParams.put("rows", "12") $!rendererParams.put("wrap", "virtual") ## let the renderer display the edit component $rendererDescriptor.getEditVM($!description, $!issue.key, $!fieldLayoutItem.rendererType, $!field.id, $!field.name, $rendererParams, false) #controlFooter ($action $fieldLayoutItem.getFieldDescription() $displayParameters.get('noHeader')) - Add a section like this:
So, ultimately it should look something like:
#if($description == '') #set ($description = 'Put stuff here:') #end#controlHeader ($action $field.id $i18n.getText($field.nameKey) $fieldLayoutItem.required $displayParameters.get('noHeader')) ## setup some additional parameters $!rendererParams.put("rows", "12") $!rendererParams.put("wrap", "virtual") #if($description == '') #set ($description = 'Put stuff here:') #end ## let the renderer display the edit component $rendererDescriptor.getEditVM($!description, $!issue.key, $!fieldLayoutItem.rendererType, $!field.id, $!field.name, $rendererParams, false) #controlFooter ($action $fieldLayoutItem.getFieldDescription() $displayParameters.get('noHeader')) - Restart your JIRA instance.
Adding multi-line values
If you wish to display in the description a default value of:
Step 1
Step 2
Step 3
you'll need to tweak the above instructions a bit:
#set ($description = "Step 1\
\
Step 2\
\
Step 3")
#set ($description = $description.replace('\',' '))
Unknown macro: {htmlcomment}
Severity: Low
Regular Expression: default value.*[dD]escription field
Article ID: JIRAKB370705080
Last modified on Aug 23, 2010
Powered by Confluence and Scroll Viewport.