Inheritance diagram for GenericKPI:

[legend]

Collaboration diagram for GenericKPI:

[legend]

Static Public Attributes
	IKQUERYCLASS = None
	Override this parameter to specify the iKnow ObjectScript API class that contains the query to use (primary API class, no QAPI or WSAPI class) More...

	IKQUERYNAME = None
	Override this parameter to specify the iKnow query to use in the class identified by <parameter>IKQUERYCLASS</parameter>.

Static Public Attributes inherited from BaseKPI
	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
_.Library.Status	OnExecute ()

Static Private Member Functions
_.Library.Status	OnGetFilterList (_.Library.List pFilters, _.Library.String pDataSourceName)

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

_.Library.Status	OnGetKPIPropertyInfo (_.Library.String pList, _.Library.Integer pPropNo, _.Library.String pModelId)

_.Library.Status	OnGetListingResultSet (_.Library.String pFilters, _.Library.String pSelection, _.Library.String pListingName, _.SQL.StatementResult pRS)

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

Static Public Member Functions inherited from BaseKPI
_.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...

Detailed Description

Implements a DeepSee KPI that executes an iKnow query. To use this class, create a subclass and override the class parameters prefixed with "IK", which you use to specify the iKnow domain (<parameter>IKDOMAINID</parameter>), query class (<parameter>IKQUERYCLASS</parameter>), query (<parameter>IKQUERYNAME</parameter>), and default page size (<parameter>IKPAGESIZE</parameter>, optional).

This generic iKnow-DeepSee KPI implementation offers the following services:

Displays all query result columns as properties (columns in the KPI tab form), which can be configured at widget level. A "resultNumber" column is added as well, indicating the "rank" of the result.
Offers all query parameters as filters so they can then be added to the widget (and controlled by the user) or fixed to a specific value. Through the GetParameterValues method in <class>iKnow.Queries.Utils</class>, a list of allowed parameter values is also made available for most common parameters.
Adds a default Listing to this KPI, showing the iKnow sources containing the entities, CRCs or paths selected in the KPI result. (not available for every query)
Exposes all the domains public metadata fields as filters (through <class>iKnow.DeepSee.BaseKPI</class>)
Adds previous and next buttons to browse through the query results (through <class>iKnow.DeepSee.BaseKPI</class>)

Member Function Documentation

◆ OnExecute()

_.Library.Status OnExecute ( )

private

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

Configures and fires the query registered for this GenericKPI instance, given the active filter criteria.

Reimplemented from KPI.

◆ 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.

Adds a list of all valid query parameters for the query identified by <parameter>IKQUERYCLASS</parameter> and <parameter>IKQUERYNAME</parameter>.

Reimplemented from BaseKPI.

◆ 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.

Adds the values for the IK: system filters (series name column, metadata-based filters and query parameters)

Reimplemented from BaseKPI.

◆ OnGetKPIPropertyInfo()

_.Library.Status OnGetKPIPropertyInfo	(	_.Library.String	pList,
		_.Library.Integer	pPropNo,
		_.Library.String	pModelId
	)

staticprivate

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

Adds the returned columns for this KPIs query as properties if there aren't any configured explicitly already, as well as a 'resultNumber' column

Reimplemented from KPI.

◆ OnGetListingResultSet()

_.Library.Status OnGetListingResultSet	(	_.Library.String	pFilters,
		_.Library.String	pSelection,
		_.Library.String	pListingName,
		_.SQL.StatementResult	pRS
	)

staticprivate

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

Triggers the applicable GetBy*** query from <class>iKnow.Queries.SourceAPI</class>, taking into account the selected values in the KPI and any active filters.

Reimplemented from KPI.

Member Data Documentation

◆ IKQUERYCLASS

IKQUERYCLASS = None

static

Override this parameter to specify the iKnow ObjectScript API class that contains the query to use (primary API class, no *QAPI or *WSAPI class)

Implements a DeepSee KPI that executes an iKnow query. To use this class, create a subclass and override the class parameters prefixed with "IK", which you use to specify the iKnow domain (<parameter>IKDOMAINID</parameter>), query class (<parameter>IKQUERYCLASS</parameter>), query (<parameter>IKQUERYNAME</parameter>), and default page size (<parameter>IKPAGESIZE</parameter>, optional).

This generic iKnow-DeepSee KPI implementation offers the following services:

Displays all query result columns as properties (columns in the KPI tab form), which can be configured at widget level. A "resultNumber" column is added as well, indicating the "rank" of the result.
Offers all query parameters as filters so they can then be added to the widget (and controlled by the user) or fixed to a specific value. Through the GetParameterValues method in <class>iKnow.Queries.Utils</class>, a list of allowed parameter values is also made available for most common parameters.
Adds a default Listing to this KPI, showing the iKnow sources containing the entities, CRCs or paths selected in the KPI result. (not available for every query)
Exposes all the domains public metadata fields as filters (through <class>iKnow.DeepSee.BaseKPI</class>)
Adds previous and next buttons to browse through the query results (through <class>iKnow.DeepSee.BaseKPI</class>)

Static Public Attributes

Private Member Functions

Static Private Member Functions

Additional Inherited Members

Detailed Description

Member Function Documentation

◆ OnExecute()

◆ OnGetFilterList()

◆ OnGetFilterMembers()

◆ OnGetKPIPropertyInfo()

◆ OnGetListingResultSet()

Member Data Documentation

◆ IKQUERYCLASS