This class provides an API for analyzing MDX queries and generating report data. More...

Inheritance diagram for MDXUtils:

Collaboration diagram for MDXUtils:

Static Public Member Functions
_.Library.Status	Version ()
	Prints the current version to the screen.

Static Public Member Functions inherited from Adaptor
_.Library.Status	XMLDTD (_.Library.String top, _.Library.String format, _.Library.Boolean input, dtdlist)
	Write the DTD to the current device for this XML enabled class serialized as. More...

_.Library.RegisteredObject	XMLNew (_.XML.Document document, _.Library.Integer node, _.Library.RegisteredObject containerOref)
	Get an instance of an XML enabled class. More...

_.Library.Status	XMLSchema (_.Library.String top, _.Library.String format, _.Library.String namespacePrefix, _.Library.Boolean input, _.Library.Boolean refOnly, schema)
	Write an XML Schema fragment to the current device which describes an XML enabled class and dependent classes. More...

_.Library.String	XMLSchemaNamespace ()
	Get the namespace to which this class belongs for use in schema generation. More...

_.Library.Status	XMLSchemaType (_.XML.Schema schemaInstance, _.XML.Node node, _.Library.String top, _.Library.Boolean encoded, _.Library.Boolean summary, _.Library.Boolean input, _.Library.Boolean refOnly)
	Add a complexType to the schema that is respresented by an <class>XML.Schema</class> instance. More...

Public Attributes
	BaseDir
	Base directory for analysis output; defaults to install directory. More...

	CubeGroup
	This property contains the ordered list of cubes that have some logical relation. More...

	Query
	MDX Query being analyzed. More...

	ResultsCached
	DeepSee ResultSet from cached query preparartion (contains statistics). More...

	ResultsUncached
	DeepSee ResultSet from uncached query preparation (contains statistics). More...

	StartTimes
	Holds the start times of the query execution and the start of Run. More...

	TrackingOn
	Used to trigger communication to the UI via the ^DeepSee.MDXUtils global. More...

	UseCache
	Use cache for statistics - set by Prep method. More...

	Verbose
	Controls whether or not status updates should be output to the current device. More...

Static Private Member Functions
_.Library.Status	ClearHistory ()
	Clear the execution history from the logging global. More...

_.Library.Status	Run (_.Library.String pMDX, _.Library.String pBaseDir, _.Library.Boolean pVerbose, pParms, pOutFile)
	This method is used for analysis of an MDX query. More...

Additional Inherited Members
Public Member Functions inherited from Adaptor
_.Library.Status	XMLExport (_.Library.String top, _.Library.String format, _.XML.Namespaces namespaces, attrs, _.Library.String createId, _.Library.String typeAttr, oreflist, idlist, _.Library.String initialIndent, _.Library.Boolean local, _.Net.MIMEPart mimeAttachments)
	Serialize an XML enabled class as an XML document and write. More...

_.Library.Status	XMLExportToStream (_.Stream.Object export, _.Library.String top, _.Library.String format, _.XML.Namespaces namespaces, attrs, _.Library.String createId, _.Library.String typeAttr, oreflist, idlist, _.Library.String initialIndent)
	Serialize an XML enabled class as an XML document and appends it to a stream. More...

_.Library.Status	XMLExportToString (_.Library.String export, _.Library.String top, _.Library.String format, _.XML.Namespaces namespaces, attrs, _.Library.String createId, _.Library.String typeAttr, oreflist, idlist, _.Library.String initialIndent)
	Serialize an XML enabled class as an XML document and write it to a string. More...

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 Attributes inherited from Adaptor
	ATTRIBUTEQUALIFIED = None
	ATTRIBUTEQUALIFIED controls the format of exported XML by controlling whether attributes. More...

	ELEMENTQUALIFIED = None
	ELEMENTQUALIFIED controls the format of exported XML. More...

	NAMESPACE = None
	NAMESPACE specifies the XML namespace to be used when projecting the. More...

	SUPPRESSTYPEPREFIX = None
	SUPPRESSTYPEPREFIX allows the type name that refers to this class. More...

	XMLDEFAULTREFERENCE = None
	XMLDEFAULTREFERENCE specifies the default value of the XMLREFERENCE property parameter. More...

	XMLENABLED = None
	If this parameter is true then XML-enabling methods. More...

	XMLFORMAT = None
	The XMLFORMAT parameter controls the generation of the XMLExport and XMLImport. More...

	XMLIGNOREINVALIDATTRIBUTE = None
	The XMLIGNOREINVALIDATTRIBUTE parameter allows the programmer to control handling of unexpected. More...

	XMLIGNOREINVALIDTAG = None
	The XMLIGNOREINVALIDTAG parameter allows the programmer to control handling of unexpected. More...

	XMLIGNORENULL = None
	XMLIGNORENULL allows the programmer to override the default XML handling. More...

	XMLINCLUDEINGROUP = None
	XMLINCLUDEINGROUP allows the programmer to control whether a class is included. More...

	XMLINHERITANCE = None
	If the XMLINHERITANCE parameter is set to "LEFT", then in the case of multiple. More...

	XMLNAME = None
	This parameter provides the default XMLNAME for the class. More...

	XMLNIL = None
	The XMLNIL class parameter controls the use of xsi:nil by XMLExport. More...

	XMLNILNOOBJECT = None
	The XMLNILNOOBJECT parameter allows creation of an object to be skipped for elements. More...

	XMLPREFIX = None
	The XMLPREFIX parameter controls the prefix to be used for the XML namespace that. More...

	XMLSEQUENCE = None
	If the XMLSEQUENCE = 1, then the order of the XML elements must match the. More...

	XMLSUMMARY = None
	The summary fields to be used when an object is referenced are specified. More...

	XMLTYPE = None
	This parameter provides the default XMLTYPE for the class. More...

	XMLUNSWIZZLE = None
	If the XMLUNSWIZZLE parameter is set to 1, then single object. More...

	XMLUSEEMPTYELEMENT = None
	If the XMLUSEEMPTYELEMENT parameter is set to 1, then the empty element shorthand (<tag>) More...

Static Public Attributes inherited from Adaptor
	DYNAMICPROPERTIES = None
	This is class is used to add support for the DataModel interface to a persistent class. 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...

Detailed Description

This class provides an API for analyzing MDX queries and generating report data.

This class is intended for diagnostic purposes only. There is no guarantee made about either the behavior or future operation of this class. Production applications should not make direct use of these APIs.

Files generated are as follows:

A general statistics report,
PERFMON samples from running the query both uncached and cached,
An export of the cube class and fact table. If this cube is a member of a relationship group, all related cube classes will also be exported.

Member Function Documentation

◆ ClearHistory()

_.Library.Status ClearHistory ( )

staticprivate

Clear the execution history from the logging global.

This will not affect any of the diagnostic reports.

◆ Run()

_.Library.Status Run	(	_.Library.String	pMDX,
		_.Library.String	pBaseDir,
		_.Library.Boolean	pVerbose,
			pParms,
			pOutFile
	)

staticprivate

This method is used for analysis of an MDX query.

This runs the query two times; once uncached and once cached.

During each of these a PERFMON report will be generated and saved to the destination folder. This utility will also collect and save general query statistics, as well as export the Cube and Fact table definitions.
pMDX - The MDX query to be analyzed
pBaseDir - The base directory for storing the output folder. This is set to the instance installation directory by default.
pVerbose - If true, the analysis will print the long-form output to the current device. Setting pVerbose = 0 will run the analysis completely silently.

There are other options that may be turned on via the pParms array:
pParms("CubeStatsOn") = 1
pParms("TimePERFMON") = 15
pParms("SystemPerformanceOn") = 0
pParms("SystemPerformanceProfile") = ""
pParms("UnattendedOn") = 1
"On" in flag name denotes it is treated as a boolean, "Time" denotes it accepts a positive integer argument, in seconds.

Member Data Documentation

◆ BaseDir

BaseDir

Base directory for analysis output; defaults to install directory.

◆ CubeGroup

CubeGroup

This property contains the ordered list of cubes that have some logical relation.

to the cube currently being queried. The list is ordered from least dependent to most independent.

◆ Query

Query

MDX Query being analyzed.

◆ ResultsCached

ResultsCached

DeepSee ResultSet from cached query preparartion (contains statistics).

◆ ResultsUncached

ResultsUncached

DeepSee ResultSet from uncached query preparation (contains statistics).

◆ StartTimes

StartTimes

Holds the start times of the query execution and the start of Run.

◆ TrackingOn

TrackingOn

Used to trigger communication to the UI via the ^DeepSee.MDXUtils global.

◆ UseCache

UseCache

Use cache for statistics - set by Prep method.

◆ Verbose

Verbose

Controls whether or not status updates should be output to the current device.

Static Public Member Functions

Public Attributes

Static Private Member Functions

Additional Inherited Members