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

For information on migrating to InterSystems IRIS, see How to Migrate to InterSystems IRIS, available on the WRC Distributions page (login required).


class %DeepSee.KPIWorksheet extends %DeepSee.AbstractKPI

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

Method Inventory (Including Private)


classmethod %GetKPICaptionName(pName As %String = "") as %String
Return the caption as defined in the XML for this KPI.
classmethod %GetKPIName(pName As %String = "") as %String
Return the logical name for this KPI.
classmethod %GetKPIValue(pKPIName As %Library.String, Output pValue As %Library.String, pKPIProperty As %Library.String = "", pSeries As %Library.String = "", ByRef pFilters As %Library.String, pCellContext As %Library.String = "", ByRef pCacheKey As %Library.String, Output pPctComplete As %Library.Integer, pParentQueryKey As %Library.String = "", Output pKPIStatus As %Library.Status) as %Status
Get a specific value from this KPI.
Overridden to bypass the generic machinery in the abstract base class implementation.
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.
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.

Inherited Members

Inherited Properties (Including Private)

Inherited Methods (Including Private)