Biml API Reference
AstCubeNode Type
BimlStudio 2017

Cube objects correspond directly to SQL Server Analysis Services (SSAS) cubes, which offer a multidimensional data storage and query mechanism.
Inheritance Hierarchy
Assembly:
Biml (in Biml.dll)
Language Element:
Properties
  Name Summary
Actions
This defines a collection of actions that are associated with the cube. Actions are stored Multidimensional Expressions (MDX) statements that are associated with the cube. Client applications such as Microsoft Excel display actions to the end user and execute them against the cube when requested. Actions can include custom report generation, redirection to URLs, drillthrough to row details for a given cell, and other operations.
AggregationPrefix
This value provides a common prefix for aggregation names used throughout the associated cube.
AggregationPrefixDefaultValue
Gets the default value for the AggregationPrefix property
AllMeasureGroups
Gets an AstCubeMeasureGroupNode corresponding to the "All Measure Groups" item
Annotations
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.
(Inherited from AstNode)
BimlFile
This value specifies the BimlFile in which the Biml code that defines AstNode resides.
(Inherited from AstNode)
CanAutoLayoutMoveSinkAnchors
Gets a value to indicate whether autolayout is permitted to rearrange sink anchors on the design surface to reduce edge overlapping
CanAutoLayoutMoveSourceAnchors
Gets a value to indicate whether autolayout is permitted to rearrange source anchors on the design surface to reduce edge overlapping
Collation
This value specifies how data is sorted and compared.
CollationDefaultValue
Gets the default value for the Collation property
Connection
This value specifies the connection to use when deploying a cube.
CubeDimensions
This collection is used to define instances of dimensions that are used in the cube. Each dimension might be referenced by multiple cube dimensions in cases where a single dimension might be used in multiple ways. For example, a date dimension might be used to indicate purchase date, ship date, and received date for a sales-tracking cube.
CubeMeasureGroups
This collection is used to define instances of fact tables that are used in the cube as measure groups. Each fact table might be referenced by multiple cube measure groups in cases where a single fact table might be used in multiple ways. For example, a fact table that tracks customer activity might be used both in a sales and an account measure group for a sales-tracking cube.
CubeState
This value displays the current cube state with respect to processing.
CubeStateDefaultValue
Gets the default value for the CubeState property
DatabaseName
Defines the name to use for the generated SSAS database.
DatabaseNameDefaultValue
Gets the default value for the DatabaseName property
DefaultMeasure
This value contains a reference to the measure that should be used by the client application for the cube when a measure or measure group has not been specified in the query.
Error
Gets the error string for this node, if any
(Inherited from AstNode)
ErrorConfiguration
This value specifies the error configuration properties associated with the cube. Error configuration includes error logging; null, duplicate, and unknown key handling; error actions; and other settings.
ErrorCount
Gets the count of error diagnostics that have been generated for this node
(Inherited from AstNode)
EstimatedRows
This value indicates the estimated number of items in the cube. 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.
EstimatedRowsDefaultValue
Gets the default value for the EstimatedRows property
FlowFile
This value specifies the containing code file of this node for Xml Binding purposes.
(Inherited from AstNode)
ForceDisableIncrementalChangeTracking
This value specifies whether changes to property values of this node should be automatically reflected in the corresponding Biml code. Its primary use is for temporary nodes that will never be persisted into BimlFiles.
(Inherited from AstNode)
FriendlyTypeName
Gets the friendly name of the type of this node
(Inherited from AstNode)
FriendlyTypeName
Gets the friendly name of the type of this node
(Inherited from AstNamedNode)
FriendlyTypeName
Gets the friendly name of the type of this node
(Inherited from AstScopeBoundaryNode)
FriendlyTypeName
Gets the friendly name of the type of this node
(Inherited from AstSecurableNode)
FriendlyTypeName
Gets the friendly name of the type of this node
FriendlyTypeNameStatic
Gets the friendly name of the type of this node
(Inherited from AstNode)
FriendlyTypeNameStatic
Gets the friendly name of the type of this node
(Inherited from AstNamedNode)
FriendlyTypeNameStatic
Gets the friendly name of the type of this node
(Inherited from AstScopeBoundaryNode)
FriendlyTypeNameStatic
Gets the friendly name of the type of this node
(Inherited from AstSecurableNode)
FriendlyTypeNameStatic
Gets the friendly name of the type of this node
ImportedScopeChildren
Gets this ScopeBoundary's referenceable items. This is used to notify the children items when this item's ScopedName changes.
(Inherited from AstScopeBoundaryNode)
IsAstNodeReadOnly
Gets a value indicating whether this node is currently in a read-only state
(Inherited from AstNode)
IsInBrokenLiveBimlScript
Specifies whether or not this object is part of a live BimlScript containing an error, which means that this is a cached object that may be out-of-date
(Inherited from AstNode)
IsInBrokenLiveBimlScript
Specifies whether or not this object is part of a live BimlScript containing an error, which means that this is a cached object that may be out-of-date
ItemLabel
Gets a label that can be used to identify this node
(Inherited from AstNode)
Kpis
This defines a collection of key performance indicator (KPI) calculations that are associated with the cube. KPIs are used to track goals, trends, and current status for values that are considered critical to the overall performance of the business. They are normally an important feature of dashboard-style reports.
Language
This value specifies the language that is associated with the cube by default.
LanguageDefaultValue
Gets the default value for the Language property
LogicalDisplayFolder
Specifies a path that should be used for organizing the tree display of this object in the Logical View in BimlStudio.
LogicalDisplayFolderDefaultValue
Gets the default value for the LogicalDisplayFolder property
MdxScripts
This defines the collection of Multidimensional Expressions (MDX) scripts that are associated with the cube. MDX scripts can contain calculated members, named sets, and standalone script objects.
Measures
Gets the AstCubeDimensionNode corresponding to the "Measures" item
MessageCount
Gets the count of message diagnostics that have been generated for this node
(Inherited from AstNode)
Name
Specifies the name of the object. This name can be used to reference this object from anywhere else in the program.
(Inherited from AstNamedNode)
NameDefaultValue
Gets the default value for the Name property
(Inherited from AstNamedNode)
ObjectTag
This property provides a general purpose storage mechanism for .NET objects to be associated with AstNode objects. It supplements the annotation system, which is intended for use with string-based metadata.
(Inherited from AstNode)
OutputCubeLabel
Specifies the name that should be used for this cube when it is emitted into the SSAS cube file. This name will be used both for the cube and the name of the cube file. If no OutputCubeLabel is specified, the Name property of this cube will be used in its place. Note that an OutputCubeLabel setting in a cube project referencing this cube can override the Name and OutputCubeLabel specified here. This property is provided to offer more fine-grained control over cube naming in automation scenarios, especially in multi-tenant environments. This can be important, since cube names are end-user visible.
OutputCubeLabelDefaultValue
Gets the default value for the OutputCubeLabel property
ParentItem
This value specifies the parent of the current node. All nodes must have a valid parent in the Biml framework, except for the root node.
(Inherited from AstNode)
ParentXObjectMappingProvider
This value specifies the parent of the current node for Xml Binding purposes.
(Inherited from AstNode)
Perspectives
This is a collection of simplified subsets of cube features. Perspectives enable users to generate specialized, more focused views of the data. Cube filtering is limited to a simple included/excluded choice for each independent cube asset. Note that perspectives are available only for deployments that target SQL Server Enterprise Edition.
ProactiveCaching
This value defines how proactive caching is performed for the cube. Proactive caching enables a cube to use a MOLAP-style multidimensional store for data but to update that store automatically to stay up-to-date with changes to the underlying relational store. This provides a compromise between MOLAP and ROLAP cube storage models.
ProcessingMode
This value specifies when indexing and aggregating should be performed. The options are Regular, which means that indexing and aggregations occur during processing, or Lazy, which means that indexing aggregation occur after after processing is completed.
ProcessingModeDefaultValue
Gets the default value for the ProcessingMode property
ProcessingPriority
This value specifies the priority of background processing operations relative to query handling, other non-background functions, and other functions that have a priority specified. Lower integer values indicate lower priority. The default value is 0.
ProcessingPriorityDefaultValue
Gets the default value for the ProcessingPriority property
PropertyChangeNotificationTarget
Gets a reference to the ViewModel object for this node. This property should only be used by the internal Biml framework.
(Inherited from AstNode)
ReferenceCount
Gets or sets the total number of other node properties that hold a reference to this node.
(Inherited from AstNamedNode)
References
Gets collection of FrameworkItemReference objects, which track rich information about the properties that hold references to this node.
(Inherited from AstNamedNode)
RefId
Returns the SSIS refid that is used to reference this item from within an SSIS package or dataflow.
(Inherited from AstNamedNode)
ScopeBoundary
Gets the scope boundary for this node
(Inherited from AstNode)
ScopeBoundary
Gets the ScopeBoundary for this referenceable item
(Inherited from AstNamedNode)
ScopedName
Gets the scoped name which can be used to uniquely identify this object among other objects of its type
(Inherited from AstNamedNode)
ScopedNamePrefix
Gets the prefix to use for ScopedName calculations
(Inherited from AstNamedNode)
ScriptCacheProcessingMode
This value specifies when the script cache is built. The options are Regular, which means that the cache is built during processing, or Lazy, which means that the script cache is built after processing is completed.
ScriptCacheProcessingModeDefaultValue
Gets the default value for the ScriptCacheProcessingMode property
ScriptErrorHandlingMode
This value specifies how script errors are handled. The options are IgnoreNone, which means that the server generates an error whenever any MDX script error is encountered, and IgnoreAll, which means that the server ignores all MDX script errors.
ScriptErrorHandlingModeDefaultValue
Gets the default value for the ScriptErrorHandlingMode property
SsisSafeName
Returns a version of the Name that has been cleaned of invalid characters for SSIS.
(Inherited from AstNamedNode)
SsisSafeScopedName
Returns a version of the ScopedName that has been cleaned of invalid characters for SSIS.
(Inherited from AstNamedNode)
StorageLocation
This value specifies the full path where the cube’s files are located. If this value is not specified, then the storage location comes from the cube’s database information.
StorageLocationDefaultValue
Gets the default value for the StorageLocation property
StorageMode
This value specifies which storage mode the cube will use.
StorageModeDefaultValue
Gets the default value for the StorageMode property
SymbolTable
Gets a reference to the symbol table that stores a reference to this and all other named objects in the project
(Inherited from AstNamedNode)
SymbolTableProvider
Gets the symbol table provider for this node
(Inherited from AstNode)
Translations
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.
TreeDepth
Gets the distance between this node and the root item
(Inherited from AstNode)
UserDefinedItems
Gets the child items of this node that were defined in user code
(Inherited from AstNode)
Visible
The value specifies whether the cube is visible to end users. If it is not visible, the cube still exists on the server and can respond to queries, but it is not visible to end-users for browsing through the client application.
VisibleDefaultValue
Gets the default value for the Visible property
WarningCount
Gets the count of warning diagnostics that have been generated for this node
(Inherited from AstNode)
XmlMapping
Gets the XML binding information that is used to track the Biml code that corresponds to this node
(Inherited from AstNode)
Methods
  Name Summary
Events
  Name Summary
ItemLabelChanged
The ItemLabelChanged event occurs when the name of this node or any scope boundary ancestor (as determined by following ParentItem to the AstRootNode) name changes.
NameChanged
The NameChanged event occurs when the Name property of the current node has changed to a new value and that value has been committed.
NameChanging
The NameChanging event occurs when the Name property of the current node is receiving a new value but that value has not yet been committed.
ScopeBoundaryChanged
The ScopeBoundaryChanged event occurs when any ancestor (as determined by following ParentItem to the AstRootNode) changes in such a way as the ScopeBoundary for this node changes. This will force the ScopedName of this node to change if it is an AstNamedNode.
ScopedNameChanged
The ScopedNameChanged event occurs when the name of this node or any scope boundary ancestor (as determined by following ParentItem to the AstRootNode) name changes.
Extension Methods
  Name Summary
AddAnnotation(AnnotationType,String)
Adds an annotation to an AstNode
[Extension Method: Import namespace Varigence.Biml.Extensions]
AddAnnotation(AnnotationType,String,String)
Adds an annotation to an AstNode
[Extension Method: Import namespace Varigence.Biml.Extensions]
EnumerateAncestors
Returns the ancestors of the current node
[Extension Method: Import namespace Varigence.Biml.Extensions]
GetBiml()
Retrieve the Biml that represents the AstNode
[Extension Method: Import namespace Varigence.Biml.Extensions]
GetTag(String)
Gets the first annotation with a matching tag and returns the value. If the tag is not found, returns an empty string.
[Extension Method: Import namespace Varigence.Biml.Extensions]
GetTag(String,Boolean)
Gets the first annotation with a matching tag and returns the value. If the tag is not found, returns an empty string.
[Extension Method: Import namespace Varigence.Biml.Extensions]
GetTag(String,Boolean,Boolean)
Gets the first annotation with a matching tag and returns the value. If the tag is not found, returns an empty string.
[Extension Method: Import namespace Varigence.Biml.Extensions]
.NET API Metadata
Assembly:
Biml
Friendly Name:
Cube
Abstract:
False
Referenceable:
True
Root Item:
False
Scope Boundary:
False
Symbol Table Provider:
False
Xml Schema Name:
Varigence.Languages.Biml.Cube.AstCubeNode
Xsd Namespace:
http://schemas.varigence.com/biml.xsd
Referenceable:
True
Scope Boundary:
False