Class Reference
IRIS for UNIX 2019.2
InterSystems: The power behind what matters   
Documentation  Search
  [ENSLIB] >  [%DeepSee] >  [PlugIn] >  [iKnow]
Private  Storage   

class %DeepSee.PlugIn.iKnow extends %DeepSee.KPIPlugIn

Sample DeepSee plugin implementation exposing the numeric results for iKnow Queries in a domain associated with an iKnow measure in this cube, as returned for the individual iKnow measure values for each fact. This PlugIn has only one result property named Result.

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

Sample usage:

%KPI("%DeepSee.iKnow","Result",1,"aggregate","total","%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 4


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

Subclasses
%DeepSee.PlugIn.iKnowDictionary

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.
• method %OnGetMDX(ByRef pMDX As %String) as %Status
Get the base query for this plug-in.


Copyright (c) 2019 by InterSystems Corporation. Cambridge, Massachusetts, U.S.A. All rights reserved. Confidential property of InterSystems Corporation.