AMO OLAP classes

Applies to: SQL Server Analysis Services Azure Analysis Services Fabric/Power BI Premium

Analysis Management Objects (AMO) OLAP classes help you create, modify, delete, and process cubes, dimensions, and related objects such as Key Performance Indicators (KPIs), actions, and proactive caching.

For more information about setting up the AMO programming environment, how to establish a connection with a server, accessing a database or defining data sources and data source views, see AMO fundamental classes.

The following illustration shows the relationship of the classes that are explained in this topic.

Basic classes

Dimension objects

A dimension is created by adding it to the dimensions collection of the parent database, and by updating the Dimension object to the server by using the Update method.

To remove a dimension, it has to be dropped by using the Drop method of the Dimension. Removing a Dimension from the dimensions collection of the database by using the Remove method does not delete it on the server, just in the AMO object model.

A Dimension object can be processed after it has been created. The Dimension can be processed using its own process method, or it can be processed with the parent object's process method when the parent object is processed.

For more information about methods and properties available, see Dimension in the Microsoft.AnalysisServices.

Cube objects

A cube is created by adding it to the cubes collection of the database, then updating the Cube object to the server by using the Update method. The Update method of the cube can include the parameter UpdateOptions.ExpandFull, which ensures that all objects in the cube that were modified will be updated to the server in this update action.
To remove a cube, it has to be dropped by using the Drop method of the Cube. Removing a cube from the collection does not affect the server.

A Cube object can be processed after it has been created. The Cube can be processed using its own process method, or it can be processed when a parent object processes itself with its own Process method.

For more information about methods and properties available, see Cube in the Microsoft.AnalysisServices.

MeasureGroup objects

A measure group is created by adding it to the measure group collection of the cube, then updating the MeasureGroup object to the server by using its own Update method. A MeasureGroup object is removed using its own Drop method.

A MeasureGroup object can be processed after it has been created. The MeasureGroup can be processed by using its own Process method, or it can be processed when a parent object processes itself with its own Process method.

For more information about methods and properties available, see MeasureGroup in the Microsoft.AnalysisServices.

Partition objects

A Partition object is created by adding it to the partitions collection of the parent measure group, then updating the Partition object on the server by using the Update method. A Partition object is removed by using the Drop method.

For more information about methods and properties available, see Partition in the Microsoft.AnalysisServices.

AggregationDesign objects

Aggregation designs are constructed using the AggregationDesign method from an AggregationDesign object.

For more information about methods and properties available, see AggregationDesign in the Microsoft.AnalysisServices.

Aggregation objects

An Aggregation object is created by adding it to the aggregation designs collection of the parent measure group, then updating the parent measure group object on the server by using the Update method. An aggregation is removed from the AggregationCollection by using the Remove method or the RemoveAt method.

For more information about methods and properties available, see Aggregation in the Microsoft.AnalysisServices.

Advanced classes

Advanced classes provide OLAP functionality beyond building and browsing a cube. The following are some of the advanced classes and the benefits they provide:

• Action classes are used to create an active response when browsing certain areas of the cube.

• Key Performance Indicators (KPIs) enable comparison analysis between values of data.

• Perspectives provide selected views of a single cube, so that users can focus on what is important to them.

• Translations allow the cube to be customized to the user locale.

• Proactive caching classes can provide a balance between the enhanced performance of MOLAP storage and the immediacy of ROLAP storage, and provide scheduled partition processing.

AMO is used to set the definitions for this enhanced behavior, but the actual experience is defined by the browsing client that implements all of these enhancements.

Action objects

An Action object is created by adding it to the actions collection of the cube, then updating the Cube object to the server by using the Update method. The update method of the cube can include the parameter UpdateOptions.ExpandFull, which ensures that all objects in the cube that were modified will be updated to the server with this update action.

To remove an Action object, it must be removed from the collection and the parent cube must be updated.

A cube must be updated and processed before the action can be used from the client.

For more information about methods and properties available, see Action in Microsoft.AnalysisServices.

Kpi objects

A Kpi object is created by adding it to the KPI collection of the cube, then updating the Cube object to the server by using the Update method. The Update method of the cube can include the parameter UpdateOptions.ExpandFull, which ensures that all objects in the cube that were modified will be updated to the server with this update action.

To remove a Kpi object, it must be removed from the collection, then and the parent cube must be updated.

A cube must be updated and processed before the KPI can be used.

For more information about methods and properties available, see Kpi in the Microsoft.AnalysisServices.

Perspective objects

A Perspective object is created by adding it to the perspective collection of the cube, then updating the Cube object to the server by using the Update method. The Update method of the cube can include the parameter UpdateOptions.ExpandFull, which ensures that all objects in the cube that were modified will be updated to the server with this update action.

To remove a Perspective object, it must be removed from the collection, then the parent cube must be updated.

A cube has to be updated and processed before the perspective can be used.

For more information about methods and properties available, see Perspective in the Microsoft.AnalysisServices.

Translation objects

A Translation object is created by adding it to the translation collection of the desired object, then updating the closest major parent object to the server by using the Update method. The Update method of the closest parent object can include the parameter UpdateOptions.ExpandFull, which ensures that all children objects that were modified will be updated to the server with this update action.

To remove a Translation object, it must be removed from the collection, then the closest parent object must be updated.

For more information about methods and properties available, see Translation in the Microsoft.AnalysisServices.

ProactiveCaching objects

A ProactiveCaching object is created by adding it to the proactive caching object collection of the dimension or partition, then updating the dimension or partition object to the server by using the Update method.

To remove a ProactiveCaching object, it must be removed from the collection, then the parent object must be updated.
A dimension or partition must be updated and processed before proactive caching is enabled and ready to be used.

For more information about methods and properties available, see ProactiveCaching in the Microsoft.AnalysisServices.