Come for the products,
stay for the community

The Atlassian Community can help you and your team get more value out of Atlassian products and practices.

Atlassian Community about banner
Community Members
Community Events
Community Groups

Setting field help text using scriptrunner behaviour

I tried to change the help text of a field with Scriptrunner Behaviours according to 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?


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."



1 answer

1 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.

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
Community showcase
Posted in Jira Service Management

Jira Service Management Documentation Opportunities

Hello everyone, Hope everyone is safe! A few months ago we posted an article sharing all the new articles and documentation that we, the AMER Jira Service Management team created. As mentioned ...

217 views 0 6
Join discussion

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