This is documentation for Caché & Ensemble. See the InterSystems IRIS version of this content.

For information on migrating to InterSystems IRIS, see Why Migrate to InterSystems IRIS?

%BI.KPI

persistent class %BI.KPI extends %Library.Persistent, %XML.Adaptor

SQL Table Name: %BI.KPI

Property Inventory (Including Private)

Method Inventory (Including Private)

Properties

property DataMart as %String (TRUNCATE = 1);
Property methods: DataMartDisplayToLogical(), DataMartGet(), DataMartGetStored(), DataMartIsValid(), DataMartLogicalToDisplay(), DataMartLogicalToOdbc(), DataMartNameCompute(), DataMartNameDisplayToLogical(), DataMartNameGet(), DataMartNameIsValid(), DataMartNameLogicalToDisplay(), DataMartNameLogicalToOdbc(), DataMartNameNormalize(), DataMartNameSQLCompute(), DataMartNormalize(), DataMartSet()
property DataMartName as %String (TRUNCATE = 1) [ Calculated ];
Property methods: DataMartNameCompute(), DataMartNameDisplayToLogical(), DataMartNameGet(), DataMartNameIsValid(), DataMartNameLogicalToDisplay(), DataMartNameLogicalToOdbc(), DataMartNameNormalize(), DataMartNameSQLCompute()
property Folder as %String (TRUNCATE = 1);
Property methods: FolderDisplayToLogical(), FolderExists(), FolderGet(), FolderGetStored(), FolderIsValid(), FolderLogicalToDisplay(), FolderLogicalToOdbc(), FolderNameDisplayToLogical(), FolderNameGet(), FolderNameIsValid(), FolderNameLogicalToDisplay(), FolderNameLogicalToOdbc(), FolderNameNormalize(), FolderNormalize(), FolderSet()
property FolderName as %String (TRUNCATE = 1) [ Calculated ];
Property methods: FolderNameDisplayToLogical(), FolderNameGet(), FolderNameIsValid(), FolderNameLogicalToDisplay(), FolderNameLogicalToOdbc(), FolderNameNormalize()
property Formula as %String (MAXLEN = 20000, TRUNCATE = 1);
Property methods: FormulaDisplayToLogical(), FormulaGet(), FormulaGetStored(), FormulaIsValid(), FormulaLogicalToDisplay(), FormulaLogicalToOdbc(), FormulaNormalize(), FormulaSet()
property IsActive as %Boolean;
Property methods: IsActiveDisplayToLogical(), IsActiveGet(), IsActiveGetStored(), IsActiveIsValid(), IsActiveLogicalToDisplay(), IsActiveLogicalToXSD(), IsActiveNormalize(), IsActiveSet(), IsActiveXSDToLogical()
property KPIChild as array of %BI.KPIList;
Property methods: KPIChildBuildValueArray(), KPIChildCollectionToDisplay(), KPIChildCollectionToOdbc(), KPIChildDisplayToCollection(), KPIChildGet(), KPIChildGetObject(), KPIChildGetObjectId(), KPIChildGetStored(), KPIChildGetSwizzled(), KPIChildIsValid(), KPIChildOdbcToCollection(), KPIChildSet(), KPIChildSetObject(), KPIChildSetObjectId()
property KPIMaximum as %String;
Property methods: KPIMaximumDisplayToLogical(), KPIMaximumGet(), KPIMaximumGetStored(), KPIMaximumIsValid(), KPIMaximumLogicalToDisplay(), KPIMaximumLogicalToOdbc(), KPIMaximumNormalize(), KPIMaximumSet()
property KPIMinimum as %String;
Property methods: KPIMinimumDisplayToLogical(), KPIMinimumGet(), KPIMinimumGetStored(), KPIMinimumIsValid(), KPIMinimumLogicalToDisplay(), KPIMinimumLogicalToOdbc(), KPIMinimumNormalize(), KPIMinimumSet()
property KPIName as %String (MAXLEN = 2000, TRUNCATE = 1);
Property methods: KPINameDisplayToLogical(), KPINameGet(), KPINameGetStored(), KPINameIdxCheck(), KPINameIdxCheckUnique(), KPINameIdxDelete(), KPINameIdxExists(), KPINameIdxOpen(), KPINameIdxSQLCheckUnique(), KPINameIdxSQLExists(), KPINameIdxSQLFindPKeyByConstraint(), KPINameIdxSQLFindRowIDByConstraint(), KPINameIsValid(), KPINameLogicalToDisplay(), KPINameLogicalToOdbc(), KPINameNormalize(), KPINameSet()
property KPIQuery as %String (MAXLEN = 20000, TRUNCATE = 1);
Property methods: KPIQueryDisplayToLogical(), KPIQueryGet(), KPIQueryGetStored(), KPIQueryIsValid(), KPIQueryLogicalToDisplay(), KPIQueryLogicalToOdbc(), KPIQueryNormalize(), KPIQuerySet()
property MetricName as %String (TRUNCATE = 1) [ Calculated ];
Property methods: MetricNameCompute(), MetricNameDisplayToLogical(), MetricNameGet(), MetricNameIsValid(), MetricNameLogicalToDisplay(), MetricNameLogicalToOdbc(), MetricNameNormalize(), MetricNameSQLCompute()
property Metrics as %String (MAXLEN = 200, TRUNCATE = 1);
Property methods: MetricsDisplayToLogical(), MetricsGet(), MetricsGetStored(), MetricsIsValid(), MetricsLogicalToDisplay(), MetricsLogicalToOdbc(), MetricsNormalize(), MetricsSet()
property RangeDisplay as array of %BI.RangeDisplay;
Property methods: RangeDisplayBuildValueArray(), RangeDisplayCollectionToDisplay(), RangeDisplayCollectionToOdbc(), RangeDisplayDisplayToCollection(), RangeDisplayGet(), RangeDisplayGetObject(), RangeDisplayGetObjectId(), RangeDisplayGetStored(), RangeDisplayGetSwizzled(), RangeDisplayIsValid(), RangeDisplayOdbcToCollection(), RangeDisplaySet(), RangeDisplaySetObject(), RangeDisplaySetObjectId()
property RangeKPIDR as %String (MAXLEN = 10, TRUNCATE = 1);
Property methods: RangeKPIDRDisplayToLogical(), RangeKPIDRGet(), RangeKPIDRGetStored(), RangeKPIDRIsValid(), RangeKPIDRLogicalToDisplay(), RangeKPIDRLogicalToOdbc(), RangeKPIDRNameDisplayToLogical(), RangeKPIDRNameGet(), RangeKPIDRNameIsValid(), RangeKPIDRNameLogicalToDisplay(), RangeKPIDRNameLogicalToOdbc(), RangeKPIDRNameNormalize(), RangeKPIDRNormalize(), RangeKPIDRSet()
property RangeKPIDRName as %String (TRUNCATE = 1) [ Calculated ];
Property methods: RangeKPIDRNameDisplayToLogical(), RangeKPIDRNameGet(), RangeKPIDRNameIsValid(), RangeKPIDRNameLogicalToDisplay(), RangeKPIDRNameLogicalToOdbc(), RangeKPIDRNameNormalize()
property StaticDays as %Numeric;
Property methods: StaticDaysDisplayToLogical(), StaticDaysGet(), StaticDaysGetStored(), StaticDaysIsValid(), StaticDaysLogicalToDisplay(), StaticDaysNormalize(), StaticDaysSet(), StaticDaysXSDToLogical()
property Variable as %String (MAXLEN = 20000, TRUNCATE = 1);
Property methods: VariableDisplayToLogical(), VariableGet(), VariableGetStored(), VariableIsValid(), VariableLogicalToDisplay(), VariableLogicalToOdbc(), VariableNormalize(), VariableSet()

Methods

method FolderNameGet() as %String
classmethod GetDataMartName(dmid As %String) as %String
classmethod GetMetricName(MetricID As %String) as %String
method KPIValue() as %String
method MetricNameGet() as %String
method RangeKPIDRNameGet() as %String

Queries

query ListAll()
SQL Query:
SELECT ID,KPIName,DataMartName,Folder,DataMart FROM KPI Order by DataMart
query ListAll2()
SQL Query:
SELECT ID,KPIName,DataMartName,Folder,DataMart FROM KPI Order by KPIName
query byFolder(folderId As %String)
SQL Query:
SELECT ID,KPIName,DataMartName,DataMart,Formula,KPIQuery,Metrics FROM KPI WHERE (Folder = :folderId) ORDER BY KPIName

Indices

index (DM on DataMart:Exact);
Index methods: DMExists()
index (Folder on Folder:Exact);
Index methods: FolderDisplayToLogical(), FolderExists(), FolderGet(), FolderGetStored(), FolderIsValid(), FolderLogicalToDisplay(), FolderLogicalToOdbc(), FolderNameDisplayToLogical(), FolderNameGet(), FolderNameIsValid(), FolderNameLogicalToDisplay(), FolderNameLogicalToOdbc(), FolderNameNormalize(), FolderNormalize(), FolderSet()
index (IDKEY on ) [IdKey, Type = key];
Index methods: IDKEYCheck(), IDKEYDelete(), IDKEYExists(), IDKEYOpen(), IDKEYSQLCheckUnique(), IDKEYSQLExists(), IDKEYSQLFindPKeyByConstraint(), IDKEYSQLFindRowIDByConstraint()
index (KPINameIdx on KPIName) [Unique];
Index methods: KPINameIdxCheck(), KPINameIdxCheckUnique(), KPINameIdxDelete(), KPINameIdxExists(), KPINameIdxOpen(), KPINameIdxSQLCheckUnique(), KPINameIdxSQLExists(), KPINameIdxSQLFindPKeyByConstraint(), KPINameIdxSQLFindRowIDByConstraint()

Inherited Members

Inherited Methods (Including Private)

Storage

Storage Model: CacheStorage (%BI.KPI)

^BI.KPID(ID,"F")
=
Formula

Storage Model: CacheStorage (%BI.KPI)

^BI.KPID(ID,"C",n)
=
KPIChild(n)

Storage Model: CacheStorage (%BI.KPI)

^BI.KPID(ID,0)
=
%%CLASSNAME

Storage Model: CacheStorage (%BI.KPI)

^BI.KPID(ID)
=
KPIName
DataMart
IsActive
KPIQuery
Metrics
RangeKPIDR
Variable
KPIMaximum
KPIMinimum
Folder
StaticDays

Storage Model: CacheStorage (%BI.KPI)

^BI.KPID(ID,"R",n)
=
RangeDisplay(n)
Feedback