How do you add a helper text above a field?

[MM6161]

What is the script for adding a text as a behavior ABOVE a field? 

[Kristian Walker _Adaptavist_ · Accepted solution]

Hi MM6161,

Are you using Jira Server/Data Center or Jira Cloud.

Using built-in Jira, you can set a field description on the field configuration page and this will add in the text below the field that can be used to explain to a user how to use the field. 

If you are using Jira Server/Data Center then you can use the behaviours plugin to add custom help text when the create screen loads using the setDescription() method and the tutorial here explains how to do this.

I hope this information helps.

Regards,

Kristian

[MM6161]

I’m using Jira Server. I used that script but not sure if it worked. I want to add a helper text to a transition screen above a field. 

[Kristian Walker _Adaptavist_]

Hi MM6161,

Unfortunately, adding text above a field in Jira is impossible. You can only add text below the field on any screen using either of the approaches mentioned above.

Regards,

Kristian

[MM6161]

Thanks Kristian for your help! 

[MM6161]

Does this sound correct. 
def attachmentText = ‘………’

//getFieldByName(‘Attachment’) .setDescription(attachmentText)

[Kristian Walker _Adaptavist_]

Hi, MM6161,

This looks correct.

One thing I would advise is referring to fields by Id instead of name in scripts, as if you have 2 fields with the same name inside your instance this will cause the field not to be found.

I have just done a test adding a description to the assignee field to confirm this works on a transiton screen and can confirm it works as shown in the screenshots below.

Regards,

Kristian

[MM6161]

Thanks Kristian. You’re awesome! I’ll come to you with all my questions! 

[Kristian Walker _Adaptavist_]

Hi MM6161,

You are welcome.

Can I please ask you to accept the answer if it has helped to solve your requirement?

Regards,

Kristian