Skip to: Site menu | Main content

XPlanner

Planning and tracking tool for agile teams following XP or Scrum

XPlanner extensions Print

Confluence plugin

A plugin to Confluence that allows Confluence users to display (but not update) XPlanner info inline. XPlanner data can be filtered by project and iteration.

Download the plugin here: http://www.crazedweasels.com/oss/

Install it according to Confluence's documentation. (For the older version of Confluence I used, this involved dropping the macros-xplanner.jar file into a lib directory, and telling Confluence to use it through the Confluence control panel. As I recall, restarting was only required if I re-deployed; that is, if the .jar had changed but the control panel configuration had not.)

Using the plugin

On the page you want the XPlanner info to appear, use the following:

{xplanner:url=http://your.xplanner.url/xplanner/soap/XPlanner|username=user|password=password|project=1|iteration=15}

Parameters

key value Notes
url your XPlanner installation's SOAP url required
username a username for XPlanner, who has permission to view the data you want to display required
password this user's password required
project the id of the particular project you want to display info for optional. leaving it out will display all projects
iteration the id of the iteration you want to display info for optional; ignored if no project param is set. leaving it out will display all iterations for the project. If the iteration id doesn't belong to the project indicated, no iterations will display

Good things to know

  • The plugin was developed and tested against XPlanner version 0.6.2 and and Confluence version 1.3.1 Build:#113. It may not work with newer versions of either.
  • The progress bar, such a nice feature of XPlanner, doesn't work in the plugin - it's always green.
  • The plugin hits the XPlanner server every Confluence page view; there is no cache. This makes the Confluence page slow, especially if the XPlanner installation is slow.
  • If the iteration id doesn't exist (if it was deleted, say) the macro fails badly with {null}