2.2.4.2.2.9.4 Kpi

  • Article

The Kpi complex type represents a KPI.

   <xsd:complexType name="Kpi">
     <xsd:all>
       <xsd:element name="Name" type="xsd:string"/>
       <xsd:element name="ID" type="xsd:string" minOccurs="0"/>
       <xsd:element name="Description" type="xsd:string" minOccurs="0"/>
       <xsd:element name="Translations"  minOccurs="0">
         <xsd:complexType>
           <xsd:sequence>
             <xsd:element name="Translation"  type="Translation" minOccurs="0"
                          maxOccurs="unbounded"/>
           </xsd:sequence>
         </xsd:complexType>
       </xsd:element>
       <xsd:element name="DisplayFolder" type="xsd:string" minOccurs="0"/>
       <xsd:element name="AssociatedMeasureGroupID" type="xsd:string" minOccurs="0"/>
       <xsd:element name="Value" type="xsd:string"/>
       <xsd:element name="Goal" type="xsd:string" minOccurs="0"/>
       <xsd:element name="Status" type="xsd:string" minOccurs="0"/>
       <xsd:element name="Trend" type="xsd:string" minOccurs="0"/>
       <xsd:element name="Weight" type="xsd:string" minOccurs="0"/>
       <xsd:element name="TrendGraphic" type="xsd:string" minOccurs="0"/>
       <xsd:element name="StatusGraphic" type="xsd:string" minOccurs="0"/>
       <xsd:element name="CurrentTimeMember" type="xsd:string" minOccurs="0"/>
       <xsd:element name="ParentKpiID" type="xsd:string" minOccurs="0"/>
       <xsd:element name="Annotations"  minOccurs="0">
         <xsd:complexType>
           <xsd:sequence>
             <xsd:element name="Annotation" type="Annotation" minOccurs="0"
                          maxOccurs="unbounded"/>
           </xsd:sequence>
         </xsd:complexType>
       </xsd:element>
     </xsd:all>
   </xsd:complexType>
           

Element

Read-Only

Default value

Description

Name

[Required]

The object name.

ID

Defaults to Name.

The ID string for the object.

Description

Empty

The object description.

Translations

Empty

A collection of Translation objects.

DisplayFolder

Empty

The folder in which to display the object.

AssociatedMeasureGroupID

Empty

The MeasureGroup that the object refers to.

Value

[Required]

The value for this KPI. An MDX expression that evaluates to a number.

Goal

Empty

The goal for this KPI. An MDX expression that evaluates to a number.

Status

Empty

The status for this KPI. An MDX expression that evaluates to a number.

Trend

Empty

The trend for this KPI. An MDX expression that evaluates to a number.

Weight

Empty

The weight for this KPI. An MDX numeric expression that assigns a relative importance to a KPI.

TrendGraphic

Empty

The recommended graphic to represent the trend of this KPI.<81>

StatusGraphic

Empty

The recommended graphic to represent the status of this KPI.<82>

CurrentTimeMember

Empty

The CurrentTimeMember that applies to this KPI. An MDX expression that returns the member that identifies the temporal context of the KPI.

ParentKpiID

Empty

The ID for a parent KPI (if any) for this KPI.

Annotations

Empty

A collection of Annotation objects.