%iKnow.DeepSee.SourceListFilterKPI

deprecated abstract class %iKnow.DeepSee.SourceListFilterKPI extends %iKnow.DeepSee.BaseKPI

Implements a DeepSee KPI that executes an iKnow query returning a list of iKnow Sources. To use this class, create a subclass and override the IKDOMAINID class parameter to point to the domain you want to query.

This iKnow-DeepSee KPI implementation offers the following services:

• Displays all metadata fields for the registered domain as properties (columns in the KPI tab form), which can be configured at widget level. The Source ID and External ID are available as well.
• Offers any relevant query parameters as filters so they can then be added to the widget (and controlled by the user) or fixed to a specific value. Through the GetParameterValues method in %iKnow.Queries.Utils, a list of allowed parameter values is also made available for most common parameters.
• Exposes all the domains public metadata fields as filters (through %iKnow.DeepSee.BaseKPI)
• Adds previous and next buttons to browse through the query results (through %iKnow.DeepSee.BaseKPI)

Method Inventory

• %OnExecute()
• %OnGetFilterList()
• %OnGetFilterMembers()
• %OnGetKPIPropertyInfo()

Methods

method %OnExecute() as %Status

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

Configures and fires the appropriate %iKnow.Queries.SourceAPI query 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 filters for concept, page size and set operation

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.

Adds the values for the IK: system filters (concept filter, 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.

This method will add all metadata fields supplied for this domain as columns for this KPI.