Share via

KPI Element (CSDL)

  • Article

The Kpi element defines a calculation that can be used as a Key performance Indicator (KPI). In a Business Intelligence data model, KPIs are based on measures, and as such the definition of the KPI contains all the metadata associated with measures, as well as information needed for presentation of the KPI values, including a default graphic.

The Kpi element does not specify the formula, which is contained in the measure definition, but rather specifies the additional metadata that is associated with measures that are used as KPIs. Once you have designated a measure as a KPI, you cannot use it as a measure in other contexts.

A KPI element can have the following child elements (in the order listed):

  • Documentation element

  • KpiGoal element

  • KpiStatus element

Applicable Attributes

The table below describes the attributes that can be found on the Kpi element.

Attribute Name

Is Required

Value

Name

Yes

The name of the KPI.

KPIStatusGraphic

Yes

A reference to an image that indicates negative, neutral, or positive progress against the targets defined in the KPI.

Remarks

When you design a model, you can create a KPI by creating a measure and then assigning the measure to use as a KPI. You then add information that is specific to KPIs, such as a graphic to use in showing trends.

Example

The following sample shows a KPI that measures sales, from the AdventureWorks tabular model sample.

<bi:Measure Caption="Total Current Quarter Margin Performance" ReferenceName="Total Current Quarter Margin Performance" Width="0" IsSimpleMeasure="false">
  <bi:Kpi StatusGraphic="Three Symbols UnCircled Colored">
    <bi:KpiGoal>
      <bi:PropertyRef Name="Measures___Total_Current_Quarter_Margin_Performance_Goal_" />
    </bi:KpiGoal>
    <bi:KpiStatus>
      <bi:PropertyRef Name="Measures___Total_Current_Quarter_Margin_Performance_Status_" />
    </bi:KpiStatus>
  </bi:Kpi>
</bi:Measure>

Optional comments.