Release notes - 7.0

7.0 is a major version of Message Field for Jira Cloud. It is major because the app asks for one new permission: Atlassian ships any change to an app’s scopes as a major version, and a site administrator has to approve it before the site moves to the new version.

A site administrator must approve the update. 7.0 requests one new read-only scope, read:cmdb-object:jira, to show JSM Assets field values by object name. Until it is approved, your site stays on 6.x and receives no further fixes. Approve it in Jira → Apps → Manage apps → Message Field → Update / Review permissions. See Action for administrators.

Action for administrators

What the new scope is

7.0 requests exactly one new scope: read:cmdb-object:jira - read JSM Assets objects.

Why: messages and panels can now show the value of an Assets field by the object’s name. Until 7.0 such a value was shown as an object id (#objectId) or as raw JSON.

What it can do: read Assets objects - and the app uses it only to read an object’s name. It does not create, update or delete anything in Assets, and it does not read or change Assets schemas.

Whose permissions apply:

  • For a licensed Jira user the object name is read as that user, so Assets applies their own permissions. An object they cannot read keeps showing as #objectId.
  • On the JSM portal the name is read only for the fields of the customer’s own request that the configuration already shows them - the same way they see the field value itself.

The full per-scope detail is in the Permissions Reference and the Security Reference for Auditors.

How to approve it

  1. Open Jira → Apps → Manage apps.
  2. Find Message Field in the list of user-installed apps.
  3. Choose Update or Review permissions, check that the only new scope is read:cmdb-object:jira, and accept.

Until you do, the site stays on 6.x: configurations keep working, but the site does not receive the fixes below or any later ones.

Nothing else changes in permissions

There are no other new or removed scopes. Egress is unchanged: the app still declares no external: scopes. The app now declares 32 scopes instead of 31.


New

Assets values by object name

Values of JSM Assets fields are shown by the object’s name instead of its id or JSON - in messages, panels and on the portal. This is what the new read:cmdb-object:jira scope is for.

Translations of a configuration

A new Translations tab on the Create panel / Edit panel form shows a panel in the viewer’s language. For up to 10 languages per panel you can translate:

  • the name (also the title of the modal window) and the description;
  • the message title and the whole message - in the same render type as the source, with templates working as in the source;
  • the labels of Additional fields to display and their values, as “value -> translation” pairs (choice options, priority, status, user names, plain text);
  • the Open button text and Close button text of the modal window.

The Message Field custom field has the same tab in its context settings (Configure Message Panel Field).

The viewer gets the language of their Jira interface (on the customer portal - the portal language, otherwise their profile language). Each text is chosen on its own: the exact language (for example de-AT), then the base language (de), then the source text, so a viewer without a translation sees the panel as before. Translations apply on the issue view, in modal windows and flags, on the customer portal (request details and request creation), on the Messages pages, in the dashboard gadget and in the custom field. They are exported and imported with the configuration (JSON and CSV). See Configuration basics.

Flag when the issue is opened

The Modal Window section of the Other tab has a new setting Show a flag when the issue is opened (Issue Panel, Issue Activity and Issue Context, while Auto-open modal window is off). Instead of opening a modal by itself, the app shows a Jira flag in the corner of the page with the modal title and the configuration’s message as plain text - issue values filled in, in the viewer’s language, formatting dropped.

  • Open the modal from the flag (on by default) adds an Open button that opens the modal. Turn it off for a flag that only shows the message. Configurations saved before this setting keep the Open button.
  • The flag also works without the modal window: the panel is shown in place as usual, and a flag with its message appears when the issue is opened.
  • The flag follows the same conditions as auto-open and appears at most once per visit to the issue; with Show only once per issue it does not appear again for this issue for 7 days.

See Modal windows.

Messages pages and dashboard gadget

  • The Global Page (Jira Apps menu) and the Project Page (project navigation) are now titled Messages in the Jira page header and carry the app icon in the Jira menus. Each message on the page is headed by its configuration’s name; an empty page says “There are no messages to display.” or “There are no messages for this project yet.”
  • The dashboard gadget Message field shows a saved configuration of the Dashboard Gadget module, chosen in the gadget settings - for org-wide announcements. When there is no such configuration, the gadget settings say how to create one.

Pages and the gadget have no current issue: they show the name, description and message of the configuration, without linked issues or issue fields. See Modules.

Custom field: shown wherever the field is placed

The configuration form now explains where the Message Field custom field shows its message: wherever the field is placed - on the issue view (in the main column or in Details, as the issue layout of each issue type decides), on the customer portal request page, on the issue create form and the portal request form, and on workflow transition screens that include the field. See Custom fields.

Migration from Data Center

Message Field configurations move from Jira Data Center with the Jira Cloud Migration Assistant (JCMA): each Data Center field configuration becomes the configuration of the matching field context of the migrated Message Field custom field. A configuration is created enabled when everything in it can be expressed in the cloud, otherwise disabled with Disabled after migration: ... and the reason at the start of its description; the JQL condition is carried over with cloud ids. Put the field on a screen of every project you migrate. See Migration from Data Center.

Import a Data Center export

The file from Download for Jira Cloud in Message Field for Jira Data Center is imported in Bulk Operations → Import, by a Jira administrator: a Field and context step chooses the field and its context for each message. Use it to move only some messages. See Import a Data Center export.

Module guidance in the configuration wizard

The configuration wizard now describes, for each module, where it appears on the work item card and when to pick it. If you only want a message in the main column of the work item, Issue Panel is the one to choose - it does not require editing the issue layout.


Fixed

  • Auto-open modal windows open again. A configuration with Auto-open modal window opens its modal when the issue is opened, even if the panel itself is collapsed or not added to the issue view; on the customer portal the panel opens it. Several auto-open modals of one issue open one after another, and during one visit a modal opens at most once.
  • The modal from a flag or auto-open looks like a regular modal window: the title in the header, coloured by Modal window appearance, the content below it and the close button at the bottom - the same as the modal opened by the panel button.
  • The modal preview shows the modal’s style. Preview (Modal Mode) in the configuration form shows the title with the icon and colour of Modal window appearance, the Close button text and the Modal window size, following the form as it is now, without saving.
  • A missing license status no longer blocks the app. When Jira sends no license status at all, the app works as licensed. Only a license Jira reports as inactive shows “Active license required”.
  • Saving from the field context page keeps the configuration’s settings. Saving a Message Field custom field configuration from its context settings no longer clears settings that page does not show.
  • Export and import keep portal bindings. Configurations bound to a JSM portal stay bound to that portal after export and import. Before 7.0 they came back as global configurations.
  • JQL selections up to 1000 issues are read in full. The app reads every page of the search result, and the total shown is correct.
  • “Delete all” removes every UI Modification, and the request types of a portal are read in full, not only the first page.
  • Fields with more than 50 contexts. A field used in a project with more than 50 field contexts no longer disables configurations.
  • Table filters “Show in Modal” and “Modal Auto-Open” only count modules where a modal is possible.
  • A failed storage read no longer overwrites indexes. If reading the app’s storage fails, the app no longer writes empty indexes over the existing ones.
  • Retries in background jobs. Background jobs retry Jira responses 429 and 5xx instead of failing on the first one.

Security

7.0 moves the access checks for configurations to the server:

  • Configurations are served and applied with a server-side check of the project or portal and of the user’s permissions.
  • Project administrators see and change only their own projects. A project administrator cannot see or change configurations of other projects, and an import run by a project administrator is limited to the projects they administer. See Delegation.
  • The display context comes from the server, not from the request sent by the browser.
  • Portal customers receive only the fields of their own request that the configuration’s actor allowlist permits.

If you review the app for a security assessment, the Security Reference for Auditors describes the current model.


Changed

Deprecated template filters

The template filters statusBadge, avatar and formatField are deprecated. They never produced a value: they are removed from editor hints and documentation, and in a template they now return an empty string. If a template still uses one of them, remove it - the output does not change. See Template filters for the supported filters.

Weight is capped on import

The configuration weight is now limited to at most 1000 on import. See Bulk operations.


Upgrade checklist

  1. Approve the update in Jira → Apps → Manage apps → Message Field - the only new scope is read:cmdb-object:jira.
  2. If your security team keeps a scope register, add read:cmdb-object:jira (read-only, JSM Assets object names) - see the Permissions Reference.
  3. Remove statusBadge, avatar and formatField from templates that still use them.
  4. Check configurations that show Assets fields: values now show the object’s name.
  5. Optionally add translations on the Translations tab, and try Show a flag when the issue is opened for messages that should not open a modal by themselves.