Plan macros

Warning:

The information in this section is now considered deprecated. It is still provided here for those who have legacy Plan reports implemented as Classic Wiki pages. New Plan reports should be created as LiveReport type Pages using the set of Plan-related Widgets. For more information see: Creating Plan Reports.

This topic lists the macros you can use in Classic Wiki pages (including the underling wiki page of Plans) to report information about Plans. Syntax details and usage examples for these macros can be found in the Plans section of the embedded Wiki Syntax Help.

Work Items Board - {workitems-board}

The {workitems-board} macro renders an easy to understand summary of the Work Items in any Plan. The Work Items Board can be configured with columns summarizing the Plan's Work Items in different states, such as To Do, In Progress, Verified, and Done. Note that only following Work Items are shown on the Work Item board:

See Work Items Board to add a drag and drop board to LiveReports, Info Pages and Plans.

  • Parent items: Work Items added to the Plan specified in the plan parameter.

  • Child items: Work Items with a link to those added to the specified Plan, and where such added Work Items have the parent link role to them (by default, if no roles parameter is specified)

  • Work Items with status defined in the columns parameter of the macro .

Burn Up and Burn Down - {plan-burnup} {plan-burndown}

The {plan-burndown} macro renders a Scrum-style "burn-down" chart of a Plan's Work Items. The {plan-burnup} macro, renders a "burn-up" chart of the Work Items.

In order for the Burn-down or Burn-up charts to show correct data, it is necessary to:

  • Specify the Plan's Start Date and Due Date in the Plan properties.

  • Add Work Items to the Plan (see: Planning Work Items)

  • Be sure all Work Items in the Plan are estimated (i.e. the Initial Estimate field should be filled in for every Work Item).

  • Start the Plan on the same date specified in the Plan's Start Date property. That is, the value in the Started On property should match that in the Start Date property.

    After the Plan is started, avoid changing Start Date or Started On date to keep progress reporting accurate. You may, however, add Work Items to a Plan after it has started, and the total work and ideal progress statistics will be updated accordingly. However, adding Work Items after Plan start is not a recommended best practice.

Plan open in table - {plan-open-in-table}

The {plan-open-in-table} macro renders the Open in Table button in the Plan page, which, when clicked by a user, opens a new browser tab and loads the Work Items Table filtered to show the Work Items currently in the Plan (by means of the Planned In visual query element.)

Plans - {plans}

The {plans} macro displays open Plans that are child Plans of the one specified in the macro's plan parameter, and also Plans set by the query defined in the macro.

Plan status button - {plan-status-button}

The {plan-status-button} can be used in Plans only. It will not work in Wiki pages. It renders a button that shows current status of the Plan and enables the user to set a different status. If status is set to "Done", the Plans Finished On property is set to the current date/time.

Plan label - {plan-label}

The {plan-label} macro shows the name and hierarchical structure of the Plan specified in the plan parameter of the macro. Users can click on the displayed parent or child Plans to jump directly to those Plans. The macro also provides an action for creating a new child Plan of the specified Plan.

Plan progress - {plan-progress}

The {plan-progress} macro displays the progress bar of the Plan specified in the plan parameter of the macro.

The macro starts showing the Done value only after the Plan is started. Otherwise, it shows only the ideal progress metric.