Troubleshooting Behaviours

Cannot Add Behaviours

The Behaviours page in ScriptRunner is failing to load information, blocking you from adding behaviours to your Jira instance. Try the steps below before contacting ScriptRunner support.

Behaviours module disabled

One cause of this issue may be that the behaviours module has been disabled. Follow the steps below to check.

1. From the Administration page, navigate to Manage Apps under Atlassian Marketplace.

2. Locate ScriptRunner and expand the section.

3. Click XXX of XXX modules enabled.

   

4. From the modules list, find Behaviour admin assets (bh-admin) and check if disabled (greyed out with Disabled in red).

   

5. If disabled, click Enable.

Customized HTML banner containing JavaScript 

Many Jira Data Center administrators add custom HTML banners to their pages (as described in Atlassian's Documentation). While this is generally fine for basic HTML, some administrators will use this banner to include custom JavaScript for various purposes, such as:

• Adding page tracking for monitoring tools (for example New Relic's browser agent)
• Adding custom interactivity to an announcement banner

These customizations usually work well with ScriptRunner. However, they can break ScriptRunner Behaviours if not carefully implemented.

Troubleshooting

If you experience issues with ScriptRunner Behaviours, check your browser's Developer Tools Console Log (see documentation for Chrome, Firefox, Edge for details on how to do this).

There may be some telltale signs that an odd bit of JavaScript is breaking Behaviours. If you see one of the following errors, it may be caused by a customized HTML banner containing JavaScript:

TypeError: $ is not a function

Uncaught ReferenceError: jQuery is not defined

Solution

1. Navigate to the HTML banner.

2. Eliminate any custom JavaScript from your banner.

   This may remove some added functionality, but it is an important troubleshooting step.

3. Clear your browser cache and reload a Jira issue to test whether your Behaviours work as expected.

4. If your Behaviours work as expected you will need to troubleshoot the JavaScript in your custom HTML banner. We recommend you try the following:

   While providing detailed instructions for this process is beyond the scope of this documentation, we can offer some general tips that have proven helpful for other customers in similar situations. The effectiveness of these solutions may vary depending on your specific circumstances. 

   • Locate the following and remove it from the HTML file (either by deleting or commenting out).

     js
     jQuery.noConflict( );

     For more information on why this line causes errors see this explanation of jQuery.noConflict().

   • If your custom JavaScript was provided by a third party application, such as New Relic's browser monitoring agent, try re-generating the code from that application.

Custom HTML/JavaScript in custom field descriptions no longer work in Jira 8.7

Problem

You have recently upgraded to Jira 8.7, and behaviours that set custom field description values are not working correctly on custom fields, or you're seeing raw code in the field's description.

Solution

Jira 8.7 automatically disables the feature labelled as "Enable HTML in custom field descriptions and list item values". If your custom HTML or JavaScript just shows as text, where your fields description should show, and your custom code is not being executed, you must re-enable that feature. Alternatively, you can load your custom JavaScript in a different way, for example, using our web resources feature.

Atlassian bug reference: JRASERVER-38866

The bug is referenced in the release notes for Jira 8.7.

Related content

• Get Help with Behaviours
• Behaviours FAQs
• Behaviours Supported Fields