DocBook|Search
Class Reference
%DeepSee.KPIWorksheet
   
Server:basexml
Instance:SOAXML
User:UnknownUser
 
-
  [BASEXML] >  [%DeepSee] >  [KPIWorksheet]
Private  Storage  

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.

Inventory

Parameters Properties Methods Queries Indices ForeignKeys Triggers
5


Summary

Properties
%filterValues %fromCache %id %message
%rangeLower %rangeUpper %seriesCount %seriesNames
%source %thresholdLower %thresholdUpper

Methods
%%OIDGet %AddToSaveSet %ApplyDefaults %CheckResource
%ClassIsLatestVersion %ClassName %ClearKPICache %ConstructClone
%CreateKPIController %CreateModelInstance %DeleteModel %DispatchClassMethod
%DispatchGetModified %DispatchMethod %DispatchSetModified %DispatchSetMultidimProperty
%Extends %GetFilterDisplayValue %GetFilterKey %GetFilterLogicalValue
%GetJSValidationCode %GetKPICaption %GetKPICaptionName %GetKPIClassTimeStamp
%GetKPIName %GetKPIPropertyCaption %GetKPIValue %GetKPIValueArray
%GetParameter %GetPropertyInfo %GetSourceType %InvokeAction
%IsA %IsAsync %IsCacheable %IsModified
%IsPublic %IsReadOnly %New %NormalizeObject
%ObjectModified %OnCopyDataFromModel %OnCopyDataToModel %OnDashboardAction
%OnDeleteModel %OnDeleteSource %OnExecute %OnGetActionList
%OnGetFilterList %OnGetFilterMembers %OnGetKPICaption %OnGetKPIPropertyInfo
%OnGetListingResultSet %OnGetListingSQL %OnGetPropertyInfo %OnInvokeAction
%OnLoadKPI %OnLoadModel %OnNewSource %OnOpenSource
%OnSaveSource %OnStoreModel %OnSubmit %OpenModel
%OriginalNamespace %PackageName %PrintValue %RemoveFromSaveSet
%SaveModel %SerializeObject %SetModified %SubmitHandler
%ValidateObject ConvertParameter Decrypt Encrypt
EscapeHTML EscapeURL HyperEventBody HyperEventCall
HyperEventFrame HyperEventHead Include InsertHiddenField
InsertHiddenFields IsPrivate Link OnHTTPHeader
OnPage OnPageError OnPostHTTP OnPostHyperEvent
OnPreHTTP OnPreHyperEvent Page QuoteJS
RewriteURL ShowError StartTimer StopTimer
ThrowError UnescapeHTML UnescapeURL


Methods

• 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 %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.
• 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.