Kpi Class

Article
03/24/2014

Key performance indicators (KPIs) are metadata wrappers around measures and MDX expressions.

Inheritance Hierarchy

Object
Microsoft.AnalysisServices.AdomdServer.Kpi

Namespace: Microsoft.AnalysisServices.AdomdServer
Assembly: msmgdsrv (in msmgdsrv.dll)

Syntax

'Declaration
Public NotInheritable Class Kpi _
    Implements IDisposable, IMetadataObject
'Usage
Dim instance As Kpi

public sealed class Kpi : IDisposable, IMetadataObject

public ref class Kpi sealed : IDisposable, 
    IMetadataObject

[<SealedAttribute>]
type Kpi =  
    class 
        interface IDisposable 
        interface IMetadataObject 
    end

public final class Kpi implements IDisposable, IMetadataObject

The Kpi type exposes the following members.

Properties

	Name	Description
	Caption	Gets the caption associated with the Kpi.
	Description	Gets a human-readable description of the Kpi.
	DisplayFolder	Gets a forward-slash-delimited categorization structure, used by client applications to determine the hierarchical presentation of the Kpi.
	Name	Gets the name of the Kpi.
	ParentCube	Gets the CubeDef representing the cube to which the Key performance indicator (KPI) belongs.
	ParentKpi	Gets the parent Kpi of the current Kpi.
	Properties	Gets a collection containing the properties of the Kpi.
	StatusGraphic	Gets a String representing a graphic for displaying Kpi status.
	TrendGraphic	Gets a String representing a graphic for displaying Kpi trend information.
	UniqueName	Gets the unique name for the Kpi.

Top

Methods

	Name	Description
	{dtor}	Releases all resources used by the Kpi.
	Dispose	Releases all resources used by the Kpi.
	Equals	(Inherited from Object.)
	GetHashCode	(Inherited from Object.)
	GetType	(Inherited from Object.)
	ToString	(Inherited from Object.)

Top

Remarks

KPIs provide a framework for categorizing these expressions into a set of pre-defined data roles (actual, goal, trend, status, and others), which allows UI developers additional metadata for creating new interfaces.

Thread Safety

Any public static (Shared in Visual Basic) members of this type are thread safe. Any instance members are not guaranteed to be thread safe.

Share via