Learning
Documentation
Community
Open Exchange
Global Masters
Home / Class Reference / ENSLIB namespace / %iKnow.DeepSee.GenericKPI
Private  Storage   

%iKnow.DeepSee.GenericKPI


abstract class %iKnow.DeepSee.GenericKPI extends
%iKnow.DeepSee.BaseKPI

Implements a DeepSee KPI that executes an iKnow query. To use this class, create a subclass and override the class parameters prefixed with "IK", which you use to specify the iKnow domain (IKDOMAINID), query class (IKQUERYCLASS), query (IKQUERYNAME), and default page size (IKPAGESIZE, optional).

This generic iKnow-DeepSee KPI implementation offers the following services:

Inventory


Parameters Properties Methods Queries Indices ForeignKeys Triggers
2 5


Summary


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

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


Parameters


• parameter IKQUERYCLASS = "%iKnow.Queries.EntityAPI";
Override this parameter to specify the iKnow ObjectScript API class that contains the query to use (primary API class, no *QAPI or *WSAPI class)
• parameter IKQUERYNAME = "GetTop";
Override this parameter to specify the iKnow query to use in the class identified by IKQUERYCLASS.

Methods


• method %OnExecute() as %Status

Implementation of %OnExecute method, inherited from %DeepSee.KPI. Do not invoke directly.

Configures and fires the query registered for this GenericKPI instance, given the active filter criteria.

• classmethod %OnGetFilterList(Output pFilters As %List, pDataSourceName As %String = "") as %Status

Implementation of %OnGetFilterList method, inherited from %DeepSee.KPI. Do not invoke directly.

Adds a list of all valid query parameters for the query identified by IKQUERYCLASS and IKQUERYNAME.

• classmethod %OnGetFilterMembers(pFilter As %String, Output pMembers As %List, pSearchKey As %String = "", pDataSourceName As %String = "") as %Status

Implementation of %OnGetFilterMembers method, inherited from %DeepSee.KPI. Do not invoke directly.

Adds the values for the IK: system filters (series name column, metadata-based filters and query parameters)

• classmethod %OnGetKPIPropertyInfo(ByRef pList As %String, pPropNo As %Integer, pModelId As %String = "") as %Status

Implementation of %OnGetKPIPropertyInfo method, inherited from %DeepSee.KPI. Do not invoke directly.

Adds the returned columns for this KPIs query as properties if there aren't any configured explicitly already, as well as a 'resultNumber' column

• classmethod %OnGetListingResultSet(ByRef pFilters As %String, ByRef pSelection As %String, pListingName As %String = "", Output pRS As %SQL.StatementResult) as %Status

Implementation of %OnGetListingResultSet method, inherited from %DeepSee.KPI. Do not invoke directly.

Triggers the applicable GetBy*** query from %iKnow.Queries.SourceAPI, taking into account the selected values in the KPI and any active filters.