Documentation

Project Admin Tab Panel

Project administration tab panel modules add a new tab and corresponding page to the left hand menu on the JIRA project settings (previously called project administration) page.

Example

{
  "modules": {
    "jiraProjectAdminTabPanels": [
      {
        "location": "projectgroup4",
        "url": "/my-admin-panel",
        "weight": 100,
        "name": {
          "value": "Admin Panel"
        },
        "key": "admin-panel"
      }
    ]
  }
}

Properties

key

Type
string
Required
Yes
Description

A key to identify this module.

This key must be unique relative to the add on, with the exception of Confluence macros: Their keys need to be globally unique.

Keys must only contain alphanumeric characters and dashes.

The key is used to generate the url to your add-on's module. The url is generated as a combination of your add-on key and module key. For example, an add-on which looks like:

{
    "key": "my-addon",
    "modules": {
        "configurePage": {
            "key": "configure-me",
        }
    }
}

Will have a configuration page module with a URL of /plugins/servlet/ac/my-addon/configure-me.

name

Required
Yes
Description

A human readable name.

url

Type
string

uri-template
Required
Yes
Description

Specifies the URL targeted by the tab panel. The URL is relative to the add-on's base URL.

conditions

Description

Conditions can be added to display only when all the given conditions are true.

location

Type
string
Description

The name of the group of tabs in the project configuration where the tab panel should appear. The following are accepted values.

  • projectgroup1
  • projectgroup2
  • projectgroup3
  • projectgroup4

See Project Configuration Locations for details.

params

Type
object
Description

This object represents a map of key/value pairs, where each property name and value corresponds to the parameter name and value respectively.

Example

{
  "params": {
    "someOtherProperty": "someValue",
    "myCustomProperty": "myValue"
  }
}

weight

Type
integer
Description

Determines the order in which the tab panel's link appears in the menu or list.

The "lightest" weight (i.e., lowest number) appears first, rising relative to other items, while the "heaviest" weights sink to the bottom of the menu or list.

Built-in web items have weights that are incremented by numbers that leave room for additional items, such as by 10 or 100. Be mindful of the weight you choose for your item, so that it appears in a sensible order given existing items.