Jira 4.4 and later
The location defines web sections (for groups of tabs) and web items (for individual tabs within a group) that are available when viewing a project's configuration in Jira's administration area.
You can add new web items to predefined web sections (that is, groups of tabs) or add new sections along with their own items.
To add your own web item to an existing web section (that is, groups of tabs) of Jira project configuration in the administration area, your web item must include a section attribute with the value , where is the existing group of tabs to which the web item will be added.
The following table lists these existing web sections (by ) and the existing web items associated with these web sections. The attribute values associated with each web section and item are indicated in brackets.
For more information about the purpose of this attribute, see Customizing the positions of items and sections.
Group of tabs
Web items associated with this group of tabs
Users and roles (15)
For example, to add a web item module that defines a new item in the section, which appears between the existing and web items, your web item module should contain the following:
1 2 3
<web-item key="my_new_tabbed_item_in_an_existing_project_group" ... section="atl.jira.proj.config/projectgroup3" ... weight="15"> ... </web-item>
To add your own section to the username drop-down menu, define a web section that includes a attribute with the value .
For example, your web section module should contain the following:
1 2 3
<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 for adding new web items to existing web sections. However, you need to specify the value of your web section's attribute in the value of your web item's attribute (preceded by the location). So, based on the previous example, your web item should contain this:
1 2 3
<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>
To ensure that a particular web item (that is, tabbed page) is displayed after a Jira administrator accesses a project's configuration by selecting the project's menu item, do the following:
Define a element in your HTML template file (such as a Velocity template file) with the attribute .
1 2 3 4 5 6 7 8
* This `meta` tag should also contain a `content` attribute whose value is the project configuration administration location (`"atl.jira.proj.config"`). For example: ``` xml <meta name="admin.active.section" content="atl.jira.proj.config"/> ```
Define another tag in the HTML template file with the attribute .
1 2 3 4
<div class="aui-message note"> <div class="icon"></div> <div> <p>This element specifies the tabbed page that is displayed by default after a Jira administrator selects
the project menu item.
1 2 3 4 5 6 7 8 9 10 11 12
</div> </div> * 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 of adding custom sections and items for defining a web item module for a custom group of tabs: ``` xml <meta name="admin.active.tab" content="my_new_tabbed_item_in_a_custom_project_group"/> ```
To customize the position of your own web items or sections in this location, add a attribute to your or and adjust its value with respect to Jira's existing web items or sections. Lower weight values result in these items or sections appearing higher up the page.
To find the values of Jira's existing web items and sections for the location, check the following file in Jira's source archive:
The and locations define web panels for individual panels/segments of an HTML page when viewing the summary tab of a project's configuration in Jira administration area.
The two and locations define web panels for the respective left and right hand sides of this summary tab.
To add your own web panel to the summary tab location of Jira project configuration administration, your web panel must include a location attribute with one of the following values:
For example, to add a web panel module that defines a new section on the right of the summary tab page, your web panel module should contain this:
1 2 3 4 5
<web-panel ... location="webpanels.admin.summary.right-panels" ...> ... <label key="my-new-panel.title"/> ... </web-panel>
If you want to create a "panel label" (that is, the collapsible heading that appears at the top of the panel), define a element with a attribute whose value defines a unique property (that is, based on the example above). The string value of this unique property (defined in your plugin's file) will be shown in bold text at the top of your section.
If you do not want a heading to appear at the top of the panel, include the following child element in your module:
To customize the position of your own web panels in this location, add a attribute to your 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.
To find the values of Jira's existing web panels for the and locations, check the following file in Jira's source archive:
In Jira 4.4 and later, the location defines web items of the "Actions" drop-down menu when viewing a project's configuration in Jira's administration area.
To add your own web item to Jira project configuration operations location, your web item must include a attribute with the value .
For example, to add a web item module that defines a new project operation link on a project configuration page, your web item module should contain:
1 2 3
<web-item ... section="system.view.project.operations" ...> ... </web-item>