Project Milestones

Milestones and goals for your project can be configured in the Wizard Bundle. A milestone has a name, a date, and allows you to set a goal for one or more metric in your project. You can configure your wizard to allow users to create milestones and define goals from scratch, or you can define your company milestones and objectives to ensure that they are part of every project created with this wizard.

In order to add support for milestones to your model, configure your wizard to allow users to create milestones and goals:

<Bundle xmlns:xi="http://www.w3.org/2001/XInclude">
  <wizard wizardId="DOC" versionPattern="v#N1#" img="../../Shared/Images/icons/faded.png">
    <tools all="FALSE">
      <tool name="project_data" optional="FALSE" checkedInUI="TRUE" />
      <tool name="Squore" optional="TRUE" checkedInUI="TRUE">
      	<param name="scnode" value="TRUE" />
      	<param name="scnode_name" value="Code" />
      </tool>
    </tools>
    <milestones canCreateMilestone="TRUE" canCreateGoal="TRUE">
      <goals displayableFamilies="GOALS" />
    </milestones>
  </wizard>
</Bundle>

The milestones element allows users to create milestones in the project wizard (canCreateMilestone="TRUE") and also set goals (canCreateGoal="TRUE"). The goals can be set for metrics of the GOALS family only in this example (displayableFamilies="GOALS").

The result in the web UI is the following:

A project wizard allowing users to create milestones freely during an analysis

When creating a new project, a user decides to create a Specification Freeze milestone with one objective of 100 for the Requirement Status indicator. Other goals can be set, for the other metrics in the project that belong to the GOALS family: Risk Index, Task Progress, Test Result.

If you have company-wide milestones and objectives that need to be set for every project created with the wizard, you can specify the goals directly. Milestones can also be marked as mandatory or optional:

<Bundle xmlns:xi="http://www.w3.org/2001/XInclude">
  <wizard wizardId="DOC_WITH_MILESTONES" versionPattern="v#N1#" img="../../Shared/Images/icons/faded.png">
    <tools all="FALSE">
      <tool name="project_data" optional="FALSE" checkedInUI="TRUE" />
      <tool name="Squore" optional="TRUE" checkedInUI="TRUE">
      	<param name="scnode" value="TRUE" />
      	<param name="scnode_name" value="Code" />
      </tool>
    </tools>
	<milestones canCreateMilestone="TRUE" canCreateGoal="TRUE">
	   <goals displayableFamilies="GOALS">
		  <goal measureId="RESULT" mandatory="TRUE" highestIsBest="FALSE" />
		  <goal measureId="STATUS" mandatory="TRUE" highestIsBest="TRUE" />
		  <goal measureId="PROGRESS" mandatory="TRUE" highestIsBest="TRUE" />
		  <goal measureId="RISK_INDEX" mandatory="TRUE" highestIsBest="FALSE" />
	   </goals>
	   <milestone id="REQUIREMENT_FREEZE" mandatory="TRUE">
	   		<defaultGoal measureId="RESULT" value="0" />
	   		<defaultGoal measureId="STATUS" value="1" />
	   		<defaultGoal measureId="PROGRESS" value="30" />
	   		<defaultGoal measureId="RISK_INDEX" value="1" />
	   </milestone>
	   <milestone id="INFRASTRUCTURE_FREEZE" mandatory="TRUE">
	   		<defaultGoal measureId="RESULT" value="0" />
	   		<defaultGoal measureId="STATUS" value="1" />
	   		<defaultGoal measureId="PROGRESS" value="50" />
	   		<defaultGoal measureId="RISK_INDEX" value="1" />
	   </milestone>
	   <milestone id="CODE_FREEZE" mandatory="TRUE">
	   		<defaultGoal measureId="RESULT" value="0" />
	   		<defaultGoal measureId="STATUS" value="1" />
	   		<defaultGoal measureId="PROGRESS" value="90" />
	   		<defaultGoal measureId="RISK_INDEX" value="0.5" />
	   </milestone>
	   <milestone id="BETA_RELEASE" mandatory="FALSE">
	   		<defaultGoal measureId="RESULT" value="1" />
	   		<defaultGoal measureId="STATUS" value="1" />
	   		<defaultGoal measureId="PROGRESS" value="95" />
	   		<defaultGoal measureId="RISK_INDEX" value="0.3" />
	   </milestone>
	   <milestone id="RELEASE" mandatory="TRUE">
	   		<defaultGoal measureId="RESULT" value="1" />
	   		<defaultGoal measureId="STATUS" value="1" />
	   		<defaultGoal measureId="PROGRESS" value="100" />
	   		<defaultGoal measureId="RISK_INDEX" value="0" />
	   </milestone>
	</milestones>
  </wizard>
</Bundle>

When creating a new project, the predefined goals are filled in in the web interface, and you can still add a Beta Release milestone (using the default values specified in the wizard bundle) if needed by using the + icon:

A project wizard with preconfigured milestones and goals

The milestones element accepts the following attributes:

canCreateMilestone (optional, default: TRUE) defines if a button is available in the web UI to add new milestones
canCreateGoal (optional, default: TRUE) defines if a button is available in the web UI to add new goals for milestones
hide (optional, default: FALSE) allows hiding the milestones pane of the wizard in the web interface

The goals element acceps the following attribute:

displayableFamilies (optional, default: no filter) allows filtering the list of metrics listed in the web interface when adding a goal. The value of the parameter is a family name, and when specified, only metrics of this family will be available as goals from the web interface.

The goal element allows preconfiguring your goals in the project and accepts the following attributes:

measureId (mandatory) is the ID of the metric to use as a goal
highestIsBest (optional, default: TRUE) specifies whether a higher value for the metric is better or not.
Warning
If this parameter was specified in the metric directly, then default value is the one set at metric-level instead of TRUE.

The milestone element accepts the following attributes:

id (mandatory) is the unique identifier of the milestone in the model
defaultDate (optional, default: none) is the date used for the milestone by default.
mandatory (optional, default: false) defines whether users can remove a milestone from the web interface.

The defaultGoal element accepts the following attributes:

measureId (mandatory) is the unique identifier of the metric to use as goal
value (mandatory) is the default value for the goal.

Tip

For a complete example of how to use milestones in a Squore project, consult Appendix D, Milestones Tutorial.

Prev	Up	Next
Source Code Configuration	Home \| ToC	Chapter 9. Configuring Reports and Exports

Project Milestones

Warning

Tip