Home > Class Reference > ENSLIB namespace > %DeepSee.PlugIn.iKnowDictionary
Private  Storage   

%DeepSee.PlugIn.iKnowDictionary


class %DeepSee.PlugIn.iKnowDictionary extends %DeepSee.PlugIn.iKnow

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 <filter> elements in the KPI XData block:

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.

Inventory


Parameters Properties Methods Queries Indices ForeignKeys Triggers
4 1


Summary


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

Methods
%AddToSaveSet %CheckResource %ClassIsLatestVersion %ClassName
%ClearKPICache %ComputeKPICacheKey %ComputeKPITimestamp %ConstructClone
%CreateKPIController %CreateModelInstance %DeleteModel %DispatchClassMethod
%DispatchGetModified %DispatchMethod %DispatchSetModified %DispatchSetMultidimProperty
%Extends %GetBaseCube %GetFilterDisplayValue %GetFilterKey
%GetFilterLogicalValue %GetJSValidationCode %GetKPICaption %GetKPICaptionName
%GetKPIClassTimeStamp %GetKPIName %GetKPIPropertyCaption %GetKPIValue
%GetKPIValueArray %GetMDXContextFilter %GetMDXForFilter %GetMDXText
%GetMaxListingRows %GetMembersForFilter %GetParameter %GetPlugInType
%GetPropertyInfo %GetSQLForFilter %GetSQLText %GetSourceType
%InvokeAction %IsA %IsAsync %IsCacheable
%IsModified %IsPublic %IsReadOnly %LoadKPIFromCache
%New %NormalizeObject %ObjectModified %OnCompute
%OnComputeKPITimestamp %OnCopyDataFromModel %OnCopyDataToModel %OnDashboardAction
%OnDeleteModel %OnDeleteSource %OnExecute %OnGetActionList
%OnGetAnalysisResultSet %OnGetFilterList %OnGetFilterMembers %OnGetKPICaption
%OnGetKPIPropertyInfo %OnGetListingFields %OnGetListingMaxRows %OnGetListingOrderBy
%OnGetListingResultSet %OnGetListingSQL %OnGetListingSource %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
%ValidateKPICache %ValidateObject ConvertParameter Decrypt
Encrypt EscapeHTML EscapeURL HyperEventCall
HyperEventHead Include InsertHiddenField InsertHiddenFields
IsPrivate Link OnHTTPHeader OnPage
OnPageError OnPostHTTP OnPostHyperEvent OnPreHTTP
OnPreHyperEvent Page QuoteJS RewriteURL
ShowError StartTimer StopTimer ThrowError
UnescapeHTML UnescapeURL


Parameters


• parameter BASECUBE = "*";
Cube that this plug-in is based on. This determines which cubes (or subject areas based on this cube) can see this plug-in. This can be a comma-delimited list. The cube name(s) should not be enclosed with [].
• parameter LISTINGFIELDS = "ID";
If defined, this the field list (RETURN clause) of the listing used to supply data for this plug-in.
• parameter LISTINGSOURCE = "FactTable";
Specifies the source of the listing data used by this plugin: "SourceTable" - the data source supplies the listing values; "FactTable" - the fact table supplies the listing values.
• parameter PLUGINTYPE = "Aggregate";
Specifies the type of this plug-in. This indicates the context in which this plug-in is used.
"Pivot" -- the plug-in is visible within the Analyzer dimension tree.
"Aggregate" -- the plug-in is not visible within the Analyzer dimension tree.

Methods


• method %OnCompute(pSQLRS As %SQL.StatementResult, pFactCount As %Integer) as %Status
Compute the median of values within the result set.