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

1
2
<component-import 
  key="appProps" 
  interface="com.atlassian.sal.api.ApplicationProperties"/>

*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

Label elements may contain optional parameters, as shown below:

1
2
<label key="common.concepts.create.new.issue">
    <param name="param0">$helper.project.name</param>
</label>

• The parameters allow you to insert values into the label using Java's MessageFormat syntax.
• Parameter names must start with param and will be mapped in alphabetical order to the substitutions in the format string. I.e. param0 is {0}, param1 is {1}, param2 is {2}, etc.
• Parameter values are rendered using Velocity, allowing you to include dynamic content.

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
2
<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
2
<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
<icon height="16" width="16">
    <link>/images/icons/print.gif</link>
</icon>

Param 

Param elements represent a map of key/value pairs, where each entry corresponds to the param elements attribute: name and value respectively.

1
2
<param name="key" value="value" />

The value can be retrieved from within the Velocity view with the following code, where $item is a WebItemModuleDescriptor:

1
2
$item.webParams.get("key") <!-- retrieve the value -->
$item.webParams.getRenderedParam("key", $user, $helper) <!-- retrieve the Velocity rendered value -->

If the value attribute is not specified, the value will be set to the body of the element. I.e. the following two param elements are equivalent:

1
2
<param name="isPopupLink" value="true" />
<param name="isPopupLink">true</param>

Context-provider

The context-provider element must contain a class attribute with the fully-qualified name of a Java class. The referenced class:The context-provider element adds to the Velocity context available to the web section and web item modules. You can add what you need to the context, to build more flexible section and item elements. Currently only one context-provider can be specified per module. Additional context-providers are ignored.

• must implement com.atlassian.plugin.web.ContextProvider, and
• will be auto-wired by Spring before any additions to the Velocity context.

For example, the following context-provider will add trackingEntry and bambooUserManager to the context.

In the following example, NotificationPanelContextProvider extends ContextProvider and add information for panel which shows person responsible for build failure.

1
2
public class NotificationPanelContextProvider implements ContextProvider {
    private final BambooUserManager bambooUserManager;
    private final TrackingEntryManager trackingEntryManager;

    @Autowired
    public NotificationPanelContextProvider(@ComponentImport final BambooUserManager bambooUserManager,
                                            final TrackingEntryManager trackingEntryManager) {
        this.bambooUserManager = bambooUserManager;
        this.trackingEntryManager = trackingEntryManager;
    }

    @Override
    public void init(final Map<String, String> params) throws PluginParseException {
    }

    @Override
    public Map<String, Object> getContextMap(final Map<String, Object> context) {
        final Map<String, Object> map = new HashMap<>(context);

        ResultsSummary resultsSummary = Narrow.to(map.get("resultsSummary"), ResultsSummary.class);
        if (resultsSummary != null) {
            map.put("trackingEntry", trackingEntryManager.getTrackingEntryByResultId(resultsSummary.getId()));
            map.put("bambooUserManager", bambooUserManager);
        }
        return map;
    }
}

The above NotificationPanelContextProvider can be used by nesting the following element in a web item module.

1
2
<context-provider class="com.atlassian.bamboo.brokenbuildtracker.notifications.NotificationPanelContextProvider"/>

The newly added context entries trackingEntry and bambooUserManager can be used in the XML module descriptors just like normal freemarker context variables, by prefixing them with the dollar symbol ($):

1
2
<!-- pass the value of trackingEntry as a parameter called trackingEntry (see param element above for its usage) -->
<param name="trackingEntry">$trackingEntry</param>

<label>Can create users: $bambooUserManager.canCreateUsers()</label>

Condition and Conditions elements

Conditions can be added to the web section, web item and web panel modules, to display them only when all the given conditions are true.

Condition elements must contain a class attribute with the fully-qualified name of a Java class. The referenced class:

• must implement com.atlassian.plugin.web.Condition, and
• will be auto-wired by Spring before any condition checks are performed.

Condition elements can take optional parameters. These parameters will be passed in to the condition's init() method as a map of string key/value pairs after autowiring, but before any condition checks are performed. For example:

1
2
<condition class="com.atlassian.bamboo.ww2.actions.admin.GlobalAdminMenuCondition">
    <param name="permission">admin</param>
</condition>

To invert a condition, add the attribute 'invert="true"' to the condition element. This is useful where you want to show the section if a certain condition is not satisfied. Conditions elements are composed of a collection of condition/conditions elements and a type attribute. The type attribute defines what logical operator is used to evaluate its collection of condition elements. The type can be one of AND or OR.

For example: The following condition is true if the current user is a restricted administrator OR a system administrator:

1
2
<conditions type="OR">
    <condition class="com.atlassian.bamboo.ww2.actions.admin.GlobalAdminMenuCondition"/>
    <condition class="com.atlassian.bamboo.ww2.actions.admin.RestrictedAdminMenuCondition"/>
</conditions>

Example

Single web item in the admin section

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

1
2
<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
<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>