Child pages
  • Bamboo Custom Dashboard Plugin
Skip to end of metadata
Go to start of metadata

Description/Features

A intrusive BAMBOO plugin to have a better presentation in the dashboard.
Why is it usefull ?
Because I have 150 plans and the All Plans tab is very heavy and long to load in my browser.
Because I have split my project into functionnalities and and it is difficult to have a simple view for a specific version. (Except if you use confluence ...)

Usage

  1. Copy the bamboo-custom-dashboard-plugin-1.0.jar file into your <BAMBOO_HOME>/webapp/WEB-INF/lib directory and restart Bamboo
  2. Add the properties configuration file dashboardTabItems.properties in <BAMBOO_HOME>/webapp/WEB-INF/classes
    • a sample file is here
    • Edit it to add your tabs
      • the key tabNumber is used to iterate on all tabs descriptions
      • A tab is composed of
        • name: the tab name shown in the dashboard
        • PLANKEYS: the list of plans separated by space shown in this tab. The * wildcard can be used at the end of a plan key to add all plans starting with the specified plan key. In the following example, all plans in the project PROJECTB.
        • groups: the list of groups separated by comma (because a group name can contains space character) who can see this tab.
        • users: the list of user separated by space who can see this tab.
          example :
          tab.0.name = 7.2
          tab.0.PLANKEYS= POM-HEAD PROJECTA-HEAD PROJECTB-*
          tab.0.groups = devProjectB
          tab.0.users = admin 
          
  3. Modify the file <BAMBOO_HOME>/webapp/start.ftl :
    • Add the following section of code between the tab3 and the tab4 declaration (in 2.2.x at line 37).
                      //Begin Dashboard plugin intrusive code
                      [#assign dashboardTabList = webwork.bean("fr.calitech.bamboo.plugins.dashboard.DashboardTabList") ]
                      [#assign tabItems = dashboardTabList.tabItems ]
                      [#list tabItems as tabItem]
                          var tabItem${tabItem.number} = jtabs.addTab("${tabItem.id}", "${tabItem.name}", null );
                          tabItem${tabItem.number}.setUrl('${req.contextPath}${tabItem.url}', '${tabItem.param}', true);
                      [/#list]
                      //End   Dashboard plugin intrusive code
      
  4. You can refresh the configuration with this URL :
    • http://Your Bamboo URL/admin/refreshDashboardTab.action

Version Compatibility

Compatibility of Custom Dashboard Plugin versions (side) versus Bamboo versions (top).

 

before 2.0

2.0-2.2.x

1.0

(error)

(tick)

Unknown macro: {roundrect}

= compatible
= not compatible
= compatibility unknown

Version History

Version

Date

Description

1.0

June 18th 2009

initial version

Screenshots

  • No labels

2 Comments

  1. Lilians,

    Very nice.  We also have a great number of build plans and our developers were quite frustrated over the number of irrelevant pans that they had to navigate over to see the full picture of a Branch.  We also have used the model of Projects containing many Branches of a given Component rather that a Project having only one Branch of many Components. This raised a rousing cheer.

    Rich

  2. This plugin will be really great for us due to the amount of plans and users we have.  One question, is there anyway to setup a tab so that all users can view it by default, without having to define in the config file?

    Thanks,

    Bryce