%iKnow.DeepSee.BaseKPI
Class %iKnow.DeepSee.BaseKPI Extends %DeepSee.KPI [ Abstract, Deprecated, System = 4 ]
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.
Parameters
IKDOMAINID
Parameter IKDOMAINID As INTEGER = 1;
Override this parameter to specify the iKnow domain for the KPI's query to access.
IKCUBENAME
Parameter IKCUBENAME As STRING;
Override this parameter and IKMEASURENAME to specify the iKnow domain linked to a particular iKnow measure for the KPI's query to access.
IKMEASURENAME
Parameter IKMEASURENAME As STRING;
Override this parameter and IKCUBENAME to specify the iKnow domain linked to a particular iKnow measure for the KPI's query to access.
IKPAGESIZE
Parameter IKPAGESIZE As INTEGER = 10;
Override this parameter to specify the default page size for the KPI's query. This can be overridden per widget through a filter.
IKINCLUDEHIDDENMETADATA
Parameter IKINCLUDEHIDDENMETADATA As BOOLEAN = 0;
Override this parameter to include hidden metadata fields when displaying metadata-based filters for this KPI.
Methods
DisplayResult
Method DisplayResult(ByRef result, nameIndex As %Integer, ByRef properties) As %Status [ Private ]
Utility method to fill up %data and %seriesNames based on an iKnow query result
GetSelectedColumnValue
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
GetDisplayedValue
ClassMethod GetDisplayedValue(rowIndex As %Integer, columnIndex As %Integer) As %String
Retrieves the cell value currently displayed at a given row and column index.
GetDomainId
Method GetDomainId() As %Integer [ Final, Private ]
Shorthand to get the domain ID from an instance context
GetDomainIdStatic
ClassMethod GetDomainIdStatic(pContext As %ZEN.proxyObject = "") As %Integer [ Final, Private ]
Shorthand to get the domain ID from a static context
BuildCurrentFilter
Method BuildCurrentFilter(Output pSC As %Status) As %iKnow.Filters.Filter [ Final, Private ]
Utility method to build an %iKnow.Filters.Filter object based on the current DeepSee dashboard-wide filter settings (fetched from %filterValues). This method will translate all DeepSee filters for which there is a metadata field having the same name as the dimension level referred to in %filterValues, eventually mapped through ^IRIS.IKD.DimFilterMapping
BuildCurrentFilterStatic
ClassMethod BuildCurrentFilterStatic(ByRef pFilters, Output pSC As %Status) As %iKnow.Filters.Filter [ Final, Private ]
Utility method to translate the array of DeepSee filter specs in pFilters into an iKnow %iKnow.Filters.Filter object. For DeepSee-managed domains, this will result in a %iKnow.DeepSee.MDXFilter object.
GetCurrentPage
ClassMethod GetCurrentPage(domainId As %Integer) As %Integer [ Final, Private ]
Returns the currently displayed result page (see iKnow query paging)
ResetPage
ClassMethod ResetPage(domainId As %Integer) As %Status [ Final, Private ]
Resets the current page
NextPage
ClassMethod NextPage(pContext As %ZEN.proxyObject) As %Status [ Final, Private ]
Advances the current query page by 1
PreviousPage
ClassMethod PreviousPage(pContext As %ZEN.proxyObject) As %Status [ Final, Private ]
Decreases the current query page by 1, with a minimum of 1 (first query result page)
%OnGetFilterList
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.
%OnGetFilterMembers
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.
%OnDashboardAction
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.
%OnGetActionList
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.