How to customize a Metadata Project Screen as an Administrator (Metadata for Jira Version 4.6)

If you are using Metadata for Jira Version 4.5 or older, please check out the documentation here.

If you want to customise a Metadata Project Screen, you can do so on the Metadata configuration page under the tab Project Screen.

Here you find a list with the existing Project Screens. You can edit them, create new screens or delete screens, if they are not needed anymore. (Note that the default screen can not be deleted.)

Selecting a default Project Screen

In order to select one Project Screen as the default, simply pick one from the dropdown in the middle of the page.
(Note that this screen can not be deleted as long as it is set as the default.)

Creating a new Project Screen based on an existing one

If you want to create a new Project Screen you can base it on an existing one.

  1. Click on the Project Screen you want to use as the basis for your new screen.
    The JSON of this screen will appear in the editor on the right.

     

  2. Now give your new screen a name and key. Both have to be unique.
    If you don’t change the name and key of the screen, the existing screen will be overwritten.

     

  3. Now change the JSON as you see fit. You can add and remove keys. But be aware that you can only use keys of Project Fields defined under the Project Field tab.
    You can find a list with all predefined Project Fields here.
    You can find out how to customise Project Fields as Jira Administrator here.

  4. If you are done with your changes, click on Save. Your new Project Screen is ready to be used.

The following Jsons can be used as a basis.

Empty Project Metadata Screen

An empty screen without any sections or fields.

{ "key": "metadata-screen-project-default", "name": "Empty Project Metadata Screen" }

Core Project Metadata Screen

A project screen with three sections:

  • Info

  • Lifetime Analysis

  • Stakeholder Analysis

The sections contain Project Fields as defined in the Project Field tab.

{ "key": "metadata-screen-project-core", "name": "Core Project Metadata Screen", "group": [ { "name": "Info", "fullRow": true, "metadata": [ { "key": "Management Summary" } ] }, { "name": "Lifetime Analysis", "metadata": [ { "key": "In Time" }, { "key": "Risk" } ] }, { "name": "Stakeholder Analysis", "metadata": [ { "key": "Importance" }, { "key": "Influence" }, { "key": "Stakeholder Group" } ] } ] }

Software Project Metadata Screen

A screen with five sections with fields for the project itself (starting at line 42):

  • Info

  • Development Environment

  • Lifetime Analysis

  • Project Roles

  • Stakeholder Analysis

The screen also holds an Info section for metadata for Versions (lines 4 to 22).

The screen also holds a Stakeholder Analysis section for components (lines 23 to 41).

The sections contain Project Fields as defined in the Project Field tab.

{ "key": "metadata-screen-project-software", "name": "Software Project Metadata Screen", "version": { "group": [ { "name": "Info", "fullRow": true, "metadata": [ { "key": "Conference Release" }, { "key": "Bitbucket Repo" }, { "key": "Hotfix" } ] } ] }, "component": { "group": [ { "name": "Stakeholder Analysis", "fullRow": true, "metadata": [ { "key": "Importance" }, { "key": "Influence" }, { "key": "Stakeholder Group" } ] } ] }, "group": [ { "name": "Info", "fullRow": true, "metadata": [ { "key": "Management Summary" }, { "key": "Budget" }, { "key": "Phone" }, { "key": "Mailing List" } ] }, { "name": "Development Environment", "metadata": [ { "key": "Bamboo Plan" }, { "key": "Conference Release" }, { "key": "Bitbucket Repo" }, { "key": "Hotfix" } ] }, { "name": "Lifetime Analysis", "metadata": [ { "key": "Start Date" }, { "key": "Due Date" }, { "key": "Estimation" }, { "key": "In Time" }, { "key": "Risk" } ] }, { "name": "Project Roles", "metadata": [ { "key": "Lead Developer" }, { "key": "Product Owner" }, { "key": "Scrum Master" }, { "key": "UX Lead" } ] }, { "name": "Stakeholder Analysis", "metadata": [ { "key": "Importance" }, { "key": "Influence" }, { "key": "Stakeholder Group" } ] } ] }