Create
cancel
Showing results for 
Search instead for 
Did you mean: 
Sign up Log in

It's not the same without you

Join the community to find out what other Atlassian users are discussing, debating and creating.

Atlassian Community Hero Image Collage

Setting field help text using scriptrunner behaviour

I tried to change the help text of a field with Scriptrunner Behaviours according to https://scriptrunner.adaptavist.com/5.3.1/jira/behaviours-api-quickref.html with setHelpText(), but it somehow adds an additional red text, instead of replacing the small gray text under the field.


How can I do this?

Screen_Shot_2018-02-02_at_09_41_20.png

My initializer script:

 import static com.atlassian.jira.issue.IssueFieldConstants.*
import com.onresolve.jira.groovy.user.FieldBehaviours
import groovy.transform.BaseScript
import com.atlassian.jira.component.ComponentAccessor
import com.atlassian.jira.user.UserLocaleStore
@BaseScript FieldBehaviours fieldBehaviours

def currentUser = ComponentAccessor.getJiraAuthenticationContext().loggedInUser
def userLanguage = ComponentAccessor.getComponent(UserLocaleStore).getLocale(currentUser).language
def summaryLabel = "Staff Member Name"
def componentsLabel = "Organizational Unit"
def katTeamLabel = "Kanban Team"
def katTeamHelp = "Optionally define of which interdisciplinary teams the employee is part of."

getFieldById("summary").setLabel(summaryLabel)
getFieldById("summary").setRequired(true)
getFieldById("components").setLabel(componentsLabel)
getFieldById("customfield_12430").setLabel(katTeamLabel)
getFieldById("customfield_12430").setHelpText(katTeamHelp)

 

1 answer

1 accepted

3 votes
Answer accepted

Hi Flaimo, 

In that case you will need 

getFieldByName("TextField").setDescription("This is a description from Behaviour")

Let me know if this does the trick.

Regards, Thanos

That's a fair point Flaimo, we will fix it. Thanks for pointing this out. 

This is still not updated on the API Quick Reference.  It's a rather difficult problem to google too, since there are so many examples that modify the "Description" *Field* itself.

https://scriptrunner.adaptavist.com/latest/jira/behaviours-api-quickref.html

After playing around with the setDescription() method, it seems like it would be extremely useful to have some kind of resetDescription() method to change it back to the unmodified text (e.g. what's set in the Field Configuration).

Basically, we have a use-case where our user wants to conditionally set the description of a field, when a specific value is selected in another field.  setDescription() lets us do this for that specific value, but if the user then changes their choice to a value that should *not* modify the description, it continues to display the modified description.

The only workaround I could think of here would be to abandon setting a description in the Field Configuration entirely, and use setDescription() calls in the Behaviour exclusively (for both positive and negative cases)

Like Dave Liao likes this

I would have expected setHelpText to Set Help Text, but it styles it like an error. I tried to restyle it using CSS but there isn't enough difference between "help text" and a real error to make the selectors work.

Suggest an answer

Log in or Sign up to answer
TAGS
Community showcase
Published in Apps & Integrations

🍻🍂Apptoberfest Update: Upcoming Virtual Events 🎉

Hello Community! I hope you've been enjoying the 🍂Apptoberfestivities🍂 (I know I have!) The event is heating up next week with a series of virtual events that we're calling the 🍻🍂Partner App ...

78 views 1 6
Read article

Community Events

Connect with like-minded Atlassian users at free events near you!

Find an event

Connect with like-minded Atlassian users at free events near you!

Unfortunately there are no Community Events near you at the moment.

Host an event

You're one step closer to meeting fellow Atlassian users at your local event. Learn more about Community Events

Events near you