2.1.20 TKpi

In CSDLBI 1.1, CSDLBI 2.0, and CSDLBI 2.5, the TKpi complex type defines a calculation that can be used as a key performance indicator (KPI). In a business intelligence data model, a KPI is based on a measure. The definition of the KPI contains all the metadata that is associated with measures and information that is needed for the presentation of the KPI values.

The TKpi complex type does not specify the formula that is contained in the measure definition. Instead, it specifies the additional metadata that is associated with measures that are used as KPIs. After a measure is designated as a KPI, it SHOULD be exposed only as a KPI.

The TKpi complex type lists attributes that SHOULD be included only with a TMeasure complex type (section 2.1.19).

The TKpi complex type is defined in the schema as follows.

  <xs:complexType name ="TKpi">
   <xs:sequence >
    <xs:element name="Documentation" type="bi:TDocumentation" minOccurs="0"
        maxOccurs="1" />
    <xs:element name="KpiGoal" minOccurs="1" maxOccurs="1" >
     <xs:complexType >
      <xs:sequence>
       <xs:element name="PropertyRef" type="bi:TPropertyRef" minOccurs="1"
           maxOccurs="1" />
      </xs:sequence>
     </xs:complexType>
    </xs:element>
    <xs:element name="KpiStatus" minOccurs="1" maxOccurs="1" >
     <xs:complexType >
      <xs:sequence>
       <xs:element name="PropertyRef" type="bi:TPropertyRef" minOccurs="1"
           maxOccurs="1" />
      </xs:sequence>
     </xs:complexType>
    </xs:element>
   </xs:sequence>
   <xs:attribute name="StatusGraphic" type="xs:string" use="required"/>
  </xs:complexType>

The elements and attribute that are defined by the TKpi complex type are specified in the following tables.

Element

Description

Documentation

An element that contains information about the KPI. The contents of this element are defined by the TDocumentation complex type (section 2.1.12).

KpiGoal

An element that contains the reference to the column that contains the KPI goal value. This element MUST contain exactly one PropertyRef element (see section 2.1.17). The contents of this element are defined by the TPropertyRef complex type (section 2.1.18).

KpiStatus

An element that contains the reference to a column that contains the value as the status indicator in a KPI. This element MUST contain exactly one PropertyRef element (see section 2.1.17). The contents of this element are defined by the TPropertyRef complex type (section 2.1.18).

Attribute

Description

StatusGraphic

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

Show: