Subclasses of this class are used to define KPIs (key performance indicators). More...

Inheritance diagram for KPI:

[legend]

Collaboration diagram for KPI:

[legend]

Static Public Attributes
	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	ComputeKPICacheKey (_.Library.String pSourceType, _.Library.String pQueryText)
	Compute the kpi cache key for the current KPI result. More...

_.Library.String	ComputeKPITimestamp (_.Library.String pTimestamp, _.Library.String pSourceType, _.Library.String pQueryText)
	Compute the kpi cache timestamp for the current KPI result.

_.Library.String	GetMDXContextFilter ()
	Return a series of FILTER clauses (as a single string) based on the "%CONTEXT". More...

_.Library.String	GetMDXForFilter (_.Library.String pLevelSpec, _.Library.String pFilterName)
	Given a filter name, pFilterName, and a level specification, pLevelSpec,. More...

_.Library.String	GetSQLForFilter (_.Library.String pFieldName, _.Library.String pFilterName)
	Given a filter name, pFilterName, and an SQL field name, pFieldName, return an SQL expression. More...

_.Library.Status	LoadKPIFromCache ()
	Load this KPI from cached data.

_.Library.Status	OnComputeKPITimestamp (_.Library.String pTimestamp, _.Library.String pSourceType, _.Library.String pQueryText)
	Compute and return the KPI cache timestamp for the current KPI result. More...

_.Library.Status	OnExecute ()
	Get data for this KPI manually. More...

_.Library.Status	OnGetMDX (_.Library.String pMDX)
	This callback, if implemented, lets a subclass provide an MDX statement to fetch data for this KPI. More...

_.Library.Status	OnGetSQL (_.Library.String pSQL)
	This callback, if implemented, lets a subclass provide an SQL statement to fetch data for this KPI. More...

_.Library.Status	OnLoadKPIFromCache ()
	Notification that we are loading this KPI from cached data.

_.Library.Status	OnLoadModel (_.Library.RegisteredObject pSource)
	This callback method does the actual work of loading values from the source object.

_.Library.Status	OnSaveKPIToCache ()
	Notification that we are saving this KPI to the cache.

_.Library.Status	SaveKPIToCache (_.Library.String pSourceType, _.Library.String pQueryText)
	Save this KPI to the KPI cache.

_.Library.Status	SetPercentComplete (_.Library.Integer pPctComplete, _.Library.Status pErrorCode)
	For a KPI running in the background, set the percentage complete.

_.Library.Status	TestKPICache (_.Library.Boolean pIsCached, _.Library.String pSourceType, _.Library.String pQueryText)
	Test if this KPI has cached data.

_.Library.Status	ValidateKPICache (_.Library.String pSourceType, _.Library.String pQueryText)
	Test if the data cached for this KPI is up-to-date. More...

Static Private Member Functions
_.Library.String	GetKPICaptionName (_.Library.String pName)
	Return the caption as defined in the XML for this KPI.

_.Library.String	GetKPIName (_.Library.String pName)
	Return the logical name for this KPI.

_.Library.String	GetMDXText ()
	Return the default MDX statement for this KPI.

_.Library.Status	GetMembersForFilter (_.Library.String pCube, _.Library.String pFilterSpec, pMembers, _.Library.String pSearchKey)
	Convenience method. More...

_.Library.String	GetSQLText ()
	Return the default SQL statement for this KPI.

_.Library.String	GetSourceType ()
	Return the sourceType for this KPI.

_.Library.Boolean	IsAsync ()
	Return true if this kpi can be computed asynchronously.

_.Library.String	IsCacheable ()
	Return true if this KPI can interact with the cache.

_.Library.Status	OnGetFilterList (_.Library.List pFilters, _.Library.String pDataSourceName)
	Callback to get additional possible filters for this KPI. More...

_.Library.Status	OnGetKPIPropertyInfo (_.Library.String pList, _.Library.Integer pPropNo, _.Library.String pModelId)
	Add additional properties beyond those defined in the KPI block. More...

_.Library.Status	OnGetListingResultSet (_.Library.String pFilters, _.Library.String pSelection, _.Library.String pListingName, _.SQL.StatementResult pRS)
	This callback, if implemented, can prepare and execute. More...

_.Library.String	OnGetListingSQL (_.Library.String pFilters, _.Library.String pSelection, _.Library.String pListingName)
	This callback, if implemented, returns the text of an SQL query used to provide. More...

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

Subclasses of this class are used to define KPIs (key performance indicators).

A KPI defines a set of related values that can be used to drive widgets on a DeepSee dashboard.
A KPI can define a set of actions that can be called from control buttons on a dashboard widget.
Each KPI class is also also a CSP page; if you view it as a Web Page, you can view a test page for the KPI (you must hold Developer privileges to do this).

Member Function Documentation

◆ ComputeKPICacheKey()

_.Library.Status ComputeKPICacheKey	(	_.Library.String	pSourceType,
		_.Library.String	pQueryText
	)

private

Compute the kpi cache key for the current KPI result.

Place the result in <property>cacheKey</property>.

◆ GetMDXContextFilter()

_.Library.String GetMDXContextFilter ( )

private

Return a series of FILTER clauses (as a single string) based on the "%CONTEXT".

of the KPI or MDX function that invoked this KPI. This behavior is automatic; you can override this method and return "" if you do not want this to happen.

◆ GetMDXForFilter()

_.Library.String GetMDXForFilter	(	_.Library.String	pLevelSpec,
		_.Library.String	pFilterName
	)

private

Given a filter name, pFilterName, and a level specification, pLevelSpec,.

return an MDX expression based on the filter value(s) that can be used within an MDX WHERE or FILTER clause.
Returns "" if there is no filter value.
For example: if you have a MDX-based KPI class with a YearSold level within a DateOfSale dimension and a filter named Year, you can get an MDX filter expression for it:
Set tYearFilter = ..GetMDXForFilter("[DateOfSale].[YearSold]","Year")
If tYearFilter is not "", then you can add it to your MDX query to add the filtering:
Set tMDX = tMDX _ " %FILTER " _ tYearFilter

◆ GetMembersForFilter()

_.Library.Status GetMembersForFilter	(	_.Library.String	pCube,
		_.Library.String	pFilterSpec,
			pMembers,
		_.Library.String	pSearchKey
	)

staticprivate

Convenience method.

For a given DeepSee cube and filter spec, return a list of members in the form:
pMembers(n)=$LB(text,value)
This list contains both the display names (text) of the filter items and the logical names (value).
pCube is the logical name of the cube with .cube appended, for example: "holefoods.cube"
pFilterSpec is the COMPLETE name of a level within the cube:
"[DateOfSale].[Actual].[YearSold]"
pSearchKey is any search text entered by the user.

◆ GetSQLForFilter()

_.Library.String GetSQLForFilter	(	_.Library.String	pFieldName,
		_.Library.String	pFilterName
	)

private

Given a filter name, pFilterName, and an SQL field name, pFieldName, return an SQL expression.

based on the filter value(s) that can be used within an SQL WHERE clause. Returns "" if there is no filter value.
For example: if you have a SQL-based KPI class based on a table with a YearSold field, you can get an SQL expression for it:
Set tYearExpr = ..GetSQLForFilter("YearSold","Year")
If tYearExpr is not "", then you can add it to your SQL WHERE clause to add the filtering:
Set tSQL = tSQL _ " WHERE " _ tYearExpr
or if your query already has a WHERE clause:
Set tSQL = tSQL _ " AND " _ tYearExpr

◆ OnComputeKPITimestamp()

_.Library.Status OnComputeKPITimestamp	(	_.Library.String	pTimestamp,
		_.Library.String	pSourceType,
		_.Library.String	pQueryText
	)

private

Compute and return the KPI cache timestamp for the current KPI result.

Typically this is the timestamp of the cube this KPI depends on.

Reimplemented in KPIPlugIn.

◆ OnExecute()

_.Library.Status OnExecute ( )

private

Get data for this KPI manually.

This is implemented by subclasses that provide manual data.

Reimplemented from AbstractKPI.

Reimplemented in SourceListFilterKPI, and GenericKPI.

◆ OnGetFilterList()

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

staticprivate

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)

Reimplemented from AbstractKPI.

Reimplemented in SourceListFilterKPI, GenericKPI, and BaseKPI.

◆ OnGetKPIPropertyInfo()

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

staticprivate

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.

Reimplemented from AbstractKPI.

Reimplemented in SourceListFilterKPI, and GenericKPI.

◆ OnGetListingResultSet()

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

staticprivate

This callback, if implemented, can prepare and execute.

a listing query used to provide a "detail listing" for this KPI. pFilters is an array of current filter values.
pListingName is the name of the listing to display. This is reserved for future use.

Reimplemented from AbstractKPI.

Reimplemented in GenericKPI.

◆ OnGetListingSQL()

_.Library.String OnGetListingSQL	(	_.Library.String	pFilters,
		_.Library.String	pSelection,
		_.Library.String	pListingName
	)

staticprivate

This callback, if implemented, returns the text of an SQL query used to provide.

a "detail listing" for this KPI.
pFilters is an array of current filter values: pFilters(name)=value.
pSelection is an array containing information about the current selected items in the pivot. It contains several values:
pSelection("selectedRange") contains the current selected cells in the pivot as a string in the form "startRow,startCol,endRow,endCol" (1-based). "" if no cells are selected.
pSelection("rowValues") contains a csv-list of "row" values for the selected rows in the pivot (similar to the $$$VALUELIST value used for OpenWindow URLs. This may contain "\," for "," within the data values.
pSelection("sortColumn") is the number of the column to sort on (or 0 for no sort).
pSelection("sortDir") is the sort direction ("ASC" or "DESC").
pListingName is the name of the listing to display. This is reserved for future use.
This method is simply a convenient alternative to the <method>OnGetListingResultSet</method> method. It takes precedence over the <method>OnGetListingResultSet</method> method.

Reimplemented from AbstractKPI.

◆ OnGetMDX()

_.Library.Status OnGetMDX ( _.Library.String pMDX )

private

This callback, if implemented, lets a subclass provide an MDX statement to fetch data for this KPI.

If there are filter values, they will be within the filterValues property (an object).

Reimplemented in PMML, Percentile, Median, iKnow, Distinct, CreateTable, and KPIPlugIn.

◆ OnGetSQL()

_.Library.Status OnGetSQL ( _.Library.String pSQL )

private

This callback, if implemented, lets a subclass provide an SQL statement to fetch data for this KPI.

If there are filter values, they will be within the filterValues property (an object).

◆ ValidateKPICache()

_.Library.Status ValidateKPICache	(	_.Library.String	pSourceType,
		_.Library.String	pQueryText
	)

private

Test if the data cached for this KPI is up-to-date.

If not, clear the cached data.

Member Data Documentation

◆ ASYNC

ASYNC = None

static

Subclasses of this class are used to define KPIs (key performance indicators).

A KPI defines a set of related values that can be used to drive widgets on a DeepSee dashboard.
A KPI can define a set of actions that can be called from control buttons on a dashboard widget.
Each KPI class is also also a CSP page; if you view it as a Web Page, you can view a test page for the KPI (you must hold Developer privileges to do this).

If true, then this KPI can be executed asychronously.

◆ MAXLISTINGROWS

MAXLISTINGROWS = None

static

Use this parameter to limit the number of losting rows displayed in pivot tables.

This setting is ignored for exports.

Static Public Attributes

Private Member Functions

Static Private Member Functions

Additional Inherited Members

Detailed Description

Member Function Documentation

◆ ComputeKPICacheKey()

◆ GetMDXContextFilter()

◆ GetMDXForFilter()

◆ GetMembersForFilter()

◆ GetSQLForFilter()

◆ OnComputeKPITimestamp()

◆ OnExecute()

◆ OnGetFilterList()

◆ OnGetKPIPropertyInfo()

◆ OnGetListingResultSet()

◆ OnGetListingSQL()

◆ OnGetMDX()

◆ OnGetSQL()

◆ ValidateKPICache()

Member Data Documentation

◆ ASYNC

◆ MAXLISTINGROWS