This class is responsible for exposing the functionality of DeepSee.CubeManager.Utils via REST APIs. More...

Inheritance diagram for CommandServer:

Collaboration diagram for CommandServer:

Static Public Member Functions
_.Library.Status	BuildAllRegisteredGroups (_.Library.String namespace)
	This is a utility method which executes a complete build of all currently registered cubes in the current cube registry. More...

_.Library.Status	BuildCube (_.Library.String namespace)
	A wrapper for <method>DeepSee.Utils. More...

_.Library.Status	BuildOneRegisteredGroup (_.Library.String namespace)
	This is a utility method which executes a complete build of one registered cube group in the current cube registry. More...

_.Library.Status	BuildRegistryMap (_.Library.String namespace)
	Retrieve the map that describes the current state of the Cube Registry and all other unregistered cubes on the system. More...

_.Library.Status	ExecuteAction (_.Library.String namespace, _.Library.String pUrl)
	Execute a KPI action defined in a cube's actionClass. More...

_.Library.Status	GetActiveRegistry (_.Library.String namespace)
	Retrieve the name of the Cube Registry currently marked Active. More...

_.Library.Status	GetCubeSize (_.Library.String namespace)
	Given the logical name, pCubeName of a DeepSee cube,. More...

_.Library.Status	GetLastUpdate (_.Library.String namespace)
	Retrieves the timestamp of the the last registered data update for the cube. More...

_.Library.Status	GetSynchScheduleParameters (_.Library.String namespace)
	Convenience method – takes the number of seconds between synchs. More...

_.Library.Status	IsValidCubeSchedule (_.Library.String namespace)
	Validation for the current cube settings. More...

_.Library.Status	IsValidGroup (_.Library.String namespace)
	Boolean test which returns 1 if the group supplied as the argument is no. More...

_.Library.Status	RepairBuild (_.Library.String namespace)
	This method provides a means of doing an unscheduled repair build of a registered cube. More...

_.Library.Status	ScheduleUpdaterTasks (_.Library.String namespace)
	Schedule the build and synch tasks according to the settings in a CubeManager.RegistryMap object. More...

_.Library.Status	SetActiveRegistry (_.Library.String namespace)
	Change which Cube Registry is currently active. More...

_.Library.Status	SynchronizeCube (_.Library.String namespace)
	A wrapper for <method>DeepSee.Utils. More...

	WriteToRegistry (_.Library.String namespace)
	Walk through a CubeManager.RegistryMap object and register the cubes. More...

Static Public Member Functions inherited from REST
_.Library.Status	OnPreDispatch (_.Library.String pUrl, _.Library.String pMethod, _.Library.Boolean pContinue)
	This method Gets called prior to dispatch of the request. More...

Static Public Member Functions inherited from REST
_.Library.Boolean	AcceptsContentType (_.Library.String pType)
	This method tests the HTTP_ACCEPT header and returns true if. More...

_.Library.Status	AccessCheck (_.Library.Boolean pAuthorized)
	This method performs a basic access check. More...

_.Library.Status	DispatchRequest (_.Library.String url, _.Library.String method, _.Library.Boolean forwarded, args)
	Dispatch a REST request according to URL and Method. More...

_.Library.Status	Error (_.Library.Boolean skipheader)
	Called for a REST page in the event of an error being trapped by CSP server.

_.Library.String	GetAuthChallenge ()
	This method determines what challenge will be sent with a 401 (Unauthorized) response. More...

_.Library.Status	Http403 (_.Library.Status pSC)
	Issue a '403' error (Deprecated, use ..ReportHttpStatusCode)

_.Library.Status	Http404 (_.Library.Status pSC)
	Issue a '404' error (Deprecated, use ..ReportHttpStatusCode)

_.Library.Status	Http405 (_.Library.String pSupportedVerbs)
	Issue a '405' error ( user can override)

_.Library.Status	Http500 (_.Exception.AbstractException pE)
	Issue a '500' error and give some indication as to what occurred.

_.Library.Status	Login (_.Library.Boolean skipheader)
	Called for a REST page in the event of a login being required.

_.Library.Status	Page (_.Library.Boolean skipheader)
	This method matches the request and method and calls the dispatcher.

_.Library.Status	ReportHttpStatusCode (pHttpStatus, _.Library.Status pSC)
	Issue an 'Http' error.

	SetResponseHeaderIfEmpty (_.Library.String pHeader, _.Library.String pValue)
	This utility method sets a response header only if it currently does not have a value.

_.Library.Status	StatusToJSON (_.Library.Status pSC, _.Library.DynamicObject pJSON)
	Render a Status as JSON.

_.Library.Status	StatusToProxyObject (_.Library.Status pSC, _.ZEN.proxyObject pJSON)
	Render a Status as JSON (in the form of an array of objects representing each status value).

_.Library.Status	SupportedVerbs (pUrl, _.Library.String pVerbs)
	This generator creates the SupportedVerbs Method used to determine supported verbs to return for the OPTIONS request.

Static Public Member Functions inherited from Login
	DrawCSS3STYLE ()
	Draw the style definitions for the login page. More...

	DrawHEAD (pTitle)
	Draw the HEAD section of the login page. More...

	DrawSTHEAD ()
	Draw the HEAD section of the security token page. More...

	DrawSTTitle (_.Library.String pTitle)
	Draw the title section of the security token page. More...

	DrawSTYLE ()
	Draw the style definitions for the login page. More...

	DrawTitle (_.Library.String pTitle)
	Draw the title section of the login page. More...

	DrawTitleSection (_.Library.String msgs)
	Draw the title section of the page. More...

_.Library.Status	OnHandleCorsRequest (_.Library.String url)
	This is the CORS request handler. More...

_.Library.Status	OnHandleOptionsRequest (_.Library.String url)
	This methods provides handling of the options request for this CSP application. More...

_.Library.Status	OnPage ()
	Output the default login page as HTML.

_.Library.Boolean	OnPreHTTP ()
	Determine if we need login CSRF tokens and if so add them. More...

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.Status	OnPreHyperEvent (_.Library.String class, _.Library.String method)
	Event handler which is invoked before a hyperevent method is called on this page. 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 Private Member Functions
_.Library.Status	SetAnswerStatus (answer, _.Library.Integer errorExists, _.Library.Status tSC, _.Library.String statusVarName, listOfStatusVarWithError)
	This method is very specific to the APIs currently written in DeepSee.REST.vx.CommandServer and is designed to be a utility function only for that class. More...

_.Library.Status	ValidateRequest (_.Library.String pUrl, _.Library.String pMethod)
	Perform specific validation for the service that will handle the request. More...

	lookup2JSON (array)
	A special case of DeepSee.REST.REST. More...

Additional Inherited Members
Static Public Attributes inherited from REST
	CHARSET = None
	Specifies the default character set for the page. More...

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

	HandleCorsRequest = None
	This parameter influences the CORS support. More...

Static Public Attributes inherited from REST
	HandleCorsRequest = None
	This parameter influences the CORS support. More...

	TokenLoginEndpoint = None
	If the REST application is using token authentication, then this parameter gives the path to use for the "login" endpoint. More...

	TokenLogoutEndpoint = None
	If the REST application is using token authentication, then this parameter gives the path to use for the "logout" endpoint. More...

	TokenRefreshEndpoint = None
	If the REST application is using token authentication, then this parameter gives the path to use for the "refresh" endpoint. More...

	TokenRevokeEndpoint = None
	If the REST application is using token authentication, then this parameter gives the path to use for the token revocation endpoint. More...

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

Static Public Attributes inherited from Login
	DOMAIN = None
	Provide a default login and security-token pages for CSP applications. More...

	FAVORITEICON = None
	Home favorite icon.

	HandleCorsRequest = None
	This parameter influences the CORS support for the CSP application that has this login page assigned. More...

	LOGINTITLE = None
	Title displayed for login page. More...

	STYLESHEET = None
	Name of stylesheet used for login page. 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...

Detailed Description

This class is responsible for exposing the functionality of DeepSee.CubeManager.Utils via REST APIs.

Member Function Documentation

◆ SetAnswerStatus()

_.Library.Status SetAnswerStatus	(		answer,
		_.Library.Integer	errorExists,
		_.Library.Status	tSC,
		_.Library.String	statusVarName,
			listOfStatusVarWithError
	)

staticprivate

This method is very specific to the APIs currently written in DeepSee.REST.vx.CommandServer and is designed to be a utility function only for that class.

answer is a dynamic abstract object, errorExists is a 0 or 1 indicating if an error has occured or not. If errorExists is 1, tSC is the status variable to be returned from the method that is invoking this method listOfStatusVarWithError is a list of integers used for methods like /Command/RepairBuild and /Command/BuildAllRegisteredGroups where the variable containing the status (such as buildStats for these 2 APIs) has 2 indices and the answer needs to indicate which buildstat contains the error

◆ ValidateRequest()

_.Library.Status ValidateRequest	(	_.Library.String	pUrl,
		_.Library.String	pMethod
	)

staticprivate

Perform specific validation for the service that will handle the request.

This is used

as a callback in each service that extends DeepSee.REST

Reimplemented from REST.

◆ lookup2JSON()

lookup2JSON ( array )

staticprivate

A special case of DeepSee.REST.REST.

Array2JSON used to modify the lookup

variable returned by DeepSee.REST.vx.CommandServer.BuildRegistryMap

◆ BuildAllRegisteredGroups()

_.Library.Status BuildAllRegisteredGroups ( _.Library.String namespace )

static

This is a utility method which executes a complete build of all currently registered cubes in the current cube registry.

Required Properties: None Optional Properties: map, buildStats

◆ BuildCube()

_.Library.Status BuildCube ( _.Library.String namespace )

static

A wrapper for <method>DeepSee.Utils.

BuildCube</method> which records

cube event information when building the cube. Required Properties: cubeName Optional Properties: async, indexOnly, maxFacts, tracking, mapCube, buildStats, factList

◆ BuildOneRegisteredGroup()

_.Library.Status BuildOneRegisteredGroup ( _.Library.String namespace )

static

This is a utility method which executes a complete build of one registered cube group in the current cube registry.

Required Properties: None Optional Properties: groupName, map, buildStats

◆ BuildRegistryMap()

_.Library.Status BuildRegistryMap ( _.Library.String namespace )

static

Retrieve the map that describes the current state of the Cube Registry and all other unregistered cubes on the system.

Required Properties: None Optional Properties: className, registeredOnly For the lookup variable in the output JSON, for each array in the "cubes" object, the first value corresponds to that the GroupIdx value and the second the CubeIdx value for that cube. The Cube can then be retrieved as follows: Set Cube = Map.Groups.GetAt(GroupIdx).Cubes.GetAt(CubeIdx)

◆ ExecuteAction()

_.Library.Status ExecuteAction	(	_.Library.String	namespace,
		_.Library.String	pUrl
	)

static

Execute a KPI action defined in a cube's actionClass.

The <pCubeName> and <pAction> must be supplied through either a GET or POST

request in order to invoke the action, and additional information may optionally be provided via a CONTEXT object and/or a DataSource.

◆ GetActiveRegistry()

_.Library.Status GetActiveRegistry ( _.Library.String namespace )

static

Retrieve the name of the Cube Registry currently marked Active.

Required Properties: None Optional Properties: None

◆ GetCubeSize()

_.Library.Status GetCubeSize ( _.Library.String namespace )

static

Given the logical name, pCubeName of a DeepSee cube,.

return the number of rows within its fact table. Required Properties: None Optional Properties: cubeKey

◆ GetLastUpdate()

_.Library.Status GetLastUpdate ( _.Library.String namespace )

static

Retrieves the timestamp of the the last registered data update for the cube.

Updates

performed outside of the Cube Manager will not be recognized in this check. Required Properties: cubeKey Optional Properties: updateType

◆ GetSynchScheduleParameters()

_.Library.Status GetSynchScheduleParameters ( _.Library.String namespace )

static

Convenience method – takes the number of seconds between synchs.

and sets the parameters for the call to SYS.Task.DeepSeeSynchronize:Schedule() Required Properties: None Optional Properties: scheduleSynchInterval, dailyFrequency, dailyFrequencyTime, dailyIncrement, dailyStartTime

◆ IsValidCubeSchedule()

_.Library.Status IsValidCubeSchedule ( _.Library.String namespace )

static

Validation for the current cube settings.

Required Properties: cube Optional Properties: None

◆ IsValidGroup()

_.Library.Status IsValidGroup ( _.Library.String namespace )

static

Boolean test which returns 1 if the group supplied as the argument is no.

less than the union of the natural groups of each of its members. Required Properties: group Optional Properties: groups, cubes, buildOrders

◆ RepairBuild()

_.Library.Status RepairBuild ( _.Library.String namespace )

static

This method provides a means of doing an unscheduled repair build of a registered cube.

Required Properties: cubeName Optional Properties: map, async, indexOnly, maxFacts, tracking, buildStats, factList

◆ ScheduleUpdaterTasks()

_.Library.Status ScheduleUpdaterTasks ( _.Library.String namespace )

static

Schedule the build and synch tasks according to the settings in a CubeManager.RegistryMap object.

Required properties: None Optional properties: cubeMap

◆ SetActiveRegistry()

_.Library.Status SetActiveRegistry ( _.Library.String namespace )

static

Change which Cube Registry is currently active.

The Active Registry is the

only one that is visible to the updater tasks. Required Properties: None Optional Properties: className, mustExist

◆ SynchronizeCube()

_.Library.Status SynchronizeCube ( _.Library.String namespace )

static

A wrapper for <method>DeepSee.Utils.

SynchronizeCube</method> which records

cube event information when building the cube. Required Properties: None Optional Properties: cubeName, readCommitted, checkReferences, async, mapCube, synchronizeStats

◆ WriteToRegistry()

WriteToRegistry ( _.Library.String namespace )

static

Walk through a CubeManager.RegistryMap object and register the cubes.

Required Properties: cubeMap Optional Properties: None

Static Public Member Functions

Static Private Member Functions

Additional Inherited Members

Detailed Description

Member Function Documentation

◆ SetAnswerStatus()

◆ ValidateRequest()

◆ lookup2JSON()

◆ BuildAllRegisteredGroups()

◆ BuildCube()

◆ BuildOneRegisteredGroup()

◆ BuildRegistryMap()

◆ ExecuteAction()

◆ GetActiveRegistry()

◆ GetCubeSize()

◆ GetLastUpdate()

◆ GetSynchScheduleParameters()

◆ IsValidCubeSchedule()

◆ IsValidGroup()

◆ RepairBuild()

◆ ScheduleUpdaterTasks()

◆ SetActiveRegistry()

◆ SynchronizeCube()

◆ WriteToRegistry()