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?

%CSP.UI.Portal.Config.Cluster

class %CSP.UI.Portal.Config.Cluster extends %CSP.UI.Portal.Template, %CSP.UI.Portal.Config.Advanced

Class for Cluster Settings

Property Inventory (Including Private)

Method Inventory (Including Private)

Parameters

parameter AUTONS = 0;
Do not switch namespace for this page: it needs to stay in %SYS
parameter CSPURL = /csp/sys/mgr/%CSP.UI.Portal.Config.Cluster.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 EMSSERVICE = Config;
parameter HELPADDRESS = Home,Configuration,Cluster Settings;
Inherited description: Each SMP page should set this link which points to the documentation anchor name.
parameter PAGENAME = Cluster Settings;
Displayed name of this page.
parameter RESOURCE = %Admin_Manage;
Security requirement

Properties

property IsEditForm as %Boolean [ InitialExpression = 1 ];
Inherited description: If set to 1 then the generic Save and Cancel button will be shown on the ribbon bar.
Property methods: IsEditFormDisplayToLogical(), IsEditFormGet(), IsEditFormIsValid(), IsEditFormLogicalToDisplay(), IsEditFormLogicalToXSD(), IsEditFormNormalize(), IsEditFormSet(), IsEditFormXSDToLogical()
property Subject as %String [ InitialExpression = "Cluster" ];
Subject name for the setting page.
Property methods: SubjectDisplayToLogical(), SubjectGet(), SubjectIsValid(), SubjectLogicalToDisplay(), SubjectLogicalToOdbc(), SubjectNormalize(), SubjectSet()

Methods

method %OnAfterCreatePage() as %Status
Subclass can override.
method %OnGetPageName() as %String
Inherited description: Get the (localized) name of the page. This should be implemented in a subclass.
clientmethod doBrowse() [ Language = javascript ]
Launching a file selector window.
clientmethod onPopupAction(popupName, action, value) [ Language = javascript ]
Returning from file select OR qualifers dialog and setting the value into the appropriate field. The id of the field that needs to be updated is saved in "dialogClicked".

Inherited Members

Inherited Properties (Including Private)

Inherited Methods (Including Private)

Feedback