Skip to main content

UI Modifications

UI modifications change Jira forms while people fill them in. They show, hide, require, lock, rename or pre-fill fields, add hints, and limit the options of a select field.

Applies to: Script Master for Jira Β· Cloud

For example, when Priority is Highest, Due date appears on the Create dialog and becomes required. When someone picks another priority, the field goes back to how it was.

UI modifications run in the browser of the person filling in the form. They don't need the Companion App.

The UI Modifications tab before the first UI modification exists, with four common tasks and the Start from scratch, Write a script and Import buttons

Rules or a script​

You build each UI modification from rules or from a script, never both. You pick one when you create it.

CompareRulesScript
How you build itPick fields, conditions and actions. No code.Write JavaScript.
Use it forMost form changes: when a field has a value, show, hide, require, lock or fill other fields.Logic rules can't express, such as Jira lookups, the current user or groups.
Test itTry it previews the form before you save.Switch it on for a test space and open the form there.

On every form, the rules of all UI modifications run first. Then each script runs, so a script can change what a rule set. You can convert rules to a script later, but you can't turn a script back into rules.

Where they run​

Each UI modification has a Where it runs section with its spaces, work types and forms. An empty Spaces list means all spaces, and an empty Work types list means all work types. Jira can't run one UI modification on every space and every work type at once, so pick at least one of the two.

FormWhat it coversJira status
CreateThe Create dialog: the Create button, the c shortcut, child items and subtasks.Ready
Transition screensScreens that open when a work item moves to another status.Preview
Work item viewThe full work item page and its side panel.Preview
Service portalRequest forms customers fill in on a Jira Service Management portal.Preview

Atlassian marks the Preview forms as preview: they work, and their behavior may change. For Service portal, you also pick the portal and at least one request type.

Script Master skips a field that isn't on the form. So one UI modification can cover several work types, even if only some of them have the field.

Limitations​

UI modifications guide people filling in a form. They don't enforce anything.

  • Some ways of creating work skip them. Board inline create, the REST API, automation and bulk edit don't run UI modifications. To block a missing value everywhere, add a workflow validator as well.
  • You can't change fields from Forge apps. Jira doesn't let UI modifications change fields that come from Forge apps, including Script Master custom fields. The editor won't save an action on one.
  • Some fields may not work on every form. The field picker lists them under Other fields: may not work on every form. Check them in Try it and on the real form.
  • Another app may change the same field. When two apps change one field, Jira keeps only one change, and Script Master counts a failure. See Failures on forms.
  • Up to 100 UI modifications per site. Delete one you no longer need to create another.
  • Size and scope limits from Jira. One UI modification can be up to 50,000 characters once saved. It can cover up to 1,000 combinations of space, work type and form. If you reach a limit, shorten the script, split the rules into two UI modifications, or pick all work types instead of a long list.

Build one​

Look after them​