Share via

2.2.4.129 KpiMeasure

  • Article

Namespace: http://www.microsoft.com/performancepoint/scorecards

The KpiMeasure complex type is contained in a KPI.

 <xs:complexType name="KpiMeasure" xmlns:xs="http://www.w3.org/2001/XMLSchema">
   <xs:complexContent mixed="false">
     <xs:extension base="tns:SecondClassElement">
       <xs:sequence>
         <xs:element minOccurs="0" maxOccurs="1" name="OwnerKpiLocation" type="tns:RepositoryLocation"/>
         <xs:element minOccurs="0" maxOccurs="1" name="DataSourceLocation" type="tns:RepositoryLocation"/>
         <xs:element minOccurs="0" maxOccurs="1" name="DefaultDimensionSettings" type="tns:ArrayOfDefaultDimensionSetting"/>
         <xs:element minOccurs="0" maxOccurs="1" name="OverrideFormatProperties" type="tns:KpiNumberFormatProperties"/>
         <xs:element minOccurs="0" maxOccurs="1" name="CalcFormulaInfo" type="tns:CalculatedFormulaInfo"/>
       </xs:sequence>
       <xs:attribute name="AggregateBy" type="tns:AggregateTypeEnum" use="required"/>
       <xs:attribute name="DisableScorecardFilters" type="xs:boolean" use="required"/>
       <xs:attribute name="ModelCurrent" type="xs:decimal" use="required"/>
       <xs:attribute name="Pattern" type="tns:KpiPattern" use="required"/>
       <xs:attribute name="CurrentFormula" type="xs:string"/>
       <xs:attribute name="IsCustomCurrentFormula" type="xs:boolean" use="required"/>
       <xs:attribute name="OdbcQuery" type="xs:string"/>
       <xs:attribute name="OverrideHoverText" type="xs:string"/>
       <xs:attribute name="TimeFilterFormula" type="xs:string"/>
       <xs:attribute name="ValueSource" type="tns:ValueSources" use="required"/>
     </xs:extension>
   </xs:complexContent>
 </xs:complexType>

OwnerKpiLocation: The location of the parent Kpi complex type (section 2.2.4.128), as specified by the RepositoryLocation complex type (see section 2.2.4.161). Upon successful Kpi creation, the server (2) MUST set this value to a RepositoryLocation, whose ItemUrl field matches the location of the parent Kpi.

DataSourceLocation: The location of the DataSource complex type (section 2.2.4.85), as specified by RepositoryLocation. For CalcFormulaInfo to apply to the measure query, DataSourceLocation.ItemUrl MUST be empty.

DefaultDimensionSettings: An array of DefaultDimensionSetting complex types (section 2.2.4.87) which represent the dimension slices to apply to the measure query.

OverrideFormatProperties: This allows for custom formatting of measure values, as specified by KpiNumberFormatProperties (section 2.2.4.130).

CalcFormulaInfo: A calculated formula to apply to the measure query, as specified by CalculatedFormulaInfo (section 2.2.4.74). For this formula to apply, DataSourceLocation.ItemUrl MUST be empty.

AggregateBy: The aggregation method to apply to the measure query, as specified by AggregateTypeEnum (section 2.2.5.1).

DisableScorecardFilters: A value of TRUE indicates that scorecard filters are disabled for the measure query; a value of FALSE indicates that scorecard filters are enabled for the measure query.

ModelCurrent: The fixed value of the KpiMeasure.

  • DataSourceLocation.ItemUrl MUST equal "/%%fixedvalues%%" for ModelCurrent to be used.

Pattern: The pattern this KpiMeasure follows, as specified by the KpiPattern simple type (section 2.2.5.32). Banding and scoring behave differently with different patterns.

CurrentFormula: The MDX formula or tuple used to retrieve the current value.

  • If IsCustomCurrentFormula is set to TRUE, the value MUST have one or more non-whitespace characters.

  • If IsCustomCurrentFormula is set to FALSE, the value is ignored.

  • MUST be a valid MDX formula or tuple if DataSource.SourceName (see section 2.2.4.85) equals "ADOMD.NET".

  • The length MUST NOT exceed 4,000 characters.

IsCustomCurrentFormula: A value of TRUE indicates that CurrentFormula is used to compute the current value; a value of FALSE indicates that CurrentFormula is ignored.

  • DataSource.SourceName MUST equal "ADOMD.NET" for IsCustomCurrentFormula to be used.

OdbcQuery: This attribute is deprecated from the protocol and MUST NOT be used.

OverrideHoverText: A descriptive string meant for the user. The length MUST NOT exceed 256 characters.

TimeFilterFormula: The time intelligence formula to apply to the measure query. The length MUST NOT exceed 4,000 characters.

ValueSource: The rollup method to apply to the source data, as specified by the ValueSources simple type (section 2.2.5.51).