Class Reference
IRIS for UNIX 2024.1.2
 InterSystems: The power behind what matters   
Documentation  Search
  [USER] >  [%CSP] >  [UI] >  [Portal] >  [Sharding] >  [NodelevelConfig]
Private  Storage   

class %CSP.UI.Portal.Sharding.NodelevelConfig extends %CSP.UI.Portal.Template, %CSP.UI.Portal.Sharding.Utils

System Management Portal - Sharding Configuration for NodeLevel Clusters

Inventory

Parameters Properties Methods Queries Indices ForeignKeys Triggers
5 18 24


Summary

This is a Zen Page class. It belongs to the application %CSP.UI.Portal.Application.

Properties
%condition %import %includeFiles %page
%resource ActivateShardingPage AdvancedSettingsPage AllowActivate
AllowAssign AllowVerify ConfigurePage EnableShardingPage
FirstFailed HasSecPriviledge HelpAddress ISREADONLY
InvalidParam IsEMSReadOnly IsEditForm IsShardingEnabled
LocatorHeader MASTERNAMESPACE NodeLevelPage OnclickArray
PID PageMessage ParentURL RebalanceShardingPage
ShardingPage StdTitle TableDetailsPage ValidationErrorMsg
VerifyShardingPage aboutPage align aux
backgroundTimerInterval cellAlign cellSize cellStyle
cellVAlign children composite contactPage
containerStyle cssLevel currSortMode currStep
currViewMode disabled dragAndDrop dragEnabled
dropEnabled enableAutoRefresh enclosingClass enclosingStyle
error groupClass groupStyle height
hidden hint hintClass hintStyle
home homePage iTimeoutInterval id
index label labelClass labelDisabledClass
labelPosition labelStyle layout lblTitle
limitPopups msgWait name onafterdrag
onbeforedrag onclick ondrag ondrop
onhide onrefresh onshow onupdate
pageModified parent searchKey showLabel
slice title tuple useSVG
useSoftModals valign visible width
window zenPersistentPopup

Methods
%AddChild %AddChildAfter %AddChildBefore %AddComponent
%AddImportedComponents %AddLocatorLinks %AddToSaveSet %ApplyURLParms
%Attr %BindExport %ClassIsLatestVersion %ClassName
%ConstructClone %DispatchClassMethod %DispatchGetModified %DispatchGetProperty
%DispatchMethod %DispatchSetModified %DispatchSetMultidimProperty %DispatchSetProperty
%DrawAutoLogout %DrawClassDefinitions %DrawComponentHTML %DrawHTML
%DrawHTMLPage %DrawJSStrings %DrawObjectDefinitions %EnclosingDivId
%EndBackgroundMethod %EndScript %Eval %EvalC
%Extends %ForceClientRender %GetChildIndex %GetComponent
%GetComponentById %GetComponentByName %GetEventHandlers %GetHomePage
%GetHomeParam %GetLinks %GetLocatorLinks %GetPageName
%GetParameter %GetProductName %GetValueById %GetValueByName
%GetXMLName %IsA %IsModified %Link
%LinkCSS %LinkScript %MakeId %New
%NormalizeObject %ObjectModified %OnAddToPageAfter %OnAddToPageBefore
%OnAfterCreatePage %OnBeforeCreatePage %OnCreateApplication %OnCreatePage
%OnDetermineCSSLevel %OnDrawEnclosingDiv %OnDrawHTMLBody %OnDrawHTMLHead
%OnDrawHTMLMeta %OnDrawObjectProperties %OnFinishBackgroundTask %OnGetPageName
%OnGetProductName %OnGetSmallMenu %OnGetTitle %OnMonitorBackgroundTask
%OnMutateChildren %OnObjectSynch %OnPreHTTP %OnSubmit
%OnUseSoftModals %OnZENDeserialize %OriginalNamespace %PackageName
%QuoteValue %QuoteValueL10N %Register %RemoveChild
%RemoveChildren %RemoveComponent %RemoveFromSaveSet %RunBackgroundMethod
%Self %SerializeObject %SetBackgroundMethodStatus %SetErrorById
%SetErrorByName %SetModified %SetValueById %SetValueByName
%SetValuesByName %StartScript %ValidateObject %ZENVersion
BuildMenu CheckAllBlanks CheckContextLinks CheckEnterpriseManager
CheckJobStatus ConvertParameter Decrypt DoLogout
DrawAddress DrawLocator DrawRibbon DrawRole
DrawTitle Encrypt EscapeHTML EscapeURL
EvalResult GetCSPURL GetContextLinks GetDocURL
GetHomePage GetNamespaceLists GetNewURL GetQuickLinks
GetShardList GetShardingRole HideComponent HyperEventCall
HyperEventHead Include InsertHiddenField InsertHiddenFields
IsPrivate IsShardingEnabled JavaInstalled Link
OnDrawRibbon OnGetRibbonInfo OnHTTPHeader OnPage
OnPageError OnPostHTTP OnPostHyperEvent OnPreHTTP
OnPreHyperEvent Page QuoteJS RegisterRecent
RewriteURL SaveOption ShowError StartRebalance
StartTimer StartVerify StopTimer ThrowError
UnescapeHTML UnescapeURL XMLDTD XMLExport
XMLExportToStream XMLExportToString XMLNew XMLSchema
XMLSchemaNamespace XMLSchemaType addChild addChildAfter
addChildBefore afterSave afterValidate cancelPopup
changePassword childrenMutated correctIELayering createComponent
createComponentNS deleteComponent disableCommandButton doCancel
doConfigure doModified doRebalance doRunQueries
doSettings doTableDetails doVerify dragFinishHandler
dragHandler dragNotifyHandler dragStartHandler dropHandler
dropStartHandler enableButtons enableCommandButton endModal
exposeComponent findElement fireOnResizeEvent fireOnUnloadEvent
fireOnUpdateEvent firePopupAction getChildIndex getComponent
getComponentById getEnclosingDiv getHidden getHintElement
getLabelElement getOpener getPageTitle getProperty
getSettings getTitleAreaHeight getType goHome
goMenu gotoNamespace gotoPage hideCommandButton
invokeSuper isButtonDisabled isOfType launchPopupWindow
logout makeId navigate onCreate
onDelete onDisplayHandler onEndModalHandler onPopupAction
onRefreshContents onSerialize onServerMethodCall onServerMethodError
onServerMethodReturn onStartModalHandler ondisabledHandler onhandleAutoLogoutWarn
onkeydownHandler onkeyupHandler onlayoutHandler onloadHandler
onlogoutHandler onoverlayHandler onresizeHandler onunloadHandler
onupdateHandler popupActionHandler refreshContents removeChild
render renderContents renderSVG resetMsg
searchBlur searchBoxHandler searchFocus searchKeyDown
searchKeyPress setComponentId setConnectivityStatusMsg setHidden
setModified setOverlayMode setPageTitle setProperty
setPropertyAll setSortMode setSortModeHandler setTraceOption
setViewMode setViewModeHandler showAbout showCommandButton
showContact showDocumentation showHelp showMsg
startModal startProgressBar stopProgressBar switchNamespace
tabChanged timeout trimSpace validateRequired


Parameters

• parameter AUTONS = 0;
Do not allow this page to auto-switch namespaces if $NAMESPACE is specified
• parameter CSPURL = "/csp/sys/mgr/%CSP.UI.Portal.Sharding.NodelevelConfig.zen";
This parameter is used to make sure that if multiple CSP applications are mapped to the same namespace that the CSP engine can correctly identify which class corresponds with which URL. If 'LockCSPName' is true (the default, defined in the CSP application) then you can only access this page if the url exactly matches this 'CSPURL'. You can set this parameter to "" if you wish to disable this check for this class. This check is applied for all CSP urls (cls/csp/zen).
If this page was compiled from a .csp file, then this parameter is automatically set to contain the url of this file used for compilation.
• parameter HELPADDRESS = "Home,Configuration,Sharding,NodelevelConfig";
Each SMP page should set this link which points to the documentation anchor name.
• parameter PAGENAME = "Sharding Configuration for Node Level Clusters";
Displayed name of this page.
• parameter RESOURCE = "%Admin_Manage";
Security requirement

Properties

• property ActivateShardingPage as %ZEN.Datatype.string [ InitialExpression = ..Link("/csp/sys/mgr/%CSP.UI.Portal.Sharding.Dialog.Activate.zen",,1) ];
• property AdvancedSettingsPage as %ZEN.Datatype.string [ InitialExpression = ..SettingsLink() ];
• property AllowActivate as %Boolean [ InitialExpression = 0 ];
Allow Activate if the current namespace is a master and if any shard is inactive
• property AllowAssign as %Boolean [ InitialExpression = 1 ];
Allow Assign if the current namespace is a master or it is not a shard
• property AllowVerify as %Boolean [ InitialExpression = 1 ];
Allow Verify if the current namespace a master
• property ConfigurePage as %ZEN.Datatype.string [ InitialExpression = ..Link("/csp/sys/mgr/%CSP.UI.Portal.Sharding.Dialog.Configure.zen",,1) ];
• property EnableShardingPage as %ZEN.Datatype.string [ InitialExpression = ..Link("/csp/sys/mgr/%CSP.UI.Portal.Sharding.Dialog.Enable.zen",,1) ];
• property HasSecPriviledge as %Boolean [ InitialExpression = $System.Security.Check("%Admin_Secure","USE") ];
Whether user can use Enable Sharding
• property IsEditForm as %Boolean [ InitialExpression = 0 ];
Do not use standare Save/Cancel buttons
• property IsShardingEnabled as %Boolean [ InitialExpression = 0 ];
Whether the current InterSystems IRIS instance is enabled to act as a shard master or shard server.
If it is not enabled, then this page will allow user to enable it.
Once it is enabled, then user may be able to Add/Verify/Activate shard for namespace
• property MASTERNAMESPACE as %String;
• property NodeLevelPage as %ZEN.Datatype.string [ InitialExpression = ..Link("/csp/sys/mgr/%25CSP.UI.Portal.Sharding.NodelevelConfig.zen",,1) ];
• property PageMessage as %String;
• property RebalanceShardingPage as %ZEN.Datatype.string [ InitialExpression = ..Link("/csp/sys/mgr/%CSP.UI.Portal.Sharding.Dialog.Rebalance.zen",,1) ];
• property ShardingPage as %ZEN.Datatype.string [ InitialExpression = ..Link("/csp/sys/mgr/%25CSP.UI.Portal.Sharding.Configuration.zen",,1) ];
• property TableDetailsPage as %ZEN.Datatype.string [ InitialExpression = ..Link("/csp/sys/mgr/%CSP.UI.Portal.Sharding.Dialog.TableDetails.zen",,1) ];
• property VerifyShardingPage as %ZEN.Datatype.string [ InitialExpression = ..Link("/csp/sys/mgr/%CSP.UI.Portal.Sharding.Dialog.Verify.zen",,1) ];
• property iTimeoutInterval as %ZEN.Datatype.integer [ InitialExpression = 1000 ];
Double the default timeout interval so long-running VerifyShards calls don't distort the page

Methods

• method %OnAfterCreatePage() as %Status
Be sure to do ##super() when overriding.
• method %OnGetPageName() as %String
Get the (localized) name of the page. This should be implemented in a subclass.
• method DrawAddress(table As %ZEN.Component.tablePane, name As %ZEN.Datatype.string, seed As %ZEN.Datatype.string) as %Status
Helper method to flag the current instance
• method DrawRole(table As %ZEN.Component.tablePane, name As %ZEN.Datatype.string, seed As %ZEN.Datatype.string) as %Status
Helper method to rename "Query" role to "Compute"
• classmethod GetShardingRole(pNamespace) as %String [ ZenMethod ]
• method HideComponent(id As %String)
• 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.
• classmethod SaveOption(MASTERNAMESPACE, OptionName, OptionValue) as %ZEN.proxyObject [ ZenMethod ]
• classmethod StartRebalance(pMASTERNAMESPACE) as %ZEN.proxyObject [ ZenMethod ]
• classmethod StartVerify(pMASTERNAMESPACE) as %ZEN.proxyObject [ ZenMethod ]
Start verifying shards
• method doCancel() [ Language = javascript ]
This method resets the modified indicator and return user to the parent page.
• method doConfigure() [ Language = javascript ]
• method doRebalance() [ Language = javascript ]
• method doRunQueries() [ Language = javascript ]
User changed RunQueriesAsync. Display appropriate hint.
• method doSettings() [ Language = javascript ]
• method doTableDetails(tableName, shardKey) [ Language = javascript ]
• method doVerify(SHARD) [ Language = javascript ]
• method enableButtons(flag) [ Language = javascript ]
User hit Verify button (flag=false): disable currently enabled buttons When verify finishes (flag=true): enable what needs enabled
• method onPopupAction(popupName, action, value) [ Language = javascript ]
This client event, if present, is fired when the a popup page launched from this page fires an action.
• method onloadHandler() [ Language = javascript ]
This client event, if present, is fired when the page is loaded.
• method onresizeHandler() [ Language = javascript ]
This client event, if present, is fired when the page is resized.
• method tabChanged(index) [ Language = javascript ]
• method timeout() [ Language = javascript ]

Copyright (c) 2025 by InterSystems Corporation. Cambridge, Massachusetts, U.S.A. All rights reserved. Confidential property of InterSystems Corporation.