Skip to main content

%DeepSee.PlugIn.iKnowDictionary

Class %DeepSee.PlugIn.iKnowDictionary Extends %DeepSee.PlugIn.iKnow [ Deprecated, System = 4 ]

Sample DeepSee plugin implementation exposing the number and total count of matching results for a domain associated with an iKnow measure in this cube. This PlugIn has two properties available for use in queries: MatchCount and MatchScore. These numbers will have been broken down to the appropriate Dictionary and Item levels if there is a corresponding Dictionary and/or Item member in the current filter, row or column spec.

The following arguments can be passed through elements in the KPI XData block:

  • %cube: the Subject Area which' iKnow measure to look for. Uses the default cube for this query if not specified.
  • %measure: the iKnow measure (in cube %cube) whose domain needs to be queried. Uses the first iKnow measure in %cube if not specified.
  • aggregate: how to aggregate the match count or total score. Any of sum (default), average, max or min.

Sample usage:

%KPI("%DeepSee.iKnowDictionary","MatchCount",1,"aggregate","sum","%CONTEXT")

Note: it is essential to pass in the "%CONTEXT" special parameter into the %KPI function for it to return correct results.

Parameters​

BASECUBE​

Parameter BASECUBE = "*";

LISTINGSOURCE​

Parameter LISTINGSOURCE = "FactTable";

PLUGINTYPE​

Parameter PLUGINTYPE = "Aggregate";

LISTINGFIELDS​

Parameter LISTINGFIELDS = "ID";

XDatas​

KPI​

XData KPI [ XMLNamespace = "http://www.intersystems.com/deepsee/kpi" ]

This XData definition defines the KPI.

Methods​

%OnCompute​

Method %OnCompute(pSQLRS As %SQL.StatementResult, pFactCount As %Integer) As %Status

Compute the median of values within the result set.