Subclasses of this class are used to implement analytic "plug-ins" for DeepSee. More...

Inheritance diagram for KPIPlugIn:

[legend]

Collaboration diagram for KPIPlugIn:

[legend]

Static Public Attributes
	ASYNC = None
	Subclasses of this class are used to implement analytic "plug-ins" for DeepSee.

	BASECUBE = None
	Cube that this plug-in is based on. More...

	LISTINGFIELDS = None
	If defined, this the field list (RETURN clause) of the listing used to supply data for this. More...

	LISTINGSOURCE = None
	Specifies the source of the listing data used by this plugin: "SourceTable" - the data source. More...

	PLUGINTYPE = None
	Specifies the type of this plug-in. More...

	PUBLIC = None
	By default, plug-ins are not visible to dashboards.

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.String	GetPluginMDX (_.Library.Status pStatus)
	Plugins have a context-specific DRILLTHROUGH/DRILLFACTS MDX query that is executed. More...

_.Library.Status	OnCompute (_.SQL.StatementResult pSQLRS, _.Library.Integer pFactCount)
	Compute value(s) for this plug-in. More...

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

_.Library.Status	OnGetAnalysisResultSet (_.SQL.StatementResult pRS, _.Library.String pSQL)
	Return an <class>SQL.StatementResult</class> object that will iterate over the facts used for analysis.

_.Library.String	OnGetListingFields ()
	Returns the field list (RETURN clause) of the listing used to supply data for this plug-in.

_.Library.String	OnGetListingMaxRows ()
	Returns the MDX MAXROWS clause for the drillthrough query used to supply data for this plug-in.

_.Library.String	OnGetListingOrderBy ()
	Returns the MDX ORDER BY clause for the drillthrough query used to supply data for this plug-in.

_.Library.String	OnGetListingSource ()
	Returns the source of the listing data used by this plugin: "SourceTable" - the data source. More...

_.Library.Status	OnGetMDX (_.Library.String pMDX)
	This callback defines the default MDX query used for analysis. More...

_.Library.Status	OnLoadKPI ()
	Notification that this KPI is being executed. More...

Static Private Member Functions
_.Library.String	GetBaseCube ()
	Return the cube(s) this KPI is based on.

_.Library.String	GetPlugInType ()
	Return the type of this plug in.

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

_.Library.Status	OnGetFilterMembers (_.Library.String pFilter, _.Library.List pMembers, _.Library.String pSearchKey, _.Library.String pDataSourceName, _.Library.String pFilterValues)
	Callback to get additional members for a KPI filter. 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 implement analytic "plug-ins" for DeepSee.

Member Function Documentation

◆ GetPluginMDX()

_.Library.String GetPluginMDX ( _.Library.Status pStatus )

private

Plugins have a context-specific DRILLTHROUGH/DRILLFACTS MDX query that is executed.

to ultimately produce the SQL resultset containing the target records for analysis. This method decorates the base query with the MDX resultset cell context and directs the drill to the proper source.

◆ GetSourceType()

_.Library.String GetSourceType ( )

staticprivate

Return the sourceType for this KPI.

Always "custom" for plugins.

Reimplemented from KPI.

◆ OnCompute()

_.Library.Status OnCompute	(	_.SQL.StatementResult	pSQLRS,
		_.Library.Integer	pFactCount
	)

private

Compute value(s) for this plug-in.

pSQLRS is an SQL result set (<class>SQL.StatementResult</class>) that will iterate over a set of facts and provide the base data for the calculations.
pFactCount Is the number of facts in the set.
Plug-in classes should implement this method to perform their calculations.

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

◆ OnGetFilterMembers()

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

staticprivate

Callback to get additional members for a KPI filter.

This takes the form:
pMembers($I(pMembers))=$LB(text,value)
In this case, return members for certain "built-in" filters such as "%cube" and "%measure".

Reimplemented from AbstractKPI.

◆ OnGetListingSource()

_.Library.String OnGetListingSource ( )

private

Returns the source of the listing data used by this plugin: "SourceTable" - the data source.

supplies the listing values; "FactTable" - the fact table supplies the listing values.

◆ OnGetMDX()

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

private

This callback defines the default MDX query used for analysis.

It also checks for the current values

in the filters.
By default, select all facts from the first base cube.
This may be overridden by subclasses.

Reimplemented from KPI.

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

◆ OnLoadKPI()

_.Library.Status OnLoadKPI ( )

private

Notification that this KPI is being executed.

In this case, we compute the value of this plug-in by setting up the context and invoking the <method>OnCompute</method> method.
Plug-in classes should implement the <method>OnCompute</method> method.

Reimplemented from AbstractKPI.

Member Data Documentation

◆ BASECUBE

BASECUBE = None

static

Cube that this plug-in is based on.

This determines which cubes (or subject areas based on this cube) can see this plug-in. This can be a comma-delimited list. The cube name(s) should not be enclosed with [].

◆ LISTINGFIELDS

LISTINGFIELDS = None

static

If defined, this the field list (RETURN clause) of the listing used to supply data for this.

plug-in.

◆ LISTINGSOURCE

LISTINGSOURCE = None

static

Specifies the source of the listing data used by this plugin: "SourceTable" - the data source.

supplies the listing values; "FactTable" - the fact table supplies the listing values.

◆ PLUGINTYPE

PLUGINTYPE = None

static

Specifies the type of this plug-in.

This indicates the context in which this plug-in is used.

"Pivot" – the plug-in is visible within the Analyzer dimension tree.
"Aggregate" – the plug-in is not visible within the Analyzer dimension tree.

Static Public Attributes

Private Member Functions

Static Private Member Functions

Additional Inherited Members

Detailed Description

Member Function Documentation

◆ GetPluginMDX()

◆ GetSourceType()

◆ OnCompute()

◆ OnGetFilterMembers()

◆ OnGetListingSource()

◆ OnGetMDX()

◆ OnLoadKPI()

Member Data Documentation

◆ BASECUBE

◆ LISTINGFIELDS

◆ LISTINGSOURCE

◆ PLUGINTYPE