Date Ranges and Periods in KPI Scorecards
The ranges
structure in a kpiscorecard
defines the date ranges or periods to use in KPI data calculations. The useperiods
Boolean element of the kpiscorecard
determines whether periods should be used instead of date ranges.
Each date range or period in the ranges
structure is represented by the range
structure. The following is an example of a ranges
structure that uses date ranges instead of periods:
...
<useperiods>F</useperiods>
...
<ranges>
<range>
<range>THIS_FISCAL_HALF</range>
<comparewithprevious>F</comparewithprevious>
<invertcomparison>T</invertcomparison>
</range>
<range>
<range>LAST_YEAR</range>
<comparevalueto>THIS_FISCAL_YEAR</comparevalueto>
<comparewithprevious>F</comparewithprevious>
<comparisontype>SUM</comparisontype>
<invertcomparison>F</invertcomparison>
</range>
</ranges>
...
Use the range
and comparevalueto
elements to reference the specific ranges that you want to compare. For more information about valid ranges, see:
Set the comparewithprevious
Boolean element to T when you want to compare the result of the range comparison with the range
comparison above it.
Set the comparisontype
element to any of the following values to define the type of relationship or operation to perform:
-
RATIO_ABSOLUTE: KPI2 / KPI1
-
RATIO_PERCENT: 100 * (KPI2 / KPI1)
-
SUM: KPI1 + KPI2
-
VARIANCE_ABSOLUTE: KPI2 - KPI1
-
VARIANCE_PERCENT: 100 * (KPI2 - KPI1) / KPI1
Set the invertcomparison
Boolean element to T to invert the operation used to calculate the comparison type.
Set the label
value to the text that should appear as a row or column header in the KPI scorecard portlet.
For more information about range
elements, see range.