Key concepts

To understand how Live Fields works, it's helpful to cover a few key concepts and to look at the general flow of how Live Fields executes its changes.

  • A configuration is what you create in Live Fields. A configuration is a script that is added to selected screens in Jira. Because these scripts are JavaScript/TypeScript, you can change many things about your Jira interface!

  • You must select the specific screens to which your configuration will be added - the Issue create screen, for example. Your script will only be called on the screens to which it is added.

  • You can also limit your configurations to only certain projects. A single configuration can be added to one or more projects.

  • A configuration can also be limited to specific issue types, making changes only to Stories, Tasks, or Bugs. You can add a single configuration to one or more issue types.

  • The trigger for the configuration determines when the script will run. Currently, two triggers are available - when the page loads, and/or when a field value changes.

How Live Fields Works

Looking at an example configuration - one that makes the Priority field editable only by the Project Lead - we can follow how Live Fields works. This configuration is included in all screens and is triggered when the page loads; field updates will never enable any other user to update the Priority of the issue.

 

livefields-flow.png


When user opens any page in your Jira instance…

 

 

The Live Fields configurations are loaded for that project, issue type, and view. In this example, all issue types are included, so no matter which issue is opened, the configuration is loaded.

 

 

The configuration is triggered On page load, so it runs immediately.

The script includes a condition, checking if the logged in user is the Project lead.

 

If the user is the Project lead, the Priority field is enabled.

If the user is not the Project lead, the Priority field is disabled.

 

 

 

 

You are viewing the documentation for Jira Cloud.