Project Configuration Locations

Available:

JIRA 4.4 and later — the following locations are available:
    - atl.jira.proj.config
    - webpanels.admin.summary.left-panels
    - webpanels.admin.summary.right-panels
JIRA 3.7 and later — the system.view.project.operations location is available.

Project Configuration Administration Location

JIRA 4.4 and later versions.


The atl.jira.proj.config location defines web sections (for groups of tabs) and web items (for individual tabs within a group), which are available when viewing a project's configuration in JIRA's administration area.

You can add new web items to pre-defined web sections (i.e. groups of tabs), or add new sections along with their own items.

Adding New Items to Existing Web Sections

To add your own web item to an existing web section (i.e. groups of tabs) of JIRA's project configuration in the administration area, your web item must include a section attribute with the value "atl.jira.proj.config/existing_web_section_name", where existing_web_section_name is the existing group of tabs to which the web item will be added.

The following table lists these existing web sections (by existing_web_section_name) and the existing web items associated with these web sections. The weight attribute vales associated with each web section and item are indicated in brackets. See 'Customising the Positions of Items and Sections' (Customising the Positions of Items and Sections) for more information about the purpose of this attribute.

Group of Tabs (existing_web_section_name)

Web Items Associated with this Group of Tabs

projectgroup1 (10)

Summary (10)

projectgroup2 (20)

Issue Types (10)
Workflows (20)
Screens (30)
Fields (40)

projectgroup3 (30)

People (10)
Permissions (20)
Issue Security (30)
Notifications (40)

projectgroup4 (40)

Versions (10)
Components (20)

For example, to add a web item module that defines a new item in the 'projectgroup4' section which appears between the existing 'Versions' and 'Components' web items, your web item module would contain:

<web-item key="my_new_tabbed_item_in_an_existing_project_group" ... section="atl.jira.proj.config/projectgroup4" ... weight="15">
    ...
</web-item>

Adding Custom Sections and Items

To add your own section to the user name drop-down menu, define a web section that includes a location attribute with the value "atl.jira.proj.config".

For example, your web section module would contain:

<web-section key="my-custom-group-of-tabs-section" ... location="atl.jira.proj.config" ...>
...
</web-section>

Adding new web items to your own sections is similar to the method Adding New Items to Existing Web Sections for adding new web items to existing web sections. However, specify the value of your web section's key attribute in the value of your web item's section attribute (preceded by the location). Hence, following on from the previous example, your web item would contain:

<web-item key="my_new_tabbed_item_in_a_custom_project_group" ... section="atl.jira.proj.config/my-custom-group-of-tabs-section" ...>
...
</web-item>

Ensuring a Particular Web Item (Tabbed Page) is Displayed by Default When Accessing a Project Configuration

To ensure that a particular tabbed page is displayed after a JIRA administrator accesses a project's configuration by selecting the project's menu item:

  1. Define a <meta> element in your HTML template file (such as a Velocity template file) with the attribute name="admin.active.section".

    This element links your HTML template to the menu item you defined above for either an Adding New Items to Existing Web Sections or Adding Custom Sections and Items group of tabs.

    • This <meta> tag should also contain a content attribute whose value is the Project Configuration Administration Location ("atl.jira.proj.config") — i.e.

      <meta name="admin.active.section" content="atl.jira.proj.config"/>
  1. Define another <meta> tag in the HTML template file with the attribute name="admin.active.tab".

    This element specifies the tabbed page which is displayed by default after a JIRA administrator selects the project's menu item.

    • This <meta> tag should also contain a content attribute whose value is the key attribute's value specified in the <web-item> module you defined above for either an existing or custom group of tabs.
    • For example, following on from the procedure Adding Custom Sections and Items for defining a web item module for a custom group of tabs:

      <meta name="admin.active.tab" content="my_new_tabbed_item_in_a_custom_project_group"/>

Customising the Positions of Items and Sections

To customise the position of your own web items or sections in this location, add a weight attribute to your <web-item> or <web-section> and adjust its value with respect to JIRA's existing web items or sections. Lower weight values result in these items/sections appearing higher up the page.

Source File

To find the values of JIRA's existing web items and sections for the atl.jira.proj.config location, view the following file in JIRA's source archive:
<source-installation-directory>/jira-project/jira-components/jira-plugins/jira-project-config-plugin/src/main/resources/atlassian-plugin.xml

Project Configuration Administration — Summary Tab Location

JIRA 4.4 and later versions.


The webpanels.admin.summary.left-panels and webpanels.admin.summary.right-panels locations define web panels for individual panels/segments of an HTML page when viewing the Summary Tab of a project's configuration in JIRA's administration area.

The two webpanels.admin.summary.left-panels and webpanels.admin.summary.right-panels locations define web panels for the respective left and right hand sides of this Summary Tab.

Adding Custom Panels

To add your own web panel to the summary tab location of JIRA's project configuration administration, your web panel must include a location attribute with either of the following values:

  • "webpanels.admin.summary.left-panels" — to add a panel to the left hand side of the summary tab page.
  • "webpanels.admin.summary.right-panels" — to add a panel to the right hand side of the summary tab page.

For example, to add a web panel module that defines a new section on the right of the summary tab page page, your web panel module would contain:

<web-panel ... location="webpanels.admin.summary.right-panels" ...>
    ...
        <label key="my-new-panel.title"/>
    ...
</web-panel>

Panel Headings

If you wish to create a 'panel label' (i.e. the collapsible heading which appears at the top of the panel), define a <label> element with a key attribute whose value defines a unique property (i.e. my-new-panel.title based on the example above). The string value of this unique property (defined in your plugin's i18n.properties file) will be shown in bold text at the top of your section.

If you do not wish a heading to appear at the top of the panel, include the following child element in your <web-panel> module:

<param name="headless">true</param>

Customising the Positions of Panels

To customise the position of your own web panels in this location, add a weight attribute to your <web-panel> and adjust its value with respect to JIRA's existing web panels. Lower weight values result in these panels appearing higher up the summary tab page.

Source File

To find the values of JIRA's existing web panels for the webpanels.admin.summary.left-panels and webpanels.admin.summary.right-panels locations, view the following file in JIRA's source archive:
<source-installation-directory>/jira-project/jira-components/jira-plugins/jira-project-config-plugin/src/main/resources/atlassian-plugin.xml

Project Configuration Operations Location

In JIRA 4.4 and later, the system.view.project.operations location defines web items of the 'Actions' drop-down menu when viewing a project's configuration in JIRA's administration area.

In versions of JIRA prior to 4.4, the system.view.project.operations location defines web items for the project operation links when viewing a project's configuration in JIRA's administration console.

Adding Custom Items

To add your own web item to JIRA's project configuration operations location, your web item must include a section attribute with the value "system.view.project.operations".

For example, to add a web item module that defines a new project operation link on a project configuration page, your web item module would contain:

<web-item ... section="system.view.project.operations" ...>
    ...
</web-item>

It is not possible to add your own web sections to the system.view.project.operations location.

Customising the Positions of Items

To customise the position of your own web items in this location, add a weight attribute to your <web-item> and adjust its value with respect to JIRA's existing web items. Lower weight values result in these items appearing higher up the 'Actions' drop-down menu in JIRA 4.4 and later or further to the left in versions of JIRA prior to 4.4.

In JIRA 4.4 and later, the position of the 'Edit Project' button is fixed.

Source File

To find the values of JIRA's existing web items and sections for the system.view.project.operations location, view the following file in JIRA's source archive:
<source-installation-directory>/jira-project/jira-components/jira-core/src/main/resources/system-view-project-operations-sections.xml

Was this page helpful?

Have a question about this article?

See questions about this article

Powered by Confluence and Scroll Viewport