DeepSee.Utils.MDXAutoFiltersKPI
abstract class DeepSee.Utils.MDXAutoFiltersKPI extends %DeepSee.KPI
Use this superclass to create an MDX-based KPI that automatically adds a %FILTER clause to your MDX query. The %FILTER clause includes any selections in any filters that use levels from the appropriate cube.To use this superclass:
- Specify sourceType="mdx" in <kpi>.
- Specify a query within the mdx attribute of <kpi>
- Specify the CUBE parameter so that we can automatically fetch the members of the levels for use as filters. Instead, all levels of the associated cube are automatically available as filters.
Or, if you want more control over the form of the query, override %OnGetMDX() as usual and include the following line after creating your basic MDX query:
set pMDX=pMDX_..FilterBuilder()
This method gets the current filter state, creates the %FILTER clause, and tacks it on to the end of your query.
If you want more control over the members of one or more filters, override %OnGetFilterMembers() as usual. To get all the members for a given level/filter, use this:
set sc=..%GetMembersForFilter(..#CUBE,pFilter,.pMembers)
And then do something different as needed in other scenarios.
To add additional filters (to be used in a different way):
- Within <kpi>, declare the filters that you want to make available. The logical name for each filter must be of the form of an MDX level specifier, e.g., [dimension].[hierarchy].[level]. This is needed so that we can retrieve the level members.
- Override %OnGetFilters(). In your implementation, get the filters from the cube by calling #super() and then add your custom filters to the array.
Method Inventory
Parameters
parameter CUBE;
Specifies the cube that this KPI uses. Specify the logical cube name.
Methods
Inherited description: Callback to get additional possible filters for this KPI.
This drives the list of filter selections for widget connected to this KPI.
This takes the form:
pFilters($I(pFilters))=$LB(name,caption,value,multiSelect)
pFilters($I(pFilters))=$LB(name,caption,value,multiSelect)
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; can be overridden.
Implementation; can be overridden.
Inherited Members
Inherited Properties
- %filterValues
- %fromCache
- %id
- %message
- %rangeLower
- %rangeUpper
- %seriesCount
- %seriesNames
- %source
- %thresholdLower
- %thresholdUpper
Inherited Methods
- %AddToSaveSet()
- %CheckResource()
- %ClassIsLatestVersion()
- %ClassName()
- %ClearKPICache()
- %ComputeKPICacheKey()
- %ComputeKPITimestamp()
- %ConstructClone()
- %CreateKPIController()
- %CreateModelInstance()
- %DeleteModel()
- %DispatchClassMethod()
- %DispatchGetModified()
- %DispatchMethod()
- %DispatchSetModified()
- %DispatchSetMultidimProperty()
- %Extends()
- %GetFilterDisplayValue()
- %GetFilterKey()
- %GetFilterLogicalValue()
- %GetJSValidationCode()
- %GetKPICaption()
- %GetKPICaptionName()
- %GetKPIClassTimeStamp()
- %GetKPIName()
- %GetKPIPropertyCaption()
- %GetKPIValue()
- %GetKPIValueArray()
- %GetMDXContextFilter()
- %GetMDXForFilter()
- %GetMDXText()
- %GetMembersForFilter()
- %GetParameter()
- %GetPropertyInfo()
- %GetSQLForFilter()
- %GetSQLText()
- %GetSourceType()
- %InvokeAction()
- %IsA()
- %IsAsync()
- %IsCacheable()
- %IsModified()
- %IsPublic()
- %IsReadOnly()
- %LoadKPIFromCache()
- %New()
- %NormalizeObject()
- %ObjectModified()
- %OnComputeKPITimestamp()
- %OnCopyDataFromModel()
- %OnCopyDataToModel()
- %OnDashboardAction()
- %OnDeleteModel()
- %OnDeleteSource()
- %OnExecute()
- %OnGetActionList()
- %OnGetKPICaption()
- %OnGetKPIPropertyInfo()
- %OnGetListingResultSet()
- %OnGetListingSQL()
- %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()