How to customize the Metadata User Screen as Jira-Administrator (Metadata for Jira Version 4.6 or older)

The Metadata User Screen defines which values every user can change for themselves.

These metadata values are also displayed in the hover profile

This page will show you, the provided (starting with version 4.3) Metadata User Screen.

Besides the existing screen you can change the default user screen.

Create a json which has the structure of this user-screen-1-0.json - scheme (you will find a validator here: http://json-schema-validator.herokuapp.com/) and upload it in the admin area on the page "Metadata configuration":

Supported Schema Types

The following field types are supported

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


Json-Templates

The following Jsons can be used as a basis.

Empty
Metadata User Screen

{
 "key": "metadata-screen-user-default",
 "name": "Default Metadata Screen"
}

Default
Metadata User Screen

{
 "key": "metadata-screen-user-default",
 "name": "Default Metadata Screen",
 "group": [
  {
   "name": "Telephone",
   "fullRow": true,
   "metadata": [
    {
     "key": "Telephone Number",
     "group": "Telephone",
     "hidden": false,
     "schema": {
      "type": "tel"
     }
    },
    {
     "key": "Mobile",
     "group": "Telephone",
     "hidden": false,
     "schema": {
      "type": "tel"
     }
    }
   ]
  },
  {
   "name": "Organization",
   "fullRow": true,
   "metadata": [
    {
     "key": "Title",
     "group": "Organization",
     "hidden": false,
     "schema": {
      "type": "string"
     }
    },
    {
     "key": "Department",
     "group": "Organization",
     "hidden": false,
     "schema": {
      "type": "string"
     }
    },
    {
     "key": "Company",
     "group": "Organization",
     "hidden": false,
     "schema": {
      "type": "string"
     }
    },
    {
     "key": "Manager",
     "group": "Organization",
     "hidden": false,
     "schema": {
      "type": "user"
     }
    }
   ]
  }
  ]
}
    

Customer Metadata User Screen

{
  "key": "metadata-screen-user-default",
  "name": "Default Metadata Screen",
  "group": [
    {
      "name": "Contact Details",
      "fullRow": true,
      "metadata": [
        {
          "key": "Telephone Number",
          "group": "Contact Details",
          "hidden": false,
          "schema": {
            "type": "tel"
          }
        }
      ]
    },
    {
      "name": "Customer",
      "fullRow": true,
      "metadata": [
        {
          "key": "Title",
          "group": "Customer",
          "hidden": false,
          "schema": {
            "type": "string"
          }
        },
        {
          "key": "Company",
          "group": "Customer",
          "hidden": false,
          "schema": {
            "type": "string"
          }
        },
        {
          "key": "Service Level",
          "group": "Customer",
          "hidden": false,
          "schema": {
            "type": "select"
          },
          "allowedValues": [
            {
              "name": "Platinum"
            },
            {
              "name": "Gold"
            },
            {
              "name": "Silver"
            }
          ]
        }
      ]
    }
  ]
}