- Summary
- 1. Web resources
- 2. JavaScript in a configuration
- 3. The message follows field changes by itself
- 4. Global settings moved to REST
- 5. Find the affected configurations
Most Message field configurations keep working after an upgrade from 4.x to 5.x. The ones that need attention are those that relied on how 4.x loaded its scripts: custom portal resources, JavaScript that waited for something with a timer, and the global waiting settings. This page lists each change, what replaces it, and how to find the configurations it touches.
Two upgrades are covered:
- 4.x → 5.x on any Jira line;
- the Jira 11.3 build → 5.6.0 (
5.6.0-jira11.3) - one more resource change, see section 1.
Summary
| Was (4.x) | Is (5.x) | What to do |
|---|---|---|
Separate portal resources - view-servicedesk, view-servicedesk-global and others |
Two resources: general (enabled) and general-global (disabled by default) |
Keep general enabled. Enable general-global instead of general only if messages do not show on some pages - section 1 |
general-global in the Jira 11.3 build before 5.6.0 |
Jira 11.3 build 5.6.0+: only general |
If general-global was enabled, enable general again - section 1 |
JavaScript waited for the form with setTimeout or for another app’s form script |
Run code on form update per configuration: No - once on page load, Yes - on every form or issue data update | Set the option to Yes, or keep an explicit delay - section 2 |
| A waiting setting was needed so the message reflected values set by another app | The message updates itself when another app changes form field values | Nothing - remove workarounds that only waited for those values - section 3 |
| Global settings Timeout, Show default message, When the JavaScript … should be run on an admin page | Same settings, no admin page - REST only | Read and change them over REST - section 4 |
| - | All Message Fields Settings shows every configuration’s JavaScript in one table | Review there, edit each configuration in its own settings - section 5 |
1. Web resources
Up to 4.x the plugin shipped separate web resource modules for the customer portal
(view-servicedesk, view-servicedesk-global and others). Since 5.0 there are two:
| Module | Default | Loads |
|---|---|---|
general |
Enabled | On the pages where messages are shown |
general-global |
Disabled | On all pages - a fallback for pages where general does not load |
The portal modules from 4.x no longer exist. If you had enabled or disabled them by hand, that
setting does not carry over: check that general is enabled after the upgrade.
The resource set depends on the build you install:
| Build | Resources |
|---|---|
Jira 10.x line (5.6.0-jira10.5) |
general (enabled) and general-global (disabled by default) |
| Jira 11.3 line, builds before 5.6.0 | general (enabled) and general-global (disabled by default) |
Jira 11.3 line, 5.6.0 and later (5.6.0-jira11.3) |
general only - general-global is removed |
Never enable 'general' and 'general-global' at the same time - every message is shown twice.
What to do
- After any upgrade to 5.x, open Manage apps → Message field → modules and make sure
generalis enabled. - Jira 11.3 build, upgrading to 5.6.0: if you had switched to
general-global, enablegeneralagain - it is the only resource left. If messages then do not show on a page, contact support with your Jira and Message field versions. - Portals built with Refined for Jira: see Refined for Jira: Sites & Themes.
2. JavaScript in a configuration
Since 5.0 every configuration has the option Run code on form update (column Run JS on Update in All Message Fields Settings). Default: No.
| Value | When the configuration’s JavaScript runs |
|---|---|
| No (default) | Once, when the page loads |
| Yes | Every time form fields or issue data are updated |
In 4.x, code often waited for the form to be ready - a setTimeout, or a wait for another app’s form
script to finish. With the default No such code runs once at page load, and the elements or values
it waits for may not be there yet.
What to do with each configuration whose code waits for something:
- set Run code on form update to Yes, so the code runs again whenever the form changes; the code must then be safe to run many times; or
- keep an explicit delay, as the hint in the settings suggests:
setTimeout(() => { /* code */ }, 1000)
The option is described in Advanced settings → JavaScript settings.
3. The message follows field changes by itself
In 5.x the message updates itself when another app - for example, a form scripting or behaviours app - changes the values of form fields. No waiting setting is needed for that.
What to do: nothing for the message itself. JavaScript or global settings that existed only to wait for another app to set field values can be removed or left at their defaults.
4. Global settings moved to REST
These global settings still exist and still work in 5.x:
- Timeout
- Show default message?
- When the JavaScript from Message field settings should be run?
The admin page for them is gone; they are read and changed only through the REST resource
/rest/message-field/1.0/config/messageFieldsConfig (GET to read, POST to update).
What to do: see the Behaviours settings page for what each setting does, and the REST API page for the request collection.
5. Find the affected configurations
The All Message Fields Settings page (Manage apps → Message Field → All Message fields settings) shows every configuration in one table. For this upgrade:
- Show the JavaScript columns: Code, Contexts and Run JS on Update.
- Narrow the table with the fields and screens filters.
- Look for code with
setTimeoutor other waits, and for configurations with Run JS on Update = No whose code depends on values set after page load. - Open each such configuration from its own settings and change it there - see section 2.
The page is an overview: it has no way to change several configurations at once. Each configuration is edited in its own settings.
Details of the page: All Message fields settings.

