2.1.27 TMeasure

The TMeasure complex type is an extension of the TBaseProperty type (section 2.1.18), adding components that appear only in measures.

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

   <xs:complexType name="TMeasure">
     <xs:complexContent>
       <xs:extension base="bi:TBaseProperty">
         <xs:sequence>
           <xs:element name="Cultures" type="bi:TCultures" minOccurs="0"
            maxOccurs="1" />
           <xs:element name="Kpi" type="bi:TKpi" minOccurs="0" maxOccurs="1" />
           <xs:element name="FormatBy" type="bi:TPropertyRefs" minOccurs="0"
            maxOccurs="1" />
           <xs:element name="ApplyCulture" type="bi:TPropertyRefs" minOccurs="0"
            maxOccurs="1" />
           <xs:element name="ContainsDetailRows" type="xs:boolean" minOccurs="0"
            maxOccurs="1" />
           <xs:element name="DistributiveBy" type="TDistributiveBy" minOccurs="0"
            maxOccurs="1" />
         </xs:sequence>
         <xs:attribute name="Private" type="xs:boolean" default="false" use="optional" />     
         <xs:attribute name="IsSimpleMeasure" type="xs:boolean" default="true" />
         <xs:attribute name="ActualType" type="xs:string" />
         <xs:attribute name="Contents" type="xs:string" />
         <xs:attribute name="LineageTag" type="xs:string" use="optional" />
         <xs:attribute name="IsError" type="xs:boolean" default="false" />
       </xs:extension>
     </xs:complexContent>
   </xs:complexType>

The elements and attributes that are defined by the TMeasure complex type are specified in the following tables.

Element

Description

Cultures<69>

In CSDLBI 2.0 and CSDLBI 2.5, when the PRINT_ALL_TRANSLATIONS flag is set, the Cultures element is added for translations. The contents of this element are defined by the TCultures complex type (section 2.1.8).

Kpi

In CSDLBI 1.1, CSDLBI 2.0, and CSDLBI 2.5, a key performance indicator (KPI). The contents of this element are defined by the TKpi complex type (section 2.1.22).

FormatBy

In CSDLBI 2.0 and CSDLBI 2.5, a reference to a measure within the entity that contains a format string for the current measure. It can be used to apply proper formatting to the values of the current measure.

ApplyCulture

In CSDLBI 2.0 and CSDLBI 2.5, a reference to a measure within the entity that contains a culture for each value of the current measure. It can be used to apply proper transformation on the values of current measure in order to display them properly.

ContainsDetailRows<70>

In CSDLBI 2.0 and CSDLBI 2.5, a Boolean value that indicates whether the measure contains a user-defined DetailRows expression, as specified in [MS-SSAS-T] section 2.2.5.28. A value of "true" means that a DetailRows expression is defined either on this measure or on the table that owns this measure and that the DetailRows expression does not refer to any restricted objects in the model.

DistributiveBy<71>

Indicates the entity over which the parent measure is additive.

The contents of this element are defined by the TDistributiveBy complex type (section 2.1.28).

Attribute

Description

Private<72>

Indicates whether the measure is private. If the value of this attribute is "true", this measure is private.

IsSimpleMeasure

A Boolean value that indicates whether the formula that is used in the measure is one of the simple aggregations (Sum, Count, Min, Max, Avg, DistinctCount). The value "true" means that one of the simple aggregations is used. The actual value is derived from the IsSimpleMeasure element in the model, as specified in [MS-SSAS] section 2.2.4.2.2.10.2.

ActualType

In CSDLBI 2.0 and CSDLBI 2.5, a string value that, if present, contains "Any" as the only possible value, which indicates that the actual measure type could change for each value. If so, the Type attribute of the Property element (see [MC-CSDL] section 2.1.3) is only a suggestion of what default data type is to be used when the client attempts to visualize values.

Contents<73>

The type of data in the measure.

LineageTag<74>

Returns a tag that represents the lineage of the measure.

IsError<75>

Indicates that the measure has an error in its expression.