Skip to main content


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

System Management Portal - Sharding Configuration

Property Inventory

Method Inventory


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.Configuration.zen;
Inherited description: 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 Configuration;
Inherited description: Each SMP page should set this link which points to the documentation anchor name.
parameter PAGENAME = Sharding Configuration;
Displayed name of this page.
parameter RESOURCE = %Admin_Manage;
Security requirement


property ActivateShardingPage as %ZEN.Datatype.string [ InitialExpression = ..Link("/csp/sys/mgr/%CSP.UI.Portal.Sharding.Dialog.Activate.zen",,1) ];
Property methods: ActivateShardingPageDisplayToLogical(), ActivateShardingPageGet(), ActivateShardingPageIsValid(), ActivateShardingPageLogicalToDisplay(), ActivateShardingPageLogicalToOdbc(), ActivateShardingPageNormalize(), ActivateShardingPageSet()
property AdvancedSettingsPage as %ZEN.Datatype.string [ InitialExpression = ..SettingsLink() ];
Property methods: AdvancedSettingsPageDisplayToLogical(), AdvancedSettingsPageGet(), AdvancedSettingsPageIsValid(), AdvancedSettingsPageLogicalToDisplay(), AdvancedSettingsPageLogicalToOdbc(), AdvancedSettingsPageNormalize(), AdvancedSettingsPageSet()
property AllowAssign as %Boolean [ InitialExpression = 0 ];
Allow Assign if the current namespace is a master or it is not a shard
Property methods: AllowAssignDisplayToLogical(), AllowAssignGet(), AllowAssignIsValid(), AllowAssignLogicalToDisplay(), AllowAssignLogicalToXSD(), AllowAssignNormalize(), AllowAssignSet(), AllowAssignXSDToLogical()
property AllowVerify as %Boolean [ InitialExpression = 0 ];
Allow Verify if the current namespace has any sharding config
Property methods: AllowVerifyDisplayToLogical(), AllowVerifyGet(), AllowVerifyIsValid(), AllowVerifyLogicalToDisplay(), AllowVerifyLogicalToXSD(), AllowVerifyNormalize(), AllowVerifySet(), AllowVerifyXSDToLogical()
property AssignShardingPage as %ZEN.Datatype.string [ InitialExpression = ..Link("/csp/sys/mgr/%CSP.UI.Portal.Sharding.Dialog.Assign.zen",,1) ];
Property methods: AssignShardingPageDisplayToLogical(), AssignShardingPageGet(), AssignShardingPageIsValid(), AssignShardingPageLogicalToDisplay(), AssignShardingPageLogicalToOdbc(), AssignShardingPageNormalize(), AssignShardingPageSet()
property CurrentNamespace as %String (ZENURL = "$NAMESPACE");
Captures the "current" namespace
Property methods: CurrentNamespaceDisplayToLogical(), CurrentNamespaceGet(), CurrentNamespaceIsValid(), CurrentNamespaceLogicalToDisplay(), CurrentNamespaceLogicalToOdbc(), CurrentNamespaceNormalize(), CurrentNamespaceSet()
property EnableShardingPage as %ZEN.Datatype.string [ InitialExpression = ..Link("/csp/sys/mgr/%CSP.UI.Portal.Sharding.Dialog.Enable.zen",,1) ];
Property methods: EnableShardingPageDisplayToLogical(), EnableShardingPageGet(), EnableShardingPageIsValid(), EnableShardingPageLogicalToDisplay(), EnableShardingPageLogicalToOdbc(), EnableShardingPageNormalize(), EnableShardingPageSet()
property HasSecPriviledge as %Boolean [ InitialExpression = $System.Security.Check("%Admin_Secure","USE") ];
Whether user can use Enable Sharding
Property methods: HasSecPriviledgeDisplayToLogical(), HasSecPriviledgeGet(), HasSecPriviledgeIsValid(), HasSecPriviledgeLogicalToDisplay(), HasSecPriviledgeLogicalToXSD(), HasSecPriviledgeNormalize(), HasSecPriviledgeSet(), HasSecPriviledgeXSDToLogical()
property HasShardingLicense as %Boolean [ InitialExpression = 0 ];
Whether Sharding license is present
Property methods: HasShardingLicenseDisplayToLogical(), HasShardingLicenseGet(), HasShardingLicenseIsValid(), HasShardingLicenseLogicalToDisplay(), HasShardingLicenseLogicalToXSD(), HasShardingLicenseNormalize(), HasShardingLicenseSet(), HasShardingLicenseXSDToLogical()
property InitializePage as %ZEN.Datatype.string [ InitialExpression = ..Link("/csp/sys/mgr/%CSP.UI.Portal.Sharding.Dialog.Initialize.zen",,1) ];
Property methods: InitializePageDisplayToLogical(), InitializePageGet(), InitializePageIsValid(), InitializePageLogicalToDisplay(), InitializePageLogicalToOdbc(), InitializePageNormalize(), InitializePageSet()
property IsEditForm as %Boolean [ InitialExpression = 0 ];
Do not use standare Save/Cancel buttons
Property methods: IsEditFormDisplayToLogical(), IsEditFormGet(), IsEditFormIsValid(), IsEditFormLogicalToDisplay(), IsEditFormLogicalToXSD(), IsEditFormNormalize(), IsEditFormSet(), IsEditFormXSDToLogical()
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 methods: IsShardingEnabled(), IsShardingEnabledDisplayToLogical(), IsShardingEnabledGet(), IsShardingEnabledIsValid(), IsShardingEnabledLogicalToDisplay(), IsShardingEnabledLogicalToXSD(), IsShardingEnabledNormalize(), IsShardingEnabledSet(), IsShardingEnabledXSDToLogical()
property NodeLevelCluster as %String;
If the current Namespace is part of a Node-level cluster, this property holds the role of this namespace for that cluster, so that checkNode() can display a proper warning. Note that this value will be left empty if this Instance is part of a node-level cluster, but the current Namespace plays no role in it, as in those cases it's OK (though likely not very practical) to change / initialize a namespace-level config here.
Property methods: NodeLevelClusterDisplayToLogical(), NodeLevelClusterGet(), NodeLevelClusterIsValid(), NodeLevelClusterLogicalToDisplay(), NodeLevelClusterLogicalToOdbc(), NodeLevelClusterNormalize(), NodeLevelClusterSet()
property NodeLevelPage as %ZEN.Datatype.string [ InitialExpression = ..Link("/csp/sys/mgr/%25CSP.UI.Portal.Sharding.NodelevelConfig.zen",,1) ];
Property methods: NodeLevelPageDisplayToLogical(), NodeLevelPageGet(), NodeLevelPageIsValid(), NodeLevelPageLogicalToDisplay(), NodeLevelPageLogicalToOdbc(), NodeLevelPageNormalize(), NodeLevelPageSet()
property PageMessage as %String;
Property methods: PageMessageDisplayToLogical(), PageMessageGet(), PageMessageIsValid(), PageMessageLogicalToDisplay(), PageMessageLogicalToOdbc(), PageMessageNormalize(), PageMessageSet()
property RebalanceShardingPage as %ZEN.Datatype.string [ InitialExpression = ..Link("/csp/sys/mgr/%CSP.UI.Portal.Sharding.Dialog.Rebalance.zen",,1) ];
Property methods: RebalanceShardingPageDisplayToLogical(), RebalanceShardingPageGet(), RebalanceShardingPageIsValid(), RebalanceShardingPageLogicalToDisplay(), RebalanceShardingPageLogicalToOdbc(), RebalanceShardingPageNormalize(), RebalanceShardingPageSet()
property ShardingPage as %ZEN.Datatype.string [ InitialExpression = ..Link("/csp/sys/mgr/%25CSP.UI.Portal.Sharding.Configuration.zen",,1) ];
Property methods: ShardingPageDisplayToLogical(), ShardingPageGet(), ShardingPageIsValid(), ShardingPageLogicalToDisplay(), ShardingPageLogicalToOdbc(), ShardingPageNormalize(), ShardingPageSet()
property StartEnable as %String;
status after EnableSharding is executed. It is either 1 or tSC. If it is 1 then we display restart instance message.
Property methods: StartEnableDisplayToLogical(), StartEnableGet(), StartEnableIsValid(), StartEnableLogicalToDisplay(), StartEnableLogicalToOdbc(), StartEnableNormalize(), StartEnableSet()
property TableDetailsPage as %ZEN.Datatype.string [ InitialExpression = ..Link("/csp/sys/mgr/%CSP.UI.Portal.Sharding.Dialog.TableDetails.zen",,1) ];
Property methods: TableDetailsPageDisplayToLogical(), TableDetailsPageGet(), TableDetailsPageIsValid(), TableDetailsPageLogicalToDisplay(), TableDetailsPageLogicalToOdbc(), TableDetailsPageNormalize(), TableDetailsPageSet()
property VerifyShardingPage as %ZEN.Datatype.string [ InitialExpression = ..Link("/csp/sys/mgr/%CSP.UI.Portal.Sharding.Dialog.Verify.zen",,1) ];
Property methods: VerifyShardingPageDisplayToLogical(), VerifyShardingPageGet(), VerifyShardingPageIsValid(), VerifyShardingPageLogicalToDisplay(), VerifyShardingPageLogicalToOdbc(), VerifyShardingPageNormalize(), VerifyShardingPageSet()
property iTimeoutInterval as %ZEN.Datatype.integer [ InitialExpression = 1000 ];
Double the default timeout interval so long-running VerifyShards calls don't distort the page
Property methods: iTimeoutIntervalDisplayToLogical(), iTimeoutIntervalGet(), iTimeoutIntervalIsValid(), iTimeoutIntervalLogicalToDisplay(), iTimeoutIntervalLogicalToOdbc(), iTimeoutIntervalNormalize(), iTimeoutIntervalSet()
property warningImage as %ZEN.Datatype.string [ InitialExpression = ..Link("/csp/broker/images/warning.png") ];
Property methods: warningImageDisplayToLogical(), warningImageGet(), warningImageIsValid(), warningImageLogicalToDisplay(), warningImageLogicalToOdbc(), warningImageNormalize(), warningImageSet()


method %OnAfterCreatePage() as %Status
Inherited description: Be sure to do ##super() when overriding.
method %OnGetPageName() as %String
Inherited description: Get the (localized) name of the page. This should be implemented in a subclass.
classmethod Deassign(Namespace, ShardDatabase) as %ZEN.proxyObject [ ZenMethod ]
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 DrawNamespaceHint(seed) as %Status
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(Namespace, OptionName, OptionValue) as %ZEN.proxyObject [ ZenMethod ]
classmethod StartActivate(Namespace) as %ZEN.proxyObject [ ZenMethod ]
Start verifying shards
classmethod StartVerify(Namespace) as %ZEN.proxyObject [ ZenMethod ]
Start verifying shards
clientmethod checkNode() [ Language = javascript ]
clientmethod doActivate() [ Language = javascript ]
clientmethod doCancel() [ Language = javascript ]
This method resets the modified indicator and return user to the parent page.
clientmethod doDeassign(SHARD) [ Language = javascript ]
clientmethod doEdit(SHARD) [ Language = javascript ]
Assign new shard or edit existing shard
clientmethod doNew() [ Language = javascript ]
clientmethod doRebalance() [ Language = javascript ]
clientmethod doRunQueries() [ Language = javascript ]
User changed RunQueriesAsync. Display appropriate hint.
clientmethod doSettings() [ Language = javascript ]
clientmethod doTableDetails(tableName, shardKey) [ Language = javascript ]
clientmethod doVerify(SHARD) [ Language = javascript ]
clientmethod enableButtons(flag) [ Language = javascript ]
User hit Verify button (flag=false): disable currently enabled buttons When verify finishes (flag=true): enable what needs enabled
clientmethod 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.
clientmethod onloadHandler() [ Language = javascript ]
This client event, if present, is fired when the page is loaded.
clientmethod onresizeHandler() [ Language = javascript ]
This client event, if present, is fired when the page is resized.
clientmethod setMaster() [ Language = javascript ]
User changed master namespace. Reload page with new namespace.
clientmethod tabChanged(index) [ Language = javascript ]
clientmethod timeout() [ Language = javascript ]

Inherited Members

Inherited Properties

Inherited Methods

FeedbackOpens in a new tab