• PRODUCTS
  • SUPPORT
  • DOCS
  • PARTNERS
  • COMPANY
  • QUOTE
  • ACCOUNT
  • STORE
QUOTE

Documentation

Support Forums
What can we help you with?
Topics

Kpi Element

API Type:
Varigence.Languages.Biml.Cube.AstKpiNode
X-Ref:
  • Ast Kpi Node

Attributes

AttributeAPI TypeDefaultDescription
NameString 
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
AssociatedMeasureGroupNameAstCubeMeasureGroupNode 
This value specifies a direct reference to the measure group that with which this KPI will be associated. This references an existing definiton.
CurrentTimeMemberString 
This value specifies a Multi-Dimensional Expression (MDX) statement that evaluates to the current time member for the KPI.
DescriptionString 
This value specifies a description of the KPI.
DisplayFolderString 
This value specifies the folder in which the parent element 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.
ParentKpiNameAstKpiNode 
This value optionally specifies a direct reference to the parent KPI with which this KPI will be associated. This references an existing definiton.
StatusGraphicKpiStatusGraphicGauge
This value specifies the image collection that should be used by the client application to display the current KPI status.
TrendGraphicKpiTrendGraphicStandardArrow
This value specifies the image collection that should be used by the client application to display the current KPI trend.
WeightString 
This value specifies a Multi-Dimensional Expression (MDX) statement that evaluates to the weight value associated with this KPI.

Singleton Children

ChildAPI TypeDescription
<Goal />StringString is the .NET Framework String class. More information can be found at http://msdn.microsoft.com/en-us/library/system.string.aspx.
<Status />StringString is the .NET Framework String class. More information can be found at http://msdn.microsoft.com/en-us/library/system.string.aspx.
<Trend />StringString is the .NET Framework String class. More information can be found at http://msdn.microsoft.com/en-us/library/system.string.aspx.
<Value />StringString is the .NET Framework String class. More information can be found at http://msdn.microsoft.com/en-us/library/system.string.aspx.

Collection Children

ChildAPI TypeDescription
<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>
AstTranslationNode
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.

© Varigence