Attribute Element
X-Ref:
- Ast Attribute Node
- Ast Dimension Named Base Node
Attributes
| Attribute | API Type | Default | Description |
|---|---|---|---|
| Name | String | Specifies the name of the object. This name can be used to reference this object from anywhere else in the program. This is a required property | |
| AttributeHierarchyDisplayFolder | String | This value specifies the folder in which the Attribute Hierarchy associate with this Attribute is listed. The default setting is None. The display folder is used by the OLAP client, such as Microsoft Excel, to visualize the measure in context of the larger measure/dimension hierarchy. Display folders enable better organization of measures to ease the navigation of large cubes for end-user analysts. | |
| AttributeHierarchyEnabled | Boolean | true | This value indicates whether SQL Server Analysis Services will generate an attribute hierarchy. Attribute hierarchies are required for the attribute to participate in a user-defined hierarchy or to be referenced by Multidimensional Expressions (MDX) queries. |
| AttributeHierarchyOptimizedState | SsasOptimizedState | FullyOptimized | This value indicates whether SQL Server Analysis Services is to index the attribute hierarchy to enhance query performance. The default setting is FullyOptimized. If the attribute hierarchy will not be queried, select the NotOptimized setting to prevent the generation of indexes for the attribute hierarchy, which can consume additional memory and cube processing time. |
| AttributeHierarchyOrdered | Boolean | true | This value indicates whether the attribute hierarchy generated from this attribute is ordered. Ordering large attribute hierarchies can consume significant cube processing time. If the attribute hierarchy will not be used in user-visible query results, or if order does not matter, then ordering can be disabled. The default value is True. |
| AttributeHierarchyVisible | Boolean | true | Client applications such as Microsoft Excel can present only attribute hierarchies that have been configured with AttributeHierarchyVisible set to True. The default setting is True. If the attribute hierarchy will not be queried and does not need to be visible to analysts in the pivot table interface, then the setting should be changed to False in order to improve processing time. |
| AttributeType | SsasAttributeType | Regular | This value specifies the type of the attribute, which can be selected from a large built-in list of types supplied by Microsoft SQL Server Analysis Services (SSAS). The type is used by the client application in cases where specific attribute types require or permit special handling. Examples of attribute types include those related to time, geography, customers, and accounts. |
| Usage | SsasAttributeUsage | Regular | This value specifies the role of the attribute relative to its parent dimension. The default setting is Regular. |
| EstimatedCount | Int32 | 0 | This value indicates the estimated number of items in the attribute. The default setting is zero. This value is used to assist in aggregation design choices and other internal operations. While EstimatedCount can be set manually to reflect estimated member counts, BimlStudio also provides an automatic Member Count Estimator in the Cube ribbon. |
| GroupingBehavior | SsasGroupingBehavior | EncourageGrouping | This value provides user-defined attribute grouping information to OLAP client applications such as Excel. |
| IsAggregatable | Boolean | true | This value indicates whether values of attribute members can be aggregated. Specifically, it indicates whether attribute hierarchy contains an (All) level. The default setting is True. |
| MemberNameUnique | Boolean | false | This value indicates whether the attribute hierarchy is guaranteed to provide unique member names. |
| OrderBy | SsasOrderBy | Key | This value specifies the method of ordering of members of an attribute, including Key, Name, AttributeKey, and AttributeName. |
| OrderByAttributeName | AstAttributeNode | This value defines the ordering of the members contained in the attribute hierarchy. If the OrderBy property is set to AttributeKey or AttributeName, then this value defines which attribute to use for the key or name ordering. If the OrderBy property is set to Key or Name, this value has no effect. This references an existing definiton. |
Singleton Children
| Child | API Type | Description |
|---|---|---|
| <CustomRollupColumn /> | AstAttributeCustomRollupColumnNode | The AstAttributeCustomRollupColumnNode type corresponds directly to an attribute custom rollup column in a SQL Server Analysis Services dimension attribute. |
| <CustomRollupSnowflakeColumn /> | AstAttributeSnowflakeCustomRollupColumnNode | The AstAttributeSnowflakeCustomRollupColumnNode type corresponds directly to a snowflaked attribute custom rollup column in a SQL Server Analysis Services dimension attribute. |
| <CustomRollupPropertiesColumn /> | AstAttributeCustomRollupPropertiesColumnNode | The AstAttributeCustomRollupPropertiesColumnNode type corresponds directly to an attribute custom rollup properties column in a SQL Server Analysis Services dimension attribute. |
| <CustomRollupPropertiesSnowflakeColumn /> | AstAttributeSnowflakeCustomRollupPropertiesColumnNode | The AstAttributeSnowflakeCustomRollupPropertiesColumnNode type corresponds directly to a snowflaked attribute custom rollup properties column in a SQL Server Analysis Services dimension attribute. |
| <DefaultMember /> | String | String is the .NET Framework String class. More information can be found at http://msdn.microsoft.com/en-us/library/system.string.aspx. |
| <DiscretizationBucketCount /> | Int32 | Int32 is the .NET Framework Int32 structure. More information can be found at http://msdn.microsoft.com/en-us/library/system.int32.aspx. |
| <DiscretizationMethod /> | SsasAttributeDiscretizationMethod | The SsasAttributeDiscretizationMethod enumeration provides options for how attribute members are grouped. |
| <InstanceSelection /> | SsasAttributeInstanceSelection | The SsasAttributeInstanceSelection enumeration provides a collection of hints to the client application regarding how the attribute members should be displayed to the user for selection. |
| <MembersWithData /> | SsasAttributeMembersWithData | The SsasAttributeMembersWithData enumeration provides options for how member values that are associated with non-leaf nodes are displayed when a parent-child hierarchy is specified. |
| <MembersWithDataCaption /> | String | String is the .NET Framework String class. More information can be found at http://msdn.microsoft.com/en-us/library/system.string.aspx. |
| <NameColumn /> | AstAttributeNameColumnNode | The AstAttributeNameColumnNode type corresponds directly to an attribute name column in a SQL Server Analysis Services dimension attribute. |
| <SnowflakeNameColumn /> | AstAttributeSnowflakeNameColumnNode | The AstAttributeSnowflakeNameColumnNode type corresponds directly to a snowflaked attribute name column in a SQL Server Analysis Services dimension attribute. |
| <NamingTemplate /> | String | String is the .NET Framework String class. More information can be found at http://msdn.microsoft.com/en-us/library/system.string.aspx. |
| <RootMemberIf /> | SsasAttributeRootMemberIf | The SsasAttributeRootMemberIf enumeration provides options for how root attribute members are determined. |
| <UnaryOperatorColumn /> | AstAttributeUnaryOperatorColumnNode | The AstAttributeUnaryOperatorColumnNode type corresponds directly to an attribute unary operator column in a SQL Server Analysis Services dimension attribute. |
| <UnaryOperatorSnowflakeColumn /> | AstAttributeSnowflakeUnaryOperatorColumnNode | The AstAttributeSnowflakeUnaryOperatorColumnNode type corresponds directly to a snowflaked attribute unary operator column in a SQL Server Analysis Services dimension attribute. |
| <ValueColumn /> | AstAttributeValueColumnNode | The AstAttributeValueColumnNode type corresponds directly to an attribute value column in a SQL Server Analysis Services dimension attribute. |
| <SnowflakeValueColumn /> | AstAttributeSnowflakeValueColumnNode | The AstAttributeSnowflakeValueColumnNode type corresponds directly to a snowflaked attribute value column in a SQL Server Analysis Services dimension attribute. |
Collection Children
| Child | API Type | Description |
|---|---|---|
| <KeyColumns> Multiple Choices... </KeyColumns> | AstAttributeKeyColumnBaseNode | This value specifies the names of the physical columns from the underlying SQL Server table that define the key and granularity for the attribute. The value specified in this column for each member is the value that users see unless another value is specified for the NameColumn property. This is a required property |
| <Annotations> <Annotation /> </Annotations> | AstAnnotationNode | This is a collection of annotation items that can be used to specify documentation, tags, or other information. Annotations are particularly useful for storing information about nodes that can be used by BimlScript code. |
| <Translations> <Translation /> </Translations> | AstAttributeTranslationNode | This value contains alternate language versions of measure groups, measures, cube dimension, perspectives, KPIs, actions, named sets, and calculated members associated with a dimension. These are used by client applications such as Microsoft Excel to show values for dimension metadata that are consistent with the language of the end-user. |