Web Item module

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:

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.

Purpose of this Module Type

Web Item plugin modules allow plugins to define new links in application menus.

Configuration

The root element for the Web Item plugin module is web-item. It allows the following attributes and child elements for configuration:

Attributes

*key and section attributes are required.

Elements

The tables summarises the elements. The sections below contain further information.

*label and link elements are required.

Label Elements

Error rendering macro ‘excerpt-include’ : No link could be created for ‘_Label Elements’.

Tooltip Elements

Tooltip elements have the same attributes and parameters as the label elements. See above.

Link Elements

Link elements may contain additional information:

1

<link linkId="create_link" absolute="false">/secure/CreateIssue!default.jspa</link>

• The linkId is optional, and provides an XML id for the link being generated.
• The absolute is optional and defaults to false unless the link starts with http:// or https://

The body of the link element is its URL. The URL is rendered with Velocity, so you can include dynamic information in the link. For example, in Confluence, the following link would include the page ID:

1

<link linkId="view-attachments-link">/pages/viewpageattachments.action?pageId=$page.id</link>

Icon Elements

Icon elements have a height and a width attribute. The location of the icon is specified within a link element:

1
2
3

<icon height="16" width="16">
    <link>/images/icons/print.gif</link>
</icon>

Param Elements

Error rendering macro ‘excerpt-include’ : No link could be created for ‘_Param Elements’.

Context-provider Element

Error rendering macro ‘excerpt-include’ : No link could be created for ‘_Context-Provider Element’.

Condition and Conditions Elements

Error rendering macro ‘excerpt-include’ : No link could be created for ‘_Condition and Conditions Elements’.

Example

Single web item in the admin section

Here is an example atlassian-plugin.xml file containing a single web item:

 1
 2
 3
 4
 5
 6
 7
 8
 9
10
11
12
13

<atlassian-plugin name="Hello World Plugin" key="example.plugin.helloworld" plugins-version="2">
    <plugin-info>
        <description>A basic web item module test</description>
        <vendor name="Atlassian Software Systems" url="http://www.atlassian.com"/>
        <version>1.0</version>
    </plugin-info>

    <web-item key="google_home" name="Google Home" section="system.admin/example1" weight="10">
        <description key="item.google.home.desc">Simple link to google.com.</description>
        <label key="item.google.home.label" />
        <link linkId="google_home">http://google.com</link>
    </web-item>
</atlassian-plugin>

Add a web item to the application header bar

Here is an example atlassian-plugin.xml file containing how to add your link to the application header.

 1
 2
 3
 4
 5
 6
 7
 8
 9
10
11
12
13

<atlassian-plugin name="Hello World Plugin" key="example.plugin.helloworld" plugins-version="2">
    <plugin-info>
        <description>A basic web item module test</description>
        <vendor name="Atlassian Software Systems" url="http://www.atlassian.com"/>
        <version>1.0</version>
    </plugin-info>

    <web-item key="google_home" name="Google Home" section="system.header/left" weight="60">
        <description key="item.google.home.desc">Simple link to google.com.</description>
        <label key="item.google.home.label" />
        <link linkId="google_home">http://google.com</link>
    </web-item>
</atlassian-plugin>