Class %iKnow.DeepSee.BaseKPI

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

This is the base class for iKnow-based KPIs, offering a number of utility methods to fetch the current filter and query result page settings.

For internal use only - use %iKnow.DeepSee.GenericKPI or %iKnow.DeepSee.SourceListFilterKPI instead.

Inventory

Parameters	Properties	Methods	Queries	Indices	ForeignKeys	Triggers
5		15

Summary

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

Methods
%%OIDGet	%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
%ValidateObject	ConvertParameter	Decrypt	Encrypt
EscapeHTML	EscapeURL	GetDisplayedValue	GetSelectedColumnValue
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

Subclasses
%iKnow.DeepSee.GenericKPI	%iKnow.DeepSee.SourceListFilterKPI

Parameters

• parameter IKCUBENAME;

Override this parameter and IKMEASURENAME to specify the iKnow domain linked to a particular iKnow measure for the KPI's query to access.

• parameter IKDOMAINID = 1;

Override this parameter to specify the iKnow domain for the KPI's query to access.

• parameter IKINCLUDEHIDDENMETADATA = 0;

Override this parameter to include hidden metadata fields when displaying metadata-based filters for this KPI.

• parameter IKMEASURENAME;

Override this parameter and IKCUBENAME to specify the iKnow domain linked to a particular iKnow measure for the KPI's query to access.

• parameter IKPAGESIZE = 10;

Override this parameter to specify the default page size for the KPI's query. This can be overridden per widget through a filter.

Methods

• classmethod %OnDashboardAction(pAction As %String, pContext As %ZEN.proxyObject, pDataSourceName As %String = "") as %Status

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

Takes care of the nextPage and previousPage pAction values.

• classmethod %OnGetActionList(ByRef pActions As %List, pDataSourceName As %String = "") as %Status

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

Adds nextPage and prevPage actions.

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

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

Unless this KPI is linked to a DeepSee-managed domain (through IKCUBENAME and IKMEASURENAME, adds all public metadata fields for this KPIs domain at the end of the pFilters list. Also adds a Value and Name column to be controlled through dashboard filters.

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

When querying for an iKnow metadata-based filter (prefixed with "IK:MDFIELD:"), it will retrieve the available values for that metadata field in the current iKnow domain.

• classmethod GetDisplayedValue(rowIndex As %Integer, columnIndex As %Integer) as %String

Retrieves the cell value currently displayed at a given row and column index.

• classmethod GetSelectedColumnValue(pContext As %ZEN.proxyObject, columnIndex As %Integer) as %String

Retrieves the value of the column identified by columnIndex for the row currently selected in the KPI


[BASEXML] > [%iKnow] > [DeepSee] > [BaseKPI]		Private Storage