View Source

Available:	Bamboo 1.0 and later

On this page:

Description

The Web Item module allows you to define a link in the Bamboo system. (Usually in some form of menu).

Currently, you can use the web-item to add links to the following locations:

Menu	Section
Dashboard Tabs (since 3.0)	`system.dashboard/dashboard`
Plan Sub Menu (tabs on the View Plan page)	`chain.subMenu/chain`
Plan Results Sub Menu (tabs on the View Plan Result page)	`chainResults.subMenu/chainResults`
Job Sub Menu (tabs on the View Job page)	`build.subMenu/build`
Job Results Sub menu (tabs on the View Job Result page)	`results.subMenu/results`
Administration Menu	`system.admin/plugins`

When putting items in the Administration Menu, you can also add your own section to the menu (rather than using the suggested plugins section above). For more information see Web Section Module.

Bamboo-specific notes about Web Items

Module Parameters

Please take note of the following Bamboo-specific information that is relevant to the Module components described in the 'Configuration' section below.

Attributes:

key — this is the unique identifier of the web-item, it is also used by Bamboo to give the link an id.
name — in the plan sub menu and results sub menu this is used to determine if the current link (tab) is active
section — the section is made of of the parent section's location followed buy the name of the parent section. In Bamboo this is used to retrieve the appropriate web-items for the menu. (see Web Section Module)
weight — this is used to determine the order of the items on the page

Elements:

condition — by implementing the com.atlassian.plugin.web.Condition class you can add rules to determine whether the link will be displayed or not.
label — this will be displayed on the screen and can be plain text or a property key
link — the link is the url the link will point to. It can be absolute or relative to Bamboo's context path

Both the link and the key id can make use of parameters passed to the page. For example:
<link>/build/viewBuildFiles.action?buildKey=${buildKey}</link> where ${buildKey} is the parameter name.

Context Aware Navigation

In Bamboo 3.0 we have added the Plan Navigator. When moving between Jobs and the Plan (as well as Job Results and Plan Result), the navigator remembers your context i.e. which tab (Web Item) you are on and will attempt to keep you on the same tab. If you are adding a new tab to a page which has the Plan Navigator, you may also wish to manually define the corresponding Job/Plan/Result URL. You can find more information on how to do this on the XWork Plugin Module page.