Create Plan reports

You can create report Pages in your project to deliver up-to-date information about Plans to the team and stakeholders. Plans in projects based on one of the default project templates always include a preconfigured report Page for the Plan. You can customize this default report Page, and/or create additional report Pages for any Plan.

The Pages feature includes several Widgets for retrieving and rendering information about a Plan, and providing Plan-specific user actions. You can find them on the Plans tab of the Widgets sidebar in the Page Editor.

  • Plan Label: Renders a label of a specific Plan, showing its due date and type via a colored icon. For each Plan, all its parents are shown to the highest level, as well as direct children. Finished Plans are shown in strike-through font. It is also possible to create new child Plans via the + button.

  • Work Items Board: Renders a Work Items Board (sometimes called Scrum Board) for a specific Plan. It shows all the planned Work Items and their children in individual stages of development (grouped if the statuses are similar). By default it shows all child items that are linked with any role with a parent-child-role attribute. Users can select for which statuses the items are displayed compacted, to minimize the space used.

  • Plan Progress: Renders a progress bar that visually shows how much work from the specified Plan is already done, how much remains, and what should be the ideal progress today to finish the entire Plan on time.

  • Plan Burn-Down: Renders a burn-down chart for a specific Plan, with customizable time scale and labels.

  • Plan Burn-Up: Renders a burn-up chart for a specific Plan, with customizable time scale and labels.

  • Plan Activity Stream: Renders an Activity Stream showing activity limited to the Work Items planned in a specific Plan.

  • Plan Status Button: Renders a graphical button set that enables a user to set the status of a specific Plan (Open, In-progress, Done). For a terminal status, the Finished On date of the Plan is shown.

  • Open Plan in Table: Renders a graphical button that enables a user to open a specific Plan in the Table view of Work Items. The table is limited to the Work Items currently planned in the specified Plan.

Note:

You can optionally create Plan-related reports using Classic Wiki pages. Syntax details and usage examples for Plan-related macros are provided in the Plans section of the embedded Wiki Syntax Help, accessible from the Wiki Mark-up Editor when editing Classic Wiki pages. Advanced users can consult the API documentation (Javadoc) for details on how to display various Plan statistics on Plan pages or in charts.

Alternatively, if you have an existing Plan or Plan Template with the Plan report implemented as a Classic Wiki page, the action Switch to LiveReport Page appears in the Actions menu on the Plan (or Plan Template) page. The source of the existing Classic Wiki page is appended as the last region in the new LiveReport Page. You can refer to it when customizing the new report Page, and delete the region when finished building the new Page. For more information, see Build Reports.