This is documentation for Caché & Ensemble. See the InterSystems IRIS version of this content.

For information on migrating to InterSystems IRIS, see Why Migrate to InterSystems IRIS?

%DeepSee.UI.Dialog.CubeBuild

class %DeepSee.UI.Dialog.CubeBuild extends %DeepSee.UI.Dialog.standardDialog

This dialog builds facts and indices for a DeepSee cube and displays the output. !!! % complete, view log file, show errors, make non-modal!!!

Property Inventory

Method Inventory

Parameters

parameter APPLYBUTTON = 0;
Inherited description: If true, then this dialog displays an Apply button.

Properties

property TempMaxFacts as %ZEN.Datatype.string;
The maximum number of records to be built for the the selected cube in this session (overrides maxFacts)
Property methods: TempMaxFactsDisplayToLogical(), TempMaxFactsGet(), TempMaxFactsIsValid(), TempMaxFactsLogicalToDisplay(), TempMaxFactsLogicalToOdbc(), TempMaxFactsNormalize(), TempMaxFactsSet()
property cubeClass as %ZEN.Datatype.string (ZENURL = "CLASS");
Cube class name.
Property methods: cubeClassDisplayToLogical(), cubeClassGet(), cubeClassIsValid(), cubeClassLogicalToDisplay(), cubeClassLogicalToOdbc(), cubeClassNormalize(), cubeClassSet()
property cubeName as %ZEN.Datatype.string (ZENURL = "CUBE");
Cube name.
Property methods: cubeNameDisplayToLogical(), cubeNameGet(), cubeNameIsValid(), cubeNameLogicalToDisplay(), cubeNameLogicalToOdbc(), cubeNameNormalize(), cubeNameSet()
property maxFacts as %ZEN.Datatype.string (ZENURL = "maxFacts");
The maximum number of records for be built defined for the selected cube
Property methods: maxFactsDisplayToLogical(), maxFactsGet(), maxFactsIsValid(), maxFactsLogicalToDisplay(), maxFactsLogicalToOdbc(), maxFactsNormalize(), maxFactsSet()
property trackingId as %ZEN.Datatype.string;
Id used to track progress.
Property methods: trackingIdDisplayToLogical(), trackingIdGet(), trackingIdIsValid(), trackingIdLogicalToDisplay(), trackingIdLogicalToOdbc(), trackingIdNormalize(), trackingIdSet()

Methods

method %OnAfterCreatePage() as %Status
Inherited description: This callback is called after the server-side page object and all of its children are created.
Subclasses can override this to add, remove, or modify items within the page object model, or to provide values for controls.
method %OnGetSubtitle() as %String
Get the (localized) subtitle string for the dialog. This should be implemented in a subclass.
method %OnGetTitle() as %String
Get the (localized) title string for the dialog. This should be implemented in a subclass.
classmethod BuildCube(pCubeName As %String, pTempMaxFacts As %Integer) as %String [ ZenMethod ]
Start the build cube process in the background. Return the tracking id.
classmethod CheckStatus(pTrackingId As %String) as %String [ ZenMethod ]
Get the current status of the background task.
clientmethod getDialogValue() [ Language = javascript ]
Inherited description: Get the value that will be applied when the user presses the OK button. This is implemented by subclasses.
clientmethod ondialogFinish(action) as %Boolean [ Language = javascript ]
This callback, if defined, is called when the user presses the OK or Apply action buttons. If this returns false, then the action is cancelled.
clientmethod ondialogStart() [ Language = javascript ]
This callback, if defined, is called when the dialog page is loaded.
clientmethod startBuild() [ Language = javascript ]
Start the index build.
clientmethod updateStatus() [ Language = javascript ]
Update the status area.

Inherited Members

Inherited Properties

Inherited Methods

Feedback