Skip to main content


class %CSP.UI.Portal.Sharding.Dialog.Settings extends %CSP.Portal.standardDialog, %CSP.UI.Portal.Sharding.Utils

The id for each field on this page should be the same name used as the property name in $SYSTEM.Sharding and each defined in the OPTIONS property on this page.

Property Inventory

Method Inventory


parameter APPLICATION = %CSP.UI.Portal.Application;
Inherited description: This is the class name of this application this page belongs to. If not defined, this page does not belong to an application.
parameter APPLYBUTTON = 0;
If true, then this dialog displays an Apply button.
parameter CSPURL = /csp/sys/mgr/%CSP.UI.Portal.Sharding.Dialog.Settings.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 PAGENAME = ShardingSettings;
Displayed name of this page.
parameter RESOURCE = %Admin_Manage;
Inherited description: This is a comma-delimited list of system Resources and associated permissions. A user must hold the specified permissions on at least one of the specified resources in order to view this page or invoke any of its server-side methods from the client.
The format of each item in the list should be as follows:
Permission is optional, and defaults to USE if not supplied. If it is supplied, it should be one of USE, READ or WRITE.


property ClusterLevel as %String (ZENURL = "CLUSTERLEVEL") [ InitialExpression = "NAMESPACE" ];
Where this dialog got opened from
Property methods: ClusterLevelDisplayToLogical(), ClusterLevelGet(), ClusterLevelIsValid(), ClusterLevelLogicalToDisplay(), ClusterLevelLogicalToOdbc(), ClusterLevelNormalize(), ClusterLevelSet()
property MaxConn as %Integer;
Current Maximum ECP connection number. If this is modified, then the instance will need to be restarted for the new value to take effect.
Property methods: MaxConnDisplayToLogical(), MaxConnGet(), MaxConnIsValid(), MaxConnLogicalToDisplay(), MaxConnNormalize(), MaxConnSet(), MaxConnXSDToLogical()
property OPTIONS as %String [ InitialExpression = "AutoVerify,DropIgnoreError,MasterIPAddress,ConnectTimeout,MirrorConnectAttempts" ];
Option property names that will be shown on this page
Property methods: OPTIONSDisplayToLogical(), OPTIONSGet(), OPTIONSIsValid(), OPTIONSLogicalToDisplay(), OPTIONSLogicalToOdbc(), OPTIONSNormalize(), OPTIONSSet()
property PageMessage as %String;
Property methods: PageMessageDisplayToLogical(), PageMessageGet(), PageMessageIsValid(), PageMessageLogicalToDisplay(), PageMessageLogicalToOdbc(), PageMessageNormalize(), PageMessageSet()


method %OnAfterCreatePage() as %Status
Inherited description: Be sure to do ##super() when overriding.
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.
method DrawAbortError(seed As %String) as %Status
method DrawResult(seed As %String) as %Status
classmethod SaveData(pMasterNamespace, pOPTIONS, pAutoVerify, pDropIgnoreError, pConnectTimeout, pMasterIPAddress, pMirrorConnectAttempts, pOldMaxConn, pNewMaxConn) as %ZEN.proxyObject [ ZenMethod ]
Save option values to server.
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 onloadHandler() [ Language = javascript ]
Inherited description: This client event, if present, is fired when the page is loaded.
clientmethod validate() as %Boolean [ Language = javascript ]

Inherited Members

Inherited Properties

Inherited Methods

FeedbackOpens in a new tab