2.1.22 TProperty
The TProperty complex type annotates the Property element that is defined in [MC-CSDL] section 2.1.3. The TProperty complex type is an extension of the TBaseProperty complex type (section 2.1.18) that adds attributes that appear only in instance columns.
The TProperty complex type is defined in the schema as follows.
-
<xs:complexType name="TProperty"> <xs:complexContent> <xs:extension base="bi:TBaseProperty"> <xs:sequence> <xs:element name="DefaultValue" type="xs:anyType" minOccurs="0" maxOccurs="1" /> <xs:element name="Cultures" type="bi:TCultures" minOccurs="0" maxOccurs="1" /> <xs:element name="GroupBy" type="bi:TPropertyRefs" minOccurs="0" maxOccurs="1" /> <xs:element name="FilterNullsBy" type="bi:TPropertyRefs" minOccurs="0" maxOccurs="1" /> <xs:element name="OrderBy" type="bi:TPropertyRefs" minOccurs="0" maxOccurs="1" /> <xs:element name="RelatedTo" type="bi:TPropertyRefs" minOccurs="0" maxOccurs="1" /> <xs:element name="Statistics" type="bi:TPropertyStatistics" minOccurs="0" maxOccurs="1" /> </xs:sequence> <xs:attribute name="Private" type="xs:boolean" default="false" use="optional" /> <xs:attribute name="Contents" type="bi:TContents" use="optional" default="Regular" /> <xs:attribute name="DefaultAggregateFunction" type="bi:TDefaultAggregateFunction" default="Default" /> <xs:attribute name="GroupingBehavior" type="bi:TGroupingBehavior" default="GroupOnValue" /> <xs:attribute name="Stability" type="bi:TStability" default="Stable" /> <xs:attribute name="AggregateBehavior" type="xs:boolean" default="true" use="optional" /> <xs:attribute name="LocaleImpact" type="xs:boolean" default="false" use="optional" /> <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 TProperty complex type are specified in the following tables.
|
Element |
Description |
|---|---|
|
DefaultValue |
In CSDLBI 2.0 and CSDLBI 2.5, a property that specifies the value that is to be used when evaluating the query. The DefaultValue property is optional, but it is automatically selected if the values from the member cannot be aggregated. |
|
Cultures<65> |
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). |
|
GroupBy |
In CSDLBI 2.0 and CSDLBI 2.5, a reference to other properties within the entity that MUST be used as group-by columns when the Data Analysis Expressions (DAX) query contains the current property. Otherwise, the query will fail. |
|
FilterNullsBy |
In CSDLBI 2.0 and CSDLBI 2.5, a reference to other properties within the entity that are to be used in DAX queries to properly construct a filter by NULL values. |
|
OrderBy |
A reference to a property within the entity that defines the sort order for that property's values. The values for the current property and the OrderBy property are mapped 1-to-1. Otherwise, the sort behavior is undefined. If this element is omitted, the properties are sorted based on their values. |
|
RelatedTo |
In CSDLBI 2.0 and CSDLBI 2.5, a reference to other properties within the entity that are related to the current property. This information can be used to construct DAX queries that will give the same results as equivalent multidimensional expression (MDX) queries that take attribute relationships into account. |
|
Statistics |
In CSDLBI 2.0 and CSDLBI 2.5, a set of statistics from the underlying data that is associated with the column. These statistics are defined by the TPropertyStatistics complex type and are provided only if they are not computationally expensive to generate, as described in section 2.1.17. |
|
Attribute |
Description |
|---|---|
|
Private<66> |
Indicates whether the property is private. If the value of this attribute is "true", the property is private. |
|
Contents |
Specifies the type of data in a column. This value is drawn from the DimensionAttribute complex type, as defined in [MS-SSAS] section 2.2.4.2.2.8.1. The contents of this attribute are defined by the TContents simple type (section 2.1.16.1). |
|
DefaultAggregateFunction |
Indicates the default aggregate function, if any, that is typically used to summarize properties. The contents of this attribute are defined by the TDefaultAggregateFunction simple type (section 2.1.16.2). |
|
GroupingBehavior |
Specifies how query results are grouped. The attribute's contents are defined by the TGroupingBehavior simple type (section 2.1.16.3). |
|
Stability |
Specifies the stability of a declared property between refresh operations. This attribute is set on columns that contain a row number or other volatile value (such as NOW()). This attribute is emitted only for an unstable value. The contents of this attribute are defined by the TStability simple type (section 2.1.16.4). |
|
AggregateBehavior |
Indicates whether to avoid aggregations over this property. If the value of this attribute is "false", aggregations of other properties over this property is to be avoided. |
|
LocaleImpact |
Indicates whether this property is automatically affected by the locale. |
|
LineageTag<67> |
Returns a tag that represents the lineage of the property. |
|
IsError<68> |
Indicates that the property has an error in its expression. |