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:

keyvalue
"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

You can use the following field types when creating project fields or customizing the User/Customer Screen.

TypeDescriptionDatamodel
Date

Date picker to set one day as value.

{
"key": "Due Date",
"schema": {
"type": "date"
}
}
Email

{
"key": "Mailing List",
"schema": {
"type": "email"
}
}

Group

Group Picker to select one Jira Group as value.

{
"key": "Stakeholder Group",
"schema": {
"type": "group"
}
}

Longstring

Text field without restrictions regarding characters, but only the first 30.000 characters are searchable. (This might be important for filtering in the Project Overview.)

{
"key": "Management Summary",
"schema": {
"type": "longstring"
}
}

Multi Group

(since Version 4.8.0)

Group Picker to select one or more Jira Groups as value.



{
"key": "All Stakeholders",
"schema": {
"type": "multigroup"
}
}

Multi Select List

(since Version 4.8.0)

Dropdown to select one or more of the predefined allowed values.

There is no limit on how many allowed values are predefined.

Can be enriched with icons or lozenges. (See the entries about Select List (with lozenge) and Select List (with icon).)

{
"key": "Skills",
"schema": {
"type": "multiselect"
},
"allowedValues": [
{
"name": "HTML"
},
{
"name": "CSS"
},
{
"name": "JavaScript"
}
]
}

Multi User

(since Version 4.8.0)

User Picker to set one or more Jira Users as value.

You can search for a name or email address.


{
"key": "Project Managers",
"schema": {
"type": "multiuser"
}
}
Number

Text field that will show a warning if anything but a number is entered. Note that values containing something other than a number will also be saved.

{
"key": "Budget",
"schema": {
"type": "number"
}
}
Select List

Dropdown to select one of the predefined allowed values.

There is no limit on how many allowed values are predefined.

Can be enriched with icons or lozenges. (See the next two entries.)

{
"key": "Hotfix",
"schema": {
"type": "select"
},
"allowedValues": [
{
"name": "Yes"
},
{
"name": "No"
}
]
}
Select List (with lozenge)

Dropdown to select one of the predefined allowed values. The predefined values are displayed in a coloured box.

For more information on possible lozenges see further down this page.

{
"key": "In Time",
"schema": {
"type": "select"
},
"allowedValues": [
{
"name": "Red",
"lozenge": {
"appearance": "removed",
"bold": false
}
},
{
"name": "Yellow",
"lozenge": {
"appearance": "moved",
"bold": false
}
},
{
"name": "Green",
"lozenge": {
"appearance": "success",
"bold": false
}
}
]
}
Select List (with icon)

Dropdown to select one of the predefined allowed values. The predefined values are accompanied by an icon.

For more information on possible icons see further down this page.

{
"key": "Importance",
"schema": {
"type": "select"
},
"allowedValues": [
{
"name": "High",
"icon": "@atlaskit/icon-priority/glyph/priority-high"
},
{
"name": "Medium",
"icon": "@atlaskit/icon-priority/glyph/priority-medium"
},
{
"name": "Low",
"icon": "@atlaskit/icon-priority/glyph/priority-low"
}
]
}
String

Text field with up to 255 characters.

{
"key": "Bamboo Plan",
"schema": {
"type": "string"
}
}
Telephone

{
"key": "Phone",
"schema": {
"type": "tel"
}
}
User

User Picker to set one Jira User as value.

You can search for a name or email address.

{
"key": "Product Owner",
"schema": {
"type": "user"
}
}


Lozenges

Lozenges come in six different colours and two styles.
The text inside the lozenge is the name of the allowed value.

Note that lozenges and icons can not be used together in one select option. If you put both in only the icon will be shown.

{
"appearance": "success",
"bold": false
}

{
"appearance": "moved",
"bold": false
}

{
"appearance": "removed",
"bold": false
}

{
"appearance": "inprogress",
"bold": false
}

{
"appearance": "new",
"bold": false
}

{
"appearance": "default",
"bold": false
}

{
"appearance": "success",
"bold": true
}

{
"appearance": "moved",
"bold": true
}

{
"appearance": "removed",
"bold": true
}

{
"appearance": "inprogress",
"bold": true
}

{
"appearance": "new",
"bold": true
}

{
"appearance": "default",
"bold": true
}

Icons

Note that lozenges and icons can not be used together in one select option. If you put both in only the icon will be shown.

"@atlaskit/icon-priority/glyph/priority-major"

"@atlaskit/icon-priority/glyph/priority-highest"

"@atlaskit/icon-priority/glyph/priority-high"

"@atlaskit/icon-priority/glyph/priority-medium"

"@atlaskit/icon-priority/glyph/priority-low"

"@atlaskit/icon-priority/glyph/priority-lowest"

"@atlaskit/icon-priority/glyph/priority-minor"

"@atlaskit/icon-priority/glyph/priority-trivial"

"@atlaskit/icon-priority/glyph/priority-blocker"

"@atlaskit/icon-priority/glyph/priority-critical"

"@atlaskit/icon-object/glyph/blog/24"

"@atlaskit/icon-object/glyph/branch/24"

"@atlaskit/icon-object/glyph/bug/24"

"@atlaskit/icon-object/glyph/calendar/24"

"@atlaskit/icon-object/glyph/changes/24"

"@atlaskit/icon-object/glyph/code/24"

"@atlaskit/icon-object/glyph/commit/24"

"@atlaskit/icon-object/glyph/epic/24"

"@atlaskit/icon-object/glyph/improvement/24"

"@atlaskit/icon-object/glyph/incident/24"

"@atlaskit/icon-object/glyph/issue/24"

"@atlaskit/icon-object/glyph/new-feature/24"

"@atlaskit/icon-object/glyph/page/24"

"@atlaskit/icon-object/glyph/problem/24"

"@atlaskit/icon-object/glyph/pull-request/24"

"@atlaskit/icon-object/glyph/question/24"

"@atlaskit/icon-object/glyph/story/24"

"@atlaskit/icon-object/glyph/subtask/24"

"@atlaskit/icon-object/glyph/task/24"