Web Item Module

説明

The WebItem 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 three locatins

• The Administration Menu
• The Plan Sub Menu (tabs on the View Plan page)
• The Results Sub Menu (tabs on the View Build Results page)

Sample Module Descriptor Element

<web-item key="pipelineConfig" name="Build Queues" section="system.admin/builds" weight="20">
  <label key="webitems.system.admin.build.queues"/>
  <link>/admin/configurePipeline!default.action</link>
  <condition class="com.atlassian.bamboo.plugins.web.conditions.AdminPermissionCondition" />
</web-item>

Module Components

• 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
• 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
• condition - by implementing the com.atlassian.plugin.web.Condition class you can add rules to determine whether the link will be displayed or not.

Both the link and the 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.