Inheritance diagram for BaseKPI:

[legend]

Collaboration diagram for BaseKPI:

[legend]

Static Public Member Functions
_.Library.String	GetDisplayedValue (_.Library.Integer rowIndex, _.Library.Integer columnIndex)
	Retrieves the cell value currently displayed at a given row and column index.

_.Library.String	GetSelectedColumnValue (_.ZEN.proxyObject pContext, _.Library.Integer columnIndex)
	Retrieves the value of the column identified by columnIndex for the row currently selected in the KPI.

Static Public Member Functions inherited from AbstractKPI
_.Library.Status	OnPage ()
	Draw the test page.

Static Public Member Functions inherited from Page
_.Library.Status	ConvertParameter (_.Library.String url, _.Library.String name, _.Library.String value)
	You pass this the <parameter>url</parameter> of the page you are going to and a. More...

_.Library.Binary	Decrypt (_.Library.String data)
	Decrypts the input string using the session.Key value that is unique to. More...

_.Library.String	Encrypt (_.Library.Binary data)
	Encrypts the input string using the session.Key value that is unique to this. More...

_.Library.String	EscapeHTML (in)
	This method converts input HTML text into Escaped HTML text.

_.Library.String	EscapeURL (_.Library.String in, _.Library.String charset)
	This method converts the in input URL string into Escaped URL string. More...

_.Library.String	HyperEventCall (_.Library.String methodName, _.Library.String args, _.Library.Integer type, _.Library.Boolean mobile)
	This method returns the string that needs to be written to the current. More...

_.Library.String	HyperEventHead (_.Library.Boolean iframeOnly, _.Library.Boolean strict, _.Library.Boolean optionalBroker)
	This method returns the string that needs to be written to the current. More...

	Include (_.Library.String url)
	Include another csp page or file in the output at this point. More...

_.Library.String	InsertHiddenField (_.Library.String url, _.Library.String name, _.Library.String value, _.Library.String extra)
	Inserts a '<input type="hidden" name="Name" value="Value">' tag into the current document. More...

_.Library.String	InsertHiddenFields (_.Library.String url, _.Library.String query)
	Return the string containing the hidden form tags. More...

_.Library.Boolean	IsPrivate ()
	Returns 1 if this page is in fact a private page (see <parameter>PRIVATE</parameter>).

_.Library.String	Link (_.Library.String link, _.Library.String query, _.Library.Boolean addQ)
	Tranforms the link specified by link into a URL and returns it as a string. More...

_.Library.Status	OnHTTPHeader (_.Library.Boolean OutputBody)
	Event handler for PAGE event: this is invoked in order to More...

	OnPageError (_.Library.Status sc)
	Event handler for any error that occurs on the page. More...

	OnPostHTTP ()
	Event handler for POSTPAGE event: this is invoked after the data. More...

_.Library.Status	OnPostHyperEvent (_.Library.String class, _.Library.String method)
	Event handler which is invoked after a hyperevent method is called on this page.

_.Library.Boolean	OnPreHTTP ()
	Event handler for PreHTTP event: this is invoked before. More...

_.Library.Status	OnPreHyperEvent (_.Library.String class, _.Library.String method)
	Event handler which is invoked before a hyperevent method is called on this page. More...

_.Library.Status	Page (_.Library.Boolean skipheader)
	Process a request to serve a CSPPage. More...

_.Library.String	QuoteJS (in)
	This method converts input string into quoted JavaScript literal.

_.Library.String	RewriteURL (_.Library.String url)
	This method will rewrite a URL to use #url()# if needed.

	ShowError (_.Library.Status sc)
	Display a <class>Status</class> error code to the CSP Page.

	StartTimer (_.Library.String name)
	Used to get performance information on your CSP pages. More...

	StopTimer (_.Library.String name)
	Used to time performance information on your CSP pages. More...

	ThrowError (_.Library.Status sc)
	Passed a <class>Status</class> code this goes to the error page passing this status code.

_.Library.String	UnescapeHTML (in)
	This method converts Escaped HTML text into normal HTML text.

_.Library.String	UnescapeURL (_.Library.String in, _.Library.String charset)
	This method converts the in Escaped URL string back to its original form. More...

Static Public Attributes
	IKCUBENAME = None
	Override this parameter and <parameter>IKMEASURENAME</parameter> to specify the iKnow. More...

	IKDOMAINID = None
	Override this parameter to specify the iKnow domain for the KPI's query to access.

	IKINCLUDEHIDDENMETADATA = None
	Override this parameter to include hidden metadata fields when displaying metadata-based filters for this KPI.

	IKMEASURENAME = None
	Override this parameter and <parameter>IKCUBENAME</parameter> to specify the iKnow. More...

	IKPAGESIZE = None
	Override this parameter to specify the default page size for the KPI's query. More...

Static Public Attributes inherited from KPI
	ASYNC = None
	Subclasses of this class are used to define KPIs (key performance indicators). More...

	CACHEABLE = None
	If true, then results for this KPI can be cached.

	LABELCONCAT = None
	For MDX-based KPIs, use this character when concatenating labels for nested rows.

	MAXLISTINGROWS = None
	Use this parameter to limit the number of losting rows displayed in pivot tables. More...

Static Public Attributes inherited from AbstractKPI
	FORCECOMPUTE = None
	If true, always recompute the value of this KPI when used within an MDX query. More...

	PUBLIC = None
	If true, this KPI is available for public use within dashboard (subject also. More...

	READONLYMODEL = None
	KPI cannot be modified from a client (part of DataModel API).

	RESOURCE = None
	The resource needed to use this KPI: More...

Static Public Attributes inherited from Page
	CHARSET = None
	The <CLASS>CSP.Page</CLASS> object serves as an event handler for CSP requests. More...

	CONTENTTYPE = None
	Specifies the default content type for the page. More...

	CONVERTINPUTSTREAM = None
	Specifies if input request.Content or request.MimeData values are converted from their. More...

	CSPFILE = None
	If this page was compiled from a .csp file, then this parameter contains the. More...

	CSPSTRICT = None
	The CSPSTRICT parameter is set to 1, if the DOCTYPE indicates that this. More...

	CSPURL = None
	This parameter is used to make sure that if multiple. More...

	CSPXHTML = None
	The CSPXHTML parameter is set to 1, if the DOCTYPE indicates that this. More...

	DOMAIN = None
	The default domain for csp:text, span and div tags. More...

	ENCODED = None
	Controls how the query parameters for this page are passed, it can. More...

	ERRORPAGE = None
	Specify a custom error page to call if there are any problems with generating this page. More...

	EXPIRES = None
	Specified the default value for the response.Expires. More...

	NOCHARSETCONVERT = None
	Specifies if we wish to turn off charset conversion for this page. More...

	PAGETIMING = None
	If this parameter is true then we automatically record timing statistics of how long it takes to. More...

	PRIVATE = None
	Controls the access to the page, it can be set to one of the following: More...

	SECURITYRESOURCE = None
	This is a comma-delimited list of system Resources and associated. More...

	TIMINGSLOTS = None
	Used by the timing to decide how many slots a day should be divided up into. More...

	UseSession = None
	This parameter controls the CSP session support. More...

Static Public Attributes inherited from ObjectDataModel
	DOMAIN = None
	This class is used to implement the Model portion of the Zen Model-View-Controller mechanism. More...

	DYNAMICPROPERTIES = None
	If true (the default), then this dataModel class supports dynamic properties: More...

Static Public Attributes inherited from DataModel
	READONLYMODEL = None
	This is the abstract base class used by all model classes within the Zen Model-View-Controller mechanism. More...

Static Public Attributes inherited from RegisteredObject
	CAPTION = None
	Optional name used by the Form Wizard for a class when generating forms. More...

	JAVATYPE = None
	The Java type to be used when exported.

	PROPERTYVALIDATION = None
	This parameter controls the default validation behavior for the object. More...

Private Member Functions
_.iKnow.Filters.Filter	__BuildCurrentFilter (_.Library.Status pSC)

_.Library.Status	__DisplayResult (result, _.Library.Integer nameIndex, properties)
	Utility method to fill up data and seriesNames based on an iKnow query result.

_.Library.Integer	__GetDomainId ()
	Shorthand to get the domain ID from an instance context.

Static Private Member Functions
_.Library.Status	OnDashboardAction (_.Library.String pAction, _.ZEN.proxyObject pContext, _.Library.String pDataSourceName)

_.Library.Status	OnGetActionList (_.Library.List pActions, _.Library.String pDataSourceName)

_.Library.Status	OnGetFilterList (_.Library.List pFilters, _.Library.String pDataSourceName)

_.Library.Status	OnGetFilterMembers (_.Library.String pFilter, _.Library.List pMembers, _.Library.String pSearchKey, _.Library.String pDataSourceName)

_.iKnow.Filters.Filter	__BuildCurrentFilterStatic (pFilters, _.Library.Status pSC)

_.Library.Integer	__GetCurrentPage (_.Library.Integer domainId)
	Returns the currently displayed result page (see iKnow query paging)

_.Library.Integer	__GetDomainIdStatic (_.ZEN.proxyObject pContext)
	Shorthand to get the domain ID from a static context.

_.Library.Status	__NextPage (_.ZEN.proxyObject pContext)
	Advances the current query page by 1.

_.Library.Status	__PreviousPage (_.ZEN.proxyObject pContext)
	Decreases the current query page by 1, with a minimum of 1 (first query result page)

_.Library.Status	__ResetPage (_.Library.Integer domainId)
	Resets the current page.

Additional Inherited Members
Public Member Functions inherited from RegisteredObject
_.Library.Status	OnAddToSaveSet (_.Library.Integer depth, _.Library.Integer insert, _.Library.Integer callcount)
	This callback method is invoked when the current object is added to the SaveSet,. More...

_.Library.Status	OnClose ()
	This callback method is invoked by the <METHOD>Close</METHOD> method to. More...

_.Library.Status	OnConstructClone (_.Library.RegisteredObject object, _.Library.Boolean deep, _.Library.String cloned)
	This callback method is invoked by the <METHOD>ConstructClone</METHOD> method to. More...

_.Library.Status	OnNew ()
	This callback method is invoked by the <METHOD>New</METHOD> method to. More...

_.Library.Status	OnValidateObject ()
	This callback method is invoked by the <METHOD>ValidateObject</METHOD> method to. More...

Detailed Description

This is the base class for iKnow-based KPIs, offering a number of utility methods to fetch the current filter and query result page settings.

For internal use only - use <class>iKnow.DeepSee.GenericKPI</class> or <class>iKnow.DeepSee.SourceListFilterKPI</class> instead.

Member Function Documentation

◆ OnDashboardAction()

_.Library.Status OnDashboardAction	(	_.Library.String	pAction,
		_.ZEN.proxyObject	pContext,
		_.Library.String	pDataSourceName
	)

staticprivate

Implementation of <method>OnDashboardAction</method> method, inherited from <class>DeepSee.KPI</class>. Do not invoke directly.

Takes care of the nextPage and previousPage pAction values.

Reimplemented from AbstractKPI.

◆ OnGetActionList()

_.Library.Status OnGetActionList	(	_.Library.List	pActions,
		_.Library.String	pDataSourceName
	)

staticprivate

Implementation of <method>OnGetFilterList</method> method, inherited from <class>DeepSee.KPI</class>. Do not invoke directly.

Adds nextPage and prevPage actions.

Reimplemented from AbstractKPI.

◆ OnGetFilterList()

_.Library.Status OnGetFilterList	(	_.Library.List	pFilters,
		_.Library.String	pDataSourceName
	)

staticprivate

Implementation of <method>OnGetFilterList</method> method, inherited from <class>DeepSee.KPI</class>. Do not invoke directly.

Unless this KPI is linked to a DeepSee-managed domain (through <parameter>IKCUBENAME</parameter> and <parameter>IKMEASURENAME</parameter>, adds all public metadata fields for this KPIs domain at the end of the pFilters list. Also adds a Value and Name column to be controlled through dashboard filters.

Reimplemented from KPI.

Reimplemented in SourceListFilterKPI, and GenericKPI.

◆ OnGetFilterMembers()

_.Library.Status OnGetFilterMembers	(	_.Library.String	pFilter,
		_.Library.List	pMembers,
		_.Library.String	pSearchKey,
		_.Library.String	pDataSourceName
	)

staticprivate

Implementation of <method>OnGetFilterMembers</method> method, inherited from <class>DeepSee.KPI</class>. Do not invoke directly.

When querying for an iKnow metadata-based filter (prefixed with "IK:MDFIELD:"), it will retrieve the available values for that metadata field in the current iKnow domain.

Reimplemented in SourceListFilterKPI, and GenericKPI.

◆ __BuildCurrentFilter()

_.iKnow.Filters.Filter __BuildCurrentFilter ( _.Library.Status pSC )

private

Utility method to build an <class>iKnow.Filters.Filter</class> object based on the current DeepSee

dashboard-wide filter settings (fetched from <property>filterValues</property>). This method will translate all DeepSee filters for which there is a metadata field having the same name as the dimension level referred to in <property>filterValues</property>, eventually mapped through ^IRIS.IKD.DimFilterMapping

◆ __BuildCurrentFilterStatic()

_.iKnow.Filters.Filter __BuildCurrentFilterStatic	(		pFilters,
		_.Library.Status	pSC
	)

staticprivate

Utility method to translate the array of DeepSee filter specs in pFilters into an

iKnow <class>iKnow.Filters.Filter</class> object. For DeepSee-managed domains, this will result in a <class>iKnow.DeepSee.MDXFilter</class> object.

Member Data Documentation

◆ IKCUBENAME

IKCUBENAME = None

static

Override this parameter and <parameter>IKMEASURENAME</parameter> to specify the iKnow.

domain linked to a particular iKnow measure for the KPI's query to access.

◆ IKMEASURENAME

IKMEASURENAME = None

static

Override this parameter and <parameter>IKCUBENAME</parameter> to specify the iKnow.

domain linked to a particular iKnow measure for the KPI's query to access.

◆ IKPAGESIZE

IKPAGESIZE = None

static

Override this parameter to specify the default page size for the KPI's query.

This can be overridden per widget through a filter.

Static Public Member Functions

Static Public Attributes

Private Member Functions

Static Private Member Functions

Additional Inherited Members

Detailed Description

Member Function Documentation

◆ OnDashboardAction()

◆ OnGetActionList()

◆ OnGetFilterList()

◆ OnGetFilterMembers()

◆ __BuildCurrentFilter()

◆ __BuildCurrentFilterStatic()

Member Data Documentation

◆ IKCUBENAME

◆ IKMEASURENAME

◆ IKPAGESIZE