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

class %DeepSee.UI.ArchitectSA extends %DeepSee.UI.standardPage, %CSP.Portal.SourceControl.Base

DeepSee SubjectArea Architect page. This is a special version of the Architect for operating on Subject Areas.

Property Inventory

Method Inventory

Parameters

parameter DEFAULTVIEWMODE = cube;
If this page has multiple views, this is its initial display mode.
parameter DOCBOOKID = D2MODEL_intro_architect;
Inherited description: Docbook ID for this page.
parameter PAGENAME = DeepSee Architect Subject Area;
Displayed name of this page.

Properties

property %basecube as %DeepSee.Model.SubjectArea.subjectArea;
Local copy of BaseCube model object.
Property methods: %basecubeGet(), %basecubeGetSwizzled(), %basecubeIsValid(), %basecubeNewObject(), %basecubeSet()
property %model as %DeepSee.Model.SubjectArea.subjectArea;
Local copy of SubjectArea model object.
Property methods: %modelGet(), %modelGetSwizzled(), %modelIsValid(), %modelNewObject(), %modelSet()
property DocumaticPage as %String;
Property methods: DocumaticPageDisplayToLogical(), DocumaticPageGet(), DocumaticPageIsValid(), DocumaticPageLogicalToDisplay(), DocumaticPageLogicalToOdbc(), DocumaticPageNormalize(), DocumaticPageSet()
property baseCube as %ZEN.Datatype.string;
Base cube name for the current subject area.
Property methods: baseCubeDisplayToLogical(), baseCubeGet(), baseCubeIsValid(), baseCubeLogicalToDisplay(), baseCubeLogicalToOdbc(), baseCubeNormalize(), baseCubeSet()
property canWrite as %ZEN.Datatype.boolean [ InitialExpression = 1 ];
If true, user can modify (non-read-only) SubjectArea definitions, otherwise they can only view.
Property methods: canWriteDisplayToLogical(), canWriteGet(), canWriteIsValid(), canWriteLogicalToDisplay(), canWriteLogicalToOdbc(), canWriteLogicalToXSD(), canWriteNormalize(), canWriteSet(), canWriteXSDToLogical()
property currItem as %ZEN.Datatype.integer [ InitialExpression = -1 ];
ID (index number, 0-based) of current selected item.
Property methods: currItemDisplayToLogical(), currItemGet(), currItemIsValid(), currItemLogicalToDisplay(), currItemLogicalToOdbc(), currItemNormalize(), currItemSet(), currItemTypeDisplayToLogical(), currItemTypeGet(), currItemTypeIsValid(), currItemTypeLogicalToDisplay(), currItemTypeLogicalToOdbc(), currItemTypeNormalize(), currItemTypeSet()
property currItemType as %ZEN.Datatype.string;
Type of the current selected item.
Property methods: currItemTypeDisplayToLogical(), currItemTypeGet(), currItemTypeIsValid(), currItemTypeLogicalToDisplay(), currItemTypeLogicalToOdbc(), currItemTypeNormalize(), currItemTypeSet()
property dataSource as %ZEN.Datatype.string;
Data source. This is a copy of the value in the base cube model.
Property methods: dataSourceDisplayToLogical(), dataSourceGet(), dataSourceIsValid(), dataSourceLogicalToDisplay(), dataSourceLogicalToOdbc(), dataSourceNormalize(), dataSourceSet()
property hlpRemove as %ZEN.Datatype.caption [ InitialExpression = $$$Text("Remove this item") ];
Property methods: hlpRemoveDisplayToLogical(), hlpRemoveGet(), hlpRemoveIsValid(), hlpRemoveLogicalToDisplay(), hlpRemoveLogicalToOdbc(), hlpRemoveNormalize(), hlpRemoveSet()
property hlpShowHide as %ZEN.Datatype.caption [ InitialExpression = $$$Text("Hide or show the properties box") ];
Property methods: hlpShowHideDisplayToLogical(), hlpShowHideGet(), hlpShowHideIsValid(), hlpShowHideLogicalToDisplay(), hlpShowHideLogicalToOdbc(), hlpShowHideNormalize(), hlpShowHideSet()
property lblDimension as %ZEN.Datatype.caption [ InitialExpression = $$$TextJS("dimension") ];
Property methods: lblDimensionDisplayToLogical(), lblDimensionGet(), lblDimensionIsValid(), lblDimensionLogicalToDisplay(), lblDimensionLogicalToOdbc(), lblDimensionNormalize(), lblDimensionSet()
property lblHier as %ZEN.Datatype.caption [ InitialExpression = $$$TextJS("hierarchy") ];
Property methods: lblHierDisplayToLogical(), lblHierGet(), lblHierIsValid(), lblHierLogicalToDisplay(), lblHierLogicalToOdbc(), lblHierNormalize(), lblHierSet()
property lblLevel as %ZEN.Datatype.caption [ InitialExpression = $$$TextJS("level") ];
Property methods: lblLevelDisplayToLogical(), lblLevelGet(), lblLevelIsValid(), lblLevelLogicalToDisplay(), lblLevelLogicalToOdbc(), lblLevelNormalize(), lblLevelSet()
property lblListing as %ZEN.Datatype.caption [ InitialExpression = $$$TextJS("listing") ];
Property methods: lblListingDisplayToLogical(), lblListingGet(), lblListingIsValid(), lblListingLogicalToDisplay(), lblListingLogicalToOdbc(), lblListingNormalize(), lblListingSet()
property lblMeasure as %ZEN.Datatype.caption [ InitialExpression = $$$TextJS("measure") ];
Property methods: lblMeasureDisplayToLogical(), lblMeasureGet(), lblMeasureIsValid(), lblMeasureLogicalToDisplay(), lblMeasureLogicalToOdbc(), lblMeasureNormalize(), lblMeasureSet()
property msgInvalid as %ZEN.Datatype.caption [ InitialExpression = $$$TextJS("Please click [Open] to select a model definition.") ];
Property methods: msgInvalidDisplayToLogical(), msgInvalidGet(), msgInvalidIsValid(), msgInvalidLogicalToDisplay(), msgInvalidLogicalToOdbc(), msgInvalidNormalize(), msgInvalidSet()
property readOnly as %ZEN.Datatype.boolean [ InitialExpression = 0 ];
If true, user cannot modify the current SubjectArea definition.
Property methods: readOnlyDisplayToLogical(), readOnlyGet(), readOnlyIsValid(), readOnlyLogicalToDisplay(), readOnlyLogicalToOdbc(), readOnlyLogicalToXSD(), readOnlyNormalize(), readOnlyReasonDisplayToLogical(), readOnlyReasonGet(), readOnlyReasonIsValid(), readOnlyReasonLogicalToDisplay(), readOnlyReasonLogicalToOdbc(), readOnlyReasonNormalize(), readOnlyReasonSet(), readOnlySet(), readOnlyXSDToLogical()
property subjectAreaClass as %ZEN.Datatype.string;
Class name of SubjectArea being viewed. This is determined from the SubjectArea name.
Property methods: subjectAreaClassDisplayToLogical(), subjectAreaClassGet(), subjectAreaClassIsValid(), subjectAreaClassLogicalToDisplay(), subjectAreaClassLogicalToOdbc(), subjectAreaClassNormalize(), subjectAreaClassSet()
property subjectAreaDependsOn as %ZEN.Datatype.string;
DependsOn for subjectArea class. If provided, this is used as the DependsOn value of the generated subjectArea. If not, the base cube for the subjectArea is used. This is handled seperately from json.
Property methods: subjectAreaDependsOnDisplayToLogical(), subjectAreaDependsOnGet(), subjectAreaDependsOnIsValid(), subjectAreaDependsOnLogicalToDisplay(), subjectAreaDependsOnLogicalToOdbc(), subjectAreaDependsOnNormalize(), subjectAreaDependsOnSet()
property subjectAreaDescription as %ZEN.Datatype.string;
Description of SubjectArea being viewed. This is determined from the subjectArea name.
Property methods: subjectAreaDescriptionDisplayToLogical(), subjectAreaDescriptionGet(), subjectAreaDescriptionIsValid(), subjectAreaDescriptionLogicalToDisplay(), subjectAreaDescriptionLogicalToOdbc(), subjectAreaDescriptionNormalize(), subjectAreaDescriptionSet()
property subjectAreaDomain as %ZEN.Datatype.string;
Domain of SubjectArea being viewed. This is handled seperately from json.
Property methods: subjectAreaDomainDisplayToLogical(), subjectAreaDomainGet(), subjectAreaDomainIsValid(), subjectAreaDomainLogicalToDisplay(), subjectAreaDomainLogicalToOdbc(), subjectAreaDomainNormalize(), subjectAreaDomainSet()
property subjectAreaFullName as %ZEN.Datatype.string (ZENURL = "CUBE");
Name of SubjectArea (with extension).
Property methods: subjectAreaFullNameDisplayToLogical(), subjectAreaFullNameGet(), subjectAreaFullNameIsValid(), subjectAreaFullNameLogicalToDisplay(), subjectAreaFullNameLogicalToOdbc(), subjectAreaFullNameNormalize(), subjectAreaFullNameSet()
property subjectAreaName as %ZEN.Datatype.string;
Name of SubjectArea being viewed.
Property methods: subjectAreaNameDisplayToLogical(), subjectAreaNameGet(), subjectAreaNameIsValid(), subjectAreaNameLogicalToDisplay(), subjectAreaNameLogicalToOdbc(), subjectAreaNameNormalize(), subjectAreaNameSet()

Methods

Return the array of links to show in the locator bar.
pLink(n)=$LB(caption,link)
method %OnAfterCreatePage() as %Status
This class method callback is called just before the server-side page object is created.
method %OnDrawHTMLHead() as %Status
This callback is called at the end of the HTML HEAD section of the page.
method %OnGetPageName() as %String
Get the (localized) name of the page.
method %OnGetProductName() as %String
Get the product name for the page.
method %OnGetTitle() as %String
Get the (localized) title string for the page. This should be implemented in a subclass.
method DrawTableHeader(pSeed As %String) as %Status
Draw the contents of the Table Header (the region between the diagram and the table).
method GetCubeDefinition(ByRef pParms, Output pBase As %RegisteredObject) as %Status
Get BaseCube definition for JSON provider.
method GetInternalName() as %String
Return the internal name of the current document, including the three letter extension in upper-case. For example, MyPackage.MyClass.CLS would be the internal name for the class MyPackage.MyClass.
method GetSubjectAreaDefinition(ByRef pParms, Output pObject As %RegisteredObject) as %Status
Get SubjectArea definition for JSON provider.
method LoadDefaultList(baseCube, pType) as %String
Return Measure list or Listing list
method LoadListingSource() as %String
Return Data Connector list
method OnDrawRibbon() as %Status
Draw additional stuff in the ribbon bar
method OnGetRibbonInfo(Output pDisplay As %Boolean, Output pViewIcons As %List, Output pSortOptions As %List, Output pSearchBox As %Boolean, Output pRibbonTitle As %String, Output pCommands As %List) as %Status
Get information to display in the ribbon bar.
method SubmitSubjectArea(pCommand As %String, pProvider As %ZEN.Auxiliary.jsonProvider, pSubmitObject As %RegisteredObject, ByRef pResponseObject As %RegisteredObject) as %Status
Object submit handler JSON provider. This is called when the client submits the Subject Area definition.
clientmethod addItem() [ Language = javascript ]
Invoke dialog to add a new item to the model.
clientmethod addNewItemToModel(typenewname) [ Language = javascript ]
Add a new item to the model and select it.
clientmethod addUndoAction() [ Language = javascript ]
Remember the current state in the undo buffer.
clientmethod adjustSizes() [ Language = javascript ]
Adjust sizes of components on the page.
clientmethod applyDependsOn(value) [ Language = javascript ]
user modified DependsOn. Since it is not part of json, handle it seperately.
clientmethod applyDescription(what) [ Language = javascript ]
Set textarea description back into the text description field.
clientmethod applyDetails() [ Language = javascript ]
Apply changes from detail form.
clientmethod applyDomain(value) [ Language = javascript ]
user modified Domain. Since it is not part of json, handle it seperately.
clientmethod browseClass(popupName) [ Language = javascript ]
Invoke class finder dialog. popupName="sourceclasses" or "cubes"
clientmethod canUndo() [ Language = javascript ]
Return true if it is possible to undo an action
clientmethod canUserModify(noAlert As %Library.String) [ Language = javascript ]
Test if the user has write privilege.
clientmethod cancelDetailForm() [ Language = javascript ]
Cancel changes from detail form.
clientmethod changeSubjectArea() [ Language = javascript ]
Launch the subjectArea finder dialog.
clientmethod changeUndoState(undostate) [ Language = javascript ]
Change Undo button state and View button state (opposite of Undo button)
clientmethod changeUseSQL() [ Language = javascript ]
User checked/unchecked the Use SQL field
clientmethod clearUndoBuffer() [ Language = javascript ]
clientmethod cloneObject(obj, clone) [ Language = javascript ]
Create a clone of the given object.
clientmethod compile() [ Language = javascript ]
Compile the cube.
clientmethod createDim(newname) [ Language = javascript ]
clientmethod createHier(newname) [ Language = javascript ]
clientmethod createLevel(newname) [ Language = javascript ]
clientmethod diffDimensions(itemObj, baseObj) [ Language = javascript ]
Check overrides for Dimension
clientmethod diffHierarchies(itemObj, baseObj) [ Language = javascript ]
Check overrides for Hierarchies
clientmethod diffLevels(itemObj, baseObj) [ Language = javascript ]
Check overrides for Levels
clientmethod diffMeasures(itemObj, baseObj) [ Language = javascript ]
Check overrides for Measure
clientmethod dimHasAll(item) [ Language = javascript ]
Find if this baseCube's dimension property hasAll is true or false. If false, then do not show the all members fields.
clientmethod doDocument() [ Language = javascript ]
Open Documatic page to view all details (if user has not modified anything).
clientmethod editDescription(what) [ Language = javascript ]
Toggle to show/hide Description textarea; set what's in text into textarea.
clientmethod editItem(what) [ Language = javascript ]
Invoke dialog to edit certain items: RangeExpression, FormatString, SourceProperty, SourceExpression.
clientmethod enableItem(row, flag) [ Language = javascript ]
Enable/disable a row in the table.
clientmethod findRowForItem(item) [ Language = javascript ]
Find the row number in the table for the given model item. This must be called after the table has been rendered.
clientmethod getCSSForType(type) [ Language = javascript ]
Find the css class for the given row type.
clientmethod getClientModel() [ Language = javascript ]
Get the jsonProvider object on the client.
clientmethod getCubeObject() [ Language = javascript ]
Return the cube definition object.
clientmethod getCurrentName() [ Language = javascript ]
Return the current name of the class/object being modified.
clientmethod getSelectedItem() [ Language = javascript ]
Return the current selected item.
clientmethod getSubjectAreaObject() [ Language = javascript ]
Return the subject area definition object.
clientmethod maxDiff(diffString) [ Language = javascript ]
clientmethod newSubjectArea() [ Language = javascript ]
Invoke dialog to add a new subjectArea.
clientmethod onDocumentLoadComplete() [ Language = javascript ]
Callback method invoked after we have successfully loaded the current document.
clientmethod onPopupAction(popupName, action, value) [ Language = javascript ]
This client event is fired when the a popup page launched from this page fires an action.
clientmethod onlayoutHandler(load) [ Language = javascript ]
Adjust sizes of components on the page.
clientmethod onloadHandler() [ Language = javascript ]
Add check to ensure that we correctly load documents on the client when source control hooks are in use. Also set up a timer to ensure we don't hit timeouts while editing documents in Studio, as well as When in Studio mode, also detect whether we are running IE10, as we need to save documents differently if that is the case.
clientmethod removeItem(type, row, index, hier, level, prop) [ Language = javascript ]
Remove a row from the table.
clientmethod renderTable() [ Language = javascript ]
Update the contents of the model table.
clientmethod rowClick(type, row) [ Language = javascript ]
User click on a row in the table.
clientmethod save() [ Language = javascript ]
Save the cube.
clientmethod saveCube() [ Language = javascript ]
Do save now. This method is called from compile also.
clientmethod selectItem(type, row, force) [ Language = javascript ]
Select a row in the table.
clientmethod selectNewItem(newItem, newType) [ Language = javascript ]
Helper method: select an item, make sure it is visible and give focus to the details panel.
clientmethod setReadOnly(readOnly) [ Language = javascript ]
method used by Source Control to set the value of the readOnly flag.
clientmethod setViewModeHandler(mode As %Library.String, oldmode As %Library.String) [ Language = javascript ]
Do the actual work of updating the view to match the current view mode.
clientmethod toggleDisclosure(key) [ Language = javascript ]
User click on disclosure icon in table.
clientmethod toggleSettings() [ Language = javascript ]
Toggle display of settings (property tabs) box.
clientmethod toolAnalyzer() [ Language = javascript ]
Show analyzer in a new window.
clientmethod toolQuery() [ Language = javascript ]
Show query tool in a new window.
clientmethod undo() [ Language = javascript ]
Undo the most recent change.
clientmethod updateDiff(diffString, propName) [ Language = javascript ]
clientmethod updateTable() [ Language = javascript ]
Update the contents of the model table.
clientmethod viewSub() [ Language = javascript ]
Open View Cube page to view all details (if user has not modified anything).

Inherited Members

Inherited Properties

Inherited Methods

Feedback