Project settings UI locations

If your app allows for per-project configuration options, you can use a Project Admin Tab Panel within that project's Settings section for users to configure your app in the context of that project. The project settings section supports web sections for your app to define one or more links (such as the location for a Project Admin Tab Panel).

Available locations

For web sections:

  • atl.jira.proj.config
In classic projects

Jira project settings location classic

In next-gen projects

Jira project settings location next gen

Sample descriptor JSON

1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
...
"modules": {
    "webSections": [
      {
        "key": "example-menu-section",
        "location": "atl.jira.proj.config",
        "name": {
          "value": "Project admin app"
        }
      }
    ],
    "jiraProjectAdminTabPanels": [
      {
        "location": "example-menu-section",
        "url": "/admin",
        "weight": 100,
        "name": {
          "value": "App page"
        },
        "key": "admin-panel"
      }
    ]
...

Properties

The properties required for this location are the standard ones defined in the documentation for web sections.


Project summary area

Adds panels to the project summary area.

Deprecated

We expect to remove the project summary area in Jira Cloud in the near future, so we recommend that you don't add new project summary panels. Instead, you should provide a Project Admin Tab Panel if you need to display content in Jira's project settings UI.

Module type

webPanel

Screenshot

Sample JSON

1
2
3
4
5
6
7
8
9
10
11
12
13
...
"modules": {
    "webPanels": [
        {
            "key": "example-panel",
            "location": "webpanels.admin.summary.left-panels",
            "name": {
                "value": "Example panel"
            }
        }
    ]
}
...

Properties

key

  • Type: string (^[a-zA-Z0-9-]+$)
  • Required: yes
  • Description: A key to identify this module. This key must be unique relative to the app, with the exception of Confluence macros: their keys need to be globally unique. Keys must only contain alphanumeric characters and dashes.

location

  • Description: Set the location to webpanels.admin.summary.left-panels or webpanels.admin.summary.right-panels.

name