Range Calculations

Range calculations can be used to derive the value of a timephased attribute over a defined period. A range calculation is used in a MathML calculation as the value for the name attribute in the RHSVariable element. A range calculation syntax has six components:

• Range Calculation A prefix for that range calculation which identifies the entry in the name attribute to be a range calculation.
• Calculation The calculation type to be used: SUM, AVG, MIN, MAX, NPV, LIST, or LISTCOUNT.
• Attribute.Dimension A timephased attribute, a calculated timephased attribute, or a group name. Using a group name will cause a macro-substitution of all the attributes in the group. The dimension to which the timephased attribute, calculated timephase attribute, or group name belongs must be specified.
• Units The unit of measurement: FTE, CURRENCY, HOURS, or UNITS.
• Timescale The period in which the range calculation will be used: CALENDAR_MONTH, CALENDAR_QUARTER, CALENDAR_YEAR, FISCAL_QUARTER, or FISCAL_YEAR.
• Range 1, +n or ,-n.Dimension The period with which the range calculation begins: TODAY, START, MONTH_START, QUARTER_START, YEAR_START, FISCAL_QUARTER_START, FISCAL_YEAR_START, or a milestone. You may use ,+n to create a range index which increments the starting range by n; you may use ,-n to create a range index which decrements the starting range by n. If the range is a milestone, then the dimension must also be specified. Milestones and actual dates (such as the actual date of the start of the fiscal year) are inclusive.
• Range 2, +n or ,-n.Dimension The period with which the range calculation ends: TODAY, END, MONTH_END, QUARTER_END, YEAR_END, FISCAL_QUARTER_END, FISCAL_YEAR_END, or a milestone. You may use ,+n to create a range index which increments the ending range by n; you may use ,-n to create a range index which decrements the ending range by n. If the range is a milestone, then the dimension must also be specified. Milestones and actual dates (such as the actual date that February ends in a given year) are inclusive.

The syntax is the six components of the range calculation presented (in order), each component contained within a percent symbol (%):

%RangeCalculation%Calculation%Attribute.Dimension
     %Units%Timescale%Range1%Range2%

For example, to find the sum of all timephased attributes in the Labor-Currency group that is part of the Plan dimension with a range from a milestone that is part of the Plan dimension through 12/1/2008, the range calculation would be:

%RangeCalculation%SUM%Labor-Currency.Plan%CURRENCY
     %CALENDAR_MONTH%StartMS.Plan%12/1/2008%

To find the monthly average cost for all timephased attributes in the Server group that is part of the Plan dimension from today through the end of the fiscal year, the range calculation would be:

%RangeCalculation%AVG%Server.Plan%CURRENCY
     %CALENDAR_MONTH%TODAY%FISCAL_YEAR_END%

To find the sum of all increased revenue in the Plan dimension for an entire calendar year and the Plan dimension is defined to begin on 1/1/2007 and end on 1/1/2008, the range calculation would be:

%RangeCalculation%SUM%IncreasedRevenue.Plan%CURRENCY
     %CALENDAR_YEAR%Start.Plan%Finish.Plan%

To use a range index to find the sum of all increased revenue in the Plan dimension for three calendar years (back from the current calendar year) and the Plan dimension is defined to begin on 1/1/2007 and end on 1/1/2008, the range calculation would be:

%RangeCalculation%SUM%IncreasedRevenue.Plan%CURRENCY
     %YEAR_START%Start.Plan,-2%Finish.Plan%

To use a range index to find the sum of all increased revenue in the Plan dimension for the two previous calendar years (back from the current calendar year) and the Plan dimension is defined to begin on 1/1/2007 and end on 1/1/2008, the range calculation would be:

%RangeCalculation%SUM%IncreasedRevenue.Plan%CURRENCY
     %YEAR_START%Start.Plan,-2%Finish.Plan,-1%