%DeepSee.UI.CubeRegistry

Class %DeepSee.UI.CubeRegistry Extends %DeepSee.UI.standardPage [ System = 4 ]

DeepSee CubeRegistry page. This UI allows you to register a "Group" by drag and drop: Drag a group from the tree and drop it on the header for the "Registered" groups. The tree reprsents Unregistered groups. The center table represents Registered groups. You can also register and merge at the same time: Drag a group from the tree and drop it on a registered group in the center table. A confirmation box will display. If confirmed the cubes from the tree will be merged into the registered group. To Unregister, click the "x" image. The map object will be saved immediately after a drag and drop or a unregister. To modify properties for a registered group and cubes, click a row from the center table and modify the properties on the right in the Details pane. After your modification is done, you can click the Save button. If you do a drag & drop or a unregister, these changes will also be saved automatically.

Parameters

JSINCLUDES

Parameter JSINCLUDES = "zenMenusSMP.js";

PAGENAME

Parameter PAGENAME = "Cube Registry";

Displayed name of this page.

RESOURCE

Parameter RESOURCE = "%DeepSee_Admin";

DEFAULTVIEWMODE

Parameter DEFAULTVIEWMODE = "cube";

If this page has multiple views, this is its initial display mode.

DOCBOOKID

Parameter DOCBOOKID = "D2IMP_current_cubemgr";

Properties

cubeName

Property cubeName As %ZEN.Datatype.string;

[NO LONGER USED ON THIS PAGE] Name of Cube being viewed.

cubeClass

Property cubeClass As %ZEN.Datatype.string;

[NO LONGER USED ON THIS PAGE] Class name of Cube being viewed. This is determined from the cube name.

tree

Property tree As %ZEN.Datatype.string;

Data source. This is a copy of the value in the cube model.

currItem

Property currItem As %ZEN.Datatype.integer [ InitialExpression = -1 ];

ID (index number, 0-based) of current selected item.

currItemType

Property currItemType As %ZEN.Datatype.string;

Type of the current selected item.

%model

Property %model As %RegisteredObject;

Local copy of cube map model object.

reloadMap

Property reloadMap As %Boolean [ InitialExpression = 0 ];

Set to 1 if server should reload json map after merge.

readOnly

Property readOnly As %ZEN.Datatype.boolean [ InitialExpression = 0 ];

If true, user cannot modify the current cube definition.

canWrite

Property canWrite As %ZEN.Datatype.boolean [ InitialExpression = 1 ];

If true, user can modify (non-read-only) cube definitions, otherwise they can only view.

hlpRemove

Property hlpRemove As %ZEN.Datatype.caption [ InitialExpression = {$$$Text("Remove this item")} ];

hlpDropTooltip

Property hlpDropTooltip As %ZEN.Datatype.caption [ InitialExpression = {$$$Text("Register %1")} ];

hlpMoveUp

Property hlpMoveUp As %ZEN.Datatype.caption [ InitialExpression = {$$$Text("Move this group up")} ];

hlpMoveDown

Property hlpMoveDown As %ZEN.Datatype.caption [ InitialExpression = {$$$Text("Move this group down")} ];

hlpShowHide

Property hlpShowHide As %ZEN.Datatype.caption [ InitialExpression = {$$$Text("Hide or show the properties box")} ];

msgSystemUpdates

Property msgSystemUpdates As %ZEN.Datatype.caption [ InitialExpression = {$$$Text("This update schedule is managed by an external application")} ];

msgInvalid

Property msgInvalid As %ZEN.Datatype.caption [ InitialExpression = {$$$TextHTML("Cube Registry map is empty.")} ];

msgMerge

Property msgMerge As %ZEN.Datatype.caption [ InitialExpression = {$$$TextJS("Are you sure you want to merge group %1 to group %2?")} ];

imgArrow1D

Property imgArrow1D As %String [ InitialExpression = {..Link("/csp/broker/images/arrow1D.gif")} ];

imgArrow1R

Property imgArrow1R As %String [ InitialExpression = {..Link("/csp/broker/images/arrow1R.gif")} ];

detailCubeGroupName

Property detailCubeGroupName As %String;

Group name for the currently selected cube.

settingsExpanded

Property settingsExpanded As %Boolean [ InitialExpression = 1, Internal ];

If true, the settings area (property sheet) is visible.

expandAll

Property expandAll As %Integer [ InitialExpression = 1 ];

Whether to expand all elements under each type. When user clicks Collapse All then this is set to 0. At end of renderTable it is set to 2.

SavedTime

Property SavedTime As %ZEN.Datatype.string;

Last cube save time when the cube is loaded.

isLocked

Property isLocked As %ZEN.Datatype.boolean [ InitialExpression = 0 ];

The cube is currently locked by someone when the cube is opened in Architect

DocumaticPage

Property DocumaticPage As %String;

activeRegistryExists

Property activeRegistryExists As %Boolean;

XDatas

CSS3Style

XData CSS3Style

This Style block contains page-specific CSS style definitions.

Style

XData Style

This Style block contains page-specific CSS style definitions.

contentPane

XData contentPane [ XMLNamespace = "http://www.intersystems.com/zen" ]

Methods

%OnGetTitle

Method %OnGetTitle() As %String

Get the (localized) title string for the page. This should be implemented in a subclass.

GetTitle

Method GetTitle() As %String [ ZenMethod ]

getPageTitle

ClientMethod getPageTitle() As %String [ Language = javascript ]

Get the title string to add to the locator row. This should be implemented in a subclass.

%OnGetPageName

Method %OnGetPageName() As %String

Get the (localized) name of the page.

%OnGetProductName

Method %OnGetProductName() As %String

Get the product name for the page.

OnGetRibbonInfo

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.

DrawTableHeader

Method DrawTableHeader(pSeed As %String) As %Status

Draw the contents of the Table Header (the region between the diagram and the table).

GetTreeInfo

ClassMethod GetTreeInfo(pRoot As %String, Output pTree, ByRef pParms) As %Status

Provide contents of the data source tree.

OnDrawRibbon

Method OnDrawRibbon() As %Status

Draw additional stuff in the ribbon bar

onlayoutHandler

ClientMethod onlayoutHandler(load) [ Language = javascript ]

Adjust sizes of components on the page.

adjustSizes

ClientMethod adjustSizes() [ Language = javascript ]

Adjust sizes of components on the page.

updateTable

ClientMethod updateTable() [ Language = javascript ]

Update the contents of the model table.

renderTable

ClientMethod renderTable() [ Language = javascript ]

Update the contents of the model table.

confirmSyncExemption

ClientMethod confirmSyncExemption() [ Language = javascript ]

Exempting the synchronize from relationship dependencies is not recommended. When the user attempts to turn this setting off, inform that this is not recommended and confirm that this is really what the user wants to do.

getDayOf

ClientMethod getDayOf(item) [ Language = javascript ]

return what to display for day of month or day of week in center pane

isClosed

ClientMethod isClosed(map, item) [ Language = javascript ]

moveItemUp

ClientMethod moveItemUp(type, row, index) [ Language = javascript ]

moveItemDown

ClientMethod moveItemDown(type, row, index) [ Language = javascript ]

toggleExpand

ClientMethod toggleExpand(flag) [ Language = javascript ]

user clicked Expand All (flag=1) or Collapsed All (flag=0).

findRowForItem

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.

%OnAfterCreatePage

Method %OnAfterCreatePage() As %Status

This class method callback is called just before the server-side page object is created.

GetMapDefinition

Method GetMapDefinition(ByRef pParms, Output pObject As %RegisteredObject) As %Status

Get Registry Map definition for JSON provider.

ShowMap

ClassMethod ShowMap(showTable = 0)

CHUI quick view

getCubeObject

ClientMethod getCubeObject() [ Language = javascript ]

Return the cube definition object.

getSelectedItem

ClientMethod getSelectedItem() [ Language = javascript ]

Return the current selected item.

createNewRegistry

ClientMethod createNewRegistry() [ Language = javascript ]

Launch a popup window to create a new Cube Registry document.

SwitchActiveRegistry

Method SwitchActiveRegistry(pClassName = "") As %Status [ ZenMethod ]

Client-side call to switch the active registry

setViewModeHandler

ClientMethod setViewModeHandler(mode) [ Language = javascript ]

Do the actual work of updating the view to match the current view mode.

filterChanged

ClientMethod filterChanged(value) [ Language = javascript ]

User entered something in to the filter. Re-load the table with filter value.

onPopupAction

ClientMethod onPopupAction(popupName, action, value) [ Language = javascript ]

This client event is fired when the a popup page launched from this page fires an action.

saveMap

ClientMethod saveMap() [ Language = javascript ]

Do save now.

mergeGroups

ClientMethod mergeGroups(mergeFromText, mergeTo, map, index) [ Language = javascript ]

Preparation for Merging two groups

rowClick

ClientMethod rowClick(type, row) [ Language = javascript ]

User click on a row in the table.

doApplyGroupChange

ClientMethod doApplyGroupChange() [ Language = javascript ]

User clicked "Apply to All Cubes in Group" button to save changes to all cubes for that group.

doMergeLoadList

ClientMethod doMergeLoadList() [ Language = javascript ]

User checked the Merge checkbox. We now load the registered groups into the drop-down and show it.

doMerge

ClientMethod doMerge() [ Language = javascript ]

User clicked Merge from "Merge to Group..."

doRegister

ClientMethod doRegister() [ Language = javascript ]

User clicked "Register Group" button to register all cubes for a group when view mode is "table".

findTableItem

ClientMethod findTableItem(cubeName) [ Language = javascript ]

selectTableItem

ClientMethod selectTableItem(cubeName) [ Language = javascript ]

User selected a row from the table view

selectItem

ClientMethod selectItem(type, row, force) [ Language = javascript ]

Select a row in the table.

loadCubeDetails

ClientMethod loadCubeDetails(item, systemLock) [ Language = javascript ]

showUpdatePlan

ClientMethod showUpdatePlan(type, UpdatePlan, BuildTimeUnit) [ Language = javascript ]

This method shows and hide Build/Synch fields based on the item's UpdatePlan

buildAllRegisteredGroups

ClientMethod buildAllRegisteredGroups() [ Language = javascript ]

buildOneRegisteredGroup

ClientMethod buildOneRegisteredGroup() [ Language = javascript ]

repairBuild

ClientMethod repairBuild() [ Language = javascript ]

getCSSForType

ClientMethod getCSSForType(type) [ Language = javascript ]

Find the css class for the given row type.

applyDetails

ClientMethod applyDetails() [ Language = javascript ]

Apply changes from detail form.

enableItem

ClientMethod enableItem(row, flag) [ Language = javascript ]

Enable/disable a row in the table.

removeItem

ClientMethod removeItem(type, row, index) [ Language = javascript ]

Remove a row from the table.

canUndo

ClientMethod canUndo() [ Language = javascript ]

Return true if it is possible to undo an action

undo

ClientMethod undo() [ Language = javascript ]

Undo the most recent change.

clearUndoBuffer

ClientMethod clearUndoBuffer() [ Language = javascript ]

changeUndoState

ClientMethod changeUndoState(undostate) [ Language = javascript ]

Change Undo button state and View button state (opposite of Undo button)

addUndoAction

ClientMethod addUndoAction() [ Language = javascript ]

Remember the current state in the undo buffer.

cloneObject

ClientMethod cloneObject(obj, clone) [ Language = javascript ]

Create a clone of the given object.

toggleDisclosure

ClientMethod toggleDisclosure(key) [ Language = javascript ]

User click on disclosure icon in table.

tableDropHandler

ClientMethod tableDropHandler(dragData) [ Language = javascript ]

Drop handler for model table. dragData.text is the GroupName; dragData.value is "group" or "cube" to indicate what is dragged here.

updateMap

ClientMethod updateMap(reloadMap) [ Language = javascript ]

Thid method will save changes and reload tree. If reloadMap is set to 1 then reload content from server for table. reloadMap is 1 for drag&drop merge and remove.

save

ClientMethod save() [ Language = javascript ]

Save the map.

SubmitMap

Method SubmitMap(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 Cube definition.

canUserModify

ClientMethod canUserModify() [ Language = javascript ]

Test if the user has write privilege.

toggleSettings

ClientMethod toggleSettings() [ Language = javascript ]

Toggle display of settings (property tabs) box.

toolMenu

ClientMethod toolMenu(pageName) [ Language = javascript ]

Show a selected tool in a new window. pageName="Analyzer", "Architect", "MDXQuery", or "ModelBrowser".

editDescription

ClientMethod editDescription(what) [ Language = javascript ]

Toggle to show/hide Description textarea; set what's in text into textarea.

applyDescription

ClientMethod applyDescription(what) [ Language = javascript ]

Set textarea description back into the text description field.

rowMouseOver

ClientMethod rowMouseOver(element, div) [ Language = javascript ]

method for when user mouse over a row in the table

rowMouseOut

ClientMethod rowMouseOut(div) [ Language = javascript ]

method for when mouse out

onloadHandler

ClientMethod onloadHandler() [ Language = javascript ]

This client event, if present, is fired when the page is loaded.