How to customize the Metadata Project Fields as Jira-Administrator

How to customize the Metadata Project Fields as Jira-Administrator

 

This page has been replaced, since version 4.7, by the following page

How to create and customize User & Project Fields

The information presented here refers to version 4.6

In the Metadata configuration under the Project Field tab you can customize your Project Fields, adding or removing them.

You can find a list with all predefined Project Fields here.

Only Project Fields that are not used in any screen can be deleted.

How to add a new Project Field based on an existing one

The easiest way to add a new custom Project Field is to build on an existing one.
Let’s say we want to create a Project Field Fun Factor to let users select how big or small the fun factor of a given project is and enrich that with icons.

  1. Select an existing Project Field with the type select. We will take Importance because it already has the icons we want.
    (You find a list with all possible icons further down this page.)

  2. Now change the key of the field from Importance to Fun Factor
    IMPORTANT: Your new Project Field must have a unique key. Otherwise the existing field with this key will be overwritten.
    If your want to you can also change the names of the allowedValues or the icons. If you are done, click on Safe.

  3. That’s it. We now have a new Project Field in our list with the key Fun Factor and the type select.
    Note that this field is part of 0 Screens and can therefore be deleted. As soon as it is used in a Screen, the bin icon will disappear.

How to add a new Project Field from scratch

If you want to create your own custom Project Field, you can do that by putting a JSON in the Project Field Editor on the right and clicking on Save.

The most basic code for a Project Field will look something like this:

{"key": "New Project Field","schema": {"type": "string"}}

A valid JSON for a Project Field must contain the following key-value pairs:

key

value

key

value

"key"

"name of field"

"schema"

Object with a ”type” key and one of the possible Field Types as value.
(See a full list of possible types and their specifications in the list below.)

"allowedValues"
(only necessary if the schema is select)

Array of Objects with at least a "name" key and its value.
(Icons or lozenges can be added. Please see Project Field Types list below.)

IMPORTANT: Your new Project Field must have a unique key. Otherwise the existing field with this key will be overwritten.

Metadata Field Types

Lozenges

Icons