Skip to main content

This is documentation for Caché & Ensemble. See the InterSystems IRIS version of this content.Opens in a new tab

For information on migrating to InterSystems IRISOpens in a new tab, see Why Migrate to InterSystems IRIS?

%CSP.UI.Portal.Dialog.ECPDataServer

class %CSP.UI.Portal.Dialog.ECPDataServer extends %CSP.UI.Portal.Dialog.WizardTemplate

This class is used internally by Caché. You should not make direct use of it within your applications. There is no guarantee made about either the behavior or future operation of this class.

Edit ECP Data Server for Management Portal

Property Inventory

Method Inventory

Parameters

parameter APPLICATION = %CSP.UI.Portal.Application;
Class name of application this page belongs to.
parameter APPLYBUTTON = 0;
If true, then this dialog displays an Apply button.
parameter CSPURL = /csp/sys/mgr/%CSP.UI.Portal.Dialog.ECPDataServer.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 = Namespace;
parameter PAGENAME = ECP Data Server;
Displayed name of this page.
parameter RESOURCE = %Admin_Manage;
Security requirement

Properties

property SERVERNAME as %String (ZENURL = "ID");
Property methods: SERVERNAMEDisplayToLogical(), SERVERNAMEGet(), SERVERNAMEIsValid(), SERVERNAMELogicalToDisplay(), SERVERNAMELogicalToOdbc(), SERVERNAMENormalize(), SERVERNAMESet()
property action as %String (ZENURL = "action");
mode - "new", "edit", "changeStatus"
Property methods: actionDisplayToLogical(), actionGet(), actionIsValid(), actionLogicalToDisplay(), actionLogicalToOdbc(), actionNormalize(), actionSet()

Methods

method %OnAfterCreatePage() as %Status
This callback is called after the server-side page object and all of its children are created.
Subclasses can override this to add, remove, or modify items within the page object model, or to provide values for controls.
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.
classmethod DrawChangeStatusWarning(pSeed As %String) as %Status
classmethod DrawPageTitle(pSeed As %String) as %Status
classmethod SaveData(pProxy As %ZEN.proxyObject) as %ZEN.proxyObject [ ZenMethod ]
clientmethod doSave() [ Language = javascript ]
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 ]
This client event, if present, is fired when the page is loaded.
clientmethod onstartHandler() [ Language = javascript ]
This client event, if present, is fired when the page is loaded.
clientmethod validate() [ Language = javascript ]

Inherited Members

Inherited Properties

Inherited Methods

FeedbackOpens in a new tab