Skip to main content

%DeepSee.KPIWorksheet

Class %DeepSee.KPIWorksheet Extends %DeepSee.AbstractKPI [ System = 4 ]

A specialized KPI that gets its values from a saved "worksheet". The worksheet information is obtained using the %DeepSee.UserLibrary.Worksheet class.

Methods​

%GetKPIName​

ClassMethod %GetKPIName(pName As %String = "") As %String

Return the logical name for this KPI.

%GetKPICaptionName​

ClassMethod %GetKPICaptionName(pName As %String = "") As %String

Return the caption as defined in the XML for this KPI.

%OnGetKPIPropertyInfo​

ClassMethod %OnGetKPIPropertyInfo(ByRef pList As %String, pPropNo As %Integer, pModelId As %String = "") As %Status

Add additional properties beyond those defined in the KPI block. This takes the form:
pList(n) = name
pList(n,"defaultValue") = value
pList(n,"columnNo") = #
pPropNo is the number of next open slot in the list.

%OnLoadKPI​

Method %OnLoadKPI() As %Status

Notify subclass that KPI is has just be executed. This is a good place to override properties, such as range and threshold.

%GetKPIValue​

ClassMethod %GetKPIValue(pKPIName As %String, Output pValue As %String, pKPIProperty As %String = "", pSeries As %String = "", ByRef pFilters As %String, pCellContext As %String = "") As %Status

Get a specific value from this KPI.
Overridden to bypass the generic machinery in the abstract base class implementation.