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

Clearing default text in description field : behaviour plugin

Suhas P

I have created a behaviour using behaviour plugin for populating default text in Description field while creating an issue. Mapping is for a Project say "Project A" and issue type "Change Request".

Behaviour works fine for correct selection of the Project and Issue Type. However to make it more appropriate, the default text should get clear on selection of the different issue type which does not happen with the current script. Can anyone help me with achieving this behaviour?

Following is the script i am using in the Initialiser.

def desc = getFieldById("description")
   
def defaultValue = """Example Text """
if (getActionName() == "Create"){
      desc.setFormValue(defaultValue)
}
else {
    
    }

Thank in Advance.

Cheers

Accepted answers

Jonny Carter_3nm6du

Instead of putting the script in the initializer, I'd put it in a server-side script on the Issue Type field. To remove your added text whenever someone switches to/from the issue type, the best thing to do would be to get the currently input value and just use a .replaceAll to remove the example text.

You can limit this behaviour to a particular project when you setup the mapping.

Also, as a side note, I thought I'd make it so the default value gets prepended to the description. That way, if they've already entered something when they switch between issue types, their other text doesn't get overwritten.

def desc = getFieldById("description")
def issueType = getFieldById("issuetype")
    
def defaultValue = """Example Text """
def currentValue = desc.getFormValue()
/*
Replace 100001 with your issue type's ID; 
Alternatively, you can use the IssueTypeManager class to get the ID 
based on the Issue Type's name and other properties for clarity, and to 
harden the script against Issue Type changes later
*/
if (issueType.value == "100001"){ 
      desc.setFormValue("$defaultValue - $currentValue")
}
else {
     desc.setFormValue(desc.value.toString().replaceAll("Example Text ", ""))
}

This does have the drawback that someone might type in "Example Text" themselves and see it removed. That said, it will preserve anything they put into the description field that wasn't the phrase "Example Text".

Note: I'm assuming that you have updated to a version of ScriptRunner that includes Behaviours as a feature, and aren't using an old version of the separate Behaviours Plugin.

All comments

Jonny Carter_3nm6du

You can limit this behaviour to a particular project when you setup the mapping.

def desc = getFieldById("description")
def issueType = getFieldById("issuetype")
    
def defaultValue = """Example Text """
def currentValue = desc.getFormValue()
/*
Replace 100001 with your issue type's ID; 
Alternatively, you can use the IssueTypeManager class to get the ID 
based on the Issue Type's name and other properties for clarity, and to 
harden the script against Issue Type changes later
*/
if (issueType.value == "100001"){ 
      desc.setFormValue("$defaultValue - $currentValue")
}
else {
     desc.setFormValue(desc.value.toString().replaceAll("Example Text ", ""))
}

Note: I'm assuming that you have updated to a version of ScriptRunner that includes Behaviours as a feature, and aren't using an old version of the separate Behaviours Plugin.

Suhas P

Thanks for the prompt response. Yes, I am using Script Runner which has Behaviour as feature.

I think I have not clarified the requirement properly. Sorry for the confusion.

Above suggested script by you replaces the "Example Text" on the action other than "Create", but i do not want that. I want to clear the default text i.e. "Example Text" on 'Create' action only when I change to different Issue Type than Change Request on the same pop-up screen. I have mappings for a project and Issue Type Change Request.

Jonny Carter_3nm6du

That makes more sense... I just sort of assumed the "if" condition was the one you wanted, and didn't look too closely! smile

I've updated my answer.

Suhas P

I found my mistake that in the mapping section i was mapping with Project and only one issue type"Change Request" which was making not to trigger script when there is a selection of different issue type. I made the changes and script works fine.

Somehow desc.setFormValue(desc.value.toString().replaceAll("Example Text ", ""))didnt work for me.. but the basic functionality was enough for me for now so will investigate why it is not working for me. If you could guess any errors, please let me know.

Thanks Jonny for your help. Much appreciated. Have great time smile

Darío Díez_x2q2kl

Hi everyone,

I have the same problem, Description field doesn't clean up when the conditions of the behaviour are not fullfilled.

I have tried all suggestions which are in this thread, but none works. Could you please help me to solve it?

Thanks a lot in advance.

Arun Sharma_7lgsnv

Got similar issue, will revert back if I found anything

Darío Díez_x2q2kl

I have been able to fix it.

I have mapped the project with all issue types and I have add in the script the following conditional in order to remove the description field:

if (issueContext.issueType.name == "Bug") { 
desc.setFormValue(defaultValue)
}else {
desc.setFormValue("")
}

Once applied it, when I choose one of my projects and select an issue type different of Bug, my description field is cleaned up.

I hope it helps.

KR.

Arun Sharma_7lgsnv

Ok, my requirement was :-

I need to set a template description for a specific Project and Issue type, and if a user chooses a different issue type, the description should remain blank.

so here's what worked for me (you can easily tweak this for your requirement)

def desc = getFieldById("description")

def defaultValue = """
* *LINE 1*
** line 1.1

* *LINE 2*
** line 2.1

"""

def des = desc.getValue();
if ((getActionName() == "Create") && (issueContext.issueType.name =="Story") &&
!desc.getValue().toString().contains("LINE 1") &&
!desc.getValue().toString().contains("LINE 2")){

desc.setFormValue(defaultValue)
}
desc =getFieldById("description")
des=desc.getValue();

if(issueContext.issueType.name !="Story" &&
desc.getValue().toString().contains("LINE 1") &&
desc.getValue().toString().contains("LINE 2")){
desc.setFormValue(" ");
}

And need to map it to *All fields*

Yoav Ashkenazi_ztgl5m

Sir, you just made my day!

Edimara Souza

I have a questions about it:

I use this script on my jira and it works very well!
But, when I will go to edit some issues all the information in the description field desapear:
How can I solve this?

Suhas P

You should use getActionName() == "Create" in the condition so script won't clear the description on Edit action.

Shereen_6v6gl6

Works like a charm! Thank you!!

Welcome!

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

Quick Links

Find more posts tagged with

scriptrunner

jira

jira-core

behaviours