Class Ens.BusinessMetricKPI

class Ens.BusinessMetricKPI extends %DeepSee.AbstractKPI

This class lets an Business Metric act as a DeepSee KPI and drive DeepSee dashboards. This class is for internal InterSystems use only. You should not make direct use of it within your applications. There is no guarantee made about either the behavior or future operation of this class.

Inventory

Parameters	Properties	Methods	Queries	Indices	ForeignKeys	Triggers
		10

Summary

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

Methods
%AddToSaveSet	%ApplyDefaults	%CheckResource	%ClassIsLatestVersion
%ClassName	%ClearKPICache	%ConstructClone	%CreateKPIController
%CreateModelInstance	%DeleteModel	%DispatchClassMethod	%DispatchGetModified
%DispatchMethod	%DispatchSetModified	%DispatchSetMultidimProperty	%Extends
%GetBusinessMetricClass	%GetBusinessMetricList	%GetFilterDisplayValue	%GetFilterKey
%GetFilterLogicalValue	%GetJSValidationCode	%GetKPICaption	%GetKPICaptionName
%GetKPIClassTimeStamp	%GetKPIName	%GetKPIPropertyCaption	%GetKPIValue
%GetKPIValueArray	%GetParameter	%GetPropertyInfo	%GetSourceType
%InvokeAction	%IsA	%IsAsync	%IsCacheable
%IsModified	%IsPublic	%IsReadOnly	%New
%NormalizeObject	%ObjectModified	%OnCopyDataFromModel	%OnCopyDataToModel
%OnDashboardAction	%OnDeleteModel	%OnDeleteSource	%OnExecute
%OnGetActionList	%OnGetFilterList	%OnGetFilterMembers	%OnGetKPICaption
%OnGetKPIPropertyInfo	%OnGetListingResultSet	%OnGetListingSQL	%OnGetPropertyInfo
%OnInvokeAction	%OnLoadKPI	%OnLoadModel	%OnNewSource
%OnOpenSource	%OnSaveSource	%OnStoreModel	%OnSubmit
%OpenModel	%OriginalNamespace	%PackageName	%PrintValue
%RemoveFromSaveSet	%SaveModel	%SerializeObject	%SetModified
%SubmitHandler	%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

Methods

• final classmethod %GetBusinessMetricClass(pDataSourceName As %String, Output pProductionName As %String, Output pHostName As %String) as %String

Given a full name (production/host.metric) for a Business Metric, return the class name that implements it.

• final classmethod %GetBusinessMetricList(Output pList) as %Status

Return list of all known Business Metrics in this namespace.

• classmethod %GetKPICaptionName() as %String

Return the caption as defined in the XML for this KPI.

• classmethod %GetKPIName() as %String

Return the logical name for this KPI.

• classmethod %OnDashboardAction(pAction As %String, pContext As %ZEN.proxyObject, pDataSourceName As %String = "") as %Status

This callback is invoked from a dashboard when an action defined by this dashboard is invoked.
pAction is the logical name of the action.
pContext is a proxy object that contains various information about the action and provides a way for the method to return information to the client.

• classmethod %OnGetActionList(ByRef pActions As %List, pDataSourceName As %String = "") as %Status

Callback to get additional actions for a KPI. This takes the form:
pActions($I(pActions))=$LB(name,caption)

• classmethod %OnGetFilterList(Output pFilters As %List, pDataSourceName As %String = "") as %Status

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)

• classmethod %OnGetFilterMembers(pFilter As %String, Output pMembers As %List, pSearchKey As %String = "", pDataSourceName As %String = "") as %Status

Callback to get additional members for a KPI filter. This takes the form:
pMembers($I(pMembers))=$LB(text,value)
pSearchKey is the search key entered by the user, if applicable.

• classmethod %OnGetKPIPropertyInfo(ByRef pList As %String, pPropNo As %Integer, pDataSourceName As %String = "") as %Status

Add additional properties beyond those defined in the KPI block. This takes the form:
pList(n) = name
pList(n,"defaultValue") = value
pList(n,"columnNo") = #
pPropNo is the number of next open slot in the list.

• method %OnLoadKPI() as %Status

Notify subclass that KPI is has just be executed. This is a good place to override properties, such as range and threshold.

Class Reference IRIS for UNIX 2024.1.2
Documentation Search