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

For information on migrating to InterSystems IRIS, see Why Migrate to InterSystems IRIS?

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

Method Inventory (Including Private)

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 %Library.String, Output pMembers As %Library.List, pSearchKey As %Library.String = "", pDataSourceName As %Library.String = "", ByRef pFilterValues As %Library.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.

private final method BuildCurrentFilter(Output pSC As %Status) as %iKnow.Filters.Filter

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 ^ISC.IKD.DimFilterMapping

private final classmethod BuildCurrentFilterStatic(ByRef pFilters, Output pSC As %Status) as %iKnow.Filters.Filter

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.

private method DisplayResult(ByRef result, nameIndex As %Integer, ByRef properties) as %Status
Utility method to fill up %data and %seriesNames based on an iKnow query result
private final classmethod GetCurrentPage(domainId As %Integer) as %Integer
Returns the currently displayed result page (see iKnow query paging)
classmethod GetDisplayedValue(rowIndex As %Integer, columnIndex As %Integer) as %String
Retrieves the cell value currently displayed at a given row and column index.
private final method GetDomainId() as %Integer
Shorthand to get the domain ID from an instance context
private final classmethod GetDomainIdStatic(pContext As %ZEN.proxyObject = "") as %Integer
Shorthand to get the domain ID from a static context
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
private final classmethod NextPage(pContext As %ZEN.proxyObject) as %Status
Advances the current query page by 1
private final classmethod PreviousPage(pContext As %ZEN.proxyObject) as %Status
Decreases the current query page by 1, with a minimum of 1 (first query result page)
private final classmethod ResetPage(domainId As %Integer) as %Status
Resets the current page

Inherited Members

Inherited Properties (Including Private)

Inherited Methods (Including Private)

Subclasses

Feedback